Mastodon bei Hostsharing

Mastodon ist ein verteilter Microblogging Dienst, der das ActivityPub-Protokoll verwendet.

Wenn man nur wenige Nutzer oder gar nur für sich selbst einen Einstiegspunkt ins "Fediverse" schaffen will, kann sich auch die Ressourcen-schonende Alternative Pleroma anbieten.

Diese Anleitung beschreibt, wie man Mastodon auf der Managed Hosting Plattform von Hostsharing installieren kann.

Hostsharing selbst nutzt die Hosting Plattform und betreibt zwei Mastodon Instanzen:

• https://geno.social
• https://hostsharing.coop

Der Autor dieser Seite betreibt:

• https://krefeld.life

Für Managed Server

Ein funktionierender Mastodon-Server erfordert mehrere laufende Server-Dienste. Für den Betrieb ist ein Managed Server sinnvoll.

Vorbereitungen

Mit Hilfe von HSAdmin wird angelegt:

1. Ein User als Service-User mit /bin/bash als Shell, zum Beispiel Beispiel: xyz00-mastodon
2. Eine Domain mit xyz00-mastodon als Domain-Administrator, zum Beispiel beispiel.social
3. Einen Postgresql-User xyz00_mastuser mit Passwort meinPasswort
4. Eine Postgresql-Datenbank xyz00_mastdb mit Datenbank-Owner xyz00_mastuser

Verwendete IP-Ports der Server-Dienste:

1. Redis: localhost:32002
2. Mastodon-Web: localhost:32003
3. Mastodon-Streaming: localhost:32004

Konfiguration des Redis Server

Anlegen einer Datei /home/pacs/xyz00/users/mastodon/redis/etc/redis.conf mit folgendem Inhalt:

daemonize yes
pidfile /home/pacs/xyz00/users/mastodon/redis/var/redis-server.pid
requirepass <hierhin-gehoert-ein-redis-passwort>
port 32002
tcp-backlog 128
bind 127.0.0.1
timeout 300
loglevel notice
logfile /home/pacs/xyz00/users/mastodon/redis/var/redis.log
databases 16
save 900 1
save 300 10
save 60 10000
slave-serve-stale-data yes
appendonly no
dbfilename dump.rdb
dir /home/pacs/xyz00/users/mastodon/redis/var

Installation von NodeJS

Als User 'xyz00-mastodon: Installation von nvm und nodejs (Version 20) nach der Anleitung NodeJS

Installation von yarn mit:

npm install -g yarn

Installation von Ruby

Als User xyz00-mastodon: Installation von Ruby mit rbenv mit folgenden Befehlen:

Zunächst rbenv and ruby-build:

git clone https://github.com/rbenv/rbenv.git ~/.rbenv
cd ~/.rbenv && src/configure && make -C src
echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.profile
echo 'eval "$(rbenv init -)"' >> ~/.profile

starte neue Shell:

exec bash

Überprüfe rbenv-Installation

type rbenv

Installiere ruby-build als rbenv-Plugin

git clone https://github.com/rbenv/ruby-build.git ~/.rbenv/plugins/ruby-build

Nun kann die benötigte Ruby-Version installiert werden:

rbenv install 3.2.3

Installation der Mastodon Software

Weiterhin Als User xyz00-mastodon:

cd ~
git clone https://github.com/tootsuite/mastodon.git live
cd ~/live

Die stabile Version auschecken:

git checkout $(git tag -l | grep -v 'rc[0-9]*$' | sort -V | tail -n 1)

Ruby Pakete installieren:

gem install bundler
bundle install -j$(getconf _NPROCESSORS_ONLN) --deployment --without development test

Node.js Pakete installieren:

yarn install --pure-lockfile

Konfiguration der Mastodon Software

Anlegen einer Datei /home/pacs/xyz00/users/mastodon/live/.env.production mit dem folgenden Inhalt:

REDIS_HOST=localhost
REDIS_PORT=32002
REDIS_PASSWORD=<hierhin-gehoert-ein-redis-passwort>
DB_HOST=localhost
DB_USER=xyz00_mastuser
DB_NAME=xyz00_mastdb
DB_PASS=meinPasswort
DB_PORT=5432
LOCAL_DOMAIN=beispiel.social
SECRET_KEY_BASE=12ab..
OTP_SECRET=34ef..
VAPID_PRIVATE_KEY=ABCD..
VAPID_PUBLIC_KEY=EFGH..
DEFAULT_LOCALE=de
SMTP_SERVER=localhost
SMTP_PORT=25
SMTP_FROM_ADDRESS=notifications@beispiel.social
SMTP_AUTH_METHOD=none
SMTP_OPENSSL_VERIFY_MODE=none
STREAMING_CLUSTER_NUM=1

Die Zufallswerte für die Variablen SECRET_KEY_BASE und OTP_SECRET erzeugt man durch zwei Aufrufe des Kommandos

RAILS_ENV=production bundle exec rake secret

Die Werte für VAPID_PRIVATE_KEY und VAPID_PUBLIC_KEY erzeugt das Kommando

RAILS_ENV=production bundle exec rake mastodon:webpush:generate_vapid_key

Initialisieren der Datenbank:

export SAFETY_ASSURED=1
RAILS_ENV=production bundle exec rails db:schema:load
RAILS_ENV=production bundle exec rails db:seed

Erzeugen der Web-Resourcen

yarn set version classic
RAILS_ENV=production bundle exec rails assets:precompile

Starten der Dienste

Zum Start aller notwendigen Dienste wird in dieser Anleitung systemctl benutzt.

Die Datei ~/.config/systemd/user/redis.service kann so aussehen:

[Unit]
Description=Redis User Service

[Service]
WorkingDirectory=%h/var/redis
Environment="PATH=/usr/local/bin:/usr/bin:/bin"
ExecStart=/usr/bin/redis-server %h/etc/redis.conf
Restart=always
PrivateTmp=true
NoNewPrivileges=true

[Install]
WantedBy=default.target

Die Datei ~/.config/systemd/user/puma.service kann so aussehen:

[Unit]
Description=Mastodon Web Service Puma
After=redis.service

[Service]
WorkingDirectory=%h/live
Environment="RAILS_ENV=production"
ExecStart=%h/.rbenv/shims/bundle exec puma -C config/puma.rb -e production -b tcp://127.0.0.1:32003
StandardError=append:%h/var/log/puma.log
StandardOutput=append:%h/var/log/puma.log
Restart=always
PrivateTmp=true
NoNewPrivileges=true

[Install]
WantedBy=default.target

Die Datei ~/.config/systemd/user/sidekiq.service kann so aussehen:

[Unit]
Description=Mastodon Sidekiq Service
After=redis.service

[Service]
WorkingDirectory=%h/live
Environment="RAILS_ENV=production"
Environment="DB_POOL=5"
ExecStart=%h/.rbenv/shims/bundle exec sidekiq -c 5 -q default -q mailers -q pull -q push -q scheduler
StandardError=append:%h/var/log/sidekiq.log
StandardOutput=append:%h/var/log/sidekiq.log
Restart=always
PrivateTmp=true
NoNewPrivileges=true

[Install]
WantedBy=default.target

Die Datei ~/.config/systemd/user/streaming.service kann so aussehen:

[Unit]
Description=Mastodon Streaming Service
After=redis.service

[Service]
WorkingDirectory=%h/live
Environment="NVM_DIR=%h/.nvm"
Environment="NVM_BIN=%h/.nvm/versions/node/v20.14.0/bin"
Environment="NODE_ENV=production"
Environment="PORT=32004"
Environment="BIND=127.0.0.1"

ExecStart=%h/.nvm/versions/node/v20.14.0/bin/node streaming/index.js
StandardError=append:%h/var/log/streaming.log
StandardOutput=append:%h/var/log/streaming.log
Restart=always
PrivateTmp=true
NoNewPrivileges=true

[Install]
WantedBy=default.target

Die Dienste werden dann aktiviert und gestartet:

systemctl --user enable redis --now
systemctl --user enable puma --now
systemctl --user enable streaming --now
systemctl --user enable sidekiq --now

Einrichten des Apache VHost

   cd ~/doms/beispiel.social
   rm -rf htdocs-ssl subs/www subs-ssl/www
   ln -s ~/live/public htdocs-ssl
   touch htdocs-ssl/.htaccess

Dann die htdocs-ssl/.htaccess mit dem Editor der Wahl öffnen und folgende Konfiguration einfügen:

DirectoryIndex disabled
RewriteEngine On
RewriteBase /
RewriteCond %{REQUEST_URI}  ^/api/v1/streaming    [NC]
RewriteRule .* ws://localhost:32004%{REQUEST_URI}  [proxy]
RequestHeader set X-Forwarded-Proto "https"
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-l
RewriteRule .* http://localhost:32003%{REQUEST_URI} [proxy]
RequestHeader set X-Forwarded-Proto "https"

Systemd Timer

Mit einem systemd Timer werden alte Ressourcen aufgeräumt.

~/.config/systemd/user/mastodon_cleanup.env

HOME=/home/pacs/xyz00/users/mastodon
MAILTO=mastodon@beispiel.social
RAILS_ENV=production
NUM_DAYS=31

~/.config/systemd/user/mastodon_cleanup.service

[Unit]
Description=fetch mail from remote server

[Service]
EnvironmentFile=/home/pacs/xyz00/users/mastodon/.config/systemd/user/mastodon_cleanup.env
WoringDirectory=/home/pacs/xyz00/users/mastodon/live
Type=oneshot
ExecStart=/home/pacs/xyz00/users/mastodon/live/bin/tootctl media remove

~/.config/systemd/user/mastodon_cleanup.timer

[Unit]
Description=fetch mail every five minutes

[Timer]
OnCalendar=4:18
Persistent=True

[Install]
WantedBy=timers.target

Timer aktivieren und starten:

$ systemctl --user enable mastodon_cleanup.timer
$ systemctl --user start mastodon_cleanupl.timer

Volltextsuche

In der installierten Version gibt es noch keine Volltextsuche. Es kann lediglich nach Nutzerkennungen und Hastags gesucht werden. Für die Volltextsuche kann optional Elasticsearch installiert werden.

• Elasticsearch bei Hostsharing
• https://docs.joinmastodon.org/admin/optional/elasticsearch/

Instanz einrichten

Nach der Installation kann man sich auf https://beispiel.social einen Benutzer einrichten.

Auf der Kommandozeile:

RAILS_ENV=production bin/tootctl accounts create \
  alice \
  --email alice@example.com \
  --confirmed \
  --role Admin

Weitere Einrichtung sollte vorgenommen werden, z.B. eine Beschreibung der Instanz hinterlegen, siehe https://docs.joinmastodon.org/admin/setup/

Mastodon Updates

siehe:

• https://github.com/tootsuite/mastodon/releases

(hier für das Update auf die Mastodon Version v4.2.9 mit Ruby 3.2.3)

Ruby

cd ~/.rbenv
git pull
cd ~/.rbenv/plugins/ruby-build
git pull
cd
rbenv install -l
rbenv install 3.2.3
rbenv global 3.2.3

Mastodon

cd ~/mastodon/live
git fetch
git checkout v4.2.9
gem update --system
bundle install
yarn install
RAILS_ENV=production bundle exec rails db:migrate
yarn set version classic
RAILS_ENV=production bundle exec rails assets:precompile

Restart Mastodon!

Links

• Offizielle Webseite von Mastodon
• im Archiv: https://github.com/mastodon/documentation/blob/archive/Running-Mastodon/Production-guide.md
• aktuell: https://docs.joinmastodon.org/admin/install/
• https://krinetzki.de/2017/04/installation-von-mastodon-auf-debian-8-jessie/
• Ansible Playbook für Hostsharing