====== Mastodon ======

How to install Mastodon [[/ActivityPub|ActivityPub]] server on %%FreeBSD%%.

===== Installation Procedure =====

==== Install Dependencies ====

<code bash>
pkg install -y nginx acme.sh postgresql13-server mastodon
</code>

==== Configure Nginx Web Server ====

Add the following inside the ''%%http%%'' block of ''%%/usr/local/etc/nginx/nginx.conf%%''

<code nginx>
include /usr/local/www/mastodon/dist/nginx.conf;
</code>

Update Nginx configuration:

**Note**: The ''%%mastodon/dist/nginx.conf%%'' was originally provided by the ''%%www/mastodon%%'' package. It will need to be created.

<code bash>
sed -i '' -e 's/example.com/<YOUR DESIRED DOMAIN>/g' /usr/local/www/mastodon/dist/nginx.conf
</code>

Enable nginx on startup and start nginx:

<code bash>
sysrc nginx_enable="YES"
service nginx start
</code>

=== Configure SSL certificates with acme.sh ===

<code bash>
mkdir -p /usr/local/etc/ssl/<YOUR DESIRED DOMAIN>
acme.sh --issue --webroot /usr/local/www/mastodon/public -d <YOUR DESIRED DOMAIN>
acme.sh --install-cert -d <YOUR DESIRED DOMAIN> --cert-file /usr/local/etc/ssl/<YOUR DESIRED DOMAIN>/cert.pem --key-file /usr/local/etc/ssl/<YOUR DESIRED DOMAIN>/key.pem --ca-file /usr/local/etc/ssl/<YOUR DESIRED DOMAIN>/ca.pem --fullchain-file /usr/local/etc/ssl/<YOUR DESIRED DOMAIN>/fullchain.pem --reloadcmd 'service nginx restart'
</code>

==== Configure PostgreSQL DB Server ====
Enable postgresql on startup, initial databases and start postgresql:

<code bash>
sysrc postgresql_enable="YES"
service postgresql initdb
service postgresql start
</code>

Create a new role for the mastodon database:

<code bash>
su -l postgres -c 'createuser -d mastodon'
</code>

==== Configure Redis Server ====
Enable redis on startup and start redis:

<code bash>
sysrc redis_enable="YES"
service redis start
</code>

<callout type="info">
In case mastodon is run in a jail; ''%%protected-mode%%'' should be disabled in ''%%/usr/local/etc/redis.conf%%''
</callout>

==== Configure Mastodon ====

File permissions is an important factor for a working copy of Mastodon so let's switch to the dedicated ''%%mastodon%%'' user and run the installations:

<code bash>
su -l mastodon
cd
yarn set version classic
bundle config deployment 'true'
bundle config without 'development test'
bundle install -j$(getconf _NPROCESSORS_ONLN)
yarn install --pure-lockfile
</code>

On the next step let's install and configure the Mastodon system still as the ''%%mastodon%%'' user.

<callout type="info">
When asked for Postgresql instance it's better to use ''%%127.0.0.1%%'' rather than ''%%localhost%%'' or sockets.
</callout>

<code bash>
RAILS_ENV=production bundle exec rake mastodon:setup
</code>

Enable the services at startup and  start the services:

<code bash>
sysrc mastodon_sidekiq_enable=YES
sysrc mastodon_streaming_enable=YES
sysrc mastodon_web_enable=YES
service mastodon_sidekiq start
service mastodon_streaming start
service mastodon_web start
</code>

===== Upgrade Procedure - 4.0.2=>4.1.0 =====
==== Stop the services ====

<code bash>
service mastodon_sidekiq stop
service mastodon_streaming stop
service mastodon_web stop
</code>

==== Upgrade the packages ====

<code bash>
pkg upgrade -y
</code>

==== Upgrade the rubygems and assets ====

<code bash>
su -l mastodon
cd
bundle install -j$(getconf _NPROCESSORS_ONLN)
yarn install --pure-lockfile
RAILS_ENV=production bundle exec rails db:migrate
RAILS_ENV=production bundle exec rake tmp:cache:clear
RAILS_ENV=production bundle exec rails assets:precompile
exit
</code>

==== Restart the services ====

<code bash>
service -R
</code>

===== References & Resources =====

  * [[https://gist.github.com/jsm222/df6bb7c045859cf1972015e78ad4cc4b|Mastodon on FreeBSD Notes]] ([[/GitHub|GitHub]]: jsm222 ([[/JesperMouridsen|JesperMouridsen]]), 2022-11-29)
  * [[https://it-notes.dragas.net/2022/11/23/installing-mastodon-on-a-freebsd-jail/|Stefano Marinelli: Installing Mastodon inside a FreeBSD jail using BastilleBSD]] (it-notes.dragas.net, 2022-11-23)
  * [[https://github.com/ddowse/mastodon|BastilleBSD template to bootstrap Mastodon in a FreeBSD jail]] (github.com: ddowse, 2022-11-23)
  * [[https://blog.gegeweb.org/installer-mastodon-sous-freebsd-sans-le-port.html|Installer Mastodon sous FreeBSD (sans le port)]] (blog.gegeweb.org, French, 2018-06-17)

----

{{tag>HowTo Ports}}