Block > HabitRPG: Installation, Wartung, Tipps

In einem anderen Beitrag habe ich beschrieben, was HabitRPG ist und wozu und warum ich es nutze. Hier folgt nun eine detaillierte Beschreibung, wie HabitRPG lokal zum Laufen gebracht werden kann.

Die Gruende, warum ich HabitRPG lokal und nicht auf der normalen Website nutze:

• es sind alles private Daten, die ich nicht in fremden Haenden sehen will (Stichwort: Datenschutz)
• weil ich auch ohne Geld zu spenden die Features nutzen kann (Hintergruende, Quests, usw.)
• und … weil ich es kann 😉

Ok, los gehts! 😊

Anleitungen fuer die lokale Installation mit Hilfe von Vagrant und unter Ubuntu befinden sich im Wiki von HabitRPG . Die Anleitung fuer Ubuntu gibt schon einige Sachen vor, aber ich will die einzelnen Schritte etwas genauer und an Arch Linux angepasst auflisten.

HabitRPG lokal aufsetzen #

HabitRPG benoetigt im Hintergrund eine Datenbank, wobei sich hier fuer MongoDB entschieden wurde. Zudem basiert es unter anderem auf Node.js und die Menschen hinter HabitRPG haben ihren Code bei GitHub liegen. Also installieren wir erstmal die MongoDB, Node.js und Git mit folgendem Befehl (Quelle MongoDB ):

sudo pacman -S mongodb nodejs git

Danach starten wir MongoDB (und lassen es optional bei jedem Systemstart starten).

sudo systemctl start mongodb
# optional, startet MongoDB mit dem Systemstart
sudo systemctl enable mongodb

Nun koennen wir den Code von GitHub beziehen und wechseln anschliessend in das neue Verzeichnis, welches auch spaeter noch in einen anderen Ordner verschoben werden kann:

cd ~
git clone https://github.com/HabitRPG/habitrpg.git
cd habitrpg

Der Branch (Zweig) von Git sollte develop sein, das testen wir mit:

git branch

Der aktuelle Branch hat einen Stern (*) vor dem Namen. Wenn es nicht develop ist, wechseln wir in diesen Branch:

git checkout develop

Mit dem Paketmanager npm von Node.js installieren wir nun global (mit -g) grunt-cli und bower, daher folgendes mit Root-Rechten ausfuehren:

sudo npm install -g grunt-cli bower phantomjs

Normalerweise sind die Rechte nun falsch gesetzt, daher passen wir die an, damit auch Leute ohne Root-Rechten die Programme nutzen koennen:

sudo chmod -R 755 /usr/lib/node_modules/{grunt-cli,bower,phantomjs}

Mit npm installieren wir jetzt noch die restlichen Abhaengigkeiten:

npm install

Wir sind fast fertig, es fehlt nur noch die Anpassung der Konfigurationsdatei. Dazu kopieren wir die Beispiel-Konfigurationsdatei:

cp config.json.example config.json

Und aendern das SESSION_SECRET in config.json, z.B. mit pwgen (ggf. mit pacman -S pwgen installieren). Der Rest der Datei kann so belassen werden.

pwgen -s 50 1

Die Datenbank sollte jetzt schon laufen (siehe oben, evtl. ueberpruefen mit systemctl status mongodb), also starten wir die Anwendung:

npm start

Im Browser rufen wir nun localhost:3000 auf. HabitRPG sollte nun dort zu sehen sein 😊

Nun koennen wir uns anmelden (auf Play klicken und unter Register anmelden), oder ein schon vorhandenes Konto beim offiziellen HabitRPG exportieren und in der lokalen Instanz importieren. Die Anleitung dafuer befindet sich weiter unten.

HabitRPG updaten #

Ab und zu gibt es am offiziellen HabitRPG Aenderungen, die dann natuerlich auch lokal genutzt werden koennen/sollten.
Dazu muessen wir folgende Schritte ausfuehren (Quelle ):

• Ins Verzeichnis mit dem Code von HabitRPG wechseln und den Code updaten:

  cd /path/to/habitrpg
  git pull origin develop
  

• ggf. Pakete aktualisieren

  npm install
  

• ggf. Migrationen vornehmen: sollte bei git pull origin develop Dateien im Ordner migrations dazugekommen sein, muessen diese in der richtigen Reihenfolge (nach Datum) angewendet werden, begonnen mit der aeltesten. Es gibt dabei drei moegliche Aufrufe (je nach Datei, leider hilft da nur testen/lesen) (Quelle ):

  mongo habitrpg ./migrations/20150125_bla.js
  

  Funktioniert das nicht, sollte ein Fehler kommen. Entweder wird was required, dann rufen wir dieses Modul einfach mit auf:

  mongo habitrpg ./node_modules/modul/modul.js ./migrations/20150125_bla.js
  

  Oder es hilft alles nichts, und wir fuehren es einfach mit node aus (da sollten die Requirements erfuellt werden):

  node migrations/20150125_bla.js
  

• HabitRPG wieder starten 😊

  npm start
  

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

#!/bin/bash

# to install HabitRPG, follow this guide (german only):
# http://yhaupenthal.org/1422213598.htm

root="/path/to/habitrpg"
new="$root/habitrpg"

# shutdown service
systemctl stop habitrpg

# backup
old="$root/habitrpg.bak-$(date +%Y%m%d)"
mv $new $old

# git clone
git clone https://github.com/HabitRPG/habitrpg.git $new

# cp config, bash.history
cp $old/.bash_history $new/.bash_history
cp $old/config.json $new/config.json

# chown+chmod
chown -R habitrpg:habitrpg $new
chmod -R 770 $new

# checking branch
cd $new
echo "### branch (should be \"develop\")"
git branch

# diff config
echo "### config"
diff $new/config.json $new/config.json.example

# diff migrations
echo "### migrations"
diff -qr $new/migrations $old/migrations | sort

# enable habitrpg user
sed -i '/^habitrpg/s/false/bash/' /etc/passwd

cat << !
### auto stuff done, you're on your own now
### use http://yhaupenthal.org/1422213598.htm ("HabitRPG updaten")
### and:
### su habitrpg
### npm install
### migrations (for each do)
#### mongo habitrpg ./migrations/20150702_bla.js
#### if this doesn't work (something is required):
#### mongo habitrpg ./node_modules/modul/modul.js ./migrations/20150702_bla.js
#### if this also doesn't work:
#### node ./migrations/20150702_bla.js
### test: npm start

### if you're done:
### sed -i '/^habitrpg/s/bash/false/' /etc/passwd
### systemctl start habitrpg
!

Datenexport und -import (zentral nach lokal) #

Um ein schon vorhandenes Konto im offiziellen HabitRPG im lokalen zu nutzen, muessen die Daten erst exportiert werden. Dazu am Besten alle drei Dateien unter Export (history.csv, userdata.xml, userdata.json) herunterladen.
Da in den Daten kein Passwort vorhanden ist, kann ein temporaeres Passwort (in diesem Fall test) in userdata.json eingefuegt werden, um sich damit einloggen zu koennen. Das Passwort sollte danach direkt wieder geaendert werden !
Dazu die Datei userdata.json mit einem Texteditor oeffnen und die Zeile mit dem Wort email suchen. An das Ende der Zeile dann ein Komma anhaengen und folgendes in die naechsten zwei Zeilen schreiben:

"salt" : "f45185359d",
"hashed_password" : "b04475ce5a970087602f702ffec1af6e4a2eb73e"

Danach die Datei schliessen und mit folgendem Befehl in MongoDB importieren (zuerst gab es bei mir eine Fehlermeldung beim Import, daher am Besten noch --jsonArray anhaengen (Quelle )):

mongoimport --db habitrpg --collection users --file userdata.json --jsonArray

Nun kann sich ganz normal eingeloggt werden (mit dem Benutzernamen wie bei der offiziellen Version und dem Passwort test).

Datensicherung #

Was manuell geht, geht natuerlich auch automatisch: die Sicherung der Daten.
Die koennen jetzt direkt per mongodump und einem Cronjob gesichert werden und ggf. per mongorestore wieder eingespielt werden.

mongodump --db habitrpg --out ~/backup

Der Cronjob koennte so aussehen:

$ crontab -l
@daily mongodump --db habitrpg --out $HOME/backup

Und die Backupdateien koennten dann z.B. in einem Gitrepository gesichert werden.

[An dieser Stelle schwand etwas meine Lust 😉]

mongorestore --drop ~/backup/habitrpg

HabitRPG auf einem Server mit SSL aufsetzen #

Das wollte ich heute (2014-07-18) mal nachholen, bin aber klaeglich gescheitert. Es existiert dafuer natuerlich wieder keine Doku, und auch herumprobieren (eher stochern) hat mich nicht weitergebracht.

Ueber jegliche Hilfe bin ich sehr dankbar! 😊

Allerdings war mein erstes Problem, dass ich nichtmal die unverschluesselte Version mit Chromium aufrufen konnte, was an [HSTS][] lag 😕
Warum gibt es da nicht die Moeglichkeit, die Ports oder auch nur einzelne Ports/Subdomains zu ignorieren?
Naja, geloescht werden kann die jeweilige Domain in den Einstellungen von Chromium, dazu einfach folgendes in die Adressleiste eingeben (Quelle ):

chrome://net-internals/#hsts

Unter “Delete domain” kann die Domain nun entfernt werden.

server.modules += ( "mod_proxy" )

$HTTP["host"] == "subdomain.domain.tld" {
  proxy.server = ( "" => ( (
    "host" => "127.0.0.1",
    "port" => "3000" )
  ) )
}

sudo systemctl restart lighttpd

HabitRPG sollte auf dem Server am Besten unter einem extra User laufen, der z.B. so erstellt werden kann:

sudo useradd -d /home/habitrpg -s /bin/nologin habitrpg

Um direkt mit dem System zu starten, reicht bei systemd folgendes (z.B. in /etc/systemd/system/habitrpg.service):

[Unit]
Description=HabitRPG
After=syslog.target network.target

[Service]
Type=simple
User=habitrpg
WorkingDirectory=/home/habitrpg
ExecStart=/usr/bin/npm start
ExecStop=/usr/bin/npm stop

[Install]
WantedBy=multi-user.target

Aktivieren und starten dann mit folgenden Befehlen:

sudo systemctl enable habitrpg.service
sudo systemctl start habitrpg.service

Fuer beide Wege gilt: erst mal den Service stoppen:

sudo systemctl stop habitrpg.service

Ersteres laesst sich dann durch folgende ergaenzende Zeile (bei [Service]) in /etc/systemd/system/habitrpg.service bewerkstelligen:

StandardOutput=null

Zweiteres durch den Austausch der ExecStart-Zeile durch folgende Zeilen …

ExecStartPre=/home/habitrpg/node_modules/.bin/grunt build:prod
ExecStart=/home/habitrpg/node_modules/.bin/grunt nodemon

… und den Austausch der NODE_ENV-Zeile in /home/habitrpg/config.json durch folgende Zeile (also quasi development in production aendern):

"NODE_ENV":"production"

In beiden Faellen dann den Service neuladen und starten:

sudo systemctl daemon-reload
sudo systemctl start habitrpg.service

HabitRPG sollte nun nicht mehr das Log zuspammen und/oder im Produktivmodus laufen 😊

Es war uebrigens wieder ein K(r)ampf, das alles herauszufinden, da der Produktivmodus ueberhaupt nicht dokumentiert ist …
Letztendlich geholfen hat das Lesen des Codes (Gruntfile.js und Procfile ) …

/home/habitrpg/node_modules/winston/lib/winston/logger.js:435
  var instance = created ? transport : (new (transport)(options));
                                        ^
TypeError: undefined is not a function
    at Logger.add (/home/habitrpg/node_modules/winston/lib/winston/logger.js:435:41)
    at Object.<anonymous> (/home/habitrpg/src/logging.js:11:16)
    at Module._compile (module.js:456:26)
    at Object.Module._extensions..js (module.js:474:10)
    at Module.load (module.js:356:32)
    at Function.Module._load (module.js:312:12)
    at Module.require (module.js:364:17)
    at require (module.js:380:17)
    at Object.<anonymous> (/home/habitrpg/src/server.js:7:15)
    at Module._compile (module.js:456:26)
[nodemon] app crashed - waiting for file changes before starting...

logger.add(winston.transports.newrelic, {});

// logger.add(winston.transports.newrelic, {});

Erweiterte Rechte #

Der Vorteil bei einer lokalen Installation ist nicht nur der Datenschutzaspekt, sondern auch die erweiterten Rechte 😉
So kann das eigene Konto mit Adminrechten und Edelsteinen ausgestattet werden, um alles machen zu koennen, was normalerweise Geld kostet. Das soll natuerlich nicht fuer alles genutzt werden, sonst macht das nicht mehr so viel Sinn 😉

Dazu folgende Schritte ausfuehren:

• User-ID z.B. hier finden und kopieren. Eine Beispiel-ID ist:

  05e3c0da-f47f-4cb4-be3c-7ab12093ceaf
  

• In der Datenbank einloggen (Quelle )

  mongo habitrpg
  

• Adminrechte setzen (Quelle ):

  db.users.update({_id: '05e3c0da-f47f-4cb4-be3c-7ab12093ceaf'}, {$set: {contributor: {"admin":1}}})
  

• Nun koennen in der Halle der Helden noch einige Einstellungen veraendert werden, unter anderem koennen bei Saldo Edelsteine verliehen werden oder die Werbung abgeschaltet werden.

Meine Website waere ja langweilig, wenn es nicht noch ein bisschen geekiger gaenge, so bin ich eben ueber HabitRPG fuer die Kommandozeile gestolpert 😄
Getestet habe ich es noch nicht, es steht aber als TODO in meiner lokalen HabitRPG-Instanz 😉

Zudem gibt es ja noch die mobile Variante , mit der ich dann auch auf meine eigene HabitRPG-Instanz zugreifen koennte. Da hab ich mich allerdings noch nicht drangewagt.