RedmineInstall » History » Revision 314

Revision 313 (Go MAEDA, 2020-10-19 08:10) → Revision 314/326 (Go MAEDA, 2020-10-21 04:45)

h1. Installing Redmine 


 This is the installation documentation for Redmine 4.0 and higher. You can still read the document for older versions: "3.x":/projects/redmine/wiki/RedmineInstall/308 , "1.4.x - 2.6.x":/projects/redmine/wiki/RedmineInstall/263, "1.3.x":/projects/redmine/wiki/RedmineInstall?version=146 

 h2. Requirements 

 h3. Operating system 

 Redmine should run on most Unix, Linux, [[RedmineInstallOSX|macOS]] and [[RedmineInstall#Notes-on-Windows-installation|Windows]] systems as long as Ruby is available on this platform.    See specific installation HowTos [[HowTos|here]]. 


 h3. Ruby interpreter 

 The required Ruby versions for a given Redmine version is: 

 |_. Redmine version|_. Supported Ruby versions                         |_. Rails version used| 
 |trunk (>= r20154) r20150) |Ruby 2.3, 2.4, 2.5, 2.6, 2.7[1]                                            |Rails 5.2              | 
 |4.1                 |Ruby 2.3, 2.4, 2.5, 2.6                            |Rails 5.2              | 
 |4.0                 |Ruby 2.2[2], 2.3, 2.4, 2.5, 2.6                    |Rails 5.2              | 

 fn1. Ruby 2.7.0 and 2.7.1 are not supported. Use Ruby 2.7.2 or higher (see #31500#note-13). 

 fn2. Redmine prior to 4.0.6 supports Ruby >= 2.2.2. Redmine 4.0.6 and later don't support Ruby 2.2 (see #32787). 

 Important notices: 

 * %{color: red}Support of Ruby 2.4 and earlier have ended by Ruby community.% See the official announcements for details: "2.2":, "2.3":, "2.4": 
 * *Redmine does not support JRuby* because "activerecord-jdbc-adapter": and "loofah": do not support Rails 4.2 or later. 


 h3. Supported database back-ends 

 * MySQL 5.5 - 5.7 

  * *MySQL 5.6 or higher* and *MariaDB* have known issues (#19344, #19395, #17460). 

 * PostgreSQL 9.2 or higher 

  * make sure your database datestyle is set to ISO (Postgresql default setting). You can set it using: @ALTER DATABASE "redmine_db" SET datestyle="ISO,MDY";@ 

 * Microsoft SQL Server "2012 or higher": 

  * Redmine 4.0.0 to 4.0.6 and 4.1.0 don't support SQL Server (#30285, #32737). 

 * SQLite 3 (not for multi-user production use!) 

 h3. Optional components 

       * SCM binaries (eg. @svn@), for repository browsing (must be available in your PATH). See [[RedmineRepositories]] for SCM compatibility and requirements. 
       * "ImageMagick": (to enable Gantt export to PNG image and thumbnails generation). 
       * "Ghostscript": (to enable thumbnails generation for PDF attachments in Redmine 4.1 or later). 

 h2. Redmine Version 

 It is recommended that the majority of users install the proper point releases of redmine. Redmine currently releases a new version every 6 months, and these releases are considered very usable and stable. It is *not* recommended to install redmine from trunk, unless you are deeply familiar with Ruby on Rails and keep up with the changes - Trunk _does_ break from time-to-time. 

 h2. Installation procedure 

 h3. Step 1 - Redmine application 

 Get the Redmine source code by either downloading a packaged release or checking out the code repository. 

 See the [[Download|download page]] for details. 

 h3. Step 2 - Create an empty database and accompanying user 

 Redmine database user will be named @redmine@ hereafter but it can be changed to anything else. 

 h4. MySQL 

 <pre><code class="sql"> 
 CREATE USER 'redmine'@'localhost' IDENTIFIED BY 'my_password'; 
 GRANT ALL PRIVILEGES ON redmine.* TO 'redmine'@'localhost'; 

 For versions of MySQL "5.5.2": or lower - use *utf8* instead of "utf8mb4": 

 <pre><code class="sql"> 
 CREATE USER 'redmine'@'localhost' IDENTIFIED BY 'my_password'; 
 GRANT ALL PRIVILEGES ON redmine.* TO 'redmine'@'localhost'; 

 For versions of MySQL "5.0.2": or lower - skip the 'CREATE USER' step and instead: 
 <pre><code class="sql"> 
 GRANT ALL PRIVILEGES ON redmine.* TO 'redmine'@'localhost' IDENTIFIED BY 'my_password'; 

 h4. PostgreSQL 

 <pre><code class="sql"> 

 h4. SQLite 

 Skip this step. A database file will be created during [[RedmineInstall#Step-6-Database-schema-objects-creation|Step 6]]. 

 h4. 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: 

 {{collapse(Show SQL,Hide SQL) 
 <pre><code class="sql"> 
 USE [master] 

 -- Very basic DB creation 

 -- Creation of a login with SQL Server login/password authentication and no password expiration policy 

 -- User creation using previously created login authentication 
 -- User permissions set via roles 
 EXEC sp_addrolemember N'db_datareader', N'REDMINE' 
 EXEC sp_addrolemember N'db_datawriter', N'REDMINE' 

 h3. Step 3 - 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 (default port): 

 <pre><code class="yml"> 
   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: 

 <pre><code class="yml"> 
   adapter: mysql2 
   database: redmine 
   host: localhost 
   port: 3307 
   username: redmine 
   password: "my_password" 

 Example for a PostgreSQL database (default port): 

 <pre><code class="yml"> 
   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 SQLite database: 

 <pre><code class="yml"> 
   adapter: sqlite3 
   database: db/redmine.sqlite3 

 Example for a SQL Server database (default host @localhost@, default port @1433@): 
 <pre><code class="yml"> 
   adapter: sqlserver 
   database: redmine 
   username: redmine # should match the database user name 
   password: "redminepassword" # should match the login password 

 h3. Step 4 - Dependencies installation 

 Redmine uses "Bundler": to manage gems dependencies. 

 You need to install Bundler first if you use Ruby 2.5 or earlier: 

   gem install bundler 

 Then you can install all the gems required by Redmine using the following command: 

   bundle install --without development test 

 h4. Optional dependencies 

 h5. RMagick 

 RMagick is an interface between the Ruby programming language and the ImageMagick image processing library. The library is necessary for Redmine prior to 4.1.0 to export gantt charts to PNG or PDF. 

 If ImageMagick (6.4.9 - 6.9.10) is not installed on your system and you are installing Redmine 4.0 or earlier, you should skip the installation of the rmagick gem using: 

  @bundle install --without development test rmagick@ 

 If you have trouble installing @rmagick@ on Windows, refer to [[HowTo_install_rmagick_gem_on_Windows|this HowTo]]. 

 h5. Database adapters 

 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! 

 h4. 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' 

 h3. Step 5 - 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. 

 bundle exec rake generate_secret_token 

 Alternatively, you can store this secret in config/secrets.yml: 

 h3. Step 6 - Database schema objects creation 

 Create the database structure, by running the following command under the application root directory: 

 RAILS_ENV=production bundle exec rake db:migrate 

 *Windows syntax:* 

 set RAILS_ENV=production 
 bundle exec 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@. 

 +Ubuntu troubleshooting:+ 

 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@. 

 h3. Step 7 - Database default data set 

 Insert default configuration data in database, by running the following command: 

   RAILS_ENV=production bundle exec 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 bundle exec rake redmine:load_default_data 

 set RAILS_ENV=production 
 bundle exec rake redmine:load_default_data 

 h3. Step 8 - File system permissions 

 NB: _Windows users can skip this section._ 

 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 

 Note: If you have files in these directories (e.g. restore files from backup), make sure these files are not executable. 

 sudo find files log tmp public/plugin_assets -type f -exec chmod -x {} + 

 h3. Step 9 - Test the installation 

 Test the installation by running WEBrick web server: 

 bundle exec 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. 

 h3. Step 10 - 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. 

 h2. Configuration 

 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. 

 h3. Email / SMTP server settings 

 Email configuration is described in a [[EmailConfiguration|dedicated page]]. 

 h3. 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: "svn_replacement.exe" 

 Absolute path: 

  scm_subversion_command: "C:\Program Files\Subversion\bin\svn.exe" 

 h3. 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 

 h2. 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@. 
 <pre><code class="ruby">,NUM_FILES_TO_ROTATE,FILE_SIZE) 
 config.logger ='/path/to/logfile.log', 2, 1000000) 
 config.logger.level = Logger::INFO 

 h2. Backups 

 Redmine backups should include: 
 * data (stored in your redmine database) 
 * attachments (stored in the @files@ directory of your Redmine install) 

 Please refer to [[RedmineBackupAndRestore|Backing up and restoring Redmine]] for more details. 

 h2. Notes on Linux/Unix installation 

 Be sure to disable security hardenning 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. 

 h2. Notes on Windows installation 

 There is an prebuilt installer of Ruby MRI available from 
 After installing it, select _Start Command Prompt with Ruby_ in the start menu. 

 +Specifying the @RAILS_ENV@ environment variable:+ 

 When running command as described in this guide, you have to set the @RAILS_ENV@ environment variable using a separate command. 

 I.e. commands with the following syntaxes: 

 <pre>RAILS_ENV=production <any commmand></pre> 

 <pre><any commmand> RAILS_ENV=production</pre> 

 have to be turned into 2 subsequent commands: 

 <pre>set RAILS_ENV=production 
 <any commmand></pre> 

 +MySQL gem installation issue:+ 

 You may need to manually install the mysql gem using the following command: 

 gem install mysql 

 And in some case it is required to copy the _libmysql.dll_ file in your ruby/bin directory. 
 Not all libmysql.dll are ok this seem to works 

 *Important note for Win7 and later* 
 On Win7 and later, @localhost@ is commented out in the hosts file[5] and IPV6 is the default[6]. As the mysql2 gem does no support IPV6 addresses[7], a connection can't be established and you get the error "@Can't connect to MySQL server on 'localhost' (10061)@". 
 You can confirm this by pinging @localhost@, if ping targets "::1:" IPV6 is being used. 

 Replace @localhost@ with @ in database.yml. 




 h2. Alternative to manual installation 

 Some users may prefer to skip manual installation by using one of the [[Download#Third-party-Redmine-bundles|third-party Redmine bundles]] on the download page.