docker-library / docker-library/redmine

Please improve README for the Image

Open
#388 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Shell
Stars
237
Forks
171
PR merge metrics
No merged PRs in 30d

Description

https://hub.docker.com/_/redmine can be improved:

  1. start a database container - PostgreSQL
$ docker run -d --name some-postgres --network some-network -e POSTGRES_PASSWORD=secret -e POSTGRES_USER=redmine postgres

could also contain POSTGRES_DB for the consistency (as MySQL example has it):

$ docker run -d --name some-postgres --network some-network -e POSTGRES_DB=redmine_db -e POSTGRES_USER=redmine -e POSTGRES_PASSWORD=secret postgres
  1. start redmine
$ docker run -d --name some-redmine --network some-network -e REDMINE_DB_POSTGRES=some-postgres -e REDMINE_DB_USERNAME=redmine -e REDMINE_DB_PASSWORD=secret redmine

could also include REDMINE_DB_DATABASE in order to differentiate it from REDMINE_DB_POSTGRES and REDMINE_SECRET_KEY_BASE in order to be consistent with docker-compose.yaml:

$ docker run -d --name some-redmine --network some-network -e REDMINE_DB_POSTGRES=some-postgres-ip -e REDMINE_DB_DATABASE=redmine_db -e REDMINE_DB_USERNAME=redmine -e REDMINE_DB_PASSWORD=secret -e REDMINE_SECRET_KEY_BASE=supersecretkey redmine
  1. compose.yaml could also have version for Postgresql and be enhanced of volumes and depends_on:
services:
  redmine:
    image: redmine
    restart: always
    environment:
      REDMINE_DB_POSTGRES: postgresql
      REDMINE_DB_DATABASE: redmine_db
      REDMINE_DB_USERNAME: redmine
      REDMINE_DB_PASSWORD: secret
      REDMINE_SECRET_KEY_BASE: supersecretkey
    ports:
      - 8080:3000
    volumes:
      - redmine_data:/usr/src/redmine/files
    depends_on:
      - postgresql

  postgresql:
    image: postgres:17-alpine
    restart: unless-stopped
    environment:
      POSTGRES_DB: redmine_db
      POSTGRES_USER: redmine
      POSTGRES_PASSWORD: secret
    volumes:
      - postgresql_data:/var/lib/postgresql/data

volumes:
  redmine_data:
  postgresql_data:

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Inspect the Image README at the Docker Hub link and the referenced compose.yaml, comparing the PostgreSQL instructions with the existing MySQL example. Validate the proposed environment variables, database settings, persistence, and service dependency with Docker Compose; done means the README examples and compose configuration are consistent and usable.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, docker-compose, postgresql
Domain
devops, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
Half a day
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.