2017-04-08 02:04:27 +00:00
# Mastodon for YunoHost
2021-02-17 18:22:07 +00:00
[](https://dash.yunohost.org/appci/app/mastodon)  
2021-01-09 15:21:48 +00:00
[](https://install-app.yunohost.org/?app=mastodon)
2019-03-18 03:22:38 +00:00
2019-05-30 08:37:28 +00:00
*[Lire ce readme en français.](./README_fr.md)*
2019-03-18 03:22:38 +00:00
2021-02-17 18:22:07 +00:00
> *This package allows you to install Mastodon 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.*
2019-03-18 03:22:38 +00:00
## Overview
2020-06-10 07:44:17 +00:00
Mastodon is a free, open-source microblogging social network. It is a decentralized alternative to commercial platforms like Twitter and avoids the risks of a single company monopolizing your communication for commercial purposes.
2017-04-08 02:04:27 +00:00
2021-01-06 00:46:32 +00:00
**Shipped version:** 3.3.0
2017-04-16 14:33:17 +00:00
2019-07-14 16:43:25 +00:00
## Important points to read before installing
1. **Mastodon** require a dedicated **root domain** , eg. mastodon.domain.tld
1. The user choosen during the installation is automatically created in Mastodon with admin rights
1. At the end of the installation a mail is sent to the user with the automatically generated password
1. It seems important to close the inscriptions for your Mastodon, so that it remains a private body. We invite you to block remote malicious instances from the administration interface. You can also add text on your home page.
2019-03-18 03:22:38 +00:00
## Screenshots
2017-04-08 02:04:27 +00:00
2019-03-18 03:22:38 +00:00
2017-04-08 02:04:27 +00:00
2019-03-18 03:22:38 +00:00
## Configuration
2017-04-16 14:08:42 +00:00
2019-07-14 16:17:03 +00:00
### Install
2020-06-10 07:44:17 +00:00
#### Using *screen* in case of disconnect
2017-06-07 18:42:42 +00:00
```
$ sudo apt-get install screen
$ screen
$ sudo yunohost app install https://github.com/YunoHost-Apps/mastodon_ynh.git
```
Recover after disconnect:
```
$ screen -d
$ screen -r
```
2017-05-07 20:23:01 +00:00
2017-04-08 02:04:27 +00:00
### Update
2019-07-14 16:17:03 +00:00
2020-06-10 07:44:17 +00:00
#### Using *screen* highly recommended
2017-04-08 02:04:27 +00:00
2019-06-13 19:09:36 +00:00
`$ sudo yunohost app upgrade mastodon -u https://github.com/YunoHost-Apps/mastodon_ynh --debug `
2017-04-16 14:08:42 +00:00
2019-03-18 03:22:38 +00:00
## Documentation
* Official documentation: https://docs.joinmastodon.org/
## YunoHost specific features
2019-08-03 22:50:29 +00:00
#### Multi-users support
2020-04-08 17:54:53 +00:00
LDAP authentication is activated. All YunoHost users can authenticate.
2019-08-03 22:50:29 +00:00
2019-03-18 03:22:38 +00:00
#### Supported architectures
2020-06-10 07:44:17 +00:00
* x86-64 - [](https://ci-apps.yunohost.org/ci/apps/mastodon/)
2019-05-10 09:40:40 +00:00
* ARMv8-A - [](https://ci-apps-arm.yunohost.org/ci/apps/mastodon/)
2019-03-18 03:22:38 +00:00
## Links
* Report a bug: https://github.com/YunoHost-Apps/mastodon_ynh/issues
2019-03-18 03:26:32 +00:00
* App website: https://joinmastodon.org/
2019-05-10 09:43:31 +00:00
* Upstream app repository: https://github.com/tootsuite/mastodon
2019-03-18 03:22:38 +00:00
* YunoHost website: https://yunohost.org/
---
2021-02-17 18:22:07 +00:00
## Developer info
2019-03-18 03:22:38 +00:00
2021-02-17 18:22:07 +00:00
Please send your pull request to the [testing branch ](https://github.com/YunoHost-Apps/mastodon_ynh/tree/testing ).
2019-03-18 03:22:38 +00:00
To try the testing branch, please proceed like that.
```
sudo yunohost app install https://github.com/YunoHost-Apps/mastodon_ynh/tree/testing --debug
or
sudo yunohost app upgrade mastodon -u https://github.com/YunoHost-Apps/mastodon_ynh/tree/testing --debug
```
