mash-playbook/docs/services/redmine.md

48 lines
1.8 KiB
Markdown
Raw Normal View History

2023-03-17 22:27:52 +01:00
# Redmine
[Redmine](https://redmine.org/) is a flexible project management web application. Written using the Ruby on Rails framework, it is cross-platform and cross-database.
## Dependencies
This service requires the following other services:
- a [Postgres](postgres.md) database
- a [Traefik](traefik.md) reverse-proxy server
## Configuration
To enable this service, add the following configuration to your `vars.yml` file and re-run the [installation](../installing.md) process:
```yaml
########################################################################
# #
2023-03-19 09:22:47 +01:00
# redmine #
2023-03-17 22:27:52 +01:00
# #
########################################################################
redmine_enabled: true
redmine_hostname: redmine.example.com
2023-03-17 22:27:52 +01:00
# If you'll be installing Redmine plugins which pull Ruby gems,
# which need to compile native code, consider installing build tools in the contianer image,
# by uncommenting the line below.
# redmine_container_image_customizations_build_tools_installation_enabled: true
2023-03-17 22:27:52 +01:00
########################################################################
# #
2023-03-19 09:22:47 +01:00
# /redmine #
2023-03-17 22:27:52 +01:00
# #
########################################################################
```
In the example configuration above, we configure the service to be hosted at `https://redmine.example.com`.
2023-03-17 22:27:52 +01:00
## Usage
After installation, you can register your administrator account
You can create additional users (admin-privileged or not) after that.