Skip to content

Deploying Tracelake

How is Tracelake deployed

Tracelake is deployed as a single containerized application. As such, it can be deployed in any environment that supports containerized applications, such as Kubernetes, Managed container services, VM instance, local Docker, etc.

Installation guide

The installation guide walks you through the steps to deploy Tracelake as a container running on a VM.

  1. Create or login to a Tracelake account

    You need to have a Tracelake account to deploy Tracelake. If you don’t have an account yet, you can sign up for free.

    In the portal, you can see your Docker registry credentials and Application token, which you will need for the next step.

    registry-credentials

  2. Validate docker installation

    Docker needs to be installed and running on the VM.

    Terminal window
    docker --version
    # Docker version 27.3.1, build ce12230
  3. Login to Tracelake Docker registry

    Terminal window
    docker login registry.tracelake.com
    # Username: <your-username>
    # Password: <your-password>
  4. Run the deployment command

    The deployment command will deploy Tracelake as a container on the VM. There are multiple configuration options available which change the behavior of Tracelake.

    If you have a domain name, you can set the TRACELAKE_HOSTNAME environment variable to your domain name. This will automatically configure Tracelake to use HTTPS with self-signed certificates. If you want to use your own certificates, you can read more about them in the Security section.

    For persistent storage, make sure you always mount the /app/db and /data volumes.

    Example deployment command:

    Terminal window
    docker run -d --restart unless-stopped \
    -v tracelake_data:/app/tracelake_server/data \
    -e TRACELAKE_PORTAL_TOKEN=••••••••••••••• \
    -e TRACELAKE_HOSTNAME=tracelake.example.com \
    --name tracelake -p 80:80 -p 443:443 registry.tracelake.com/tracelake:latest

    For deployment on localhost (not accessible from other machines), you can use this command:

    Terminal window
    docker run -d --restart unless-stopped \
    -v tracelake_data:/app/tracelake_server/data \
    -e TRACELAKE_PORTAL_TOKEN=••••••••••••••• \
    --name tracelake -p 8000:8000 registry.tracelake.com/tracelake:latest
  5. Verify the deployment

    Now you should be able to access Tracelake at the address you specified in the TRACELAKE_HOSTNAME environment variable or at localhost:8000 if you deployed without a domain name.