Instalação e Configuração Redmine Docker

Instalação Redmine Docker Bitnami

Link: https://github.com/bitnami/containers/tree/main/bitnami/redmine

Bitnami package for Redmine
What is Redmine?

Redmine is an open source management application. It includes a tracking issue system, Gantt charts for a visual view of projects and deadlines, and supports SCM integration for version control.

Overview of Redmine Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.

TL;DR

docker run --name redmine bitnami/redmine:latest

Warning: This quick setup is only intended for development environments. You are encouraged to change the insecure default credentials and check out the available configuration options in the Environment Variables section for a more secure deployment.

Why use Bitnami Images?

Looking to use Redmine in production? Try VMware Tanzu Application Catalog, the commercial edition of the Bitnami catalog.

How to deploy Redmine in Kubernetes?

Deploying Bitnami applications as Helm Charts is the easiest way to get started with our applications on Kubernetes. Read more about the installation in the Bitnami Redmine Chart GitHub repository.

Bitnami containers can be used with Kubeapps for deployment and management of Helm Charts in clusters.

Only latest stable or LTS branch maintained in the free Bitnami catalog

Starting December 10th 2024, only the latest stable or LTS branch of any container will receive updates in the free Bitnami catalog. To access up-to-date releases for all upstream-supported branches, consider upgrading to Bitnami Premium. Previous versions already released will not be deleted. They are still available to pull from DockerHub.

Please check the Bitnami Premium page in our partner Arrow Electronics for more information.

Supported tags and respective Dockerfile links

Learn more about the Bitnami tagging policy and the difference between rolling tags and immutable tags in our documentation page.

You can see the equivalence between the different tags by taking a look at the tags-info.yaml file present in the branch folder, i.e bitnami/ASSET/BRANCH/DISTRO/tags-info.yaml.

Subscribe to project updates by watching the bitnami/containers GitHub repo.

Get this image

The recommended way to get the Bitnami Redmine Docker Image is to pull the prebuilt image from the Docker Hub Registry.

docker pull bitnami/redmine:latest

To use a specific version, you can pull a versioned tag. You can view the list of available versions in the Docker Hub Registry.

docker pull bitnami/redmine:[TAG]

If you wish, you can also build the image yourself by cloning the repository, changing to the directory containing the Dockerfile and executing the docker build command. Remember to replace the APP, VERSION and OPERATING-SYSTEM path placeholders in the example command below with the correct values.

git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .

How to use this image

Redmine requires access to a MySQL, MariaDB or PostgreSQL database to store information. We'll use the Bitnami Docker Image for MariaDB for the database requirements.

Using the Docker Command Line

Step 1: Create a network

docker network create redmine-network

Step 2: Create a volume for MariaDB persistence and create a MariaDB container

$ docker volume create --name mariadb_data
docker run -d --name mariadb \
  --env ALLOW_EMPTY_PASSWORD=yes \
  --env MARIADB_USER=bn_redmine \
  --env MARIADB_PASSWORD=bitnami \
  --env MARIADB_DATABASE=bitnami_redmine \
  --network redmine-network \
  --volume mariadb_data:/bitnami/mariadb \
  bitnami/mariadb:latest

Step 3: Create volumes for Redmine persistence and launch the container

$ docker volume create --name redmine_data
docker run -d --name redmine \
  -p 8080:8080 -p 8443:8443 \
  --env ALLOW_EMPTY_PASSWORD=yes \
  --env REDMINE_DATABASE_USER=bn_redmine \
  --env REDMINE_DATABASE_PASSWORD=bitnami \
  --env REDMINE_DATABASE_NAME=bitnami_redmine \
  --network redmine-network \
  --volume redmine_data:/bitnami/redmine \
  bitnami/redmine:latest

Access your application at http://your-ip/

Run the application using Docker Compose

curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/redmine/docker-compose.yml > docker-compose.yml
docker-compose up -d

Please be aware this file has not undergone internal testing. Consequently, we advise its use exclusively for development or testing purposes. For production-ready deployments, we highly recommend utilizing its associated Bitnami Helm chart.

If you detect any issue in the docker-compose.yaml file, feel free to report it or contribute with a fix by following our Contributing Guidelines.

Persisting your application

If you remove the container all your data will be lost, and the next time you run the image the database 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 you should mount a directory at the /bitnami/redmine path. If the mounted directory is empty, it will be initialized on the first run. Additionally you should mount a volume for persistence of the MariaDB data.

The above examples define the Docker volumes named mariadb_data and redmine_data. The Redmine application state will persist as long as volumes are not removed.

To avoid inadvertent removal of volumes, you can mount host directories as data volumes. Alternatively you can make use of volume plugins to host the volume data.

Mount host directories as data volumes with Docker Compose

This requires a minor change to the docker-compose.yml file present in this repository:

   mariadb:
     ...
     volumes:
-      - 'mariadb_data:/bitnami/mariadb'
+      - /path/to/mariadb-persistence:/bitnami/mariadb
   ...
   redmine:
     ...
     volumes:
-      - 'redmine_data:/bitnami/redmine'
+      - /path/to/redmine-persistence:/bitnami/redmine
   ...
-volumes:
-  mariadb_data:
-    driver: local
-  redmine_data:
-    driver: local

NOTE: As this is a non-root container, the mounted files and directories must have the proper permissions for the UID 1001.

Mount host directories as data volumes using the Docker command line

Step 1: Create a network (if it does not exist)

docker network create redmine-network

Step 2. Create a MariaDB container with host volume

docker run -d --name mariadb \
  --env ALLOW_EMPTY_PASSWORD=yes \
  --env MARIADB_USER=bn_redmine \
  --env MARIADB_PASSWORD=bitnami \
  --env MARIADB_DATABASE=bitnami_redmine \
  --network redmine-network \
  --volume /path/to/mariadb-persistence:/bitnami/mariadb \
  bitnami/mariadb:latest

Step 3. Create the Redmine container with host volumes

docker run -d --name redmine \
  -p 8080:8080 -p 8443:8443 \
  --env ALLOW_EMPTY_PASSWORD=yes \
  --env REDMINE_DATABASE_USER=bn_redmine \
  --env REDMINE_DATABASE_PASSWORD=bitnami \
  --env REDMINE_DATABASE_NAME=bitnami_redmine \
  --network redmine-network \
  --volume /path/to/redmine-persistence:/bitnami/redmine \
  bitnami/redmine:latest

Configuration

Environment variables

Customizable environment variables

Name Description Default Value
REDMINE_DATA_TO_PERSIST Files to persist relative to the Redmine installation directory. To provide multiple values, separate them with a whitespace. ${REDMINE_CONF_DIR}/configuration.yml ${REDMINE_CONF_DIR}/database.yml files plugins public/plugin_assets
REDMINE_PORT_NUMBER Port number in which Redmine will run. 3000
REDMINE_ENV Redmine environment mode. Allowed values: development, production, test. production
REDMINE_LANGUAGE Redmine site default language. en
REDMINE_REST_API_ENABLED Whether to allow REST API calls to Redmine. 0
REDMINE_LOAD_DEFAULT_DATA Whether to generate default data for Redmine. yes
REDMINE_SKIP_BOOTSTRAP Whether to perform initial bootstrapping for the application. nil
REDMINE_QUEUE_ADAPTER Active job queue adapter. You may need to install additional dependencies if you select a value other than "async" or "inline". inline
REDMINE_USERNAME Redmine user name. user
REDMINE_PASSWORD Redmine user password. bitnami1
REDMINE_EMAIL Redmine user e-mail address. user@example.com
REDMINE_FIRST_NAME Redmine user first name. UserName
REDMINE_LAST_NAME Redmine user last name. LastName
REDMINE_SMTP_HOST Redmine SMTP server host. nil
REDMINE_SMTP_PORT_NUMBER Redmine SMTP server port number. nil
REDMINE_SMTP_USER Redmine SMTP server user. nil
REDMINE_SMTP_DOMAIN Redmine SMTP domain. USER@ part from SMTP_USER is used when not defined. nil
REDMINE_SMTP_PASSWORD Redmine SMTP server user password. nil
REDMINE_SMTP_PROTOCOL Redmine SMTP server protocol to use. nil
REDMINE_SMTP_AUTH Redmine SMTP server protocol to use. Allowed values: login, plain, cram_md5. login
REDMINE_SMTP_OPENSSL_VERIFY_MODE SMTP sets the level of verification for the SSL certificate presented by the server. Allowed values: none, peer. peer
REDMINE_SMTP_CA_FILE Path to the SMTP CA file. /etc/ssl/certs/ca-certificates.crt
REDMINE_DATABASE_TYPE Database type to be used for the Redmine installation. Allowed values: mariadb, postgresql. mariadb
REDMINE_DATABASE_HOST Database server host. $REDMINE_DEFAULT_DATABASE_HOST
REDMINE_DATABASE_PORT_NUMBER Database server port. 3306
REDMINE_DATABASE_NAME Database name. bitnami_redmine
REDMINE_DATABASE_USER Database user name. bn_redmine
REDMINE_DATABASE_PASSWORD Database user password. nil

Read-only environment variables

Name Description Value
REDMINE_BASE_DIR Redmine installation directory. ${BITNAMI_ROOT_DIR}/redmine
REDMINE_CONF_DIR Redmine directory for configuration files. ${REDMINE_BASE_DIR}/config
REDMINE_VOLUME_DIR Redmine directory for mounted configuration files. ${BITNAMI_VOLUME_DIR}/redmine
REDMINE_DAEMON_USER Redmine system user. redmine
REDMINE_DAEMON_GROUP Redmine system group. redmine
REDMINE_DEFAULT_DATABASE_HOST Default database server host. mariadb

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:

Examples

SMTP configuration using a Gmail account

This would be an example of SMTP configuration using a Gmail account:

Connect Redmine container to an existing database

The Bitnami Redmine container supports connecting the Redmine application to an external database. This would be an example of using an external database for Redmine.

In case the database already contains data from a previous Redmine installation, you need to set the variable REDMINE_SKIP_BOOTSTRAP to yes. Otherwise, the container would execute the installation wizard and could modify the existing data in the database. Note that, when setting REDMINE_SKIP_BOOTSTRAP to yes, values for environment variables such as REDMINE_USERNAME, REDMINE_PASSWORD or REDMINE_EMAIL will be ignored.

Logging

The Bitnami Redmine Docker image sends the container logs to stdout. To view the logs:

docker logs redmine

Or using Docker Compose:

docker-compose logs redmine

You can configure the containers logging driver using the --log-driver option if you wish to consume the container logs differently. In the default configuration docker uses the json-file driver.

Customize this image

The Bitnami Redmine Docker image is designed to be extended.

Extend this image

Before extending this image, please note there are certain configuration settings you can modify using the original image:

If your desired customizations cannot be covered using the methods mentioned above, extend the image. To do so, create your own image using a Dockerfile with the format below:

FROM bitnami/redmine
### Put your customizations below
...

Here is an example of extending to install custom plugins:

FROM bitnami/redmine

### Install custom plugins
RUN cd /opt/bitnami/redmine && \
    git clone https://github.com/user_name/name_of_the_plugin.git plugins/name_of_the_plugin && \
    bundle config set frozen false && bundle install && bundle config set frozen true

Maintenance

Backing up your container

To backup your data, configuration and logs, follow these simple steps:

Step 1: Stop the currently running container

docker stop redmine

Or using Docker Compose:

docker-compose stop redmine

Step 2: Run the backup command

We need to mount two volumes in a container we will use to create the backup: a directory on your host to store the backup in, and the volumes from the container we just stopped so we can access the data.

docker run --rm -v /path/to/redmine-backups:/backups --volumes-from redmine busybox \
  cp -a /bitnami/redmine /backups/latest

Restoring a backup

Restoring a backup is as simple as mounting the backup as volumes in the containers.

For the MariaDB database container:

 $ docker run -d --name mariadb \
   ...
-  --volume /path/to/mariadb-persistence:/bitnami/mariadb \
+  --volume /path/to/mariadb-backups/latest:/bitnami/mariadb \
   bitnami/mariadb:latest

For the Redmine container:

 $ docker run -d --name redmine \
   ...
-  --volume /path/to/redmine-persistence:/bitnami/redmine \
+  --volume /path/to/redmine-backups/latest:/bitnami/redmine \
   bitnami/redmine:latest

Upgrade this image

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/containers/tree/main/bitnami/mariadb#upgrade-this-image

The bitnami/redmine:latest tag always points to the most recent release. To get the most recent release you can simple repull the latest tag from the Docker Hub with docker pull bitnami/redmine:latest. However it is recommended to use tagged versions.

Step 1: Get the updated image

docker pull bitnami/redmine:latest

Step 2: Stop the running container

Stop the currently running container using the command

docker-compose stop redmine

Step 3: Take a snapshot of the application state

Follow the steps in Backing up your container to take a snapshot of the current application state.

Step 4: Remove the currently running container

Remove the currently running container by executing the following command:

docker-compose rm -v redmine

Step 5: Run the new image

Update the image tag in docker-compose.yml and re-create your container with the new image:

docker-compose up -d

Notable Changes

4.2.1-debian-10-r70

Contributing

We'd love for you to contribute to this container. You can request new features by creating an issue or submitting a pull request with your contribution.

Issues

If you encountered a problem running this container, you can file an issue. For us to provide better support, be sure to fill the issue template.

License

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.

Plugins Redmine Docker

Link: https://www.redmine.org/plugins?page=1&sort=&utf8=%E2%9C%93&v=6.0

Plugins Versão 6.0: https://www.redmine.org/plugins?utf8=%E2%9C%93&page=1&sort=&v=6.0
Plugins Versão 5.0 : https://www.redmine.org/plugins?page=4&sort=&utf8=%E2%9C%93&v=5.0
Plugins Versão 5.1: https://www.redmine.org/plugins?utf8=%E2%9C%93&page=1&sort=&v=5.1

Links de Plugins para instalar:

Add new elements on detailed issue page to dynamically update issue's attributes and custom fields, directly in the details block of the issue without any page refresh (JIRA style). https://github.com/Ilogeek/redmine_issue_dynamic_edit

Redmine plugin. Adds date formats with day names to Redmine settings: https://github.com/ablidadev/add_date_formats_with_day_names

Redmine plugin. Adds option to change issue due date and start date via context menu on issues list. Selectable options are: Today Tomorrow, In 2 days, Next workday, In 7 days, In 14 days e In 30 days. https://github.com/ablidadev/context_menu_dates

A Redmine plugin which displays the documents list in a shorter way. https://github.com/smoreau/redmine_documents_short

Adds a download button to zip and download all attachments for an issue. Installation P Download the Attachments Plugin for Redmine This plugin adds a download button to each issue in Redmine, allowing users to download all attachments for the issue as a zip file. The button is enabled only if the issue has attachments. https://github.com/vaibhavpetkar/redmine_issue_attachments

A very simple Redmine plugin that will redirect signed-in users to My Page when they sign-in or when they click the home link in the website header. https://www.redmine.org/plugins/home-page-redirector 

The Issue Reminder Plugin adds the functionality to send issue reminders automatically and manually. https://www.redmine.org/plugins/issue_reminder

This plugin posts updates to issues in your Redmine installation to a Microsoft Teams channel. https://github.com/wellbia/redmine_microsoftteams

This plugin automatically creates issues when a period of time passes. https://github.com/jperelli/Redmine-Periodic-Task/

Provides a better projects overview. Subprojects displayed as a table including stats about open/closed/total issues.  https://github.com/maxrossello/redmine_better_overview

This Redmine plugin add an issue dashboard that supports drag and drop for issues and various filters. https://github.com/jgraichen/redmine_dashboard

This plugin let administrators securely login to other users' account with a single click.   https://github.com/nounder/redmine_impersonate

This is a plugin for Redmine that adds issue hierarchy filter. https://github.com/sk-ys/redmine_issue_hierarchy_filter/

This plugin adds two buttons to the right edge of the jsToolBar that allow sliding the toolbar buttons when the toolbar is overflowing. https://github.com/sk-ys/redmine_jstoolbar_slider/

This is a plugin for Redmine which adds OR filters. https://github.com/apsmir/redmine_or_filters

The Submenus plugin adds drop-down menus to project and wiki titles that lead to subprojects or subpages. https://github.com/modoq/redmine_submenus

This plugin allows to customize specific terms in Redmine translations, and allows third party plugins to support translations containing customizable terms. https://github.com/maxrossello/redmine_translation_terms/tree/master

This plugin adds the possibility to limit the visibility of issue descriptions, based on role permissions and selected trackers.   https://github.com/redminetrustteam/redmine_view_issue_description

Plugin Redmine Mattermost

Link: https://github.com/alphanodes/redmine_messenger/tree/main?tab=readme-ov-file

git clone https://github.com/alphanodes/redmine_messenger.git

Messenger plugin for Redmine

This plugin posts updates to issues in your Redmine installation to Slack, Rocket.Chat, Discord or Mattermost channel.

Features

Screenshot

Rocket.Chat output:

screenshot

Redmine configuration:

screenshot

Prepare your messenger service

Slack

Go to Slack documentation Incoming Webhooks for more information to set up Incoming WebHook

Mattermost

Go to Mattermost documentation Incoming Webhooks for more information to set up Incoming WebHook

Discord

Go to Discord documentation Intro to Webhooks for more information to set up Incoming WebHook You have to add /slack after your webhook url.

Rocket.Chat

Go to Rocket.Chat documentation Incoming WebHook Scripting for more information to set up Incoming WebHook

Requirements

Older versions

Installation

Install redmine_messenger plugin for Redmine

cd $REDMINE_ROOT
git clone https://github.com/AlphaNodes/redmine_messenger.git plugins/redmine_messenger
bundle config set --local without 'development test'
bundle install
bundle exec rake redmine:plugins:migrate RAILS_ENV=production

Make sure that the directory is named redmine_messenger (you cannot use another name for it)! Restart Redmine (application server) and you should see the plugin show up in the Plugins page. Under the configuration options, set the Messenger API URL to the URL for an Incoming WebHook integration in your Messenger account and also set the Messenger Channel to the channel's handle (be careful, this is not the channel's display name visible to users, you can find each channel's handle by navigating inside the channel and clicking the down-arrow and selecting view info).

Uninstall

Uninstall redmine_messenger

cd $REDMINE_ROOT
bundle exec rake redmine:plugins:migrate NAME=redmine_messenger VERSION=0 RAILS_ENV=production
rm -rf plugins/redmine_messenger

Restart Redmine (application server)

License

redmine_messenger plugin is developed under the MIT License.

The redmine_messenger is a plugin extension for Redmine Project Management Software, whose Copyright follows. Copyright (C) 2006- Jean-Philippe Lang

Redmine is a flexible project management web application written using Ruby on Rails framework. More details can be found in the doc directory or on the official website http://www.redmine.org

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Credits

The source code is forked from

Special thanks to the original author and contributors for making this awesome hook for Redmine. This fork is just refactored to use Messenger-namespaced configuration options in order to use all hooks for Rocket.Chat, Mattermost AND Slack in a Redmine installation.