diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/DESCRIPTION.md | 1 | ||||
| -rw-r--r-- | doc/DESCRIPTION_fr.md | 1 | ||||
| -rw-r--r-- | doc/DISCLAIMER.md | 38 | ||||
| -rw-r--r-- | doc/DISCLAIMER_fr.md | 47 | ||||
| -rw-r--r-- | doc/screenshots/mastodon.png | bin | 0 -> 249637 bytes |
5 files changed, 87 insertions, 0 deletions
diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md new file mode 100644 index 0000000..72981f6 --- /dev/null +++ b/doc/DESCRIPTION.md @@ -0,0 +1 @@ +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.
\ No newline at end of file diff --git a/doc/DESCRIPTION_fr.md b/doc/DESCRIPTION_fr.md new file mode 100644 index 0000000..bb225b2 --- /dev/null +++ b/doc/DESCRIPTION_fr.md @@ -0,0 +1 @@ +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. diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md new file mode 100644 index 0000000..7966fa5 --- /dev/null +++ b/doc/DISCLAIMER.md @@ -0,0 +1,38 @@ +## 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. + +## Configuration + +### Install + +#### Using *screen* in case of disconnect +``` +$ 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 +``` + +### Update + +#### Using *screen* highly recommended + +`$ sudo yunohost app upgrade mastodon -u https://github.com/YunoHost-Apps/mastodon_ynh --debug ` + +### Administrate with tooctl + +`$ (cd /var/www/mastodon/live && sudo -u mastodon RAILS_ENV=production PATH=/opt/rbenv/versions/mastodon/bin bin/tootctl --help)` + +## YunoHost specific features + +#### Multi-users support + +LDAP authentication is activated. All YunoHost users can authenticate. diff --git a/doc/DISCLAIMER_fr.md b/doc/DISCLAIMER_fr.md new file mode 100644 index 0000000..9218cd3 --- /dev/null +++ b/doc/DISCLAIMER_fr.md @@ -0,0 +1,47 @@ +## 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 + + + +## 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 tooctl + +`$ (cd /var/www/mastodon/live && sudo -u mastodon RAILS_ENV=production PATH=/opt/rbenv/versions/mastodon/bin bin/tootctl --help)` + +## Documentation + + * Documentation officielle : https://docs.joinmastodon.org/ + +## Caractéristiques spécifiques YunoHost + +#### Support multi-utilisateur + +L'authentification LDAP est activée. Tous les utilisateurs YunoHost peuvent s'authentifier. diff --git a/doc/screenshots/mastodon.png b/doc/screenshots/mastodon.png Binary files differnew file mode 100644 index 0000000..f248fd5 --- /dev/null +++ b/doc/screenshots/mastodon.png |
