selfhost.directory

The index of self-hostable projects — ranked, categorized and served with live updates.
Own your data and stop giving it to big tech.

GitLab

Self-host Soapbox

v3.2.0

White-label Fediverse frontend for Mastodon API servers

ReleaseOpen Sourceagpl-3.0
Updatedlast month
Setup difficultyModerate
Install with Build from Source

What is Soapbox?

Soapbox FE is the browser client you serve from your own Fediverse server: it speaks the Mastodon API, so it can front Mastodon, Pleroma, Akkoma, GoToSocial and other compatible backends, and it can also be pointed at any such domain straight from the browser. Its design goal is white-labelling, meaning visitors see your site's name and logo rather than the client's own brand, supported by an admin configuration screen, logo and theme settings, and built-in moderation tooling. Deploying it means unpacking a static build onto your web server, either into a Pleroma instance's static directory or behind Nginx in front of Mastodon, where the backend is used only as an API. Compile-time options cover a custom/ directory, environment variables such as BACKEND_URL and FE_SUBDIRECTORY, per-build feature toggles, locale message overrides and custom HTML about pages. Because the frontend knows nothing about the backend, plain static hosting loses link previews, which the maintainers solve with a companion Cloudflare Worker project. The code is AGPL-3.0 and credits its lineage from Gab Social's and Mastodon's frontends. Development attention has moved to Ditto, the successor project; Soapbox FE remains available as a classic Fediverse frontend, with its most recent tagged release at v3.2.0.

Soapbox alternatives

Should you self-host Soapbox?

Soapbox scores 58/100 on selfhost.directory (how scoring works) and ranks #26 of 75 in Social Networks & Forums.

There was no stable release in the past 12 months, so check the repository's recent activity before you rely on it.

Setup is moderate: expect some configuration beyond a single command. It is agpl-3.0-licensed.

Its closest alternative on selfhost.directory is Mastodon (84/100, 50 557 stars). It scores higher overall, so compare the two before you pick. See Soapbox vs Mastodon side by side.

Features

  • Admin configuration UI
  • Automatic OAuth app registration
  • Custom about pages
  • Custom head snippets
  • Custom site branding
  • External client mode
  • Locale message overrides
  • Moderation tools
  • Per-build feature toggles
  • Static-file hosting

How to install Soapbox

Install Soapbox with Build from Source

Environment variables
NODE_ENV, BACKEND_URL, FE_SUBDIRECTORY, SENTRY_DSN

curl -O https://dl.soapbox.pub/main/soapbox.zip

busybox unzip soapbox.zip -o -d /opt/soapbox

The main part of the URL can be replaced with any git ref, eg v2.0.0. Custom builds are usually produced by forking on GitLab and letting GitLab CI build them.

How to configure Soapbox

  • NODE_ENVdevelopmentEnvironment to compile the Soapbox build for; production mode is recommended for live sites.

    values: "production" | "development" | "test"

  • BACKEND_URLBase URL for API calls; only needed when Soapbox is hosted somewhere other than the backend.

    values: Absolute URL (eg "https://gleasonator.com") or empty string

  • FE_SUBDIRECTORY/Subdirectory to host Soapbox out of; sets index.html imports and the React route basename.

    values: Any path, eg "/soapbox" or "/fe/soapbox"

  • SENTRY_DSNSentry (or GlitchTip) endpoint for error monitoring in this custom build; does nothing when unset.

    values: Endpoint URL

  • custom/features.jsonOptional build file to disable version-checking and force individual features on or off.

    values: JSON object of feature booleans, eg {"bookmarks": false, "lists": false, "quotePosts": true}

More in Social Networks & Forums

Rate this project

Click to rate — no account needed.

0 comments

Posting as guest
Loading comments…