Übersetzung von Rev. 252

Installation von Redmine

Dies ist die Installationsanleitung für Redmine 1.4.0 und höher. Die Anleitung für 1.3.x findet sich hier.

Anforderungen

Betriebssystem

Redmine sollte auf den meisten Unix-, Linux-, Mac-, Mac Server- und Windows-Systemen laufen, sofern Ruby auf diesem System vorhanden ist. Weitere spezielle Installationsanleitungen finden sich hier.

Ruby-Interpreter

Die erforderliche Ruby-Version für die Redmine-Versionen sind:

Redmine-Version Unterstützte Ruby-Versionen Verwendete Rails-Version
Aktueller Trunk ruby 1.9.33, 2.0.02, 2.1, 2.21 Rails 4.20
3.0 ruby 1.9.33, 2.0.02, 2.1, 2.21 Rails 4.20
2.6 ruby 1.8.74, 1.9.2, 1.9.33, 2.0.02, 2.1, 2.2, jruby-1.7.6 Rails 3.2

Redmine in Version 2.6.5 unterstützt kein Ruby 2.2, jedoch die Version 2.6.6 (#19652).

Redmine 3.0 unterstützt kein JRuby weil einige Gems nicht die Version 4.2 von Rails unterstützen.

0 Rails 4.2.2 (Redmine-Version 3.0.3) hatte ein Problem mit Non-ASCII-URLs und MinGW-Ruby (RubyInstaller für Windows) thin und puma (#19321, #19374). Ist behoben in Rails-Version 4.2.3 (Redmine-Version 3.0.4).

1 MinGW-Ruby 2.2 hat ein nokogiri-Problem (#19419).

2 Zum Zeitpunkt des Verfassens dieser Wiki-Seite (3/19/2013) war der SQL Server Support mit Ruby 2.0.0 unter Windows wegen einer Datenbankadapter/Gem-Inkompatibilität als defekt gemeldet.

3 MRI 1.9.3p327 enthält einen Bug, der das Laden der Plugins verhindert - im Gegensatz zu 1.9.3p194 oder 1.9.3p392.

4 Ruby MRI 1.8.7 hat sein Lebenszyklusende erreicht - vom Gebrauch wird daher abgeraten. Important: Ruby 1.8.7 out of support and #14371 liefert dazu weitere Informationen.

Unterstützte Datenbanken

  • MySQL 5.0 oder höher
    • C bindings sollten installiert sein, was die Geschwindigkeit wesentlich erhöht. Sie lassen sich mit gem install mysql2 installieren.
    • Redmine 2.x ist nicht mit MySQL 5.7.3 (#17460) kompatibel. Diese Version wird erst mit Redmine 3.x unterstützt.
  • PostgreSQL 8.2 oder höher
    • Der Datenstyle der Datenbank sollte auf ISO gesetzt sein (Standardeinstellung bei PorgresSQL). Dies kann mit mit "redmine_db" SET datestyle="ISO,MDY"; erreicht werden.
    • Einige Bugs in PostgreSQL 8.4.0 und 8.4.1 wirken sich auf das Verhalten von Redmine aus (#4259, #4314). Sie wurden jedoch in PostgreSQL 8.4.2 gefixt.
  • Microsoft SQL Server
    • Redmine 2.x: 2008 oder höher (seit Redmine 2.3.0)
    • Redmine 3.x: 2012 oder höher
  • SQLite 3 (nicht für den Produktiveinsatz mit mehreren Benutzern gedacht!)

Optionale Komponenten

  • SCM-Programme (z.B. svn) für das Browsen in Projektarchiven. RedmineRepositories enthält Informationen zu Kompatibilitäten und Anforderungen.
  • ImageMagick (um den Gantt-Export zu PNG-Bildern und die Generierung von Vorschaubildern zu ermöglichen).
  • Ruby-OpenID-Bibliothek (um OpenID zu unterstützen). Es wird dazu Version 2 oder höher benötigt.

Redmine-Version

Dem Großteil der Benutzer wird im Allgemeinen empfohlen, die entsprechenden Point-Releases zu installieren. Derzeit veröffentlicht Redmine alle sechs Monate eine neue Version - diese Veröffentlichungen werden als relativ gut einsetzbar und als stabil erachtet. Es wird nicht empfohlen Redmine von Trunk zu installieren, außer man ist mit Ruby on Rails sehr vertraut und bleibt mit den Änderungen auf dem letzten Stand - der Trunk-Zweig kann zuweilen auch Fehler enthalten.

Ablauf der Installation

Schritt 1 - Redmine holen

Der Source-Code von Redmine kann entweder durch das Herunterladen eines gepackten Releases oder durch das Auschecken des Codes geholt werden.

Mehr Informationen auf der Download-Seite.

Schritt 2 - Eine leere Datenbank erstellen und einen Benutzer zuweisen

Nach den folgenden Anweisungen heißt der Datenbankbenutzer von Redmine redmine, jedoch kann der Name auch geändert werden.

MySQL

CREATE DATABASE redmine CHARACTER SET utf8;
CREATE USER 'redmine'@'localhost' IDENTIFIED BY 'my_password';
GRANT ALL PRIVILEGES ON redmine.* TO 'redmine'@'localhost';

Für MySQL-Versionen vor 5.0.2 die Anweisung 'CREATE USER' ersetzen durch:

GRANT ALL PRIVILEGES ON redmine.* TO 'redmine'@'localhost' IDENTIFIED BY 'my_password';

PostgreSQL

CREATE ROLE redmine LOGIN ENCRYPTED PASSWORD 'my_password' NOINHERIT VALID UNTIL 'infinity';
CREATE DATABASE redmine WITH ENCODING='UTF8' OWNER=redmine;

SQL Server

Die Datenbank, das Login und der Benutzer können im SQL Server Management Studio mit ein paar Klicks erstellt werden.

Hier aber auch ein Beispiel auf der der Kommandozeile mit SQLCMD:

Schritt 3 - Konfiguration der Datenbankverbindung

Um die Datenbankverbindung für den Produktiveinsatz zu konfigurieren wird config/database.yml.example nach config/database.yml kopiert und wie folgt bearbeitet.

Beispiel für eine MySQL-Datenbank unter Verwendung von Ruby 1.8 oder jRuby:

production:
  adapter: mysql
  database: redmine
  host: localhost
  username: redmine
  password: my_password

Beispiel für eine MySQL-Datenbank unter Verwendung von Ruby 1.9 (adapter muss auf mysql2 gesetzt werden):

production:
  adapter: mysql2
  database: redmine
  host: localhost
  username: redmine
  password: my_password

Diese Konfiguration ist zu verwenden, falls der Server nicht auf dem Standardport (3306) horcht:

production:
  adapter: mysql
  database: redmine
  host: localhost
  port: 3307
  username: redmine
  password: my_password

Beispiel für eine PostgreSQL-Datenbank (mit dem Standardport):

production:
  adapter: postgresql
  database: <your_database_name>
  host: <postgres_host>
  username: <postgres_user>
  password: <postgres_user_password>
  encoding: utf8
  schema_search_path: <database_schema> (default - public)

Beispiel für eine SQL-Server-Datenbank (mit Standard-Host localhost und Standardport 1433):

production:
  adapter: sqlserver
  database: redmine
  username: redmine # sollte dem Datenbankbenutzer entsprechen
  password: redminepassword # sollte dem Login-Passwort entsprechen

Schritt 4 - Installation der Abhängigkeiten

Um die gem-Abhängigkeiten zu verwalten, verwendet Redmine Bundler.

Zuerst muss Bundler installiert werden:

gem install bundler

Dann können alle von Redmine benötigten gems mit folgenden Kommando installiert werden:

bundle install --without development test

Optionale Abhängigkeiten

RMagick

RMagick ermöglicht die Verwendung von ImageMagick, welches wiederum erlaubt Bilder für die Erzeugung von PDFs, und für den PNG-Export generieren zu lassen.

Falls ImageMagick auf dem System nicht installiert ist, so sollte die Installation des RMagick Gem ausgelassen werden:

bundle install --without development test rmagick

Falls es bei der Installation von RMagick unter Windows zu Problemen kommt, sind weitere Informationen in diesem HowTo zu finden.

Datenbankadapter

Redmine installiert automatisch die Adapter-Gems, die von Datenbankkonfiguration benötigt werden, in dem es die Datei config/database.yml ausliest.

bundle install --without development test ... ist jedes Mal auszuführen, wenn in der Datei config/database.yml Adapter hinzugefügt oder entfernt worden sind. Dies sollte nicht vergessen werden.

Weitere Abhängigkeiten (Gemfile.local)

Wenn Gems geladen werden müssen, die nicht vom Redmine-Core benötigt werden (z.B. Puma, fcgi), so kann eine Datei Gemfile.local im Root-Verzeichnis des Redmine-Verzeichnisses erstellt werden. Sie wird automatisch geladen, sobald bundle install ausgeführt wird.

Beispiel:

# Gemfile.local
gem 'puma'

Schritt 5 - Erzeugen des Session Store Secrets

Dieser Schritt erzeugt einen zufälligen Schlüssel, der von Rails verwendet wird, um Session-Daten zu verschlüsseln, die in einem Cookie gespeichert werden, sodass Manipulationen verhindert werden.

Das Erzeugen eines neuen Secret Tokens macht nach einem Neustart alle bestehenden Sesssions ungültig.

  • mit Redmine 1.4.x:
  bundle exec rake generate_session_store
  • mit Redmine 2.x
bundle exec rake generate_secret_token

Alternativ kann das Secret auch in config/secrets.yml gespeichert werden:
http://guides.rubyonrails.org/upgrading_ruby_on_rails.html#config-secrets-yml

Schritt 6 - Anlegen der Datenbankstruktur und -daten

Mit dem Ausführen der folgende Anweisung im Root-Verzeichnis von Redmine wird die Datenbankstruktur angelegt:

RAILS_ENV=production bundle exec rake db:migrate

Syntax unter Windows:

set RAILS_ENV=production
bundle exec rake db:migrate

Damit werden nacheinander alle Migrationen durchgeführt - was die Tabellen, eine Reihe von Berechtigungen und das Administrator-Konto erzeugt.

Problemlösung für Ubuntu

Falls unter Ubuntu dieser Fehler entsteht:

Rake aborted!
no such file to load -- net/https

dann ist es erforderlich libopenssl-ruby1.8 mittels apt-get install libopenssl-ruby1.8 zu installieren.

Schritt 7 - Grunddaten in die Datenbank einfügen

Mit folgender Anweisung werden die Daten der Grundkonfiguration in die Datenbank hinzugefügt:

RAILS_ENV=production bundle exec rake redmine:load_default_data

Redmine fragt dabei nach der Sprache für die Daten, die beim Hinzufügen verwendet werden soll. Das Setzen der Umgebungsvariable REDMINE_LANG vor dem Ausführen der Anweisung ermöglicht hingegen den Silent-Modus, so dass keine Nachfrage mehr stattfindet, da die Sprache nun aus der Variablen gelesen wird.

Beispiel für unixoide Systeme:

RAILS_ENV=production REDMINE_LANG=fr bundle exec rake redmine:load_default_data

Beispiel für Windows:

set RAILS_ENV=production
set REDMINE_LANG=fr
bundle exec rake redmine:load_default_data

Schritt 8 - Berechtigungen im Dateisystem

Hinweis: Windows-Benutzer können diesen Abschnitt überspringen.

Der Benutzer, mit dem die Anwendung ausgeführt wird, muss die Berechtigung zum Schreiben in folgende Subverzeichnisse haben:

  1. files (Speicherort für Anhänge)
  2. log (Log-Datei der Anwendung production.log)
  3. tmp and tmp/pdf (Verzeichnisse sind anzulegen, falls sie noch nicht existieren; wird unter anderem auch für das Erstellen von PDFs verwendet)
  4. public/plugin_assets (Assets der Plugins)

Beispiel - davon ausgehend, die Anwendung wird mit einem Benutzer redmine betrieben:

mkdir -p tmp tmp/pdf public/plugin_assets
sudo chown -R redmine:redmine files log tmp public/plugin_assets
sudo chmod -R 755 files log tmp public/plugin_assets

Schritt 9 - Die Installation testen

Die Installation kann mit dem Ausführen des WEBrick-Webserver ausprobiert werden:

  • mit Redmine 1.4.x:
bundle exec ruby script/server webrick -e production
  • mit Redmine 2.x:
bundle exec ruby script/rails server webrick -e production
  • mit Redmine 3.x:
bundle exec rails server webrick -e production

Wenn WEBrick gestartet wurde, kann im Browser http://localhost:3000/ (oder eine andere Domain, mit Port 3000) aufgerufen werden. Es sollte dann die Willkommensseite von Redmine erscheinen.

Hinweis: WEBrick ist nicht für den Produktiveinsatz geeignet. WEBrick sollte nur zum Überprüfen der Installation verwendet werden, um zu sehen, ob soweit alles funktioniert. Es kann aber einer der zahlreichen Anleitungen in diesem Wiki verwendet werden, um Redmine mit Passenger (vormals mod_rails), FCGI oder einem Rack-Server (Unicorn, Thin, Puma, hellip) zu betreiben.

Schritt 10 - In die Anwendung einloggen

Zum Einloggen wird der Administrator-Zugang verwendet:

  • Mitgliedsname: admin
  • Passwort: admin

Die meisten Einstellungen können nun vorgenommen werden indem man im Menü zur Administration und dort in den Bereich Konfiguration geht.

Konfiguration

Die Redmine-Einstellungen werden in einer Datei namens config/configuration.yml gespeichert.

Wenn andere Werte als die Standardeinstellungen verwendet werden sollen, so muss lediglich config/configuration.yml.example nach config/configuration.yml kopiert und angepasst werden. Die Datei enthält Dokumentation in Form von Kommentaren und ist daher selbsterklärend.

Diese Einstellungen können auch durch die Umgebungsvariablen für Rails vorgenommen werden (production/development/test).

Wichtig: die Anwendung muss nach jeder Änderung neu gestartet werden.

Email/SMTP-Servereinstellungen

Die Email-Konfiguration wird auf einer separaten Seite erklärt.

SCM-Einstellungen

Dieser Abschnitt ermöglicht:

  • das Überschreiben der Standardanweisungsnamen, falls die SCM-Binärdateien in der PATH-Variablen nicht die üblichen Namen verwenden
  • das Festlegen des kompletten Pfads zu den SCM-Binärdateien

Beispiele (mit Subversion):

Überschreiben des Anweisungsnamen:

scm_subversion_command: "svn_replacement.exe"

Setzen des Pfades:

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

Speichereinstellungen für Anhänge

Mit der Einstellung attachments_storage_path kann das Verzeichnis für den Ort, wohin Anhänge gespeichert werden, vom Standard files auf einen anderen geändert werden.

Beispiele:

attachments_storage_path: /var/redmine/files
attachments_storage_path: D:/redmine/files

Konfiguration des Loggings

Standardmäßig verwendet Redmine beim Schreiben in das log-Verzeichnis das Log-Level :info. Abhängig von der Verwendungsintensität der Anwendung kann dies eine umfangreiche Menge an Daten bedeuten. Um dabei ein uferloses Wachsen der Log-Datei zu vermeiden, sollte eine Rotation der Log-Datei erwogen werden - entweder durch System-Tools wie logrotate oder durch Einstellungen in der Datei config/additional_environment.rb.

Um die zweite Möglichkeit zu verwenden, wird die config/additional_environment.rb.example nach config/additional_environment.rb kopiert und folgende Zeilen hinzugefügt. Zu beachten ist dabei, dass der nun verwendete Logger standardmäßig auf ein hohes Log-Level eingestellt ist, und dass daher dieser explizit auf info gesetzt werden muss.

#Logger.new(PATH,NUM_FILES_TO_ROTATE,FILE_SIZE)
config.logger = Logger.new('/path/to/logfile.log', 2, 1000000)
config.logger.level = Logger::INFO

Sicherungen

Redmine-Sicherungen sollten enthalten:

  • Daten (in der Redmine-Datenbank gespeichert)
  • Anhänge (standardmäßig im files-Verzeichnis des Redmine-Installationsverzeichnisses enthalten)

Im folgenden ist ein einfaches Shell-Skript, das für die tägliche Sicherung verwendet werden kann (mit der Annahmen, dass eine MySQL-Datenbank verwendet wird):

# Datenbank
/usr/bin/mysqldump -u <username> -p<password> <redmine_database> | gzip > /path/to/backup/db/redmine_`date +%y_%m_%d`.gz

# Anhänge
rsync -a /path/to/redmine/files /path/to/backup/files

Hinweise zur Installation unter Linux/Unix

Falls während der Installation seltsame Probleme auftreten, so sollte sichergestellt werden, dass sicherheitsüberwachende Tools ausgeschaltet sind. So etwas passiert häufig ohne Fehlermeldungen oder anderem Feedback und kann durch Tools wie Erweiterte ACLs, SELinux oder AppArmor verursacht werden. Jene Tools werden meistens in größeren Firmen mit strengen Sicherheitsrichtlinien verwendet. Die Einstellungen von Standard-Linux- oder Unix-Distributionen sollten aber keine Probleme verursachen.

Hinweise zur Installation unter Windows

Unter http://rubyinstaller.org gibt es einen vorgefertigtes Installationsprogramm für den Ruby-MRI (Matz' Ruby-Interpreter).
Nach dessen Installation ist Start Command Prompt with Ruby im Startmenü auszuwählen.

Setzen der RAILS_ENV-Variable:

Beim Ausführen von Anweisungen, wie sie in dieser Anleitung beschrieben sind, muss die RAILS_ENV-Variable mit einer anderen Anweisung zuvor gesetzt werden.

D.h. Anweisungen mit der Syntax folgender Art:

RAILS_ENV=production <irgendeine Anweisung>
<irgendeine Anweisung> RAILS_ENV=production

müssen in zwei aufeinanderfolgende Anweisungen zerlegt werden:

set RAILS_ENV=production
<any commmand>

Probleme bei der Installation des MySQL-Gem

Es kann nötig sein, das MySQL-Gem manuell mit folgender Anweisung zu installieren:

gem install mysql

Und in manchen Fällen ist es erforderlich libmysql.dll in das ruby/bin-Verzeichnis zu kopieren.
Nicht alle libmysql.dll-Dateien scheinen fehlerfrei zu sein, jedoch sollte diese Datei funktionieren: http://instantrails.rubyforge.org/svn/trunk/InstantRails-win/InstantRails/mysql/bin/libmySQL.dll.

Wichtiger Hinweis für Windows 7 und höher

Unter Window 7 und höher ist localhost in der hosts-Datei auskommentiert1 und es wird standardmäßig IPv6 verwendet2. Da das mysql2-Gem IPv6-Adressen nicht unterstützt3, kann keine Verbindung aufgebaut werden und es tritt der Fehler "Can't connect to MySQL server on 'localhost' (10061)" auf.

Dies lässt sich überprüfen indem localhost gepingt wird: wenn "::1:" gepingt wird, so ist IPv6 in Verwendung.

Workaround:

localhost mit 127.0.0.1 in database.yml ersetzen.

1 http://serverfault.com/questions/4689/windows-7-localhost-name-resolution-is-handled-within-dns-itself-why

2 http://www.victor-ratajczyk.com/post/2012/02/25/mysql-fails-to-resolve-localhost-disable-ipv6-on-windows.aspx

3 https://github.com/brianmario/mysql2/issues/279

Alternative zur manuellen Installation

Einige Nutzer verzichten lieber auf die manuelle Installation, indem sie einer der Redmine-Pakete von Drittanbietern verwenden, die auf der Download-Seite aufgelistet sind.