Windows 10

important

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

For Windows, we recommend launching the pre-built Docker image on a Linux virtual machine (see Deploying ClearML Server: Linux or macOS). However, ClearML Server can be launched on Windows 10, using Docker Desktop for Windows (see the Docker System Requirements).

For information about upgrading ClearML Server on Windows, see here.

important

If ClearML Server is being reinstalled, we recommend clearing browser cookies for ClearML Server. For example, for Firefox, go to Developer Tools > Storage > Cookies, and for Chrome, go to Developer Tools > Application > Cookies, and delete all cookies under the ClearML Server URL.

Deploying

warning

By default, ClearML Server launches with unrestricted access. To restrict ClearML Server access, follow the instructions in the Security page.

To deploy ClearML Server on Windows 10:

1. Install the Docker Desktop for Windows application by either:

   • Following the Install Docker Desktop on Windows instructions.
   • Running the Docker installation wizard.

2. Increase the memory allocation in Docker Desktop to 4GB.

   1. In the Windows notification area (system tray), right click the Docker icon.

   2. Click Settings > Advanced, and then set the memory to at least 4096.

   3. Click Apply.

3. Remove any previous installation of ClearML Server.

   This clears all existing ClearML SDK databases.

   rmdir c:\opt\clearml /s

4. Create local directories for data and logs. Open PowerShell and execute the following commands:

   cd c:

   mkdir c:\opt\clearml\data

   mkdir c:\opt\clearml\logs

5. Save the ClearML Server docker-compose YAML file.

   curl https://raw.githubusercontent.com/allegroai/clearml-server/master/docker/docker-compose-win10.yml -o c:\opt\clearml\docker-compose-win10.yml

6. Run docker-compose. In PowerShell, execute the following commands:

   docker-compose -f c:\opt\clearml\docker-compose-win10.yml up

   The server is now running on http://localhost:8080.

Port mapping

After deploying ClearML Server, the services expose the following node ports:

• Web server on port 8080
• API server on port 8008
• File server on port 8081

Restarting

To restart ClearML Server Docker deployment:

• Stop and then restart the Docker containers by executing the following commands:

  docker-compose -f c:\opt\clearml\docker-compose-win10.yml down

  docker-compose -f c:\opt\clearml\docker-compose-win10.yml up -d

Next Step

• Configuring ClearML for ClearML Server.