Redmine is a flexible project management web application. Written using the Ruby on Rails framework, it is cross-platform and cross-database.
$ curl -LO https://raw.githubusercontent.com/bitnami/bitnami-docker-redmine/master/docker-compose.yml
$ docker-compose up
To run this application you need Docker Engine 1.10.0. Docker Compose is recomended with a version 1.6.0 or later.
Running Redmine with a database server is the recommended way. You can either use docker-compose or run the containers manually.
This is the recommended way to run Redmine. You can use the following docker compose template:
version: '2'
services:
mariadb:
image: 'bitnami/mariadb:latest'
volumes:
- 'mariadb_data:/bitnami/mariadb'
application:
image: 'bitnami/redmine:latest'
ports:
- '80:3000'
volumes:
- 'redmine_data:/bitnami/redmine'
depends_on:
- mariadb
volumes:
mariadb_data:
driver: local
redmine_data:
driver: local
If you want to run the application manually instead of using docker-compose, these are the basic steps you need to run:
- Create a new network for the application and the database:
$ docker network create redmine_network
- Start a MariaDB database in the network generated:
$ docker run -d --name mariadb --net=redmine_network bitnami/mariadb
Note: You need to give the container a name in order to Redmine to resolve the host
- Run the Redmine container:
$ docker run -d -p 80:3000 --name redmine --net=redmine_network bitnami/redmine
Then you can access your application at http://your-ip/
If you remove every container and volume all your data will be lost, and the next time you run the image the application will be reinitialized. To avoid this loss of data, you should mount a volume that will persist even after the container is removed.
For persistence of the Redmine deployment, the above examples define docker volumes namely mariadb_data
and redmine_data
. The Redmine application state will persist as long as these volumes are not removed.
To avoid inadvertent removal of these volumes you can mount host directories as data volumes. Alternatively you can make use of volume plugins to host the volume data.
Note! If you have already started using your application, follow the steps on backing up to pull the data from your running container down to your host.
The following docker-compose.yml
template demonstrates the use of host directories as data volumes.
version: '2'
mariadb:
image: 'bitnami/mariadb:latest'
volumes:
- '/path/to/mariadb-persistence:/bitnami/mariadb'
redmine:
image: bitnami/redmine:latest
ports:
- 80:3000
volumes:
- '/path/to/redmine-persistence:/bitnami/redmine'
- Create a network (if it does not exist):
$ docker network create redmine-tier
- Create a MariaDB container with host volume:
$ docker run -d --name mariadb \
--net redmine-tier \
--volume /path/to/mariadb-persistence:/bitnami/mariadb \
bitnami/mariadb:latest
Note: You need to give the container a name in order to Redmine to resolve the host
- Run the Redmine container:
$ docker run -d --name redmine -p 80:3000 \
--net redmine-tier \
--volume /path/to/redmine-persistence:/bitnami/redmine \
bitnami/redmine:latest
Bitnami provides up-to-date versions of MariaDB and Redmine, including security patches, soon after they are made upstream. We recommend that you follow these steps to upgrade your container. We will cover here the upgrade of the Redmine container. For the MariaDB upgrade see https://github.com/bitnami/bitnami-docker-mariadb/blob/master/README.md#upgrade-this-image
- Get the updated images:
$ docker pull bitnami/redmine:latest
- Stop your container
- For docker-compose:
$ docker-compose stop redmine
- For manual execution:
$ docker stop redmine
-
(For non-compose execution only) Create a backup if you have not mounted the redmine folder in the host.
-
Remove the currently running container
- For docker-compose:
$ docker-compose rm redmine
- For manual execution:
$ docker rm redmine
- Run the new image
- For docker-compose:
$ docker-compose start redmine
- For manual execution (mount the directories if needed):
docker run --name redmine bitnami/redmine:latest
When you start the redmine image, you can adjust the configuration of the instance by passing one or more environment variables either on the docker-compose file or on the docker run command line. If you want to add a new environment variable:
- For docker-compose add the variable name and value under the application section:
application:
image: bitnami/redmine:latest
ports:
- 80:3000
environment:
- REDMINE_PASSWORD=my_password
volumes:
- 'redmine_data:/bitnami/redmine'
depends_on:
- mariadb
- For manual execution add a
-e
option with each variable and value:
$ docker run -d -e REDMINE_PASSWORD=my_password -p 80:3000 --name redmine -v /your/local/path/bitnami/redmine:/bitnami/redmine --network=redmine_network bitnami/redmine
Available variables:
REDMINE_USERNAME
: Redmine application username. Default: userREDMINE_PASSWORD
: Redmine application password. Default: bitnamiREDMINE_EMAIL
: Redmine application email. Default: [email protected]REDMINE_LANG
: Redmine application default language. Default: enMARIADB_USER
: Root user for the MariaDB database. Default: rootMARIADB_PASSWORD
: Root password for the MariaDB.MARIADB_HOST
: Hostname for MariaDB server. Default: mariadbMARIADB_PORT
: Port used by MariaDB server. Default: 3306
To configure Redmine to send email using SMTP you can set the following environment variables:
SMTP_HOST
: SMTP host.SMTP_PORT
: SMTP port.SMTP_USER
: SMTP account user.SMTP_PASSWORD
: SMTP account password.SMTP_TLS
: Use TLS encription with SMTP. Default true
This would be an example of SMTP configuration using a GMail account:
- docker-compose:
redmine:
image: bitnami/redmine:latest
ports:
- 80:3000
environment:
- SMTP_HOST=smtp.gmail.com
- SMTP_PORT=587
- [email protected]
- SMTP_PASSWORD=your_password
- For manual execution:
$ docker run -d -e SMTP_HOST=smtp.gmail.com -e SMTP_PORT=587 -e [email protected] -e SMTP_PASSWORD=your_password -p 80:3000 --name redmine -v /your/local/path/bitnami/redmine:/bitnami/redmine --network=redmine_network bitnami/redmine$ docker rm -v redmine
To backup your application data follow these steps:
- Stop the running container:
- For docker-compose:
$ docker-compose stop redmine
- For manual execution:
$ docker stop redmine
- Copy the Redmine data folder in the host:
$ docker cp /your/local/path/bitnami:/bitnami/redmine
To restore your application using backed up data simply mount the folder with Redmine data in the container. See persisting your application section for more info.
We'd love for you to contribute to this container. You can request new features by creating an issue, or submit a pull request with your contribution.
If you encountered a problem running this container, you can file an issue. For us to provide better support, be sure to include the following information in your issue:
- Host OS and version
- Docker version (
docker version
) - Output of
docker info
- Version of this container (
echo $BITNAMI_IMAGE_VERSION
inside the container) - The command you used to run the container, and any relevant output you saw (masking any sensitive information)
Copyright (c) 2015-2016 Bitnami
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.