Redmined

A docked CLI for Redmine development environment. Inspired by rails/docked.

Prerequisites

• Source code of Redmine or its distribution such as RedMica
• Docker

Installation

Create a Docker volume for the bundle cache.

docker volume create redmine-bundle-cache

Download redmined and place it in a location in your PATH, such as ~/.local/bin/, and grant execution permission.

If curl is available, you can also install it with the following command.

curl https://raw.githubusercontent.com/hidakatsuya/redmined/main/redmined -o ~/.local/bin/redmined && chmod +x $_

Usage

cd your-redmine-root-directory

Create configuration for SQLite database.

cat <<EOS > config/database.yml
development:
  adapter: sqlite3
  database: db/development.sqlite3
test:
  adapter: sqlite3
  database: db/test.sqlite3
EOS

Setup and start Redmine.

redmined bundle install
redmined bin/rails db:prepare
redmined bin/rails s

Run tests.

redmined bin/rails test
redmined bin/rails test:system

Note

Since Chrome is not installed on the ARM64 platform, test:system task can't be executed.

Settings

• REDMINED_CONTAINER_NAME Container name for redmined. If not set, use "redmined-container" as default.
• REDMINED_MAP_HOST_USER_TO_CONTAINER_USER Map the UID and GID of the host user to the container user
• REDMINED_BUNDLE_CACHE_VOLUME Volume name for bundler cache. If not set, use "redmine-bundle-cache" as default.
• REDMINED_IMAGE Docker image for redmined. If not set, use "ghcr.io/hidakatsuya/redmined" as default.
• REDMINED_PUBLISH_PORT Port mapping for Redmine. If not set, use "3000:3000" as default.

See redmined for further details.

Tips

Executing redmined command with modified environment variables

redmined env RAILS_ENV=development bin/about

Using separate environments for multiple Redmines

This section introduces how to develop in multiple Redmine environments using the environment variables of Redmined and direnv.

As an example, consider an environment where Redmine is developed with Ruby 3.3 and RedMica with Ruby 3.2.

First, prepare the source code for Redmine and RedMica.

/home/you/
  ├── redmica/
  └── redmine/

Move to the redmine/ directory and execute the following commands.

docker volume create redmine-bundle-cache

cat <<EOF > .envrc
export REDMINED_IMAGE=ghcr.io/hidakatsuya/redmined:ruby3.3
export REDMINED_BUNDLE_CACHE_VOLUME=redmine-bundle-cache
EOF

direnv allow .

Next, move to the redmica/ directory and execute the following commands.

docker volume create redmica-bundle-cache

cat <<EOF > .envrc
export REDMINED_IMAGE=ghcr.io/hidakatsuya/redmined:ruby3.2
export REDMINED_BUNDLE_CACHE_VOLUME=redmica-bundle-cache
EOF

direnv allow .

That's it. It would be a good idea to add .envrc to gitignore.