You have a number of options when installing Redmine on Ubuntu - these include doing so manually or installing through Cloud 66 EasyDeploy.
Depending on your configuration, a manual installation of Redmine can take up to a few days. Deploying through Cloud 66 on the other hand takes up to an hour for the initial deploy, and up to five minutes for subsequent deployments.
This post will take you through each option.
Option 1: Deploying with Cloud 66
Deploying with Cloud 66 consists of five simple steps:
1. Create an account on Cloud 66.
2. Click here to auto-fill your new stack page.
3. Once the code has been analyzed, you need to specify environment variables for your deployment, as seen in the image below:
These are the environment variables you need to set:
- ‘HOST' - the domain hosting your site
- ‘SMTP_ADDRESS' - your SMTP provider address
- ‘SMTP_DOMAIN' - the domain you are sending emails from
- ‘SMTP_USERNAME' - your SMTP username
- ‘SMTP_PASSWORD' - your SMTP password
- ‘SMTP_PORT' - your SMTP port
4. Next, choose where you’d like to deploy Redmine, the region and server size. You can also choose if you’d like to deploy to separate web, database and Redis servers.
5. Once you’re happy with your configuration, simply click ‘deploy’, and sit back and relax while we deploy Redmine for you.
Your default login details are as follows:
- Username: admin
- Password: admin
Option 2: Manual Installation
1. Redmine application
Get the Redmine source code by either downloading a packaged release or checking out the code repository. See the Redmine download page for details.
2. Create an empty database and accompanying user
Redmine database user will be named redmine hereafter but it can be changed to anything else.
CREATE DATABASE redmine CHARACTER SET utf8; CREATE USER ‘redmine’@’localhost’ IDENTIFIED BY ‘my_password’; GRANT ALL PRIVILEGES ON redmine.* TO ‘redmine’@’localhost’;
For versions of MySQL prior to 5.0.2 - skip the ‘create user’ step and instead:
GRANT ALL PRIVILEGES ON redmine.* TO ‘redmine’@’localhost’ IDENTIFIED BY ‘my_password’;
CREATE ROLE redmine LOGIN ENCRYPTED PASSWORD ‘my_password’ NOINHERIT VALID UNTIL ‘infinity’; CREATE DATABASE redmine WITH ENCODING=’UTF8’ OWNER=redmine;
5. SQL Server
The database, login and user can be created within SQL Server Management Studio with a few clicks.
If you prefer the command line option with SQLCMD, here’s some basic example:
USE [master] GO — Very basic DB creation CREATE DATABASE [REDMINE] GO — Creation of a login with SQL Server login/password authentication and no password expiration policy CREATE LOGIN [REDMINE] WITH PASSWORD=N’redminepassword’, DEFAULT_DATABASE=[REDMINE], CHECK_EXPIRATION=OFF, CHECK_POLICY=OFF GO — User creation using previously created login authentication USE [REDMINE] GO CREATE USER [REDMINE] FOR LOGIN [REDMINE] GO — User permissions set via roles EXEC sp_addrolemember N’db_datareader’, N’REDMINE’ GO EXEC sp_addrolemember N’db_datawriter’, N’REDMINE’ GO
6. Database connection configuration
Copy config/database.yml.example to config/database.yml and edit this file in order to configure your database settings for “production” environment.
Example for a MySQL database using ruby 1.8 or jruby:
production: adapter: mysql database: redmine host: localhost username: redmine password: my_password
Example for a MySQL database using ruby 1.9 (adapter must be set to mysql2):
production: adapter: mysql2> database: redmine host: localhost username: redmine password: my_password
If your server is not running on the standard port (3306), use this configuration instead:
production: adapter: mysql database: redmine host: localhost port: 3307 username: redmine password: my_password
Example for a PostgreSQL database (default port):
production: adapter: postgresql database: <your_database_name> host: <postgres_host> username: <postgres_user> password: <postgres_user_password> encoding: utf8 schema_search_path: <database_schema> (default - public)
Example for a SQL Server database (default host localhost, default port 1433):
production: adapter: sqlserver database: redmine username: redmine # should match the database user name password: redmine # should match the login password
7. Dependencies installation
Redmine uses Bundler to manage gems dependencies.
You need to install Bundler first:
gem install bundler
Then you can install all the gems required by Redmine using the following command:
bundle install —without development test
8. Optional dependencies
RMagick (allows the use of ImageMagick to manipulate images for PDF and PNG export)
If ImageMagick is not installed on your system, you should skip the installation of the rmagick gem using:
bundle install —without development test rmagick
Redmine automatically installs the adapter gems required by your database configuration by reading it from the config/database.yml file (eg. if you configured only a connection using the mysql2 adapter, then only the mysql2 gem will be installed).
Don’t forget to re-run bundle install —without development test … after adding or removing adapters in the config/database.yml file!
9. Additional dependencies (Gemfile.local)
If you need to load gems that are not required by Redmine core (eg. Puma, fcgi), create a file named Gemfile.local at the root of your redmine directory. It will be loaded automatically when running bundle install.
# Gemfile.local gem ‘puma’
10. Session store secret generation
This step generates a random key used by Rails to encode cookies storing session data thus preventing their tampering.
Generating a new secret token invalidates all existing sessions after restart.
- with Redmine 1.4.x:
- with Redmine 2.x:
11. Database schema objects creation
Create the database structure, by running the following command under the application root directory:
RAILS_ENV=production rake db:migrate
It will create tables by running all migrations one by one then create the set of the permissions and the application administrator account, named admin.
If you get this error with Ubuntu:
Rake aborted! no such file to load — net/https
Then you need to install libopenssl-ruby1.8 just like this: apt-get install libopenssl-ruby1.8.
12. Database default data set
Insert default configuration data in database, by running the following command:
RAILS_ENV=production rake redmine:load_default_data
Redmine will prompt you for the data set language that should be loaded; you can also define the REDMINE_LANG environment variable before running the command to a value which will be automatically and silently picked up by the task.
RAILS_ENV=production REDMINE_LANG=fr rake redmine:load_default_data
13. File system permissions
The user account running the application must have write permission on the following subdirectories:
- files (storage of attachments)
- log (application log file production.log)
- tmp and tmp/pdf (create these ones if not present, used to generate PDF documents among other things)
- public/plugin_assets (assets of plugins)
E.g., assuming you run the application with a redmine user account:
mkdir -p tmp tmp/pdf public/plugin_assets sudo chown -R redmine:redmine files log tmp public/plugin_assets sudo chmod -R 755 files log tmp public/plugin_assets
14. Test the installation
Test the installation by running WEBrick web server:
with Redmine 1.4.x:
ruby script/server webrick -e production
with Redmine 2.x:
ruby script/rails server webrick -e production
Once WEBrick has started, point your browser to http://localhost:3000/. You should now see the application welcome page.
Note: Webrick is not suitable for production use, please only use webrick for testing that the installation up to this point is functional. Use one of the many other guides in this wiki to setup redmine to use either Passenger (aka mod_rails), FCGI or a Rack server (Unicorn, Thin, Puma, hellip;) to serve up your redmine.
15. Logging into the application
Use default administrator account to log in:
- login: admin
- password: admin
You can go to Administration menu and choose Settings to modify most of the application settings.
Redmine settings are defined in a file named config/configuration.yml.
If you need to override default application settings, simply copy config/configuration.yml.example to config/configuration.yml and edit the new file; the file is well commented by itself, so you should have a look at it.
These settings may be defined per Rails environment (production/development/test).
Important : don’t forget to restart the application after any change.
17. Email / SMTP server settings
Email configuration is described in a dedicated page.
18. SCM settings
This configuration section allows you to:
- override default commands names if the SCM binaries present in the PATH variable doesn’t use the standard name (Windows .bat/.cmd names won’t work)
- specify the full path to the binary
Examples (with Subversion):
Command name override:
scm_subversion_command: “C:\Program Files\Subversion\bin\svn.exe”
19. Attachment storage settings
You can set a path where Redmine attachments will be stored which is different from the default ‘files’ directory of your Redmine instance using the attachments_storage_path setting.
attachments_storage_path: /var/redmine/files attachments_storage_path: D:/redmine/files
20. Logging configuration
Redmine defaults to a log level of :info, writing to the log subdirectory. Depending on site usage, this can be a lot of data so to avoid the contents of the logfile growing without bound, consider rotating them, either through a system utility like logrotate or via the config/additional_environment.rb file.
To use the latter, copy config/additional_environment.rb.example to config/additional_environment.rb and add the following lines. Note that the new logger defaults to a high log level and hence has to be explicitly set to info.
#Logger.new(PATH,NUM_FILES_TO_ROTATE,FILE_SIZE) config.logger = Logger.new(‘/path/to/logfile.log’, 2, 1000000) config.logger.level = Logger::INFO
Redmine backups should include:
- data (stored in your redmine database)
- attachments (stored in the files directory of your Redmine install)
Here is a simple shell script that can be used for daily backups (assuming you’re using a mysql database):
# Database /usr/bin/mysqldump -u <username> -p<password> <redmine_database> | gzip > /path/to/backup/db/redmine_`date +%y_%m_%d`.gz # Attachments rsync -a /path/to/redmine/files /path/to/backup/files
22. Notes on Linux/Unix installation
Be sure to disable security hardening tools during the installation process if you run into bizarre permission problems. These problems are mostly silent and can be caused by tools like extended ACLs, SELinux, or AppArmor. There tools are mostly used in big companies with a strict security policy, default Linux/Unix distributions settings shouldn’t be a problem.