Official Repository

Last pushed: a day ago
Short Description
Redmine is a flexible project management web application written using Ruby on Rails framework
Full Description

Supported tags and respective Dockerfile links

For more information about this image and its history, please see the relevant manifest file (library/redmine). This image is updated via pull requests to the docker-library/official-images GitHub repo.

For detailed information about the virtual/transfer sizes and individual layers of each of the above supported tags, please see the repos/redmine/tag-details.md file in the docker-library/repo-info GitHub repo.

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.

wikipedia.org/wiki/Redmine

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 recommened way.

  1. start a database container

    • PostgreSQL

      $ docker run -d --name some-postgres -e POSTGRES_PASSWORD=secret -e POSTGRES_USER=redmine postgres
      
    • MySQL (replace --link some-postgres:postgres with --link some-mysql:mysql when running redmine)

      $ docker run -d --name some-mysql -e MYSQL_ROOT_PASSWORD=secret -e MYSQL_DATABASE=redmine mysql
      
  2. start redmine

    $ docker run -d --name some-redmine --link some-postgres:postgres redmine
    

... via docker-compose

Example docker-compose.yml for redmine:

version: '2'

services:

  redmine:
    image: redmine
    ports:
      - 8080:3000
    environment:
      REDMINE_DB_MYSQL: db
      REDMINE_DB_PASSWORD: example
    depends_on:
      - db
    restart: always

  db:
    image: mariadb
    environment:
      MYSQL_ROOT_PASSWORD: example
      MYSQL_DATABASE: redmine
    restart: always

Run docker-compose up, wait for it to initialize completely, and visit http://localhost:8080 or http://host-ip:8080.

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:

  1. Create a data directory on a suitable volume on your host system, e.g. /my/own/datadir.
  2. 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.

Note that users on host systems with SELinux enabled may see issues with this. The current workaround is to assign the relevant SELinux policy type to the new data directory so that the container will be allowed to access it:

$ chcon -Rt svirt_sandbox_file_t /my/own/datadir

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_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_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.

License

Redmine is open source and released under the terms of the GNU General Public License v2 (GPL).

Supported Docker versions

This image is officially supported on Docker version 17.03.0-ce.

Support for older versions (down to 1.6) is provided on a best-effort basis.

Please see the Docker installation documentation for details on how to upgrade your Docker daemon.

User Feedback

Issues

If you have any problems with or questions about this image, please contact us through a GitHub issue. If the issue is related to a CVE, please check for a cve-tracker issue on the official-images repository first.

You can also reach many of the official image maintainers via the #docker-library IRC channel on Freenode.

Contributing

You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.

Before you start to code, we recommend discussing your plans through a GitHub issue, especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.

Documentation

Documentation for this image is stored in the redmine/ directory of the docker-library/docs GitHub repo. Be sure to familiarize yourself with the repository's README.md file before attempting a pull request.

Docker Pull Command

Comments (24)
naotoe
3 months ago

I applied custom themes using following command, and that took effect.
docker cp ./datadir/public/themes/a1 some-redmine:/usr/src/redmine/public/themes/
Should I use volume mount?

edenilsonf
3 months ago

Hello, how do I execute bundle (Ruby on Rails) commands directly from docker?

liangchaob
4 months ago

How can I change the default charset for the Database??

prgwar
7 months ago

Can any provide me information about backing and restoring redmine and mysql data

sabbane
8 months ago

It would be very helpful to provide an example how to run the application with docker compose.

maximkrusina
9 months ago

Plz 3.3.0 needed! :)

finn13
a year ago

Hi guys, how about redmine 2.4.2? Is it too old and doesn't receive the support yet?

niklv
a year ago

Here is mine docker-compose config for redmine+postgresql
https://gist.github.com/Niklv/a950869f99fe0e1ae1be9cd615e1bfc3

naidu
a year ago

Where to find the redmine logs for this container?

viktorsmari
a year ago

Should the documentation not mention you need the MYSQL_PORT_3306_TCP or POSTGRES_PORT_5432_TCP environment variables to be able to use these database containers?