Redmine (AlmaLinux 8)

Software included

Package	Version
Redmine	latest
Docker	3.20.10
Docker compose	2.12.2
containerd.io	1.6.10

Initial start of the service

This application uses Docker to provide faster startup of the companion software (Redmine) and direct use of it. This eliminates the need to familiarize yourself with its specifics in terms of configuration and installation. To start working directly with the application, all you need to do is visit the IP address assigned to your virtual machine in your browser to see your new Redmine installation.

Note: By default, Redmine can be accessed directly by IP address. To start using Redmine with your real domain, you must first point the domain in question to your IP address and change the settings for where Redmine opens from through its admin panel.

Quick settings and frequently asked questions

• Logging into the cloud service is done using an SSH key or password that you have specified.
• Docker is installed as recommended by the official docker documentation.
• The standard docker and docker compose commands are now available in this application.
• When the virtual machine is first started, it takes a few minutes before a Docker container containing Redmine is started.
• Redmine data is set to be persistent and is located in /opt/redmine/data/. MariaDB is also persistent and stores its databases in /opt/mariadb/data/.
• The user to access the Redmine admin panel is admin and the password is P@ssw0rd!.

Additional Docker settings

Additional Redmine settings that you can change and that are controlled directly by Docker are set as variable values in the configuration file /opt/docker-redmine/docker-compose.yml:

Note: After changing any of the values, you must recreate the Docker container on which the application is running. For more information, please read the Recreating Docker containers section.

Redmine configuration options

General options

• REDMINE_PORT_NUMBER: Port number in which Redmine will run in the Docker container. Default: 3000
• REDMINE_USERNAME: Redmine application username. Default: admin
• REDMINE_PASSWORD: Redmine application password. Default: P@ssw0rd!
• REDMINE_EMAIL: Redmine email. Default: admin@example.com
• REDMINE_FIRST_NAME: Redmine user first name. Default: UserName
• REDMINE_LAST_NAME: Redmine user last name. Default: LastName
• REDMINE_LANGUAGE: Redmine site default language. Default: en
• REDMINE_REST_API_ENABLED: Whether to allow REST API calls to Redmine. Default: 0
• REDMINE_LOAD_DEFAULT_DATA: Whether to load default configuration data for Redmine. Default: yes
• REDMINE_SKIP_BOOTSTRAP: Whether to skip performing the initial bootstrapping for the application. Default: no

Database connection configuration

• REDMINE_DATABASE_TYPE: Database type to be used for the Redmine installation. Allowed values: mariadb, postgresql. Default: mariadb
• REDMINE_DATABASE_HOST: Hostname for the MariaDB or MySQL server. Default: mariadb
• REDMINE_DATABASE_PORT_NUMBER: Port used by the MariaDB or MySQL server. Default: 3306
• REDMINE_DATABASE_NAME: Database name that Redmine will use to connect with the database. Default: redmine
• REDMINE_DATABASE_USER: Database user that Redmine will use to connect with the database. Default: redmine
• REDMINE_DATABASE_PASSWORD: Database password that Redmine will use to connect with the database. Без default стойности.
• ALLOW_EMPTY_PASSWORD: It can be used to allow blank passwords. Default: no

SMTP Configuration

• REDMINE_SMTP_HOST: SMTP host.
• REDMINE_SMTP_PORT: SMTP port.
• REDMINE_SMTP_USER: SMTP user.
• REDMINE_SMTP_PASSWORD: SMTP password.
• REDMINE_SMTP_PROTOCOL: If specified, SMTP protocol to use. Allowed values: tls, ssl. No default.
• REDMINE_SMTP_AUTH: SMTP authentication method. Allowed values: login, plain, cram_md5. Default: login.

Working with Docker

The organization of this application is entirely done using Docker. In this way, we can provide you with ready-made applications faster. In addition, their configuration is more flexible and quite controllable. To be able to control this application, however, you need to know some basic Docker functionalities and features.

Restarting all services

Restarting the database and the Docker container that contains Redmine itself, along with the rest of the software, can be done in two ways:

1. By restarting the entire virtual machine
2. Restarting the Docker containers, which is the faster option. To do this, access your machine via SSH, and run the following commands:

sudo su -
cd /opt/docker-redmine/
docker compose restart

Recreating Docker containers

Recreation of a docker container may be necessary if you've changed the configuration inside the docker-compose.yml file. If there are changes, please follow these steps:

cd /opt/docker-redmine/
docker compose stop
docker compose up -d

Checking the status of the Docker application

To check, you need to run the following commands:

sudo su -
docker ps -a

Please pay attention to the STATUS column. It should show how long the service has been running, for example Up X minutes. If the status is Restarting then you need to check what is wrong with the application. In such a case, you can check by following the application logs as follows:

1. Get the application name that you can see in the NAMES column from the output of the docker ps -a command. View the logs with the docker logs <NAME> command, where is the name of the container.

Changing settings

The settings in section Additional Docker settings can be set in the docker-compose.yml file. The path to it is described again in this section. To change a setting, open the configuration file and note the environment section under redmine. Each configuration option must be described on a new line with a dash in front, as in the following example:

    environment:
      - REDMINE_USERNAME=admin
      - REDMINE_PASSWORD=P@ssw0rd!

Please note that the correct indentation (number of spaces) must also be observed, as this is important for yaml configuration files.