YouTrack Server 2024.2 Help

Run Docker Container as a Service

Docker recommends using their cross-platform built-in restart policy for running a container as a service. For this, configure your Docker service to start on system boot and add the --restart unless-stopped parameter to the docker run command that starts YouTrack.

If you want to start multiple services one after the other, including YouTrack, the restart policy won't work well. In such cases, it's better to use a process manager instead.

Specific instructions for setting up a restart policy vary by operating system. To make sure you see information that is relevant to your installation, select the tab that corresponds with the operating system used in your host environment.

Here's an example of how to run YouTrack container as a service on Linux with help of systemd.

To run the YouTrack container as a service on Linux with systemd

  1. Create a service descriptor file /etc/systemd/system/docker.youtrack.service:

    [Unit] Description=YouTrack Service After=docker.service Requires=docker.service [Service] TimeoutStartSec=0 Restart=always ExecStartPre=-/usr/bin/docker exec %n stop ExecStartPre=-/usr/bin/docker rm %n ExecStartPre=/usr/bin/docker pull jetbrains/youtrack:<version> ExecStart=/usr/bin/docker run --rm --name %n \ -v <path to data directory>:/opt/youtrack/data \ -v <path to conf directory>:/opt/youtrack/conf \ -v <path to logs directory>:/opt/youtrack/logs \ -v <path to backups directory>:/opt/youtrack/backups \ -p <port on host>:8080 \ --stop-timeout 60 \ jetbrains/youtrack:<version> ExecStop=/usr/bin/docker exec %n stop [Install]
  2. Enable starting the service on system boot with the following command:

    systemctl enable docker.youtrack

You can also stop and start the service manually at any moment with the following commands, respectively:

sudo service docker.youtrack stop sudo service docker.youtrack start

For Windows, you can run YouTrack as a service with the help of Docker Compose.

  • Ensure you have Docker Desktop installed on your Windows system. For instructions, please refer to the Docker documentation.

  • Create a Docker Compose File.

    A Docker Compose file is typically a .yml that defines your containerized application and its configuration. In this case, your file contains the parameters you would typically use to run YouTrack.

    Here's an example you can use as a guide for writing your file:

    version: "3" services: YouTrack: container_name: youtrack-server image: jetbrains/youtrack:<version> user: "13001:13001" restart: unless-stopped ports: - "<port on host>:8080" volumes: - <path to data folder>:/opt/youtrack/data - <path to conf folder>:/opt/youtrack/conf - <path to logs folder>:/opt/youtrack/logs - <path to backups folder>:/opt/youtrack/backups
  • Run Docker Compose as a Windows Service.

    Open a Command Prompt or PowerShell with administrative privileges. Navigate to the directory where your Docker Compose file is located and use the following command to run it as a Windows service:

    docker-compose -f docker-compose.yml up -d

    This command starts YouTrack as a Windows service in detached mode, running it in the background.

You can then manage your YouTrack service using standard Docker commands. For example:

  • To stop the service, use: docker-compose -f docker-compose.yml down

  • To check the service status, use: docker-compose -f docker-compose.yml ps

If the server shuts down for whatever reason, Docker will automatically restart the container on reboot.

In order for this to work, you must configure the Docker service to start automatically when the server boots up. For specific instructions, please refer to the documentation for your server operating system.

You will also need to ensure that the Windows user account that runs the service is automatically logged in on reboot. This is typically done at the Windows service level and is managed separately from the Docker container's user context. For specific instructions, please refer to the documentation for the application that manages user access in your server environment.

Last modified: 19 July 2024