mirror of
https://github.com/bitnami/containers.git
synced 2026-03-27 07:17:59 +08:00
248 lines
19 KiB
Markdown
248 lines
19 KiB
Markdown
# Bitnami Secure Image for 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](https://www.redmine.org/)
|
||
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
|
||
|
||
```console
|
||
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](#environment-variables) section for a more secure deployment.
|
||
|
||
## Why use Bitnami Secure Images?
|
||
|
||
Those are hardened, minimal CVE images built and maintained by Bitnami. Bitnami Secure Images are based on the cloud-optimized, security-hardened enterprise [OS Photon Linux](https://vmware.github.io/photon/). Why choose BSI images?
|
||
|
||
- Hardened secure images of popular open source software with Near-Zero Vulnerabilities
|
||
- Vulnerability Triage & Prioritization with VEX Statements, KEV and EPSS Scores
|
||
- Compliance focus with FIPS, STIG, and air-gap options, including secure bill of materials (SBOM)
|
||
- Software supply chain provenance attestation through in-toto
|
||
- First class support for the internet’s favorite Helm charts
|
||
|
||
Each image comes with valuable security metadata. You can view the metadata in [our public catalog here](https://app-catalog.vmware.com/bitnami/apps). Note: Some data is only available with [commercial subscriptions to BSI](https://bitnami.com/).
|
||
|
||
|
||
|
||
|
||
If you are looking for our previous generation of images based on Debian Linux, please see the [Bitnami Legacy registry](https://hub.docker.com/u/bitnamilegacy).
|
||
|
||
## 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](https://github.com/bitnami/charts/tree/master/bitnami/redmine).
|
||
|
||
## 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](https://techdocs.broadcom.com/us/en/vmware-tanzu/application-catalog/tanzu-application-catalog/services/tac-doc/apps-tutorials-understand-rolling-tags-containers-index.html).
|
||
|
||
## Get this image
|
||
|
||
The recommended way to get the Bitnami Redmine Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/redmine).
|
||
|
||
```console
|
||
docker pull bitnami/redmine:latest
|
||
```
|
||
|
||
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/redmine/tags/) in the Docker Hub Registry.
|
||
|
||
```console
|
||
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.
|
||
|
||
```console
|
||
git clone https://github.com/bitnami/containers.git
|
||
cd bitnami/APP/VERSION/OPERATING-SYSTEM
|
||
docker build -t bitnami/APP:latest .
|
||
```
|
||
|
||
## 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](https://github.com/bitnami/containers/blob/main/bitnami/mariadb#persisting-your-database).
|
||
|
||
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](https://docs.docker.com/engine/tutorials/dockervolumes/). Alternatively you can make use of volume plugins to host the volume data.
|
||
|
||
> **NOTE** As this is a non-root container, the mounted files and directories must have the proper permissions for the UID `1001`.
|
||
|
||
## Configuration
|
||
|
||
The following section describes the supported environment variables
|
||
|
||
### Environment variables
|
||
|
||
The following tables list the main variables you can set.
|
||
|
||
#### 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.
|
||
|
||
### FIPS configuration in Bitnami Secure Images
|
||
|
||
The Bitnami Redmine Docker image from the [Bitnami Secure Images](https://go-vmware.broadcom.com/contact-us) catalog includes extra features and settings to configure the container with FIPS capabilities. You can configure the next environment variables:
|
||
|
||
- `OPENSSL_FIPS`: whether OpenSSL runs in FIPS mode or not. `yes` (default), `no`.
|
||
|
||
## Logging
|
||
|
||
The Bitnami Redmine Docker image sends the container logs to `stdout`. To view the logs:
|
||
|
||
```console
|
||
docker logs redmine
|
||
```
|
||
|
||
Or using Docker Compose:
|
||
|
||
```console
|
||
docker-compose logs redmine
|
||
```
|
||
|
||
You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) 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:
|
||
|
||
- Settings that can be adapted using environment variables. For instance, you can change the port used by Redmine by setting the environment variable `REDMINE_PORT_NUMBER`.
|
||
- You can mount your custom scripts under `/docker-entrypoint-init.d` directory. These scripts will be executed in alphabetical order when the container during the 1st container bootstrap.
|
||
|
||
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:
|
||
|
||
```Dockerfile
|
||
FROM bitnami/redmine
|
||
### Put your customizations below
|
||
...
|
||
```
|
||
|
||
## Maintenance
|
||
|
||
### Backing up your container
|
||
|
||
To backup your data, configuration and logs, follow these simple steps:
|
||
|
||
#### Step 1: Stop the currently running container
|
||
|
||
```console
|
||
docker stop redmine
|
||
```
|
||
|
||
Or using Docker Compose:
|
||
|
||
```console
|
||
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.
|
||
|
||
```console
|
||
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:
|
||
|
||
```diff
|
||
$ 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:
|
||
|
||
```diff
|
||
$ docker run -d --name redmine \
|
||
...
|
||
- --volume /path/to/redmine-persistence:/bitnami/redmine \
|
||
+ --volume /path/to/redmine-backups/latest:/bitnami/redmine \
|
||
bitnami/redmine:latest
|
||
```
|
||
|
||
## Notable Changes
|
||
|
||
### 4.2.1-debian-10-r70
|
||
|
||
- The size of the container image has been decreased.
|
||
- The configuration logic is now based on Bash scripts in the *rootfs/* folder.
|
||
- It is now possible to use an already populated Redmine database from another installation. In order to do this, use the environment variable `REDMINE_SKIP_BOOTSTRAP`, which forces the container not to run the initial Redmine setup wizard.
|
||
- The following environment variables have been deprecated. They will continue to work as before, but support for these may be removed in a future update:
|
||
|
||
- `REDMINE_DB_POSTGRES` in favor of `REDMINE_DATABASE_HOST`. When used, `REDMINE_DATABASE_TYPE=postgresql` will also be set.
|
||
- `REDMINE_DB_MYSQL`, in favor of `REDMINE_DATABASE_HOST`. Whenused, `REDMINE_DATABASE_TYPE=mariadb` will also be set.
|
||
|
||
## License
|
||
|
||
Copyright © 2026 Broadcom. The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
|
||
|
||
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.
|