Bitnami Redmine+Agile Installer

NOTE: Before running the commands shown on this page, you should load the Bitnami stack environment by executing the installdir/use_APPNAME script (Linux and Mac OS X) or by clicking the shortcut in the Start Menu under "Start -> Bitnami APPNAME Stack -> Application console" (Windows). Learn more.
NOTE: When running the commands shown on this page, replace the installdir placeholder with the full installation directory for your Bitnami stack.

Description

Apply the best Agile practices in your projects with Redmine Agile plugin.

License information

The Bitnami Redmine + Agile package contains the Bitnami Redmine Stack with a light version of the Agile plugin specifically for use in a self-hosted and managed environment. To learn more about Redmine+Agile plans and licensing visit the Redmine+Agile website.

First steps with the Bitnami Redmine+Agile Stack

Welcome to your new Bitnami application! Here are a few questions (and answers!) you might need when first starting with your application.

What are the system requirements?

Before you download and install your application, check that your system meets these requirements.

How do I install the Bitnami Redmine+Agile Stack?

Windows, OS X and Linux installer
  • Download the executable file for the Bitnami Redmine+Agile Stack from the Bitnami website.

  • Run the downloaded file:

    • On Linux, give the installer executable permissions and run the installation file in the console.
    • On other platforms, double-click the installer and follow the instructions shown.

Check the FAQ instructions on how to download and install a Bitnami Stack for more details.

The application will be installed to the following default directories:

Operating System Directory
Windows C:\Bitnami\APPNAME-VERSION
Mac OS X /Applications/APPNAME-VERSION
Linux /opt/APPNAME-VERSION (running as root user)
OS X VM
  • Download the OS X VM file for the Bitnami Redmine+Agile Stack from the Bitnami website.
  • Begin the installation process by double-clicking the image file and dragging the WordPress OS X VM icon to the Applications folder.
  • Launch the VM by double-clicking the icon in the Applications folder.

What credentials do I need?

You need application credentials, consisting of a username and password. These credentials allow you to log in to your new Bitnami application.

What is the administrator username set for me to log in to the application for the first time?

  • For Windows, Linux and OS X installers, the username was configured by you when you first installed the application.
  • For OS X VMs, the username can be obtained by clicking the Bitnami badge at the bottom right corner of the application welcome page.

What is the administrator password?

  • For Windows, Linux and OS X installers, the password was configured by you when you first installed the application.
  • For OS X VMs, the password can be obtained by clicking the Bitnami badge at the bottom right corner of the application welcome page.

How to start or stop the services?

Linux

Bitnami native installers include a graphical tool to manage services. This tool is named manager-linux-x64.run on Linux and is located in the installation directory. To use this tool, double-click the file and then use the graphical interface to start, stop or restart services. Server log messages can be checked in the "Server Events" tab.

Management tool

The native installer also includes a command-line script to start, stop and restart applications, named ctlscript.sh. This script can be found in the installation directory and accepts the options start, stop, restart, and status. To use it, log in to the server console and execute it following the examples below:

  • Call it without any service names to start all services:

      $ sudo installdir/ctlscript.sh start
    
  • Use it to restart a specific service only by passing the service name as argument - for example, mysql, postgresql or apache:

      $ sudo installdir/ctlscript.sh restart mysql
      $ sudo installdir/ctlscript.sh restart postgresql
      $ sudo installdir/ctlscript.sh restart apache
    
  • Obtain current status of all services:

      $ installdir/ctlscript.sh status
    

The list of available services varies depending on the required components for each application.

Mac OS X

Bitnami native installers include a graphical tool to manage services. This tool is named manager-osx on Mac OS X and is located in the installation directory. To use this tool, double-click the file and then use the graphical interface to start, stop or restart services. Server log messages can be checked in the "Server Events" tab.

Management tool

The native installer also includes a command-line script to start, stop and restart applications, named ctlscript.sh. This script can be found in the installation directory and accepts the options start, stop, restart, and status. To use it, log in to the server console and execute it following the examples below:

  • Call it without any service names to start all services:

    $ sudo installdir/ctlscript.sh start
    
  • Use it to restart a specific service only by passing the service name as argument - for example, mysql or apache:

     $ sudo installdir/ctlscript.sh restart mysql
     $ sudo installdir/ctlscript.sh restart apache
    
  • Obtain current status of all services:

     $ installdir/ctlscript.sh status
    

The list of available services varies depending on the required components for each application.

NOTE: If you are using the stack manager for Mac OS X-VM, please check the following blog post to learn how to manage services from its graphical tool.

Windows

Bitnami native installers include a graphical tool to manage services. This tool is named manager-windows.exe on Windows and is located in the installation directory. To use this tool, double-click the file and then use the graphical interface to start, stop or restart services. Server log messages can be checked in the "Server Events" tab.

Management tool

The Windows native installer creates shortcuts to start and stop services created in the Start Menu, under "Programs -> Bitnami APPNAME Stack -> Bitnami Service". Servers can also be managed from the Windows "Services" control panel. Services are named using the format APPNAMESERVICENAME, where APPNAME is a placeholder for the application name and SERVICENAME is a placeholder for the service name. For example, the native installer for the Bitnami WordPress Stack installs services named wordpressApache and wordpressMySQL.

These services will be automatically started during boot. To modify this behaviour, refer to the section on disabling services on Windows.

How to access the administration panel?

Access the administration panel by browsing to http://localhost/admin.

How to see a Subversion repository from the Redmine application or from a Web browser directly?

NOTE: The Windows installer for the Bitnami Redmine Stack no longer includes Subversion. Linux and Mac OS X installers for this stack continue to include Subversion as before.

Redmine lets users check repository changes and link to cases. Simply configure the "Repository URL" in the project's "Settings -> Repositories" tab.

SCM: Subversion
URL: http://your_repository
Login: repository_login
Password: repository_password

Redmine and Subversion

How to configure Redmine for advanced integration with Subversion?

Before starting this guide, take into account that this is not necessary to see the repository changes in the Redmine application. If you only want to see the repository changes and link to the issues, it is only necessary to configure the project repository: "Project -> Settings -> Repository -> URL and Control Version System".

This Redmine configuration is for automatic repository creation and rights management. Since v1.1.3-1, Redmine Stack ships all required modules for this configuration. This guide has been updated to work with Redmine 2.1.4.

Follow these steps:

  • Make sure that the mod_dav module is enabled in your Apache configuration file (httpd.conf). This module should be loaded before the modules mentioned in the next step.

     LoadModule dav_module modules/mod_dav.so
    
  • Add the following lines in the Apache configuration file:

     LoadModule dav_svn_module modules/mod_dav_svn.so
     LoadModule perl_module modules/mod_perl.so
    
  • You will also need to add the following lines to the installdir/apache2/bin/envvars file (the path may change depending on the version):

     LD_LIBRARY_PATH="installdir/perl/lib/5.16.3/x86_64-linux-thread-multi/CORE/:$LD_LIBRARY_PATH"
     export LD_LIBRARY_PATH
    
  • Copy the Redmine.pm file into the Perl modules folder:

     $ cp installdir/apps/redmine/htdocs/extra/svn/Redmine.pm installdir/perl/lib/site_perl/5.8.8/*/Apache2/
    
  • Create a directory for the repository, for instance:

     $ mkdir installdir/repository
     $ mkdir installdir/repository/svn
     $ chown root:daemon installdir/repository/ [or "your_user:your_user" if you installed the Stack without root privileges]
     $ chown root:daemon installdir/repository/svn/ [or "your_user:your_user" if you installed the Stack without root privileges]
     $ chmod 0755 installdir/repository
     $ chmod 0750 installdir/repository/svn
    
  • Add these lines to the installdir/apps/redmine/conf/httpd-app.conf file:

     PerlLoadModule Apache2::Redmine
     <Location /svn>
       DAV svn
       SVNParentPath "installdir/repository/svn"
       Order deny,allow
       Deny from all
       Satisfy any
    
       PerlAccessHandler Apache::Authn::Redmine::access_handler
       PerlAuthenHandler Apache::Authn::Redmine::authen_handler
       AuthType Basic
       AuthName "Redmine SVN Repository"
    
       #read-only access
       <Limit GET PROPFIND OPTIONS REPORT>
          Require valid-user
          Allow from all
          # Allow from another-ip
          Satisfy any
       </Limit>
       # write access
       <LimitExcept GET PROPFIND OPTIONS REPORT>
         Require valid-user
       </LimitExcept>
    
       ## for mysql
       RedmineDSN "DBI:mysql:database=bitnami_redmine;host=localhost;mysql_socket=installdir/mysql/tmp/mysql.sock" 
    
       RedmineDbUser "bitnami"
       RedmineDbPass "bitnami_database_password"
       #You can find this value at installdir/apps/redmine/htdocs/config/database.yml
     </Location>
    
  • Restart the server:

       $ sudo installdir/ctlscript.sh restart apache
    
  • Log in to the Redmine application as administrator and navigate to "Settings -> Repositories -> Enable WS for repository management".

  • Click "Generate a key" and save the key.

  • Add the following line in the crontab. You can edit the crontab using the command crontab -e:

     */2 * * * * installdir/ruby/bin/ruby installdir/apps/redmine/htdocs/extra/svn/reposman.rb --redmine localhost:YOUR_APACHE_PORT/redmine --svn-dir installdir/repository/svn --owner root --group daemon --command="installdir/subversion/bin/svnadmin create --pre-1.6-compatible --fs-type fsfs" --url http://localhost:YOUR_APACHE_PORT/svn --key="YOUR_API_KEY" --verbose >> /var/log/reposman.log 
    

    If you have configured Redmine for access over SSL, you can specify --redmine http://127.0.0.1:3001/redmine in the previous crontab line.

Check that everything works properly creating a project from the Redmine application and checking the /var/log/reposman.log file.

Thanks to Jedbifa who posted a complete guide in the Bitnami forums.

How to configure outbound email settings?

Email settings can be configured in the installdir/apps/redmine/htdocs/config/configuration.yml file. In older versions, use the installdir/apps/redmine/htdocs/config/email.yml file.

The file includes sample configuration settings for most common scenarios, including Gmail. To use Gmail as the SMTP server, find and uncomment the Gmail settings such that you end up with the result below. Remember to update the user_name and password variables with the correct credentials for the Gmail account you plan to use.

# ==== SMTP server at using TLS (GMail)
# This might require some additional configuration. See the guides at:
# http://www.redmine.org/projects/redmine/wiki/EmailConfiguration
#
email_delivery:
  delivery_method: :smtp
  smtp_settings:
    enable_starttls_auto: true
    address: "smtp.gmail.com"
    port: 587
    domain: "smtp.gmail.com" # 'your.domain.com' for Google Apps
    authentication: :plain
    user_name: "USERNAME@gmail.com"
    password: "PASSWORD"

Once the configuration file has been modified, restart the services following these instructions.

To change the link that appears in the email, navigate to the "Administration -> Settings -> General -> Host name and path" section and enter your domain name and port.

More information is available on this Redmine wiki page and this Redmine blog post.

Troubleshooting email configuration issues

  • In case you receive an error message containing "530 5.7.0 Must issue a STARTTLS command first …", make sure you have the enable_starttls_auto property set after the password line. For example:

     email_delivery:
       delivery_method: :smtp
       smtp_settings:
         enable_starttls_auto: true
         address: "smtp.gmail.com"
         port: 587
         domain: "smtp.gmail.com" # 'your.domain.com' for GoogleApps
         authentication: :plain
         user_name: "USERNAME@gmail.com"
         password: "PASSWORD"
    
  • In Redmine 2.0 or greater, if you see an error similar to "An error occurred while sending mail (SSL_connect returned=1 errno=0 state=SSLv2/v3 read server hello A: unknown protocol)", remove the tls: true option from the configuration.yml file. Then, restart the services.

  • If using an SMTP server that does not require authentication, you may need to add the openssl_verify_mode: 'none' option to the configuration.yml file.

To configure the application to use other third-party SMTP services for outgoing email, such as SendGrid or Mandrill, refer to the FAQ.

NOTE: If you are using Gmail as the outbound email server and have experienced issues trying to send emails correctly, check the How to troubleshoot Gmail SMTP issues to learn the causes of these issues and how to solve them.

How to install a plugin on Redmine?

Before installing a plugin, make sure that the plugin is compatible with your Redmine version. For plugins from the Redmine Plugin Directory, check the "Compatible with:" field for each plugin.

  • Load the Bitnami stack environment by executing the installdir/use_redmine script (Linux and Mac OS X) or by clicking the shortcut in the Start Menu under "Start -> Bitnami Redmine Stack -> Application console" (Windows). Learn more.
  • Download the plugin and copy it into installdir/apps/redmine/htdocs/plugins.
  • If the plugin requires a migration, run the following commands to upgrade your database. It is advisable to back up the database before running these commands.

      $ cd installdir/apps/redmine/htdocs/
      $ bundle install --without development test postgresql sqlite
      $ ruby bin/rake redmine:plugins RAILS_ENV=production
    
  • Restart Redmine using these instructions.
  • After copying the plugin into the installdir/apps/redmine/htdocs/plugins directory, run these commands:

      $ cd installdir/apps/redmine/htdocs/
      $ bundle install --without development test postgresql sqlite --no-deployment
      $ bundle install --without development test postgresql sqlite --deployment
      $ ruby bin/rake redmine:plugins RAILS_ENV=production
    
  • Restart Redmine using these instructions.

Troubleshooting plugin installation

  • If you receive an error like this in Redmine 2.4.0-0 and better:

        You are trying to install in deployment mode after changing your Gemfile. Run 'bundle install' elsewhere and add the updated Gemfile.lock to version control.
    

    Try adding the --no-deployment argument to the bundle install command as suggested in the error message.

  • If you are using the Bitnami Redmine installer for Windows and your Thin servers don't run after installing a plugin, run them manually to understand the error:

    • Go to the Bitnami Redmine console: "Start -> Program Files -> Bitnami Redmine Stack -> Use Redmine"
    • Go to apps/redmine/htdocs.
    • Run the following command:

       $ bundle exec thin start -e production -p 3001 --prefix /redmine
      

    Now, you will be able to see the error when starting the servers or accessing the application through a Web browser at http://127.0.0.1:3001/redmine.

How to create a full backup of Redmine+Agile?

The Bitnami Redmine+Agile Stack is self-contained and the simplest option for performing a backup is to copy or compress the Bitnami stack installation directory. To do so in a safe manner, you will need to stop all servers, so this method may not be appropriate if you have people accessing the application continuously.

NOTE: If you want to create only a database backup, refer to these instructions for MySQL and PostgreSQL.

Backup on Linux and Mac OS X

Follow these steps:

  • Change to the directory in which you wish to save your backup.

     $ cd /your/directory
    
  • Stop all servers.

     $ sudo installdir/ctlscript.sh stop
    
  • Create a compressed file with the stack contents.

     $ sudo tar -pczvf application-backup.tar.gz installdir
    
  • Start all servers.

     $ sudo installdir/ctlscript.sh start
    
  • Download or transfer the application-backup.tar.gz file to a safe location.

You should now download or transfer the application-backup.tar.gz file to a safe location.

Backup on Windows

Follow these steps:

  • Stop all servers using the shortcuts in the Start Menu or the graphical manager tool.

  • Create a compressed file with the stack contents. You can use a graphical tool like 7-Zip or WinZip or just right-click the folder, click "Send to", and select the "Compressed (zipped) folder" option.

  • Download or transfer the compressed file to a safe location.

  • Start all servers using the shortcuts in the Start Menu or the graphical manager tool.

Restore on Linux and Mac OS X

Follow these steps:

  • Change to the directory containing your backup:

    $ cd /your/directory
    
  • Stop all servers.

    $ sudo installdir/ctlscript.sh stop
    
  • Move the current stack to a different location:

    $ sudo mv installdir /tmp/bitnami-backup
    
  • Uncompress the backup file to the original directory:

    $ sudo tar -pxzvf application-backup.tar.gz -C /
    
  • Start all servers.

    $ sudo installdir/ctlscript.sh start
    
IMPORTANT: When restoring, remember to maintain the original permissions for the files and folders. For example, if you originally installed the stack as the root user on Linux, make sure that the restored files are owned by root as well.

Restore on Windows

  • Change to the directory containing your backup:

       $ cd /your/directory
    
  • Stop all servers using the shortcuts in the Start Menu or the graphical manager tool.

  • Uninstall the previous services by executing the following command:

        $ serviceinstall.bat
    
  • Create a safe folder named Backups in the desktop and move the current stack to it. Remember to replace PATH with the right location of your folder:

        $ move installdir \PATH\Backups
    
  • Uncompress the backup file using a tool like 7-Zip or Winzip or just double-click the .zip file to uncompress it, and move it to the original directory.
  • Install services by running the following commands from an elevated command prompt:

      $ cd installdir
      $ serviceinstall.bat INSTALL
    
  • Start all servers using the shortcuts in the Start Menu or the graphical manager tool.

How to upgrade Redmine?

It is strongly recommended that you create a backup before starting the update process. If you have important data, it is advisable that you create and try to restore a backup to ensure that everything works properly.

You can upgrade the application and the stack components by following the steps below:

  • Launch a new Redmine server.
  • Copy the database backup to the new server.
  • Stop all servers and start only MySQL.

    $ sudo installdir/ctlscript.sh stop apache
    $ sudo installdir/ctlscript.sh stop mysql
    $ sudo installdir/ctlscript.sh start mysql
    
  • Remove the previous database and create the new one. You can configure the database user password with a secure password. Remember to add the -h option to specify the hostname if your database is hosted on a different server.

    $ mysql -u root -p
    Password: ****
    mysql> drop database bitnami_redmine;
    mysql> create database bitnami_redmine;
    mysql> grant all privileges on bitnami_redmine.* to 'bn_redmine'@'localhost' identified by 'DATABASE_PASSWORD';
    
  • Restore the new database:

    $ mysql -u root -p bitnami_redmine < backup.sql
    
  • Edit the Redmine configuration file to update the database user password (the same that you set previously) at installdir/apps/redmine/htdocs/config/database.yml.

    production:
      adapter: mysql2
      database: bitnami_redmine
      host: localhost
      username: bn_redmine
      password: "DATABASE_PASSWORD"
      encoding: utf8
    
  • Migrate the database to the latest version:

    $ cd installdir/apps/redmine/htdocs/
    $ ruby bin/rake db:migrate RAILS_ENV=production
    

Troubleshooting upgrades

  • If you see the following error, go to your database and remove the specified table and run the migration command again.

     Mysql::Error: Table 'changeset_parents' already exists: CREATE TABLE `changeset_parents` (`changeset_id` int(11) NOT NULL, `parent_id` int(11) NOT NULL) ENGINE=InnoDB
    

    Run these commands:

     $ mysql -u root -p 
     mysql> use bitnami_redmine;
     mysql> drop table changeset_parents;
    
     $ cd installdir/apps/redmine/htdocs/ 
     $ ruby bin/rake db:migrate RAILS_ENV=production
    

    Then, copy the installdir/apps/redmine/htdocs/files directory from the old installation to the new one. If you have installed plugins in the previous version, copy the directories from the vendor/plugins directory into the new installation area, in the plugins directory. Check that the plugins are compatible with the new version and run the following command:

     $ ruby bin/rake redmine:plugins RAILS_ENV="production"
    

    Clean the cache and the sessions.

     $ ruby bin/rake tmp:cache:clear
     $ ruby bin/rake tmp:sessions:clear
    

    Restart the servers.

     $ sudo installdir/ctlscript.sh restart
    
  • If you upgrade from a 1.x version and you see something similar to this error:

     MysqlStatement::Error Value for field `value` cannot be NULL INSERT INTO custom_value ...
    

    Go to your custom values in the admin panel, edit and save them again to fix the issue.

How to create an SSL certificate?

OpenSSL is required to create an SSL certificate. A certificate request can then be sent to a certificate authority (CA) to get it signed into a certificate, or if you have your own certificate authority, you may sign it yourself, or you can use a self-signed certificate (because you just want a test certificate or because you are setting up your own CA).

Follow the steps below for your platform.

Linux and Mac OS X

NOTE: OpenSSL will typically already be installed on Linux and Mac OS X. If not installed, install it manually using your operating system's package manager.

Follow the steps below:

  • Generate a new private key:

     $ sudo openssl genrsa -out installdir/apache2/conf/server.key 2048
    
  • Create a certificate:

     $ sudo openssl req -new -key installdir/apache2/conf/server.key -out installdir/apache2/conf/cert.csr
    
    IMPORTANT: Enter the server domain name when the above command asks for the "Common Name".
  • Send cert.csr to the certificate authority. When the certificate authority completes their checks (and probably received payment from you), they will hand over your new certificate to you.

  • Until the certificate is received, create a temporary self-signed certificate:

     $ sudo openssl x509 -in installdir/apache2/conf/cert.csr -out installdir/apache2/conf/server.crt -req -signkey installdir/apache2/conf/server.key -days 365
    
  • Back up your private key in a safe location after generating a password-protected version as follows:

     $ sudo openssl rsa -des3 -in installdir/apache2/conf/server.key -out privkey.pem
    

    Note that if you use this encrypted key in the Apache configuration file, it will be necessary to enter the password manually every time Apache starts. Regenerate the key without password protection from this file as follows:

     $ sudo openssl rsa -in privkey.pem -out installdir/apache2/conf/server.key
    

Windows

NOTE: OpenSSL is not typically installed on Windows. Before following the steps below, download and install a binary distribution of OpenSSL.

Follow the steps below once OpenSSL is installed:

  • Set the OPENSSL_CONF environment variable to the location of your OpenSSL configuration file. Typically, this file is located in the bin/ subdirectory of your OpenSSL installation directory. Replace the OPENSSL-DIRECTORY placeholder in the command below with the correct location.

     $ set OPENSSL_CONF=C:\OPENSSL-DIRECTORY\bin\openssl.cfg
    
  • Change to the bin/ sub-directory of the OpenSSL installation directory. Replace the OPENSSL-DIRECTORY placeholder in the command below with the correct location.

     $ cd C:\OPENSSL-DIRECTORY\bin
    
  • Generate a new private key:

     $ openssl genrsa -out installdir/apache2/conf/server.key 2048
    
  • Create a certificate:

     $ openssl req -new -key installdir/apache2/conf/server.key -out installdir/apache2/conf/cert.csr
    
    IMPORTANT: Enter the server domain name when the above command asks for the "Common Name".
  • Send cert.csr to the certificate authority. When the certificate authority completes their checks (and probably received payment from you), they will hand over your new certificate to you.

  • Until the certificate is received, create a temporary self-signed certificate:

     $ openssl x509 -in installdir/apache2/conf/cert.csr -out installdir/apache2/conf/server.crt -req -signkey installdir/apache2/conf/server.key -days 365
    
  • Back up your private key in a safe location after generating a password-protected version as follows:

     $ openssl rsa -des3 -in installdir/apache2/conf/server.key -out privkey.pem
    

    Note that if you use this encrypted key in the Apache configuration file, it will be necessary to enter the password manually every time Apache starts. Regenerate the key without password protection from this file as follows:

     $ openssl rsa -in privkey.pem -out installdir/apache2/conf/server.key
    

Find more information about certificates at http://www.openssl.org.

How to enable HTTPS support with SSL certificates?

TIP: If you wish to use a Let's Encrypt certificate, you will find specific instructions for enabling HTTPS support with Let's Encrypt SSL certificates in our Let's Encrypt guide.
NOTE: The steps below assume that you are using a custom domain name and that you have already configured the custom domain name to point to your cloud server.

Bitnami images come with SSL support already pre-configured and with a dummy certificate in place. Although this dummy certificate is fine for testing and development purposes, you will usually want to use a valid SSL certificate for production use. You can either generate this on your own (explained here) or you can purchase one from a commercial certificate authority.

Once you obtain the certificate and certificate key files, you will need to update your server to use them. Follow these steps to activate SSL support:

  • Use the table below to identify the correct locations for your certificate and configuration files.

    Variable Value
    Current application URL https://[custom-domain]/
      Example: https://my-domain.com/ or https://my-domain.com/appname
    Apache configuration file installdir/apache2/conf/bitnami/bitnami.conf
    Certificate file installdir/apache2/conf/server.crt
    Certificate key file installdir/apache2/conf/server.key
    CA certificate bundle file (if present) installdir/apache2/conf/server-ca.crt
  • Copy your SSL certificate and certificate key file to the specified locations.

    NOTE: If you use different names for your certificate and key files, you should reconfigure the SSLCertificateFile and SSLCertificateKeyFile directives in the corresponding Apache configuration file to reflect the correct file names.
  • If your certificate authority has also provided you with a PEM-encoded Certificate Authority (CA) bundle, you must copy it to the correct location in the previous table. Then, modify the Apache configuration file to include the following line below the SSLCertificateKeyFile directive. Choose the correct directive based on your scenario and Apache version:

    Variable Value
    Apache configuration file installdir/apache2/conf/bitnami/bitnami.conf
    Directive to include (Apache v2.4.8+) SSLCACertificateFile "installdir/apache2/conf/server-ca.crt"
    Directive to include (Apache < v2.4.8) SSLCertificateChainFile "installdir/apache2/conf/server-ca.crt"
    NOTE: If you use a different name for your CA certificate bundle, you should reconfigure the SSLCertificateChainFile or SSLCACertificateFile directives in the corresponding Apache configuration file to reflect the correct file name.
  • Once you have copied all the server certificate files, you may make them readable by the root user only with the following commands:

     $ sudo chown root:root installdir/apache2/conf/server*
    
     $ sudo chmod 600 installdir/apache2/conf/server*
    
  • Open port 443 in the server firewall. Refer to the FAQ for more information.

  • Restart the Apache server.

You should now be able to access your application using an HTTPS URL.

How to force HTTPS redirection with Apache?

Add the following lines in the default Apache virtual host configuration file at installdir/apache2/conf/bitnami/bitnami.conf, inside the default VirtualHost directive, so that it looks like this:

<VirtualHost _default_:80>
  DocumentRoot "installdir/apache2/htdocs"
  RewriteEngine On
  RewriteCond %{HTTPS} !=on
  RewriteRule ^/(.*) https://%{SERVER_NAME}/$1 [R,L]
  ...
</VirtualHost>

After modifying the Apache configuration files:

  • Open port 443 in the server firewall. Refer to the FAQ for more information.

  • Restart Apache to apply the changes.

How to debug Apache errors?

Once Apache starts, it will create two log files at installdir/apache2/logs/access_log and installdir/apache2/logs/error_log respectively.

  • The access_log file is used to track client requests. When a client requests a document from the server, Apache records several parameters associated with the request in this file, such as: the IP address of the client, the document requested, the HTTP status code, and the current time.

  • The error_log file is used to record important events. This file includes error messages, startup messages, and any other significant events in the life cycle of the server. This is the first place to look when you run into a problem when using Apache.

If no error is found, you will see a message similar to:

Syntax OK

How to find the MySQL database credentials?

How to connect to the MySQL database?

You can connect to the MySQL database from the same computer where it is installed with the mysql client tool.

$ mysql -u root -p

You will be prompted to enter the root user password. This is the same as the application password.

How to debug errors in your database?

The main log file is created at installdir/mysql/data/mysqld.log on the MySQL database server host.

How to change the MySQL root password?

You can modify the MySQL password using the following command at the shell prompt. Replace the NEW_PASSWORD placeholder with the actual password you wish to set.

$ installdir/mysql/bin/mysqladmin -p -u root password NEW_PASSWORD

How to reset the MySQL root password?

If you don't remember your MySQL root password, you can follow the steps below to reset it to a new value:

  • Create a file in /home/bitnami/mysql-init with the content shown below (replace NEW_PASSWORD with the password you wish to use):

     UPDATE mysql.user SET Password=PASSWORD('NEW_PASSWORD') WHERE User='root';
     FLUSH PRIVILEGES;
    

    If your stack ships MySQL v5.7.x, use the following content instead of that shown above:

     UPDATE mysql.user SET authentication_string=PASSWORD('NEW_PASSWORD') WHERE User='root';
     FLUSH PRIVILEGES;
    
    TIP: Check the MySQL version with the command installdir/mysql/bin/mysqladmin --version or installdir/mysql/bin/mysqld --version.
  • Stop the MySQL server:

     $ sudo installdir/ctlscript.sh stop mysql
    
  • Start MySQL with the following command:

     $ sudo installdir/mysql/bin/mysqld_safe --pid-file=installdir/mysql/data/mysqld.pid --datadir=installdir/mysql/data --init-file=/home/bitnami/mysql-init 2> /dev/null &
    
  • Restart the MySQL server:

     $ sudo installdir/ctlscript.sh restart mysql
    
  • Remove the script:

     $ rm /home/bitnami/mysql-init
    

How to change the MySQL root password in Windows?

You can modify the MySQL password using the following command at the shell prompt. Replace the NEW_PASSWORD placeholder with the actual password you wish to set.

installdir\mysql\bin\mysqladmin.exe -p -u root password NEW_PASSWORD

How to reset the MySQL root password in Windows?

If you don't remember your MySQL root password, you can follow the steps below to reset it to a new value:

  • Stop the MySQL server using the graphic manager tool. Refer to the how to start or stop the services section.
  • Check the MySQL version:

    installdir\mysql\bin\mysqladmin.exe –version

  • Create a file named mysql-init.txt with the content shown below depending on your MySQL version (replace NEW_PASSWORD with the password you wish to use):
    • MySQL 5.6.x or earlier:

       UPDATE mysql.user SET Password=PASSWORD('NEW_PASSWORD') 
       WHERE User='root';
       FLUSH PRIVILEGES;
      
    • MySQL 5.7.x or later:

       ALTER USER 'root'@'localhost' IDENTIFIED BY 'NEW_PASSWORD'; 
      
  • Start MySQL server with the following command. Remember to replace PATH with the location in which you have saved the mysql-init.txt file:

     installdir " installdir\mysql\bin\mysqld.exe" --defaults-file=" installdir\mysql\my.ini" --init-file="\PATH\mysql-init.txt" --console
    
    • The --init file option is used by the server for executing the content of the mysql-init.txt file at startup, it will change each root account password.
    • The --defaults-file option is specified since you have installed MySQL using the Bitnami installer.
    • The --console option (optional) has been added in order to show the server output at the console window rather than in the log file.
  • After some minutes, hit Ctrl-C to force the shutdown.
  • Restart the MySQL server from the graphic manager tool.
  • After the server has restarted successfully, delete the mysql-init.txt file.

How to access phpMyAdmin?

You should be able to access phpMyAdmin directly, by browsing to http://127.0.0.1/phpmyadmin.

The username is root for phpMyAdmin, and the password is the one specified by you during the installation process.

How to modify PHP settings for Apache?

The PHP configuration file allows you to configure the modules enabled, the email settings or the size of the upload files. It is located at installdir/php/etc/php.ini.

For example, to modify the default upload limit for PHP, update the PHP configuration file following these instructions.

After modifying the PHP configuration file, restart both Apache and PHP-FPM for the changes to take effect:

$ sudo installdir/ctlscript.sh restart apache
$ sudo installdir/ctlscript.sh restart php-fpm

How to modify the allowed limit for uploaded files in Apache?

Modify the following options in the installdir/php/etc/php.ini file to increase the allowed size for uploads:

; Maximum size of POST data that PHP will accept.
post_max_size = 16M

; Maximum allowed size for uploaded files.
upload_max_filesize = 16M

Restart PHP-FPM and Apache for the changes to take effect.

$ sudo installdir/ctlscript.sh restart apache
$ sudo installdir/ctlscript.sh restart php-fpm    

How to configure fail2ban to work with Redmine?

If you want to limit the number of login attempts (and avoid brute-force attacks), install fail2ban and configure it to work with the Bitnami Redmine Stack.

  • Install fail2ban:

    • Debian:

       $ sudo apt-get update
       $ sudo apt-get install fail2ban
      
    • CentOS:

        $ sudo yum install epel-release
        $ sudo yum install fail2ban
        $ sudo systemctl enable fail2ban
        $ sudo systemctl start fail2ban
      
  • Modify the installdir/apps/redmine/htdocs/config/environment.rb file to allow the Redmine logger to add timestamps to the production.log file. To do this, add the following lines:

    class Logger
      def format_message(severity, timestamp, progname, msg)
        "#{timestamp} (#{$$}) #{msg}\n"
      end
    end
    
  • Restart the Apache server.

     $ sudo installdir/ctlscript.sh restart apache
    

Next, configure fail2ban following the steps below:

  • Create the /etc/fail2ban/filter.d/redmine.conf file with the following code:

    [Definition]
    
    failregex = Failed [-/\w]+ for .* from <HOST>
    ignoreregex =
    
  • Create the /etc/fail2ban/jail.local file and add the code below:

    [redmine]
    enabled = true
    filter = redmine
    port = http,https
    logpath = installdir/apps/redmine/htdocs/log/production.log
    maxretry = 5
    findtime = 600
    bantime = 600
    

    This fail2ban configuration will ban the IP of any user that tried to access five (maxretry) different times in 10 minutes (findtime) without success. Note that the ban only will affect the ports 80 and 443, and the user with the banned IP will not be able to contact the web server for 10 minutes (bantime).

  • Before applying the configuration,test if the regex configuration is correct. To test this, browse to your Bitnami Redmine login page and use a non-existent user/password to get a login error. Then, run this command:

    $ fail2ban-regex installdir/apps/redmine/htdocs/log/production.log /etc/fail2ban/filter.d/redmine.conf 
    

    If the last two lines of the output show you at least "1 matched", the regex is properly configured:

    Lines: 412 lines, 0 ignored, 1 matched, 397 missed
    Missed line(s):: too many to print.  Use --print-all-missed to print all 397 lines
    
  • Apply the configuration with this command

    • Debian:

      $ sudo /etc/init.d/fail2ban restart

    • CentOS:

      $ sudo systemctl restart fail2ban

To check if all is working, try logging in five different times with bad credentials. On the fifth unsuccessful attempt, you will be banned for 10 minutes.

How to change the Redmine timezone?

  • Check all the available timezones by executing these commands:

      $ cd installdir/apps/redmine/htdocs/ 
      $ bundle exec rake time:zones:all
    
  • Once you decide on the correct one, edit the file installdir/apps/redmine/htdocs/config/application.rb and substitute the line

     config.active_record.default_timezone = :local
    

    with

     config.active_record.default_timezone = 'your_timezone'
    

    Note that the single quotes around the timezone value are necessary.

  • Restart services.

     $ sudo installdir/ctlscript.sh restart apache 
    

How to enable HTTPS support with SSL certificates for Redmine on Windows?

Apart from the steps described in this section, when using the native installer on Windows, add the RequestHeader option to the installdir/apps/redmine/conf/httpd-prefix.conf file:

    <Proxy balancer://redminecluster
      RequestHeader set X_FORWARDED_PROTO 'https'
      BalancerMember http://127.0.0.1:3001/redmine
      BalancerMember http://127.0.0.1:3002/redmine
    </Proxy>

Restart the Apache server for your changes to take effect:

    $ sudo installdir/ctlscript.sh restart apache

How to install the Redmine Custom Workflows plugin?

Before installing the Redmine Custom Workflows plugin, create a backup. Once your backup is complete, follow these steps:

  • Change to the Redmine plugins directory and get the latest Custom Workflows version:

     $ cd installdir/apps/redmine/htdocs/plugins
     $ git clone http://github.com/anteo/redmine_custom_workflows.git
    
  • Install the plugin:

     $ cd installdir/apps/redmine/htdocs/
     $ bundle exec rake redmine:plugins:migrate RAILS_ENV=production
    

NOTE: It could display a warning message about the log production file. In that case, run the following commands:

$ sudo chown :bitnami log/production.log
$ sudo chmod g+w log/production.log
  • Restart services for the changes to take effect:

     $ sudo installdir/ctlscript.sh restart
    
  • Sign in to your Redmine installation and navigate to the "Administration -> Custom Workflows" section to configure the new plugin.

How to see a Git repository from the Redmine application or from a Web browser directly?

Redmine lets users check repository changes and link to cases. Follow the steps below:

  • Clone the remote Git repository, or initialize a new one. Replace the REPO_URL placeholder with the correct repository URL and the REPO placeholder with the correct directory name for the cloned repository.

     $ cd $HOME
     $ mkdir repos
     $ cd repos
     $ sudo git clone REPO_URL --bare
    
NOTE: Include the --bare option regardless of whether you're cloning an existing repository or initializing a new one.
  • Create a new Redmine project.

  • From the project dashboard, select the "Settings -> Repositories" tab and add a new repository using the settings below. Replace the ID placeholder with a short identifier for the repository, the USER placeholder with the username, and the REPO placeholder with the correct directory name for the cloned repository.

     SCM: Git
     Identifier: ID
     Path to repository: /home/USER/repos/REPO
    

Redmine and Git

How to configure Redmine for advanced integration with Git?

This Redmine configuration makes it possible for users created in the Redmine application to also use the Git repository. For example, new users in the Redmine application will also be able to "push" changes to the Git project repository. This guide is based on the Felix Schafer guide posted on the Redmine Wiki.

Before starting this guide, take into account that these steps are not necessary if all you wish to do is track the repository changes in the Redmine application. If you only wish to track repository changes and link to issues, you only need to configure the project to point to your repository. To do this, go to the project dashboard, select the "Settings -> Repository" tab and add a new repository by specifying its URL and SCM.

  • Create a Git repository. This guide will create a repository named test under the projects/ directory in the user's home directory. This directory should have write privileges for the user account the stack was installed under. Note the name of the repository as you will need to use the same name as the identifier for your Redmine project in a later step.

       $ cd $HOME
       $ mkdir projects
       $ mkdir projects/test
       $ cd projects/test
       $ sudo git init --bare
    
  • Download the Grack project from GitHub:

     $ cd installdir/apache2/htdocs/
     $ git clone http://github.com/schacon/grack.git
     $ sudo chown USERNAME:USERNAME grack
    
  • Edit the grack/config.ru file to specify your Git project location:

     $LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/lib')
     use Rack::ShowExceptions
     require 'git_http'
     config = {
       :project_root => "installdir/projects/",
       :adapter => Grack::GitAdapter,
       :git_path => 'installdir/git/bin/git',
       :upload_pack => true,
       :receive_pack => true,
     }
     run GitHttp::App.new(config)
    
  • Test the basic behaviour: start the Grack server and try to clone the repository and push the changes from a different machine.

     $ cd installdir/apache2/htdocs/grack
     $ rackup --host 0.0.0.0 -p 8080 config.ru &
    

    If all goes well, you should see a message that the Thin web server is running and listening for connections, as below:

     >> Thin web server (v1.5.1 codename Straight Razor)
     >> Maximum connections set to 1024
     >> Listening on 0.0.0.0:8080, CTRL+C to stop
    
IMPORTANT: Also ensure that port 8080 is open in the firewall as otherwise, the next step will fail.
  • Next, clone the repository, add your name and email address, and push changes from a different machine. Remember to replace the localhost placeholder below with the actual IP address of your Redmine server, and the EMAIL_ADDRESS and NAME placeholders with your email address and real name.

     $ cd /tmp/
     $ git clone http://localhost:8080/test
     $ cd test
     $ git config user.email "EMAIL_ADDRESS"
     $ git config user.name "NAME"
     $ echo "test" > test_file
     $ git add test_file
     $ git commit -m "test" test_file
     $ git push origin master
    

If all goes well, you will see something like this:

    Counting objects: 3, done.
    Writing objects: 100% (3/3), 200 bytes, done.
    Total 3 (delta 0), reused 0 (delta 0)
    To http://localhost:8080/test
    * [new branch]      master -> master
  • Stop the Grack server and configure Apache to use Passenger. First, create two directories in the grack/ folder and install necessary dependencies:

     $ mkdir installdir/apache2/htdocs/grack/public
     $ mkdir installdir/apache2/htdocs/grack/tmp
     $ cd installdir/apache2/htdocs/grack/
     $ bundle install
    
  • Edit the installdir/apache2/conf/bitnami/bitnami.conf file and add the code to the end of the file, replacing YOUR_DOMAIN_NAME with your own domain name or the domain name of your server:

     <VirtualHost *:80>
         ServerName git.YOUR_DOMAIN_NAME
         PassengerEnabled on
         PassengerAppRoot "installdir/apache2/htdocs/grack/"   
         DocumentRoot "installdir/apache2/htdocs/grack/public"
         <Directory "installdir/apache2/htdocs/grack/public">
             Options None
             AllowOverride None
             <IfVersion < 2.3 >
             Order allow,deny
             Allow from all
             </IfVersion>
             <IfVersion >= 2.3>
             Require all granted
             </IfVersion>   
         </Directory> 
     </VirtualHost>
    
  • Restart the Apache server as below:

     $ sudo installdir/ctlscript.sh restart apache
    
  • Next, clone the repository again, add your name and email address, and push changes from a different machine. Remember to replace the YOUR_DOMAIN_NAME placeholder below with your own domain name or the domain name of your server, and the EMAIL_ADDRESS and NAME placeholders with your email address and real name.

     $ cd /tmp/
     $ rm -rf test/
     $ git clone http://git.YOUR_DOMAIN_NAME/test
     $ cd test
     $ git config user.email "EMAIL_ADDRESS"
     $ git config user.name "NAME"
     $ echo "test 2" > test_file_2
     $ git add test_file_2
     $ git commit -m "test 2" test_file_2
     $ git push origin master
    

If all goes well, you will see something like this:

    Counting objects: 3, done.
    Compressing objects: 100% (2/2), done.
    Writing objects: 100% (2/2), 234 bytes | 0 bytes/s, done.
    Total 2 (delta 0), reused 0 (delta 0)
    To http://git.YOUR_DOMAIN_NAME/test
       328f124..68d1bb4  master -> master
  • The next step is to configure Git access control using the Redmine.pm module. Begin by copying the Redmine.pm file to the appropriate Perl folder:

     $ sudo cp installdir/apps/redmine/htdocs/extra/svn/Redmine.pm installdir/perl/lib/site_perl/5.16.3/x86_64-linux-thread-multi/Apache/
     $ sudo cp installdir/apps/redmine/htdocs/extra/svn/Redmine.pm installdir/perl/lib/site_perl/5.16.3/x86_64-linux-thread-multi/Apache2/
    
  • Enable the module in the installdir/apache2/conf/httpd.conf by adding the following line:

     LoadModule perl_module modules/mod_perl.so
    

You will also need to add the following lines to the installdir/apache2/bin/envvars file. Note that the library path shown below (installdir/perl/lib/5.16.3/x86_64-linux-thread-multi/CORE/) varies depending on the platform, so it's a good idea to verify that it exists or modify it as needed.

    LD_LIBRARY_PATH="installdir/perl/lib/5.16.3/x86_64-linux-thread-multi/CORE/:$LD_LIBRARY_PATH"
    export LD_LIBRARY_PATH
  • Finally, update the previously-created VirtualHost in the installdir/apache2/conf/bitnami/bitnami.conf file as shown below. The REDMINE_DB_USERNAME and REDMINE_DB_PASSWORD credentials can be obtained from the installdir/apps/redmine/htdocs/config/database.yml file, from the username and password fields for the production database:

     <VirtualHost *:80>
          ServerName git.YOUR_DOMAIN_NAME
          PassengerEnabled on
          PassengerAppRoot "installdir/apache2/htdocs/grack/"  
          DocumentRoot "installdir/apache2/htdocs/grack/public"
          <Directory "installdir/apache2/htdocs/grack/public">
             Options None
             AllowOverride None
             <IfVersion < 2.3 >
             Order allow,deny
             Allow from all
             </IfVersion>
             <IfVersion >= 2.3>
             Require all granted
             </IfVersion>       
          </Directory>
            
          PerlLoadModule Apache::Redmine
            
          <Location "/">
            AuthType Basic
            AuthName "Redmine git repositories"
            Require valid-user
              
            PerlAccessHandler Apache::Authn::Redmine::access_handler
            PerlAuthenHandler Apache::Authn::Redmine::authen_handler
            RedmineDSN "DBI:mysql:database=bitnami_redmine;host=localhost;mysql_socket=installdir/mysql/tmp/mysql.sock"
            RedmineDbUser "REDMINE_DB_USERNAME"
            RedmineDbPass "REDMINE_DB_PASSWORD"
            RedmineGitSmartHttp yes
          </Location>
     </VirtualHost>
    
  • After making this change, restart the Apache server as below:

     $ sudo installdir/ctlscript.sh restart apache
    
  • Log in to Redmine and create a new project. It is important to note that the project identifier configured at this stage must match the repository name created earlier. In this example, the project identifier is test. Also ensure that the project is configured as private.

Redmine and Git

Note that the project must be configured to work as private for this configuration to work due to a Redmine bug. Click "Create" to save your changes and create the project.

  • From the project dashboard in Redmine, click the "Settings -> Repositories" tab and then click the "New repository" link. Select the "SCM" as "Git" and specify the path to the repository. In this example, the path will be installdir/projects/test. Click "Create" to save your changes.

Redmine and Git

  • From the project dashboard in Redmine, click the "Settings -> Members" tab and add one or more users to the project with role "Developer". Save your changes.

Redmine and Git

The users added to the repository should now be able to develop in the test repository using their Redmine application passwords. To test this, try cloning and pushing a change to the repository as one of the specified users. If you are successful, you will also be able to see the changes in the Redmine project's repository view, as shown below:

Redmine and Git

How to use Mercurial with Redmine?

Redmine only works with Mercurial repositories cloned in your local machine, as explained in the official guide.

  • Install the Mercurial package:

    • Debian:

       $ sudo apt-get install mercurial
      
    • CentOS:

       $ sudo yum install mercurial
      
  • Restart services:

      $ sudo installdir/ctlscript.sh restart
    
  • Create the repository directory, clone it and give it the proper permissions:

     $ cd $HOME
     $ mkdir mercurialRepo
     $ cd mercurialRepo
     $ sudo hg clone REPO_URL
    
  • Add your repository to Redmine by navigating in your project to the "Settings -> Repositories -> New repository" menu. Replace the ID placeholder with a short identifier for the repository, the USER placeholder with the username, and the REPO placeholder with the correct directory name for the cloned repository.

     SCM: Mercurial
     Identifier: ID
     Path to repository: /home/USER/mercurialRepo/REPO
    
  • Check the repository and confirm that you can view the files, commits, comments and so on.

nativeInstaller

Bitnami Documentation