mirror of
https://github.com/YunoHost-Apps/mastodon_ynh.git
synced 2024-09-03 19:46:02 +02:00
98 lines
4.1 KiB
Markdown
98 lines
4.1 KiB
Markdown
<!--
|
||
Nota bene : ce README est automatiquement généré par <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
|
||
Il NE doit PAS être modifié à la main.
|
||
-->
|
||
|
||
# Mastodon pour YunoHost
|
||
|
||
[![Niveau d’intégration](https://dash.yunohost.org/integration/mastodon.svg)](https://dash.yunohost.org/appci/app/mastodon) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/mastodon.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/mastodon.maintain.svg)
|
||
|
||
[![Installer Mastodon avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=mastodon)
|
||
|
||
*[Lire le README dans d'autres langues.](./ALL_README.md)*
|
||
|
||
> *Ce package vous permet d’installer Mastodon rapidement et simplement sur un serveur YunoHost.*
|
||
> *Si vous n’avez pas YunoHost, consultez [ce guide](https://yunohost.org/install) pour savoir comment l’installer et en profiter.*
|
||
|
||
## Vue d’ensemble
|
||
|
||
Mastodon est un réseau social de microblog auto-hébergé et open source. C'est une alternative décentralisée aux plates-formes commerciales comme Twitter. Mastodon évite ainsi les risques qu'une seule société monopolise votre communication à des fins commerciales.
|
||
|
||
|
||
**Version incluse :** 4.2.8~ynh1
|
||
|
||
**Démo :** <https://joinmastodon.org/>
|
||
|
||
## Captures d’écran
|
||
|
||
![Capture d’écran de Mastodon](./doc/screenshots/mastodon.png)
|
||
|
||
## Avertissements / informations importantes
|
||
|
||
## Points importants à lire avant l'installation
|
||
|
||
1. **Mastodon** nécessite un **nom de domaine** dédié, par exemple : mastodon.domain.tld
|
||
1. L'utilisateur sélectionné pendant l'installation sera créé automatiquement dans Mastodon avec des droits d'administration.
|
||
1. À la fin de l'installation, un mail est envoyé à cet utilisateur avec un mot de passe généré automatiquement.
|
||
1. Pour que votre instance Mastodon reste privée, il est important de fermer les inscriptions. Nous vous invitons à bloquer les instances distantes indésirables depuis l'interface d'administration. Vous pouvez également ajouter un texte sur votre page d'accueil dans l'administration.
|
||
|
||
## Captures d'écran
|
||
|
||
![](https://framalibre.org/sites/default/files/mastodon.png)
|
||
|
||
## Configuration
|
||
|
||
### Installation
|
||
|
||
#### Utilisation de *screen* en cas de déconnection
|
||
```
|
||
$ sudo apt-get install screen
|
||
$ screen
|
||
$ sudo yunohost app install https://github.com/YunoHost-Apps/mastodon_ynh.git
|
||
```
|
||
Récupérer l'installation après une deconnection :
|
||
```
|
||
$ screen -d
|
||
$ screen -r
|
||
```
|
||
L'utilisateur admin est créé automatiquement comme : user@domain.tld
|
||
|
||
### Mise à jour
|
||
|
||
#### Utilisation de *screen* fortement recommandée
|
||
|
||
`$ sudo yunohost app upgrade mastodon -u https://github.com/YunoHost-Apps/mastodon_ynh --debug `
|
||
|
||
### Administration avec tootctl
|
||
|
||
`$ (cd /var/www/mastodon/live && sudo -u mastodon RAILS_ENV=production PATH=/opt/rbenv/versions/mastodon/bin bin/tootctl --help)`
|
||
|
||
## Caractéristiques spécifiques YunoHost
|
||
|
||
#### Support multi-utilisateur
|
||
|
||
L'authentification LDAP est activée. Tous les utilisateurs YunoHost peuvent s'authentifier.
|
||
|
||
Se déconnecter depuis le portail YunoHost ne vous déconnecte pas de Mastodon. Voir https://github.com/YunoHost/issues/issues/501
|
||
|
||
## Documentations et ressources
|
||
|
||
- Site officiel de l’app : <https://joinmastodon.org/>
|
||
- Documentation officielle de l’admin : <https://docs.joinmastodon.org/>
|
||
- Dépôt de code officiel de l’app : <https://github.com/mastodon/mastodon>
|
||
- YunoHost Store : <https://apps.yunohost.org/app/mastodon>
|
||
- Signaler un bug : <https://github.com/YunoHost-Apps/mastodon_ynh/issues>
|
||
|
||
## Informations pour les développeurs
|
||
|
||
Merci de faire vos pull request sur la [branche `testing`](https://github.com/YunoHost-Apps/mastodon_ynh/tree/testing).
|
||
|
||
Pour essayer la branche `testing`, procédez comme suit :
|
||
|
||
```bash
|
||
sudo yunohost app install https://github.com/YunoHost-Apps/mastodon_ynh/tree/testing --debug
|
||
ou
|
||
sudo yunohost app upgrade mastodon -u https://github.com/YunoHost-Apps/mastodon_ynh/tree/testing --debug
|
||
```
|
||
|
||
**Plus d’infos sur le packaging d’applications :** <https://yunohost.org/packaging_apps>
|