Skip to content

SSL Configuration

You have several options to run Tracardi in SSL mode.

Building Tracardi API with SSL certificates embedded into docker

Clone repository tracardi/tracardi-api.git.

git clone

Next go to tracardi folder and find file Dockerfile.ssl-internal and type path to your SSL certificate and key file.

  • Find and replace ssl/key.pem with a path to your key file
  • Find and replace ssl/cert.pem with a path to your certificate

This is how the Dockerfile.ssl-internal looks like

FROM tiangolo/uvicorn-gunicorn-fastapi

RUN apt-get update
RUN apt-get install -y git

# set the working directory in the container
RUN mkdir app/

## Install dependencies
COPY app/requirements.txt .
RUN pip install -r requirements.txt

## Copy application
COPY app app/
COPY ssl ssl/
COPY docs manual/
ENV VARIABLE_NAME="application"

CMD ["gunicorn", "-b", "", "--workers", "25,"--keyfile", "ssl/key.pem", "--certfile", "ssl/cert.pem", "-k", "uvicorn.workers.UvicornWorker", "app.main:application"]

If you would like to tweak the number of workers running change --workers option in gunicorn.

Then run

cd tracardi-api/
docker build . -f Dockerfile.ssl-internal -t tracardi-api-ssl

Once built you can run Tracardi with the following command:

docker run -p 8686:443 -e ELASTIC_HOST=http://<your-laptop-ip>:9200 tracardi-api-ssl

This will make API available at https://localhost:8686. If you want it on the standard HTTPS port run:

docker run -p 443:443 -e ELASTIC_HOST=http://<your-laptop-ip>:9200 tracardi-api-ssl

And the API will be available https://localhost.

Running Tracardi API with SSL certificates provided from outside container

Sometimes you do not want to build the docker yourself. Then you can use the prebuilt docker and attach your certificates. To do that pull tracardi/tracardi-api-ssl.

docker pull tracardi/tracardi-api-ssl

Then copy your SSL certificates to any folder. For the purpose of this manual we place it in /local/path/to/ssl. You can place it anywhere but remember to change the location in the command below:

docker run \
-v /local/path/to/ssl:/ssl \
-p 8686:443 \
-e ELASTIC_HOST=http://<your-elastic-instance-ip>:9200 \
-e GUNICORN_CMD_ARGS="--keyfile=/ssl/key.pem --certfile=/ssl/cert.pem" \

It will start Tracardi with files from your local /local/path/to/ssl folder copied/linked to internal docker folder called /ssl. If you placed certificates inside that folder then the files will be accessible form /ssl in docker. The Docker image expects na SSL key file to be named key.pem and certificate to be named cert.pem.

Tracardi API behind HTTPS proxy

You can use treafik to hide Tracardi API behind HTTPS proxy.

Refer to this link for instructions:

Tracardi GUI in HTTPS mode

git clone

Find tracardi-gui/nginix/conf-ssl/certs and place there your certificates:

  • cert.pem
  • key.pem


docker build . -f Dockerfile-https --no-cache -t tracardi/tracardi-gui-https

Use tracardi/tracardi-gui-https as you docker image instead of tracardi/tracardi-gui.