Redmine

How to Deploy Redmine

Redmine is an open-source, web-based project management and issue-tracking application built with Ruby on Rails. It can be installed from Marketplace or deployed manually to a Ruby application server with a MySQL database.

In this article
✓

One-click option

Redmine can also be installed from the platform Marketplace. Use the manual workflow below when you need to configure the application and database yourself.

Create the Environment

1

Open the environment wizard

Sign in to the dashboard and click Create Environment.

2

Select the required topology

Open the Ruby tab, select Apache as the application server and MySQL as the database. Set the Cloudlet limits, enter an environment name such as redmine, and click Create.

Redmine environment topology wizard
Create a Ruby environment with Apache and MySQL.
3

Wait for provisioning

Wait until the environment is created and both nodes are available in the dashboard.

Redmine environment created
The Apache Ruby and MySQL nodes are ready.

Deploy Redmine

1

Download Redmine

Download the latest stable Redmine release as a .tar.gz or .zip archive from the official Redmine website.

Download the Redmine package
Download a stable Redmine archive.
2

Upload the package

Return to the platform dashboard and upload the archive through Deployment Manager.

Upload Redmine archive
Upload the Redmine package to Deployment Manager.
3

Deploy to the environment

Click Deploy to beside the archive, select the Redmine environment, choose Production as the deployment type, and click Deploy.

Deploy Redmine to production
Deploy the application in Production mode.

Configure the Database

1

Open the MySQL admin panel

Click Open in Browser beside the MySQL node.

Open MySQL in browser
Open the MySQL administration interface.
2

Open the SQL tab

Sign in using the database credentials provided after environment creation and open the SQL tab.

MySQL SQL tab
Open the SQL query interface.
3

Create the Redmine database

Run the following query:

CREATE DATABASE redmine CHARACTER SET utf8;
Create the Redmine database
Execute the SQL query to create the database.
4

Open Apache configuration

Return to the dashboard and click Config beside the Apache node.

Apache Config button
Open the Apache configuration-file manager.
5

Create database.yml

Go to webroot > ROOT > config, copy the content of database.yml.example, create a new file named database.yml, and paste the copied configuration into it.

Copy database.yml.example
Copy the example database configuration.
Create database.yml
Create database.yml in the application config directory.
6

Set the MySQL connection

In the production section, enter the MySQL host without http://, along with the database username and password supplied by the platform. Save the file.

Configure Redmine MySQL connection
Enter the database host and credentials in database.yml.
i

Other deployment modes

When changing the application to development or test mode later, add the database connection details to the corresponding section of database.yml.

Configure the Application Server

1

Create rake_deploy

In webroot > ROOT, create a file named rake_deploy.

Create rake_deploy file
Create the post-deployment task file in the application root.
2

Add the Redmine tasks

Add one task per line:

generate_secret_token
db:migrate
redmine:load_default_data
Configure rake_deploy
Add the Redmine initialization and migration tasks.
3

Restart Apache

Save the file and restart the Apache node. The platform executes the Rake tasks during restart.

Restart Apache node
Restart Apache to execute the Redmine post-deploy tasks.

Open Redmine

Click Open in Browser beside the environment. The Redmine home page should open after the application initialization is complete.

Open Redmine in browser
Open the deployed Redmine application.
Redmine home page
The Redmine application is running successfully.

Expected Result

A Redmine application is deployed in a Ruby Apache environment, connected to the MySQL redmine database, initialized through the required Rake tasks, and accessible from the environment URL.

Important Notes

  • Use the production database section when Redmine is deployed in Production mode.
  • Keep MySQL credentials secure and do not expose them publicly.
  • Create database.yml from the supplied example file.
  • Place rake_deploy in the application root.
  • Add one Rake task per line without the rake prefix.
  • Review Apache and deployment logs when initialization fails.

Common Issues and Solutions

Database connection failsCheck the MySQL hostname, username, password, database name, deployment section, and database-node status.
Redmine opens with an application errorReview Apache logs, Gemfile dependencies, Ruby compatibility, and the output of the Rake tasks.
Database tables are missingConfirm that db:migrate ran successfully after the Apache restart.
Default data is unavailableReview the result of redmine:load_default_data in the environment logs.
rake_deploy is not processedConfirm the file name and location, save the changes, and restart the Apache node.