# Soapbox for YunoHost
[![Integration level](https://dash.yunohost.org/integration/soapbox.svg)](https://dash.yunohost.org/appci/app/soapbox) ![Working status](https://ci-apps.yunohost.org/ci/badges/soapbox.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/soapbox.maintain.svg)
[![Install Soapbox with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=soapbox)
*[Lire ce readme en français.](./README_fr.md)*
> *This package allows you to install Soapbox quickly and simply on a YunoHost server.
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview
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.
**Shipped version:** 3.0.0~ynh1
## Screenshots
![Screenshot of Soapbox](./doc/screenshots/screenshot.jpg)
## Disclaimers / important information
### Important points to read before installing
- [Pleroma (YunoHost ver.)](https://github.com/YunoHost-Apps/pleroma_ynh) must be installed locally before you install SoapboxFE
- SoapboxFE must be installed under a Pleroma domain (i.e soapboxfe.your-pleroma-instance-domain.net)
- AdminFE under SoapboxFE returns 404
Using screen in case of disconnects
```
sudo apt-get install screen
screen
sudo yunohost app install https://github.com/YunoHost-Apps/soapbox_ynh.git
```
Recover after disconnect:
```
screen -d
screen -r
```
## Documentation and resources
* Official app website:
* Official admin documentation:
* Upstream app code repository:
* YunoHost documentation for this app:
* Report a bug:
## Developer info
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/soapbox_ynh/tree/testing).
To try the testing branch, please proceed like that.
``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/soapbox_ynh/tree/testing --debug
or
sudo yunohost app upgrade soapbox -u https://github.com/YunoHost-Apps/soapbox_ynh/tree/testing --debug
```
**More info regarding app packaging:**