Docker Compose

The Environment

In a folder you are going to create two files .env and compose.yaml.

Depending on what you are doing, you are not going to to put the folder in the same directory. To explain this, this an example to guide you :

If you intend to have a production environment :

/srv/tuleap/

If it’s for a demo/test :

/home/$USERNAME/Workspace/test-tuleap

Now you can create the file .env with this configuration :

TULEAP_FQDN="tuleap.example.com"
MYSQL_ROOT_PASSWORD="some random strong password"
TULEAP_SYS_DBPASSWD="another strong password"
SITE_ADMINISTRATOR_PASSWORD="and a third strong password"

Please be aware that you need double quotes around your variables in order for docker to parse the whole string.

Please check the environment variables to know what they stand for.

Tuleap Community

Warning

The following section is meant for test purpose only. The database (MySQL) is handled by Docker and it is not a recommended setup.

Then create a compose.yaml file with following content:

version: "2"

services:
  web:
    image: tuleap/tuleap-community-edition
    hostname: ${TULEAP_FQDN}
    restart: always
    ports:
      - "80:80"
      - "443:443"
      - "22:22"
    volumes:
      - tuleap-data:/data
    depends_on:
      - db
    environment:
      - TULEAP_FQDN=${TULEAP_FQDN}
      - TULEAP_SYS_DBHOST=db
      - TULEAP_SYS_DBPASSWD=${TULEAP_SYS_DBPASSWD}
      - SITE_ADMINISTRATOR_PASSWORD=${SITE_ADMINISTRATOR_PASSWORD}
      - DB_ADMIN_USER=root
      - DB_ADMIN_PASSWORD=${MYSQL_ROOT_PASSWORD}

  # This is for test purpose only. It's not advised to run a production database as a docker container
  db:
    image: mysql:8.0
    command: ["--character-set-server=utf8mb4", "--collation-server=utf8mb4_unicode_ci", "--sql-mode=NO_ENGINE_SUBSTITUTION"]
    environment:
      - MYSQL_ROOT_PASSWORD=${MYSQL_ROOT_PASSWORD}
    volumes:
      - db-data:/var/lib/mysql

volumes:
  tuleap-data:
  db-data:

Tuleap Enterprise

Attention

This image is only available to Tuleap Enterprise subscribers. Please contact your support team to get your access to the private registry.

You first need to authenticate towards Tuleap’s registry:

$ docker login docker.tuleap.org

You should add these variables in your .env file (along with the aforementioned ones):

TULEAP_VERSION="15.0-1"
DB_FQDN="mysql.example.com"
REDIS_FQDN="redis.example.com"

Please check the environment variables to know what they stand for.

version: "2"

services:
tuleap:
    image: docker.tuleap.org/tuleap-enterprise-edition:${TULEAP-VERSION}
    hostname: ${TULEAP_FQDN}
    restart: always
    ports:
      - "80:80"
      - "443:443"
      - "22:22"
    volumes:
    - tuleap-data:/data
    environment:
    - TULEAP_FQDN=${TULEAP_FQDN}
    - TULEAP_SYS_DBHOST=${DB_FQDN}
    - TULEAP_SYS_DBPASSWD=${TULEAP_SYS_DBPASSWD}
    - SITE_ADMINISTRATOR_PASSWORD=${SITE_ADMINISTRATOR_PASSWORD}
    - DB_ADMIN_USER=root
    - DB_ADMIN_PASSWORD=${MYSQL_ROOT_PASSWORD}
    - TULEAP_FPM_SESSION_MODE=redis
    - TULEAP_REDIS_SERVER=${REDIS_FQDN}

volumes:
    tuleap-data:

If you want to secure your server and use certificates, you may spawn a Reverse-Proxy in the stack.

Run the docker-compose file

Go inside the directory where you created the two files and run

$ docker-compose up -d

Then you can follow the progress of the installation with

$ docker-compose logs -f tuleap

Until you see something like:

...
web_1      | ***********************************************************************************************************
web_1      | * Your Tuleap fully qualified domain name is tuleap.example.com and it's IP address is 172.21.0.5         *
web_1      | ***********************************************************************************************************
web_1      | Setup Supervisord
web_1      | Let the place for Supervisord
web_1      | 2021-06-15 14:46:50,731 INFO Included extra file "/etc/supervisord.d/backend_workers.ini" during parsing
web_1      | 2021-06-15 14:46:50,731 INFO Included extra file "/etc/supervisord.d/crond.ini" during parsing
web_1      | 2021-06-15 14:46:50,731 INFO Included extra file "/etc/supervisord.d/fpm.ini" during parsing
web_1      | 2021-06-15 14:46:50,731 INFO Included extra file "/etc/supervisord.d/httpd.ini" during parsing
web_1      | 2021-06-15 14:46:50,732 INFO Included extra file "/etc/supervisord.d/nginx.ini" during parsing
web_1      | 2021-06-15 14:46:50,732 INFO Included extra file "/etc/supervisord.d/postfix.ini" during parsing
web_1      | 2021-06-15 14:46:50,732 INFO Included extra file "/etc/supervisord.d/rsyslog.ini" during parsing
web_1      | 2021-06-15 14:46:50,732 INFO Included extra file "/etc/supervisord.d/sshd.ini" during parsing
web_1      | 2021-06-15 14:46:50,732 INFO Included extra file "/etc/supervisord.d/supervisord-server-credentials.ini" during parsing
web_1      | 2021-06-15 14:46:50,732 INFO Set uid to user 0 succeeded
web_1      | 2021-06-15 14:46:50,769 INFO RPC interface 'supervisor' initialized
...

You can then quit the logs command (Ctrl+C) and open your browser at the address set in TULEAP_FQDN and that’s it.

The docker-compose file provided here is for general guidance and you should adapt it to your environment. One of the main things you will want to configure is a proper email relay.