Skip to content
Caliber Technology

Overview

Welcome to the TaxServer API documentation. This API is designed to provide a simple front-end to the TaxControls tax engine.

To start the TaxServer container, you can use the following command:

Terminal window
docker run -p 8000:80 calibertechnology/taxserver

Direct your browser to http://localhost:8000.

If you prefer https service, which will run on port 8443 (ignore the browser warning about the self-signed certificate):

Terminal window
sudo docker run -p 8443:8443 calibertechnology/taxserver

This image comes with the latest software, and a slightly older taxfile (check version).

The default ports used by the TaxServer container are 80 for HTTP and 8443 for HTTPS. If you wish to use different ports, you can do so by setting the environment variables HTTP_PORT and/or HTTPS_PORT:

Terminal window
export HTTPS_PORT="443"
docker run --env HTTPS_PORT -p 443:443 calibertechnology/taxserver

If you have a TaxUpdate subscription, you can import the latest taxfile at startup. Using your <username> and <password> credentials, run:

Terminal window
export USERNAME=<username>
export PASSWORD=<password>
docker run --env USERNAME --env PASSWORD -p 8443:8443 calibertechnology/taxserver

The container will attempt to download the latest taxfile. If this fails, you’ll see a message on the console, and it will use the demo tables.

Alternatively, you can load one or more taxfiles by mapping a local directory to /taxes on the image. For example, if the local directory local contains the desired tables, you can start the container using:

Terminal window
docker run -v ./local:/taxes -p 8443:8443 calibertechnology/taxserver

If multiple taxfiles are found, all will be read and merged.

For typical cloud services, you can set the USERNAME and PASSWORD environment variables for TaxServer using either the CLI or web interface for starting the container. Please remember that this container instance should not be used by third parties except through your licensed product.

On cloud services which do not allow redirection of exposed ports, you may wish to adjust the ports used by this container as described above. The TaxServer application will open the ports as requested.