This document describes how to install the Redmine web application. The Redmine application is a project management web application that functions on the Ruby platform. You can register the Redmine application in cPanel's Application Manager interface (cPanel >> Home >> Software >> Application Manager).
- cPanel Technical Support does not provide assistance with the steps in this document.
- We recommend that only experienced system administrators perform these steps.
- We are not responsible for any data loss.
- We recommend that you perform the steps in this document via the command line as a cPanel user unless otherwise specified.
- You can also use cPanel's Terminal interface ( cPanel >> Home >> Advanced >> Terminal) to perform these steps in cPanel & WHM version 72 and later.
To use this feature, the cPanel account must possess compiler access in WHM's Compiler Access interface (WHM >> Home >> Security Center >> Compiler Access). If the account does not possess compiler access, the system will return an error similar to the following message:
- In this document,
userrepresents the cPanel user, and
greenminerepresents the Redmine web application's name.
For more information, read Redmine's documentation.
Before you begin, ensure that you remove the operating system-provided Ruby installation. Then, install Ruby via the following RPMs:
If you enable this module, the system will disable Apache's
ea-apache24-mod_envmodule allows you to add environment variables when you register your application. For more information about environment variables, read our Application Manager documentation.
To install these RPMs, run the following command as the
To install the
bundler Ruby gem, run the following command as a cPanel user:
If you do not wish to use the
scl utility, perform the following steps to install the
bundler Ruby gem:
Log in to the server as a cPanel user.
Add the following line to your shell's
rcfile (for example,
Log out of your terminal session, and log back in again.
You can also create an additional terminal session.
- Run the
gem install bundler --user-installcommand.
redmine archive file.
After you install the
rake Ruby gems, download the application and extract the archive file. To do this, perform the following steps:
In the following examples,
redmine-X.X.X.tar.gz represents the most recent
- Access the Redmine website in a web browser.
Download the most recent
.tar.gzfile from the Stable Releases section. To do this, run the following command:
Make certain that you install
wgetbefore you run this command.
.tar.gzfile's contents. To do this, run the following command:
After you extract the
.tar.gzfile, rename the file to your Ruby application's name. To do this, run the following command:
greenminerepresents your web application's name.
Create the database and database users.
After you extrac thte
redmine archive file, create the application's database and configure the database users. To do this, perform the following steps:
- Create production and development databases and database users in cPanel's MySQL Database Wizard interface (cPanel >> Home >> Databases >> MySQL Database Wizard).
- Copy the contents of the
/home/user/greenmine/config/database.yml.examplefile to the
- Open the
/config/database.ymlfile with a text editor.
- Add the following information to the file:
- The databases' names.
- The databases' usernames.
- The databases' passwords.
The file will resemble the following example:Click to view...
Install your Ruby Gems.
To install the Ruby Gems that reside in the
/home/user/greenmine/Gemfile file, change to the
/home/user/greenmine directory and run the following command.
greenmine represents your web application's name.
Create a secret key.
After you install your Ruby Gems, create the "secret" key, which the system uses to encode cookies. To generate the "secret" key, run the following command:
This command returns a key hash that resembles the following example:
After you create the secret key, create the
/home/user/greenmine/config/secrets.yml file and add the following content:
secretkey with the key that the
scl enable ea-ruby24 'rake secret' command returned.
greenmine represents your web application's name.
Create the database structure.
After you add the security key to the
/home/user/greenmine/config/secrets.yml file, create the database structure. To do this, change to the
/home/user/greenmine directory and run the following command:
The output will resemble the following partial example:
Create the data configuration.
After you create the database structure, create the database's default configuration data set. To do this, perform the following steps:
Run the following command:
When the system prompts you, select the database's locale. To do this, enter your chosen locale's two letter abbreviation in the command line, for example:
This example selects British English (
en-GB) as the database's locale.
Set the file system permissions.
After you create the database's data configuration, set the file system permissions. To do this, change to the
/home/user/greenmine directory and run the following series of commands:
This step is optional. UAPI's
register_application function performs an Apache restart, but may not execute immediately.
After you register the Apache configuration, restart Apache. To do this, run the following command as the root user:
After Apache restarts, you can access the
greenmine application in cPanel's Application Manager interface (cPanel >> Home >> Software >> Application Manager).