OpenProject installieren

2026-07-24T09:58:48Z

Oad:

== Allgemein ==
OpenProject ist eine umfangreiche Projektmanagement-Software. Die Software ist multiprojektfähig; für jedes Projekt stehen unter anderem folgende Werkzeuge zur Verfügung:
* Wiki
* Vorgangsverfolgung (Ticketsystem, Issue Tracker)
* Zeiterfassung
* Dokument- und Dateiverwaltung

Diese Anleitung beschreibt, wie man OpenProject auf der Managed Hosting Plattform von Hostsharing installieren kann. OpenProject lässt sich in jedem Managed Webspace betreiben.

Die Anleitung wurde für OpenProject Version 11 erstellt.

== Ansible Skript ==

Alternativ zur manuellen Installation, die in diesem Wiki Artikel beschrieben wird, gibt es ein
Ansible Skript, das die Installationsschritte für OpenProject automatisiert durchführt.

Die Quellen für das Ansible Skript können hier eingesehen werden: https://codeberg.org/tpokorra/hs.ansible/src/branch/main/playbooks/openproject

== Vorbereitungen ==

=== Service-User, Domain und Datenbank ===

Mit Hilfe von HSAdmin werden angelegt:
# Ein User als Service-User mit ''/bin/bash'' als Shell, zum Beispiel Beispiel: ''xyz00-project"
# Eine Domain mit ''xyz00-project'' als Domain-Administrator, zum Beispiel "prj.example.com"
# Einen Postgresql-User ''xyz00_dbuser'' mit Passwort ''meinPasswort''
# Eine Postgresql-Datenbank ''xyz00_prjdb'' mit Datenbank-Owner ''xyz00_dbuser''

=== Vorbereitung des Webspace ===

Die "leichtgewichtige" Subdomain "www" wird gelöscht. Ebenso die ''.htaccess''-Datei mit der Weiterleitung dorthin.

<syntaxhighlight lang="bash">
xyz00@h20 $ sudo -u xyz00-project -i
xyz00-project@h20:~$ cd ~/doms/projekt.example.com/
xyz00-project@h20:~/doms/projekt.example.com$ rm -rf subs/www/ subs-ssl/www/ htdocs-ssl/.htaccess
</syntaxhighlight>

=== Installation von Ruby ===

Weiterhin benötigt OpenProject eine geeignete Version der Programmiersprache Ruby.

Die gewünschte Version kann hier abgelesen werden: https://github.com/opf/openproject/blob/stable/11/.ruby-version

Die Installation-Anleitung für OpenProject schlägt für die Installation ''rbenv'' vor.

<syntaxhighlight lang="bash">
xyz00-project@h20:~/doms/projekt.example.com$ cd
xyz00-project@h20:~$ git clone https://github.com/sstephenson/rbenv.git ~/.rbenv
xyz00-project@h20:~$ touch .profile
xyz00-project@h20:~$ chmod u+x .profile
xyz00-project@h20:~$ echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.profile
xyz00-project@h20:~$ echo 'eval "$(rbenv init -)"' >> ~/.profile
xyz00-project@h20:~$ source ~/.profile
xyz00-project@h20:~$ git clone https://github.com/sstephenson/ruby-build.git ~/.rbenv/plugins/ruby-build
xyz00-project@h20:~$ rbenv install 2.7.4
xyz00-project@h20:~$ rbenv rehash
xyz00-project@h20:~$ rbenv global 2.7.4
</syntaxhighlight>

Als Test bitte aufrufen: ''ruby -v''

Die Anzeige sollte etwa das Folgende enthalten:
ruby 2.7.4pXYZ (....) [x86_64-linux]

=== Installation von Node ===

Die Installation-Anleitung für OpenProject schlägt für die Installation ''nodenv'' vor.

<syntaxhighlight lang="bash">
xyz00-project@h20:~$ git clone https://github.com/OiNutter/nodenv.git ~/.nodenv
xyz00-project@h20:~$ echo 'export PATH="$HOME/.nodenv/bin:$PATH"' >> ~/.profile
xyz00-project@h20:~$ echo 'eval "$(nodenv init -)"' >> ~/.profile
xyz00-project@h20:~$ source ~/.profile
xyz00-project@h20:~$ git clone git://github.com/OiNutter/node-build.git ~/.nodenv/plugins/node-build
xyz00-project@h20:~$ nodenv install 12.18.4
xyz00-project@h20:~$ nodenv rehash
xyz00-project@h20:~$ nodenv global 12.18.4
</syntaxhighlight>

Ein Test mit ''node --version'' solte anzeigen: v12.18.4

== Installation und Konfiguration ==

=== Installation von OpenProject ===

Wir installieren die OpenProject Community Edition. siehe https://github.com/opf/openproject

<syntaxhighlight lang="bash">
xyz00-project@h20:~$ git clone https://github.com/opf/openproject.git --branch stable/11 --depth 1
xyz00-project@h20:~$ cd ~/openproject
xyz00-project@h20:~$ gem update --system
xyz00-project@h20:~$ gem install bundler
xyz00-project@h20:~$ bundle update --bundler
xyz00-project@h20:~$ bundle config set deployment 'true'
xyz00-project@h20:~$ bundle config set without 'mysql2 sqlite development test therubyracer docker'
xyz00-project@h20:~$ bundle install
xyz00-project@h20:~$ npm install
</syntaxhighlight>

=== Konfiguration von OpenProject ===

Erstelle eine Konfiguration für den Datenbank-Zugriff in der Datei ''config/database.yml''

<syntaxhighlight lang="bash">
xyz00-project@h20:~$ cd ~/openproject
xyz00-project@h20:~/openproject$ cp config/database.yml.example config/database.yml
</syntaxhighlight>

In der neuen Datei ''database.yml'' wird die mit HSAdmin angelegte PostgreSQL-Datenbank eingetragen:
<syntaxhighlight lang="yaml" line>
production:
adapter: postgresql
encoding: unicode
host: localhost
database: xyz00_prjdb (wie oben angegeben)
pool: 10
username: xyz00_dbuser (wie oben angegeben)
password: meinPasswort (wie oben angegeben)
</syntaxhighlight>

Die Einträge für ''development'' und ''test'' können gelöscht werden.

Dann wird die Datei ''configuration.yml'' angelegt:

<syntaxhighlight lang="yaml" line>
xyz00-project@h20:~$ cd ~/openproject
xyz00-project@h20:~/openproject$ cp config/configuration.yml.example config/configuration.yml
</syntaxhighlight>

Dort erfolgen die Einstellungen für ausgehende E-Mails:

<syntaxhighlight lang="yaml" line>
default:
log_level: info
email_delivery_method: :smtp
smtp_address: localhost
smtp_port: 25
smtp_domain: example.com
#smtp_authentication: :login
#smtp_user_name: "openproject@example.net"
#smtp_password: "my_openproject_password"
</syntaxhighlight>

Die Zeilen mit smtp_authentication, smtp_user_name und smtp_password können auskommentiert werden, sie werden in unserem Setup nicht benötigt.

Es muss außerdem vermieden werden, dass beim Hochladen von Dateien in /tmp geschrieben wird. Dazu wird das Verzeichnis $HOME/var/tmp angelegt, und die Datei <code>openproject/config/initializers/tmpdir.rb</code> mit folgendem Inhalt erstellt:

<syntaxhighlight lang="ruby" line>
class Dir
def self.tmpdir
"/home/pacs/xyz00/users/project/var/tmp/"
end
end
</syntaxhighlight>

=== Einen geheimen Schlüssel erzeugen ===

<syntaxhighlight lang=bash>
xyz00-project@h20:~$ cd ~/openproject
xyz00-project@h20:~/openproject$ EDITOR=cat ./bin/rails credentials:edit
</syntaxhighlight>

=== Initialisiere Datenbank und erzeuge Web-Ressourcen ===

<syntaxhighlight lang=bash>
xyz00-project@h20:~$ cd ~/openproject
xyz00-project@h20:~/openproject$ export RAILS_ENV="production"
xyz00-project@h20:~/openproject$ source ~/.profile
xyz00-project@h20:~/openproject$ ./bin/rails db:prepare
xyz00-project@h20:~/openproject$ ./bin/rake assets:precompile
</syntaxhighlight>

=== Anlegen des Administrators ===

Es kann eine Demo Installation installiert werden:
<syntaxhighlight lang=bash>
xyz00-project@h20:~$ cd ~/openproject
xyz00-project@h20:~/openproject$ export RAILS_ENV="production"
xyz00-project@h20:~/openproject$ source ~/.profile
xyz00-project@h20:~/openproject$ LOCALE=en ./bin/rake db:seed
</syntaxhighlight>

Damit wird ein Beispiel-Projekt angelegt, das man wieder löschen kann.

Wichtig ist aber, dass der Benutzer <code>admin</code> mit dem Passwort <code>admin</code> angelegt wird. Das Passwort muss bei der ersten Anmeldung geändert werden.

=== Konfiguration in Passenger ===

<syntaxhighlight lang=bash>
xyz00-project@h20:~$ cd ~/doms/prj.example.com
xyz00-project@h20:~/doms/prj.example.com$ rm -rf app-ssl htdocs-ssl
xyz00-project@h20:~/doms/prj.example.com$ ln -s $HOME/openproject app-ssl
xyz00-project@h20:~/doms/prj.example.com$ ln -s $HOME/openproject/public htdocs-ssl
</syntaxhighlight>

Weiterhin muss in einer .htaccess-Datei in diesem Verzeichnis die richtige Umgebung gesetzt sein:

<syntaxhighlight lang=apache>
# xyz00-project@h20:~/doms/prj.example.com$ cat .htaccess

SetEnv OPENPROJECT_STORAGE_TMP__PATH /home/pacs/xyz00/users/project/var/tmp/
SetEnv TMPDIR /home/pacs/xyz00/users/project/var/tmp/
PassengerRuby /home/pacs/xyz00/users/project/.rbenv/shims/ruby
</syntaxhighlight>

== Aufsetzen des systemd Timers für Hintergrundprozesse ==

Es werden Benachrichtigungs-E-Mails im Hintergrund verschickt. Dazu muss ein Prozess im Hintergrund gestartet werden. Um Probleme zu vermeiden, dass source nicht zur Verfügung steht, kann der Aufruf in einer eigenen Skriptdatei geschehen, die zwingend mit Bash ausgeführt wird, wo source verfügbar ist.

Datei ''/home/pacs/xyz00/users/project/emailjob.sh'':

<syntaxhighlight lang=bash line>
#!/bin/bash
source ~/.profile
cd ~/openproject
RAILS_ENV="production" ./bin/rake jobs:workoff
</syntaxhighlight>

Datei ''/home/pacs/xyz00/users/project/jobrestart.sh'':

<syntaxhighlight lang=bash line>
#!/bin/bash
source ~/.profile
cd ~/openproject
RAILS_ENV="production" ./bin/delayed_job restart
</syntaxhighlight>

Nun können die Timer eingerichtet werden:

''~/.config/systemd/user/openproject_emails.service''
<syntaxhighlight lang=ini line>
[Unit]
Description=openproject mails

[Service]
Type=oneshot
ExecStart=/home/pacs/xyz00/users/project/emailjob.sh
</syntaxhighlight>

~/.config/systemd/user/openproject_emails.timer
<syntaxhighlight lang=ini line>
[Unit]
Description=openproject mails

[Timer]
OnCalendar=*:0/2
Persistent=True

[Install]
WantedBy=timers.target
</syntaxhighlight>

Damit wird der Hintergrundprozess alle 2 Minuten gestartet.

Es gibt noch einen Hintergrundjob, den ich einmal in der Stunde neu starte:

''~/.config/systemd/user/openproject_jobrestart.service''
<syntaxhighlight lang=ini line>
[Unit]
Description=openproject restart job

[Service]
Type=oneshot
ExecStart=/home/pacs/xyz00/users/project/jobrestart.sh
</syntaxhighlight>

~/.config/systemd/user/openproject_jobrestart.timer
<syntaxhighlight lang=ini line>
[Unit]
Description=openproject restart job

[Timer]
OnCalendar=*:22
Persistent=True

[Install]
WantedBy=timers.target
</syntaxhighlight>

Timer aktivieren und starten:
<syntaxhighlight lang=bash line>
$ systemctl --user enable openproject_emails.timer
$ systemctl --user start openproject_emails.timer
$ systemctl --user enable openproject_jobrestart.timer
$ systemctl --user start openproject_jobrestart.timer
</syntaxhighlight>

== Upgrade durchführen ==

Die gewünschte Ruby Version kann hier abgelesen werden (ggf. Branch passend wechseln): https://github.com/opf/openproject/blob/stable/11/.ruby-version

Wichtig! OpenProject ist sehr empfindlich darin bspw. von 15.2 -> 15.x (latest) -> 16(.0) oder 16.x upgegraded zu werden, sonst schlagen die DB migrationen fehl.

Die benötigte Nodejs Version kann im git repository in der package.json unter engine abgelesen werden.

Für das Upgrade von OpenProject 11.2.4 auf 11.3.4, musste eine neue Version von Ruby installiert werden:

<syntaxhighlight lang=bash>
xyz00-project@h20:~$ cd ~/openproject
xyz00-project@h20:~/openproject$ source ~/.profile
xyz00-project@h20:~/openproject$ git -C $HOME/.rbenv/plugins/ruby-build pull
xyz00-project@h20:~/openproject$ rbenv install 2.7.4
xyz00-project@h20:~/openproject$ rbenv rehash
xyz00-project@h20:~/openproject$ rbenv global 2.7.4
xyz00-project@h20:~/openproject$ source ~/.profile
xyz00-project@h20:~/openproject$ rm -Rf $HOME/.rbenv/versions/2.7.3/ # alte Version kann gelöscht werden
</syntaxhighlight>

Weil das Git Repository bei der Erstinstallation nur einen Branch enthielt, muss nun das Repository passend nachgeladen werden (Beispielhaft für den Branch stable/15)

<syntaxhighlight lang=bash>
xyz00-project@h20:~$ cd openproject
xyz00-project@h20:~/openproject$ source ~/.profile
xyz00-project@h20:~/openproject$ git remote set-branches --add origin stable/15
xyz00-project@h20:~/openproject$ git fetch
xyz00-project@h20:~/openproject$ git checkout stable/15
</syntaxhighlight>

Nach Verifikation dass das update erfolgreich war, kann der alte Branch gelöscht werden, nach bedarf mit:

<syntaxhighlight lang=bash>
xyz00-project@h20:~$ git branch -D old_branch_name
</syntaxhighlight>

Generell müssen diese Schritte durchgeführt werden:

<syntaxhighlight lang=bash>
xyz00-project@h20:~$ cd openproject
xyz00-project@h20:~/openproject$ source ~/.profile
xyz00-project@h20:~/openproject$ git fetch
xyz00-project@h20:~/openproject$ git pull
xyz00-project@h20:~/openproject$ gem update --system
xyz00-project@h20:~/openproject$ bundle install
xyz00-project@h20:~/openproject$ npm install
xyz00-project@h20:~/openproject$ export RAILS_ENV="production"
xyz00-project@h20:~/openproject$ ./bin/rake db:migrate
xyz00-project@h20:~/openproject$ ./bin/rake assets:precompile
xyz00-project@h20:~/openproject$ touch ~/doms/prj.example.com/app-ssl/tmp/restart.txt
</syntaxhighlight>

Falls es ein Update der Ruby Version gab muss die neue Version ggf. noch im HS Admin für Passenger eingetragen werden.

== Referenzen ==

* [https://docs.openproject.org/installation-and-operations/installation/manual/ Anleitung für die manuelle Installation]
* [https://codeberg.org/tpokorra/hs.ansible/src/branch/main/playbooks/openproject Ansible Playbook für Hostsharing]
----
[[Kategorie:HSDoku]]
[[Kategorie:Installationsanleitungen]]
[[Kategorie:Ansible Playbook]]
[[Kategorie:Software]]
[[Kategorie:RubyOnRails]]
[[Kategorie:Passenger]]
[[Kategorie:Projektmanagement]]
[[Kategorie:Projektverwaltung]]

Hostsharing Wiki - Benutzerbeiträge [de]

OpenProject installieren