2022-08-29 16:20:56 +00:00
2020-05-24 13:57:41 +00:00
2022-12-18 22:59:55 +00:00
**Soapbox** is customizable open-source software that puts the power of social media in the hands of the people. Feature-rich and hyper-focused on providing a user experience to rival Big Tech, Soapbox is already home to some of the biggest alternative social platforms.
2020-04-21 18:34:18 +00:00
2022-12-18 22:59:55 +00:00
# On The Fediverse
2020-04-21 18:34:18 +00:00
2022-12-18 22:59:55 +00:00
You may have heard of **Mastodon** . Soapbox builds upon what Mastodon made great to make something even better.
2020-04-21 18:34:18 +00:00
2022-12-18 22:59:55 +00:00
You can run **Mastodon+Soapbox** , **Rebased+Soapbox** , and more.
2020-04-21 18:34:18 +00:00
2022-12-18 22:59:55 +00:00
Soapbox is the **frontend** (what users see) while Mastodon is the **backend** (data, APIs). You can mix-and-match in the Fediverse ecosystem.
2020-04-21 18:34:18 +00:00
2022-12-18 22:59:55 +00:00
> 💡 If you're starting a new server, we highly recommend **Rebased+Soapbox**. Rebased is our custom-built backend just for Soapbox, providing important new features such as **quote posting** and **chats**.
>
> See: [Installing Rebased+Soapbox](https://soapbox.pub/install/)
2020-04-21 18:34:18 +00:00
2022-12-18 22:59:55 +00:00
# Try It Out
2020-04-21 18:34:18 +00:00
2022-12-18 22:59:55 +00:00
Want to give Soapbox a shot? Here are some suggested servers:
2020-04-14 17:30:26 +00:00
2022-12-18 22:59:55 +00:00
- [gleasonator.com ](https://gleasonator.com/ ) - operated by the lead developer of Soapbox
- [social.teci.world ](https://social.teci.world/ ) - free speech server run by a Soapbox contributor
- [spinster.xyz ](https://spinster.xyz/ ) - one of the largest feminist communities on the internet
- [poa.st ](https://poa.st/ ) - the largest Soapbox server on the network
2020-04-26 17:49:20 +00:00
2022-12-18 22:59:55 +00:00
Want to use Soapbox against **any existing Mastodon/Pleroma server?** Try:
2020-04-14 17:30:26 +00:00
2022-12-18 22:59:55 +00:00
- [fe.soapbox.pub ](https://fe.soapbox.pub ) - enter your server's domain name to use Soapbox on any server!
2022-12-17 03:05:47 +00:00
2022-12-18 22:59:55 +00:00
# 🚀 Starting Your Own Server
2020-04-14 21:50:42 +00:00
2022-12-18 22:59:55 +00:00
Starting your own server is one of the best ways to have freedom online! We recommend installing **Rebased+Soapbox** .
2022-12-17 03:05:47 +00:00
2022-12-18 22:59:55 +00:00
See here for a detailed setup guide: [Installing Rebased+Soapbox ](https://soapbox.pub/install/ )
2020-04-14 17:30:26 +00:00
2022-12-18 22:59:55 +00:00
# Adding Soapbox to an Existing Server
2022-12-17 03:05:47 +00:00
2022-12-18 22:59:55 +00:00
Already have a server? No problem — it is still possible to use Soapbox.
2020-04-14 17:30:26 +00:00
2022-12-18 22:59:55 +00:00
- [Deploying on Pleroma ](https://docs.soapbox.pub/frontend/installing/#install-soapbox )
- [Deploying on Mastodon ](https://docs.soapbox.pub/frontend/administration/mastodon/ )
2022-12-17 03:05:47 +00:00
2022-12-18 22:59:55 +00:00
> 💡 If using Pleroma, it's recommended to [upgrade it to Rebased](https://gitlab.com/-/snippets/2411739). This comes with better support and many new features, helping you get the most out of Soapbox.
2020-04-14 17:30:26 +00:00
2022-12-18 22:59:55 +00:00
# Developing Soapbox
2020-04-14 17:30:26 +00:00
2022-12-18 22:59:55 +00:00
tl;dr — `git clone` , `yarn` , and `yarn dev` .
2020-04-14 17:30:26 +00:00
2022-12-18 22:59:55 +00:00
For detailed guides, see these pages:
2020-04-14 17:30:26 +00:00
2022-12-18 22:59:55 +00:00
1. [Soapbox local development ](https://docs.soapbox.pub/frontend/development/running-locally/ )
2. [yarn commands ](https://docs.soapbox.pub/frontend/development/yarn-commands/ )
3. [How it works ](https://docs.soapbox.pub/frontend/development/how-it-works/ )
4. [Environment variables ](https://docs.soapbox.pub/frontend/development/local-config/ )
5. [Developing a backend ](https://docs.soapbox.pub/frontend/development/developing-backend/ )
2020-04-14 17:30:26 +00:00
2022-12-18 22:59:55 +00:00
## Contributing
2020-05-01 20:12:02 +00:00
2022-07-18 16:48:55 +00:00
We welcome contributions to this project.
To contribute, see [Contributing to Soapbox ](docs/contributing.md ).
2020-05-01 20:12:02 +00:00
2022-12-18 22:59:55 +00:00
Translators can help by providing [translations through Weblate ](https://hosted.weblate.org/projects/soapbox-pub/soapbox/ ).
2022-12-17 03:05:47 +00:00
Native speakers from all around the world are welcome!
2022-12-18 22:59:55 +00:00
# Project Philosophy
2020-05-01 20:12:02 +00:00
2022-12-18 22:59:55 +00:00
Soapbox was born out of the need to build independent platforms with **a unique identity and brand** .
2022-07-18 17:12:50 +00:00
2022-12-18 22:59:55 +00:00
This is in contrast to Mastodon's idea, where all servers are called "Mastodon" and use the Mastodon colors and logo. Users won't see the word "Soapbox" throughout the UI, they'll see the name of **your website** and your logo. To facilitate this, Soapbox has a robust customization UI and integrated moderation tools. Large servers are a priority.
2022-07-18 17:12:50 +00:00
2022-12-18 22:59:55 +00:00
One disadvantage of this approach is that it does not help the software spread. Some of the biggest servers on the network and running Soapbox and people don't even know it!
2020-05-01 20:12:02 +00:00
2020-06-10 18:32:03 +00:00
# License & Credits
2022-12-18 23:14:34 +00:00
© Alex Gleason & other Soapbox contributors
© Eugen Rochko & other Mastodon contributors
2022-12-23 00:32:55 +00:00
© Trump Media & Technology Group
2022-12-18 23:14:34 +00:00
© Gab AI, Inc.
2020-09-18 04:10:58 +00:00
2022-08-29 16:20:56 +00:00
Soapbox is free software: you can redistribute it and/or modify
2020-03-28 21:06:29 +00:00
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
2022-08-29 16:20:56 +00:00
Soapbox is distributed in the hope that it will be useful,
2020-03-28 21:06:29 +00:00
but WITHOUT ANY WARRANTY; without even the implied warranty of
2022-12-17 03:05:47 +00:00
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
2020-03-28 21:06:29 +00:00
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
2022-12-17 03:05:47 +00:00
along with Soapbox. If not, see < https: / / www . gnu . org / licenses / > .
