diff options
| -rw-r--r-- | README.md | 24 | ||||
| -rw-r--r-- | README_fr.md | 24 |
2 files changed, 20 insertions, 28 deletions
@@ -8,10 +8,6 @@ > *This package allow you to install Mastodon quickly and simply on a YunoHost server. If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.* -:warning: UPDATE 05/06/17 :This app can work now on ARM, but installation takes several hours and you must add a swapfile of 1GB. - -:warning: This application uses the Debian backports packages, do not install this application directly in production - ## Overview Mastodon is a free, open-source social network. A decentralized alternative to commercial platforms, it avoids the risks of a single company monopolizing your communication. Pick a server that you trust — whichever you choose, you can interact with everyone else. Anyone can run their own Mastodon instance and participate in the social network seamlessly. @@ -25,6 +21,15 @@ Mastodon is a free, open-source social network. A decentralized alternative to c ## Configuration +### Install + +#### 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. + #### Adding "swapfile" If you have less than 2Go of RAM ``` sudo dd if=/dev/zero of=/swapfile bs=1024 count=1024000 @@ -37,7 +42,6 @@ add this line on /etc/fstab /swapfile none swap sw 0 0 ``` -### Install #### Using __screen__ in case of disconnect ``` $ sudo apt-get install screen @@ -49,19 +53,12 @@ Recover after disconnect: $ screen -d $ screen -r ``` -The admin user is automatically created as: user@domain.tld - ### Update + #### Using __screen__ highly recommended `$ sudo yunohost app upgrade mastodon -u https://github.com/YunoHost-Apps/mastodon_ynh --debug ` -## Recommendation - -You can't install Mastodon in subdirectory, you must use a domain or subdomain for this application. - -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. - ## Documentation * Official documentation: https://docs.joinmastodon.org/ @@ -86,7 +83,6 @@ It seems important to close the inscriptions for your Mastodon, so that it remai Developers info ---------------- -**Only if you want to use a testing branch for coding, instead of merging directly into master.** Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/mastodon_ynh/tree/testing). To try the testing branch, please proceed like that. diff --git a/README_fr.md b/README_fr.md index 8dfda3d..2c0387b 100644 --- a/README_fr.md +++ b/README_fr.md @@ -8,10 +8,6 @@ > *Ce package vous permet d'installer Mastodon rapidement et simplement sur un serveur Yunohost. Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.* -:warning: MAJ 05/06/17 :Cette application peut maintenant fonctionner sur ARM, mais l'installation prend plusieurs heures et il faut ajouter un swapfile de 1Go. - -:warning: Cette application utilise les packages backports de Debian, nous vous recommendons de ne pas installer cette application directement en production - ## Vue d'ensemble Mastodon est un réseau social gratuit et open source. Une alternative décentralisée aux plates-formes commerciales, elle évite les risques d'une seule société qui monopolise votre communication. Choisissez un serveur sur lequel vous faites confiance - selon votre choix, vous pouvez interagir avec tous les autres. N'importe qui peut exécuter sa propre instance de Mastodon et participer au réseau social de façon transparente. @@ -23,6 +19,15 @@ Mastodon est un réseau social gratuit et open source. Une alternative décentra ## Configuration +### Installation + +#### Points important à 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. A la fin de l'installation, un mail est envoyé à cet utilisateur avec le mot de passe qui a été généré automatiquement. +1. Il semble important de fermer les inscriptions pour votre Mastodon, pour que ça reste une instance privé. Nous vous invitons à bloquer les instances distantes malfaisantes depuis l'interface d'administration. Vous pouvez également ajouter un texte sur votre page d'accueil dans l'administration. + #### Ajout d'un "swapfile" si vous avez moins de 2Go de RAM ``` sudo dd if=/dev/zero of=/swapfile bs=1024 count=1024000 @@ -34,9 +39,6 @@ ajouter cette ligne dans /etc/fstab ``` /swapfile none swap sw 0 0 ``` - -### Installation - #### Utilisation de __screen__ en cas de déconnection ``` $ sudo apt-get install screen @@ -51,16 +53,11 @@ $ screen -r L'utilisateur admin est crée automatiquement comme: user@domain.tld ### Mise à jour + #### Utilisation de __screen__ fortement recommandé `$ sudo yunohost app upgrade mastodon -u https://github.com/YunoHost-Apps/mastodon_ynh --debug ` -## Recommandations - -Vous ne pouvez pas installer Mastodon en subdirectory, vous devez obligatoirement utiliser un domaine ou un sous-domaine pour cette application. - -Il semble important de fermer les inscriptions pour votre Mastodon, pour que ça reste une instance privé. Nous vous invitons à bloquer les instances distantes malfaisantes depuis l'interface d'administration. Vous pouvez également ajouter un texte sur votre page d'accueil dans l'administration. - ## Documentation * Documentation officielle: https://docs.joinmastodon.org/ @@ -85,7 +82,6 @@ Il semble important de fermer les inscriptions pour votre Mastodon, pour que à Informations pour les développeurs ---------------- -**Seulement si vous voulez utiliser une branche de test pour le codage, au lieu de fusionner directement dans la banche principale.** 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. |