From fb17e59d77224bea4c30b5324b6aeac6e2210c8a Mon Sep 17 00:00:00 2001 From: Alex Gleason Date: Tue, 10 May 2022 15:55:26 -0500 Subject: [PATCH] Add Mastodon installation docs --- docs/administration/mastodon.md | 35 +++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 docs/administration/mastodon.md diff --git a/docs/administration/mastodon.md b/docs/administration/mastodon.md new file mode 100644 index 000000000..d8261d9de --- /dev/null +++ b/docs/administration/mastodon.md @@ -0,0 +1,35 @@ +# Installing Soapbox over Mastodon + +It is possible to run Soapbox as your main frontend on top of Mastodon. +This will replace the homepage and all static pages with Soapbox, using Mastodon only as the API. + +To do so, shell into your server and unpack Soapbox: + +```sh +mkdir -p /opt/soapbox + +curl -L https://gitlab.com/soapbox-pub/soapbox-fe/-/jobs/artifacts/develop/download?job=build-production -o soapbox-fe.zip + +busybox unzip soapbox-fe.zip -o -d /opt/soapbox +``` + +Now create an Nginx file for Soapbox with Mastodon. +If you already have one, replace it: + +```sh +curl https://gitlab.com/soapbox-pub/soapbox-fe/-/raw/develop/installation/mastodon.conf > /etc/nginx/sites-available/mastodon +``` + +Edit this file and replace all occurrences of `example.com` with your domain name. +Uncomment the SSL lines if you've enabled SSL, otherwise do that first. + +Finally, ensure the file is symlinked, then restart Nginx: + +```sh +ln -s /etc/nginx/sites-available/mastodon /etc/nginx/sites-enabled/mastodon + +systemctl restart nginx +``` + +If all is well, hopefully this worked! +If not, run `nginx -t` to see if anything is amiss, and try reviewing Mastodon's [install guide](https://docs.joinmastodon.org/admin/install/).