redmine
Estimated reading time: 10 minutesRedmine is a flexible project management web application written using Ruby on Rails framework
GitHub repo: https://github.com/docker-library/redmine
Library reference
This content is imported from the official Docker Library docs, and is provided by the original uploader. You can view the Docker Hub page for this image at https://hub.docker.com/images/redmine
Supported tags and respective Dockerfile
links
4.0.3
,4.0
,4
,latest
(4.0/Dockerfile)4.0.3-passenger
,4.0-passenger
,4-passenger
,passenger
(4.0/passenger/Dockerfile)3.4.10
,3.4
,3
(3.4/Dockerfile)3.4.10-passenger
,3.4-passenger
,3-passenger
(3.4/passenger/Dockerfile)
Quick reference
-
Where to get help:
the Docker Community Forums, the Docker Community Slack, or Stack Overflow -
Where to file issues:
https://github.com/docker-library/redmine/issues -
Maintained by:
the Docker Community -
Supported architectures: (more info)
amd64
,arm32v5
,arm32v7
,arm64v8
,i386
,ppc64le
,s390x
-
Published image artifact details:
repo-info repo’srepos/redmine/
directory (history)
(image metadata, transfer size, etc) -
Image updates:
official-images PRs with labellibrary/redmine
official-images repo’slibrary/redmine
file (history) -
Source of this description:
docs repo’sredmine/
directory (history) -
Supported Docker versions:
the latest release (down to 1.6 on a best-effort basis)
What is Redmine?
Redmine is a free and open source, web-based project management and issue tracking tool. It allows users to manage multiple projects and associated subprojects. It features per project wikis and forums, time tracking, and flexible role based access control. It includes a calendar and Gantt charts to aid visual representation of projects and their deadlines. Redmine integrates with various version control systems and includes a repository browser and diff viewer.
How to use this image
Run Redmine with SQLite3
This is the simplest setup; just run redmine.
$ docker run -d --name some-redmine redmine
not for multi-user production use (redmine wiki)
Run Redmine with a Database Container
Running Redmine with a database server is the recommended way.
-
start a database container
-
PostgreSQL
$ docker run -d --name some-postgres --network some-network -e POSTGRES_PASSWORD=secret -e POSTGRES_USER=redmine postgres
-
MySQL (replace
-e REDMINE_DB_POSTGRES=some-postgres
with-e REDMINE_DB_MYSQL=some-mysql
when running Redmine)$ docker run -d --name some-mysql --network some-network -e MYSQL_USER=redmine -e MYSQL_PASSWORD=secret -e MYSQL_DATABASE=redmine -e MYSQL_RANDOM_ROOT_PASSWORD=1 mysql:5.7
-
-
start redmine
$ docker run -d --name some-redmine --network some-network -e REDMINE_DB_POSTGRES=some-postgres -e REDMINE_DB_USERNAME=redmine -e REDMINE_DB_PASSWORD=secret redmine
... via docker stack deploy
or docker-compose
Example stack.yml
for redmine
:
version: '3.1'
services:
redmine:
image: redmine
restart: always
ports:
- 8080:3000
environment:
REDMINE_DB_MYSQL: db
REDMINE_DB_PASSWORD: example
db:
image: mysql:5.7
restart: always
environment:
MYSQL_ROOT_PASSWORD: example
MYSQL_DATABASE: redmine
Run docker stack deploy -c stack.yml redmine
(or docker-compose -f stack.yml up
), wait for it to initialize completely, and visit http://swarm-ip:8080
, http://localhost:8080
, or http://host-ip:8080
(as appropriate).
Alternative Web Server
The other tags in this repository, like those with passenger
, use the same environment and --links
as the default tags that use WEBrick (rails s
) but instead give you the option of a different web and application server. passenger
uses Phusion Passenger. tini
is used for reaping zombies.
Accessing the Application
Currently, the default user and password from upstream is admin/admin (logging into the application).
Where to Store Data
Important note: There are several ways to store data used by applications that run in Docker containers. We encourage users of the redmine
images to familiarize themselves with the options available, including:
- Let Docker manage the storage of your files by writing the files to disk on the host system using its own internal volume management. This is the default and is easy and fairly transparent to the user. The downside is that the files may be hard to locate for tools and applications that run directly on the host system, i.e. outside containers.
- Create a data directory on the host system (outside the container) and mount this to a directory visible from inside the container. This places the database files in a known location on the host system, and makes it easy for tools and applications on the host system to access the files. The downside is that the user needs to make sure that the directory exists, and that e.g. directory permissions and other security mechanisms on the host system are set up correctly.
The Docker documentation is a good starting point for understanding the different storage options and variations, and there are multiple blogs and forum postings that discuss and give advice in this area. We will simply show the basic procedure here for the latter option above:
- Create a data directory on a suitable volume on your host system, e.g.
/my/own/datadir
. -
Start your
redmine
container like this:$ docker run -d --name some-redmine -v /my/own/datadir:/usr/src/redmine/files --link some-postgres:postgres redmine
The -v /my/own/datadir:/usr/src/redmine/files
part of the command mounts the /my/own/datadir
directory from the underlying host system as /usr/src/redmine/files
inside the container, where Redmine will store uploaded files.
Port Mapping
If you’d like to be able to access the instance from the host without the container’s IP, standard port mappings can be used. Just add -p 3000:3000
to the docker run
arguments and then access either http://localhost:3000
or http://host-ip:3000
in a browser.
Environment Variables
When you start the redmine
image, you can adjust the configuration of the instance by passing one or more environment variables on the docker run
command line.
REDMINE_DB_MYSQL
or REDMINE_DB_POSTGRES
These two variables allow you to set the hostname or IP address of the MySQL or PostgreSQL host, respectively. These values are mutually exclusive so it is undefined behavior if both are set. If neither variable is set, the image will fall back to using SQLite.
REDMINE_DB_PORT
This variable allows you to specify a custom database connection port. If unspecified, it will default to the regular connection ports: 3306 for MySQL, 5432 for PostgreSQL, and empty string for SQLite.
REDMINE_DB_USERNAME
This variable sets the user that Redmine and any rake tasks use to connect to the specified database. If unspecified, it will default to root
for MySQL, postgres
for PostgreSQL, or redmine
for SQLite.
REDMINE_DB_PASSWORD
This variable sets the password that the specified user will use in connecting to the database. There is no default value.
REDMINE_DB_DATABASE
This variable sets the database that Redmine will use in the specified database server. If not specified, it will default to redmine
for MySQL, the value of REDMINE_DB_USERNAME
for PostgreSQL, or sqlite/redmine.db
for SQLite.
REDMINE_DB_ENCODING
This variable sets the character encoding to use when connecting to the database server. If unspecified, it will use the default for the mysql2
library (UTF-8
) for MySQL, utf8
for PostgreSQL, or utf8
for SQLite.
REDMINE_NO_DB_MIGRATE
This variable allows you to control if rake db:migrate
is run on container start. Just set the variable to a non-empty string like 1
or true
and the migrate script will not automatically run on container start.
db:migrate
will also not run if you start your image with something other than the default CMD
, like bash
. See the current docker-entrypoint.sh
in your image for details.
REDMINE_PLUGINS_MIGRATE
This variable allows you to control if rake redmine:plugins:migrate
is run on container start. Just set the variable to a non-empty string like 1
or true
and the migrate script will be automatically run on every container start. It will be run after db:migrate
.
redmine:plugins:migrate
will not run if you start your image with something other than the default CMD
, like bash
. See the current docker-entrypoint.sh
in your image for details.
REDMINE_SECRET_KEY_BASE
This variable is used to create an initial config/secrets.yml
and set the secret_key_base
value, which is “used by Rails to encode cookies storing session data thus preventing their tampering. Generating a new secret token invalidates all existing sessions after restart” (session store). If you do not set this variable or provide a secrets.yml
one will be generated using rake generate_secret_token
.
Docker Secrets
As an alternative to passing sensitive information via environment variables, _FILE
may be appended to the previously listed environment variables, causing the initialization script to load the values for those variables from files present in the container. In particular, this can be used to load passwords from Docker secrets stored in /run/secrets/<secret_name>
files. For example:
$ docker run -d --name some-redmine -e REDMINE_DB_MYSQL_FILE=/run/secrets/mysql-host -e REDMINE_DB_PASSWORD_FILE=/run/secrets/mysql-root redmine:tag
Currently, this is only supported for REDMINE_DB_MYSQL
, REDMINE_DB_POSTGRES
, REDMINE_DB_PORT
, REDMINE_DB_USERNAME
, REDMINE_DB_PASSWORD
, REDMINE_DB_DATABASE
, REDMINE_DB_ENCODING
, and REDMINE_SECRET_KEY_BASE
.
License
Redmine is open source and released under the terms of the GNU General Public License v2 (GPL).
As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained).
Some additional license information which was able to be auto-detected might be found in the repo-info
repository’s redmine/
directory.
As for any pre-built image usage, it is the image user’s responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.