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 running on Microsoft Azure! Here are a few questions (and answers!) you might need when first starting with your application.

What credentials do I need?

You need two sets of credentials:

• The application credentials that allow you to log in to your new Bitnami application. These credentials consist of a username and password.
• The server credentials that allow you to log in to your Microsoft Azure server using an SSH client and execute commands on the server using the command line. These credentials consist of an SSH username and key.

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

Username: user

What SSH username should I use for secure shell access to my application?

SSH username: bitnami

What are the default ports?

A port is an endpoint of communication in an operating system that identifies a specific process or a type of service. Bitnami stacks include several services or servers that require a port.

Remember that if you need to open some ports you can follow the instructions given in the FAQ to learn how to open the server ports for remote access.

Port 22 is the default port for SSH connections.

Bitnami opens some ports for the main servers. These are the ports opened by default: 80, 443.

How to start or stop the services?

Each Bitnami stack includes a control script that lets you easily stop, start and restart services. The script is located at /opt/bitnami/ctlscript.sh. Call it without any service name arguments to start all services:

$ sudo /opt/bitnami/ctlscript.sh start

Or use it to restart a single service, such as Apache only, by passing the service name as argument:

$ sudo /opt/bitnami/ctlscript.sh restart apache

Use this script to stop all services:

$ sudo /opt/bitnami/ctlscript.sh stop

Restart the services by running the script without any arguments:

$ sudo /opt/bitnami/ctlscript.sh restart

Obtain a list of available services and operations by running the script without any arguments:

$ sudo /opt/bitnami/ctlscript.sh

How to access the administration panel?

Access the administration panel by browsing to http://SERVER-IP/admin.

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

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

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 /opt/bitnami/apache2/bin/envvars file (the path may change depending on the version):

   LD_LIBRARY_PATH="/opt/bitnami/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 /opt/bitnami/apps/redmine/htdocs/extra/svn/Redmine.pm /opt/bitnami/perl/lib/site_perl/5.8.8/*/Apache2/
  

• Create a directory for the repository, for instance:

   $ mkdir /opt/bitnami/repository
   $ mkdir /opt/bitnami/repository/svn
   $ chown root:daemon /opt/bitnami/repository/ [or "your_user:your_user" if you installed the Stack without root privileges]
   $ chown root:daemon /opt/bitnami/repository/svn/ [or "your_user:your_user" if you installed the Stack without root privileges]
   $ chmod 0755 /opt/bitnami/repository
   $ chmod 0750 /opt/bitnami/repository/svn
  

• Add these lines to the /opt/bitnami/apps/redmine/conf/httpd-app.conf file:

   PerlLoadModule Apache2::Redmine
   <Location /svn>
     DAV svn
     SVNParentPath "/opt/bitnami/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=/opt/bitnami/mysql/tmp/mysql.sock" 
  
     RedmineDbUser "bitnami"
     RedmineDbPass "bitnami_database_password"
     #You can find this value at /opt/bitnami/apps/redmine/htdocs/config/database.yml
   </Location>
  

• Restart the server:

     $ sudo /opt/bitnami/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 * * * * /opt/bitnami/ruby/bin/ruby /opt/bitnami/apps/redmine/htdocs/extra/svn/reposman.rb --redmine localhost:YOUR_APACHE_PORT/redmine --svn-dir /opt/bitnami/repository/svn --owner root --group daemon --command="/opt/bitnami/subversion/bin/svnadmin create --pre-1.6-compatible --fs-type fsfs" --url http://SERVER-IP: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 /opt/bitnami/apps/redmine/htdocs/config/configuration.yml file. In older versions, use the /opt/bitnami/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.

Troubleshooting Gmail SMTP issues

If you are using Gmail as the outbound email server and you are not able to send email correctly, Google may be blocking sign-in attempts from your apps or devices. Depending on whether or not you use Google Apps, the steps to correct this will differ.

For Google Apps users

If you are a Google Apps user, you will need your administrator to allow users to change the policy for less secure apps. If you are a Google Apps administrator, follow these steps:

• Browse to the Google Apps administration panel.

• Click on "Security" and then "Basic settings".

• Look for the section "Less secure apps" and then click on "Go to settings for less secure apps".

• Select "Allow users to manage their access to less secure apps".

For other Google users

If you do not use Google Apps, follow the steps in the following sections, depending on whether 2-step verification has been enabled on the account or not.

If 2-step verification has not been enabled on the account, follow these steps:

• Browse to the "Less secure apps" page and log in using the account you are having problems with. This option is typically required by many popular email clients, such as Outlook and Thunderbird, and should not be considered unsafe.

• Select the "Turn on" option.

  

If 2-step verification has been enabled on the account, you have to generate an app password. Follow these steps:

• Browse to the "App passwords" page.

• Click "Select app" and choose the app you're using.

• Click "Select device" and choose the device you're using.

• Click the "Generate" button.

• Enter the app password on your device.

• Click the "Done" button.

Here are other options you may try:

• Browse to the web version of Gmail and sign in to your account. Once you're signed in, try to enable access for the application again.

• Browse to the "Unlock Captcha" function page and sign in with your Gmail username and password.

• Disable IMAP from the Gmail web server interface and enable it again.

  

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. Select your Redmine version and check if the plugin is compatible or not with your version using the drop down menu located in the top right margin: "Show only plugins compatible with Redmine: version".

• Get the .zip file or clone the git repository in the /opt/bitnami/apps/redmine/htdocs/plugins directory:

  $ cd /opt/bitnami/apps/redmine/htdocs/plugins
  

  • If you have obtained a .zip file, Once you have the plugin .zip file, uncompress it an remove the .zip file. (Remember to replace PLUGIN_NAME-x-y-z with the correct name and version of the plugin):

      $ unzip PLUGIN_NAME-x-y-z.zip
      $ rm PLUGIN_NAME-x-y-z.zip
    

• Install the plugin in the htdocs directory:

  $ cd /opt/bitnami/apps/redmine/htdocs/
  $ bundle install
  $ bundle exec rake redmine:plugins NAME=PLUGIN_NAME 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 Apache services:

   $ sudo /opt/bitnami/ctlscript.sh restart
  

Troubleshooting plugin installation

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

   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.

How to create a full backup of Redmine+Agile?

Backup

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.

Follow these steps:

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

    $ cd /your/directory
  

• Stop all servers:

    $ sudo /opt/bitnami/ctlscript.sh stop
  

• Create a compressed file with the stack contents:

    $ sudo tar -pczvf application-backup.tar.gz /opt/bitnami
  

• Restart all servers:

    $ sudo /opt/bitnami/ctlscript.sh start
  

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

Restore

Follow these steps:

• Change to the directory containing your backup:

    $ cd /your/directory
  

• Stop all servers:

    $ sudo /opt/bitnami/ctlscript.sh stop
  

• Move the current stack to a different location:

    $ sudo mv /opt/bitnami /tmp/bitnami-backup
  

• Uncompress the backup file to the original directoryv

    $ sudo tar -pxzvf application-backup.tar.gz -C /
  

• Start all servers:

    $ sudo /opt/bitnami/ctlscript.sh start
  

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

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.

Upgrade Redmine and all stack components (recommended)

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 /opt/bitnami/ctlscript.sh stop apache
  $ sudo /opt/bitnami/ctlscript.sh stop mysql
  $ sudo /opt/bitnami/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 /opt/bitnami/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 /opt/bitnami/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 /opt/bitnami/apps/redmine/htdocs/ 
   $ ruby bin/rake db:migrate RAILS_ENV=production
  

  Then, copy the /opt/bitnami/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 /opt/bitnami/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:

• Generate a new private key:

   $ sudo openssl genrsa -out /opt/bitnami/apache2/conf/server.key 2048
  

• Create a certificate:

   $ sudo openssl req -new -key /opt/bitnami/apache2/conf/server.key -out /opt/bitnami/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 /opt/bitnami/apache2/conf/cert.csr -out /opt/bitnami/apache2/conf/server.crt -req -signkey /opt/bitnami/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 /opt/bitnami/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 /opt/bitnami/apache2/conf/server.key
  

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

How to enable HTTPS support with SSL certificates?

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	/opt/bitnami/apache2/conf/bitnami/bitnami.conf
  Certificate file	/opt/bitnami/apache2/conf/server.crt
  Certificate key file	/opt/bitnami/apache2/conf/server.key
  CA certificate bundle file (if present)	/opt/bitnami/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	/opt/bitnami/apache2/conf/bitnami/bitnami.conf
  Directive to include (Apache v2.4.8+)	SSLCACertificateFile "/opt/bitnami/apache2/conf/server-ca.crt"
  Directive to include (Apache < v2.4.8)	SSLCertificateChainFile "/opt/bitnami/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 /opt/bitnami/apache2/conf/server*
  
   $ sudo chmod 600 /opt/bitnami/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 to the top of the /opt/bitnami/apps/redmineplusagile/conf/httpd-prefix.conf file:

RewriteEngine On
RewriteCond %{HTTPS} !=on
RewriteRule ^/(.*) https://%{SERVER_NAME}/$1 [R,L]

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 /opt/bitnami/apache2/logs/access_log and /opt/bitnami/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 create a Virtual Network peering?

To connect two instances internally you can enable a Virtual Network (VNet) peering from the Azure Portal. Depending if the instances were launched in the same or in different resource groups, there are two methods for performing a internal connection: sharing a virtual network or enabling a virtual network peering.

• Learn how to share a virtual network to join instances from the same resource group.
• Learn how to enable virtual network peering to join instances from different resource groups.

How to find the MySQL database credentials?

• Database username: root.
• Database password: The same as the application password. Find out how to obtain application 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 /opt/bitnami/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.

$ /opt/bitnami/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 /opt/bitnami/mysql/bin/mysqladmin --version or /opt/bitnami/mysql/bin/mysqld --version.

• Stop the MySQL server:

   $ sudo /opt/bitnami/ctlscript.sh stop mysql
  

• Start MySQL with the following command:

   $ sudo /opt/bitnami/mysql/bin/mysqld_safe --pid-file=/opt/bitnami/mysql/data/mysqld.pid --datadir=/opt/bitnami/mysql/data --init-file=/home/bitnami/mysql-init 2> /dev/null &
  

• Restart the MySQL server:

   $ sudo /opt/bitnami/ctlscript.sh restart mysql
  

• Remove the script:

   $ rm /home/bitnami/mysql-init
  

How to access phpMyAdmin?

For security reasons, phpMyAdmin is accessible only when using 127.0.0.1 as the hostname. To access it from a remote system, you must create an SSH tunnel that routes requests to the Web server from 127.0.0.1. This implies that you must be able to connect to your server over SSH in order to access these applications remotely.

Accessing phpMyAdmin on Windows

Watch the following video to access phpMyAdmin on Windows through an SSH tunnel using a private key:

In order to access phpMyAdmin via SSH tunnel you need an SSH client. In the instructions below we have selected PuTTY, a free SSH client for Windows and UNIX platforms. The first step is having PuTTY configured. Please, check how to configure it in the section how to connect to the server through SSH using an SSH client on Windows.

Once you have your SSH client correctly configured and you tested that you can successfully access to your instance via SSH, you need to create an SSH tunnel in order to access phpMyAdmin. For doing so, follow these steps:

• In the "Connection -> SSH -> Tunnels" section, add a new forwarded port by introducing the following values:

  • Source port: 8888
  • Destination: localhost:80

  This will create a secure tunnel by forwarding a port (the "destination port") on the remote server to a port (the "source port") on the local host (127.0.0.1 or localhost).

• Click the "Add" button to add the secure tunnel configuration to the session. (You'll see the added port in the list of "Forwarded ports").

  

• In the "Session" section, save your changes by clicking the "Save" button.
• Click the "Open" button to open an SSH session to the server. The SSH session will now include a secure SSH tunnel between the two specified ports.
• Access the phpMyAdmin console through the secure SSH tunnel you created, by browsing to http://127.0.0.1:8888/phpmyadmin.

• Log in to phpMyAdmin by using the following credentials:

  • Username: root
  • Password: application password. (Refer to our FAQ to learn how to find your application credentials).

Here is an example of what you should see:

If you are unable to access phpMyAdmin, verify that the SSH tunnel was created by checking the PuTTY event log (accessible via the "Event Log" menu):

Accessing phpMyAdmin on Linux and Mac OS X

To access the application using your Web browser, create an SSH tunnel, as described below.

• Open a new terminal window on your local system (for example, using "Finder -> Applications -> Utilities -> Terminal" in Mac OS X or the Dash in Ubuntu).

• You have two options to configure the SSH tunnel: connect to the server using a private key (recommended) or connect to the server using a SSH password. Follow the instructions below per each option:

  • Option 1: Connect to the server using a private key

    • Make sure that you have your SSH credentials (.pem key file) in hand.

    • Run the following command to configure the SSH tunnel. Remember to replace KEYFILE with the path to your private key and SERVER-IP with the public IP address or hostname of your server:

        $ ssh -N -L 8888:127.0.0.1:80 -i KEYFILE bitnami@SERVER-IP
      

  • Option 2: Connect to the server using a SSH password

    • Run the following command, remembering to replace SERVER-IP with the public IP address or hostname of your server. Enter your SSH password when prompted.

       $ ssh -N -L 8888:127.0.0.1:80 bitnami@SERVER-IP
      

• Access the phpMyAdmin console through the secure SSH tunnel you created, by browsing to http://127.0.0.1:8888/phpmyadmin.

• Log in to phpMyAdmin by using the following credentials:

  • Username: root
  • Password: application password. (Refer to our FAQ to learn how to find your application credentials).

Here is an example of what you should see:

How to modify PHP settings?

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 /opt/bitnami/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 /opt/bitnami/ctlscript.sh restart apache
$ sudo /opt/bitnami/ctlscript.sh restart php-fpm

How to modify the allowed limit for uploaded files?

Modify the following options in the /opt/bitnami/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 /opt/bitnami/ctlscript.sh restart apache
$ sudo /opt/bitnami/ctlscript.sh restart php-fpm    

How to upload files to the server with SFTP?

Although you can use any SFTP/SCP client to transfer files to your server, the link below explains how to configure FileZilla (Windows, Linux and Mac OS X), WinSCP (Windows) and Cyberduck (Mac OS X). It is required to use your server's private SSH key to configure the SFTP client properly. Choose your preferred application and follow the steps in the link below to connect to the server through SFTP.

How to upload files to the server

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 /opt/bitnami/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 /opt/bitnami/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 = /opt/bitnami/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 /opt/bitnami/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 /opt/bitnami/apps/redmine/htdocs/ 
    $ bundle exec rake time:zones:all
  

• Once you decide on the correct one, edit the file /opt/bitnami/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 /opt/bitnami/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 /opt/bitnami/apps/redmine/htdocs/plugins
   $ git clone http://github.com/anteo/redmine_custom_workflows.git
  

• Install the plugin:

   $ cd /opt/bitnami/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 /opt/bitnami/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
  

• 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
  

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.

• Create a Git repository. This guide will create a repository named test under the projects/ directory in the user's home directory. 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 /opt/bitnami/apache2/htdocs/
   $ git clone http://github.com/schacon/grack.git
   $ sudo chown bitnami:daemon grack
  

• Edit the grack/config.ru file to specify your Git project location. Replace the USERNAME placeholder with the correct username.

   $LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/lib')
   use Rack::ShowExceptions
   require 'git_http'
   config = {
     :project_root => "/home/USERNAME/projects/",
     :adapter => Grack::GitAdapter,
     :git_path => '/opt/bitnami/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 /opt/bitnami/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
  

• Next, clone the repository, add your name and email address, and push changes from a different machine. Remember to replace the SERVER-IP 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://SERVER-IP: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://SERVER-IP: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 /opt/bitnami/apache2/htdocs/grack/public
   $ mkdir /opt/bitnami/apache2/htdocs/grack/tmp
   $ cd /opt/bitnami/apache2/htdocs/grack/
   $ bundle install
  

• Edit the /opt/bitnami/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 "/opt/bitnami/apache2/htdocs/grack/"   
       DocumentRoot "/opt/bitnami/apache2/htdocs/grack/public"
       <Directory "/opt/bitnami/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 /opt/bitnami/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 /opt/bitnami/apps/redmine/htdocs/extra/svn/Redmine.pm /opt/bitnami/perl/lib/site_perl/5.16.3/x86_64-linux-thread-multi/Apache/
   $ sudo cp /opt/bitnami/apps/redmine/htdocs/extra/svn/Redmine.pm /opt/bitnami/perl/lib/site_perl/5.16.3/x86_64-linux-thread-multi/Apache2/
  

• Enable the module in the /opt/bitnami/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 /opt/bitnami/apache2/bin/envvars file. Note that the library path shown below (/opt/bitnami/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="/opt/bitnami/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 /opt/bitnami/apache2/conf/bitnami/bitnami.conf file as shown below. The REDMINE_DB_USERNAME and REDMINE_DB_PASSWORD credentials can be obtained from the /opt/bitnami/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 "/opt/bitnami/apache2/htdocs/grack/"  
        DocumentRoot "/opt/bitnami/apache2/htdocs/grack/public"
        <Directory "/opt/bitnami/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=/opt/bitnami/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 /opt/bitnami/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.

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 /opt/bitnami/projects/test. Click "Create" to save your changes.

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

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:

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 /opt/bitnami/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.