diff --git a/docs/administration/deploy-at-scale.md b/docs/administration/deploy-at-scale.md index 40e878a0a..4280a82b2 100644 --- a/docs/administration/deploy-at-scale.md +++ b/docs/administration/deploy-at-scale.md @@ -11,7 +11,7 @@ The best way to get Soapbox builds is from a GitLab CI job. The official build URL is here: ``` -https://gitlab.com/soapbox-pub/soapbox/-/jobs/artifacts/develop/download?job=build-production +https://dl.soapbox.pub/main/soapbox.zip ``` (Note that `develop` in that URL can be replaced with any git ref, eg `v2.0.0`, and thus will be updated with the latest zip whenever a new commit is pushed to `develop`.) @@ -44,7 +44,7 @@ location ~ ^/(api|oauth|admin) { } ``` -We recommend trying [`mastodon.conf`](https://gitlab.com/soapbox-pub/soapbox/-/blob/develop/installation/mastodon.conf) as a starting point. +We recommend trying [`mastodon.conf`](https://gitlab.com/soapbox-pub/soapbox/-/blob/main/installation/mastodon.conf) as a starting point. It is fine-tuned, includes support for federation, and should work with any backend. ## The ServiceWorker diff --git a/docs/administration/install-yunohost.md b/docs/administration/install-yunohost.md index 156547d9e..83a96d800 100644 --- a/docs/administration/install-yunohost.md +++ b/docs/administration/install-yunohost.md @@ -7,7 +7,7 @@ If you want to install Soapbox to a Pleroma instance installed using [YunoHost]( First, download the latest build of Soapbox from GitLab. ```sh -curl -L https://gitlab.com/soapbox-pub/soapbox/-/jobs/artifacts/develop/download?job=build-production -o soapbox-fe.zip +curl -O https://dl.soapbox.pub/main/soapbox.zip ``` ## 2. Unzip the build @@ -15,7 +15,7 @@ curl -L https://gitlab.com/soapbox-pub/soapbox/-/jobs/artifacts/develop/download Then, unzip the build to the Pleroma directory under YunoHost's directory: ```sh -busybox unzip soapbox-fe.zip -o -d /home/yunohost.app/pleroma/ +busybox unzip soapbox.zip -o -d /home/yunohost.app/pleroma/static ``` ## 3. Change YunoHost Admin Static directory diff --git a/docs/administration/mastodon.md b/docs/administration/mastodon.md index 345408ad1..8f0914461 100644 --- a/docs/administration/mastodon.md +++ b/docs/administration/mastodon.md @@ -8,16 +8,16 @@ To do so, shell into your server and unpack Soapbox: ```sh mkdir -p /opt/soapbox -curl -L https://gitlab.com/soapbox-pub/soapbox/-/jobs/artifacts/develop/download?job=build-production -o soapbox-fe.zip +curl -O https://dl.soapbox.pub/main/soapbox.zip -busybox unzip soapbox-fe.zip -o -d /opt/soapbox +busybox unzip soapbox.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/-/raw/develop/installation/mastodon.conf > /etc/nginx/sites-available/mastodon +curl https://gitlab.com/soapbox-pub/soapbox/-/raw/main/installation/mastodon.conf > /etc/nginx/sites-available/mastodon ``` Edit this file and replace all occurrences of `example.com` with your domain name. diff --git a/docs/administration/updating.md b/docs/administration/updating.md index 6e5252efa..21eb8ffa0 100644 --- a/docs/administration/updating.md +++ b/docs/administration/updating.md @@ -1,6 +1,6 @@ # Updating Soapbox -You should always check the [release notes/changelog](https://gitlab.com/soapbox-pub/soapbox/-/blob/develop/CHANGELOG.md) in case there are deprecations, special update changes, etc. +You should always check the [release notes/changelog](https://gitlab.com/soapbox-pub/soapbox/-/blob/main/CHANGELOG.md) in case there are deprecations, special update changes, etc. Besides that, it's relatively pretty easy to update Soapbox. There's two ways to go about it: with the command line or with an unofficial script. @@ -10,15 +10,10 @@ To update Soapbox via the command line, do the following: ``` # Download the build. -curl -L https://gitlab.com/soapbox-pub/soapbox/-/jobs/artifacts/develop/download?job=build-production -o soapbox-fe.zip - -# Remove all the current Soapbox build in Pleroma's instance directory. -rm -R /opt/pleroma/instance/static/packs -rm /opt/pleroma/instance/static/index.html -rm -R /opt/pleroma/instance/static/sounds +curl -O https://dl.soapbox.pub/main/soapbox.zip # Unzip the new build to Pleroma's instance directory. -busybox unzip soapbox-fe.zip -o -d /opt/pleroma/instance +busybox unzip soapbox.zip -o -d /opt/pleroma/instance/static ``` ## After updating Soapbox diff --git a/docs/contributing.md b/docs/contributing.md index bb59effc7..2d6aed726 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -15,7 +15,7 @@ When contributing to Soapbox, please first discuss the change you wish to make b When you push to a branch, the CI pipeline will run. -[Soapbox uses GitLab CI](https://gitlab.com/soapbox-pub/soapbox/-/blob/develop/.gitlab-ci.yml) to lint, run tests, and verify changes. +[Soapbox uses GitLab CI](https://gitlab.com/soapbox-pub/soapbox/-/blob/main/.gitlab-ci.yml) to lint, run tests, and verify changes. It's important this pipeline passes, otherwise we cannot merge the change. New users of gitlab.com may see a "detatched pipeline" error. @@ -31,4 +31,4 @@ We recommend developing Soapbox with [VSCodium](https://vscodium.com/) (or its p This will help give you feedback about your changes _in the editor itself_ before GitLab CI performs linting, etc. When this project is opened in Code it will automatically recommend extensions. -See [`.vscode/extensions.json`](https://gitlab.com/soapbox-pub/soapbox/-/blob/develop/.vscode/extensions.json) for the full list. +See [`.vscode/extensions.json`](https://gitlab.com/soapbox-pub/soapbox/-/blob/main/.vscode/extensions.json) for the full list. diff --git a/docs/development/developing-backend.md b/docs/development/developing-backend.md index 723a28002..ee8f5c56a 100644 --- a/docs/development/developing-backend.md +++ b/docs/development/developing-backend.md @@ -48,7 +48,7 @@ Typically checks are done against `BACKEND_NAME` and `VERSION`. The version string is similar in purpose to a [User-Agent](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/User-Agent) string. The format was first invented by Pleroma, but is now widely used, including by Pixelfed, Mitra, and Soapbox BE. -See [`features.ts`](https://gitlab.com/soapbox-pub/soapbox/-/blob/develop/app/soapbox/utils/features.ts) for the complete list of features. +See [`features.ts`](https://gitlab.com/soapbox-pub/soapbox/-/blob/main/app/soapbox/utils/features.ts) for the complete list of features. ## Forks of other software @@ -73,4 +73,4 @@ For Pleroma forks, the fork name should be in the compat section (eg Soapbox BE) ## Adding support for a new backend -If the backend conforms to the above format, please modify [`features.ts`](https://gitlab.com/soapbox-pub/soapbox/-/blob/develop/app/soapbox/utils/features.ts) and submit a merge request to enable features for your backend! +If the backend conforms to the above format, please modify [`features.ts`](https://gitlab.com/soapbox-pub/soapbox/-/blob/main/app/soapbox/utils/features.ts) and submit a merge request to enable features for your backend! diff --git a/docs/development/how-it-works.md b/docs/development/how-it-works.md index 52a326d8a..f8578d893 100644 --- a/docs/development/how-it-works.md +++ b/docs/development/how-it-works.md @@ -18,7 +18,7 @@ location / { } ``` -(See [`mastodon.conf`](https://gitlab.com/soapbox-pub/soapbox/-/blob/develop/installation/mastodon.conf) for a full example.) +(See [`mastodon.conf`](https://gitlab.com/soapbox-pub/soapbox/-/blob/main/installation/mastodon.conf) for a full example.) Soapbox incorporates much of the [Mastodon API](https://docs.joinmastodon.org/methods/), [Pleroma API](https://api.pleroma.social/), and more. It detects features supported by the backend to provide the right experience for the backend. diff --git a/docs/development/running-locally.md b/docs/development/running-locally.md index 7cd1164a6..08728ab75 100644 --- a/docs/development/running-locally.md +++ b/docs/development/running-locally.md @@ -40,5 +40,5 @@ Try again. ## Troubleshooting: it's not working! -Run `node -V` and compare your Node.js version with the version in [`.tool-versions`](https://gitlab.com/soapbox-pub/soapbox/-/blob/develop/.tool-versions). +Run `node -V` and compare your Node.js version with the version in [`.tool-versions`](https://gitlab.com/soapbox-pub/soapbox/-/blob/main/.tool-versions). If they don't match, try installing [asdf](https://asdf-vm.com/). diff --git a/docs/installing.md b/docs/installing.md index 37c9c36e5..c70448b70 100644 --- a/docs/installing.md +++ b/docs/installing.md @@ -10,9 +10,9 @@ First, follow the instructions to [install Pleroma](https://docs-develop.pleroma The Soapbox frontend is the main component of Soapbox. Once you've installed Pleroma, installing Soapbox is a breeze. -First, ssh into the server and download a .zip of the latest build: ``curl -L https://gitlab.com/soapbox-pub/soapbox/-/jobs/artifacts/develop/download?job=build-production -o soapbox-fe.zip`` +First, ssh into the server and download a .zip of the latest build: `curl -O https://dl.soapbox.pub/main/soapbox.zip` -Then unpack it into Pleroma's ``instance`` directory: ``busybox unzip soapbox-fe.zip -o -d /opt/pleroma/instance`` +Then unpack it into Pleroma's `instance` directory: `busybox unzip soapbox.zip -o -d /opt/pleroma/instance/static` **That's it! 🎉 Soapbox is installed.** The change will take effect immediately, just refresh your browser tab. It's not necessary to restart the Pleroma service. diff --git a/installation/mastodon.conf b/installation/mastodon.conf index 5a6d16b99..535a3b5ee 100644 --- a/installation/mastodon.conf +++ b/installation/mastodon.conf @@ -33,7 +33,7 @@ server { listen 80; listen [::]:80; server_name example.com; - root /opt/soapbox/static; + root /opt/soapbox; location /.well-known/acme-challenge/ { allow all; } location / { return 301 https://$host$request_uri; } } @@ -58,7 +58,7 @@ server { sendfile on; client_max_body_size 80m; - root /opt/soapbox/static; + root /opt/soapbox; gzip on; gzip_disable "msie6";