Skip to main content

Linux or macOS


This documentation page applies to deploying your own open source ClearML Server. It does not apply to ClearML Hosted Service users.

Important: Upgrading from v0.14 or older

For Linux only, if upgrading from Trains Server v0.14 or older, configure the ClearML Agent Services.

  • If CLEARML_HOST_IP is not provided, then ClearML Agent Services will use the external public address of the ClearML Server.
  • If CLEARML_AGENT_GIT_USER / CLEARML_AGENT_GIT_PASS are not provided, then ClearML Agent Services will not be able to access any private repositories for running service tasks.
export CLEARML_HOST_IP=server_host_ip_here
export CLEARML_AGENT_GIT_USER=git_username_here
export CLEARML_AGENT_GIT_PASS=git_password_here

For backwards compatibility, the environment variables TRAINS_HOST_IP, TRAINS_AGENT_GIT_USER, and TRAINS_AGENT_GIT_PASS are supported.

To upgrade ClearML Server Docker deployment:

  1. Shutdown ClearML Server. Execute the following command (which assumes the configuration file is in the environment path).

    docker-compose -f docker-compose.yml down
  2. If upgrading from Trains Server version 0.15 or older to ClearML Server, a data migration is required before upgrading. First follow these data migration instructions, and then continue this upgrade.

  3. We recommend backing up data and, if the configuration folder is not empty, backing up the configuration.

  4. If upgrading from Trains Server to ClearML Server, rename /opt/trains and its subdirectories to /opt/clearml.

    sudo mv /opt/trains /opt/clearml
  5. Download the latest docker-compose.yml file.

    curl -o /opt/clearml/docker-compose.yml
  6. Startup ClearML Server. This automatically pulls the latest ClearML Server build.

    docker-compose -f /opt/clearml/docker-compose.yml pull
    docker-compose -f /opt/clearml/docker-compose.yml up -d

If issues arise during your upgrade, see the FAQ page, How do I fix Docker upgrade errors?.