From 0f0e6422d7790d17c23cd221c800b7599a6f4f1f Mon Sep 17 00:00:00 2001 From: yalh76 Date: Sun, 14 Jul 2019 18:17:03 +0200 Subject: Update README --- README.md | 24 ++++++++++-------------- 1 file changed, 10 insertions(+), 14 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 27dac5f..77011a1 100644 --- a/README.md +++ b/README.md @@ -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. -- cgit v1.2.3-70-g09d2 From d308718c4885d440e2b01aeec94941c8f5abd592 Mon Sep 17 00:00:00 2001 From: yalh76 Date: Sun, 14 Jul 2019 18:43:25 +0200 Subject: update README --- README.md | 14 +++++++------- README_fr.md | 14 +++++++------- 2 files changed, 14 insertions(+), 14 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 77011a1..6458570 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,13 @@ Mastodon is a free, open-source social network. A decentralized alternative to c **Shipped version:** 2.9.2 +## 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. + ## Screenshots ![](https://framalibre.org/sites/default/files/mastodon.png) @@ -23,13 +30,6 @@ Mastodon is a free, open-source social network. A decentralized alternative to c ### 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 diff --git a/README_fr.md b/README_fr.md index 2c0387b..803538f 100644 --- a/README_fr.md +++ b/README_fr.md @@ -13,6 +13,13 @@ Mastodon est un réseau social gratuit et open source. Une alternative décentra **Version incluse:** 2.9.2 +## 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. 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. + ## Captures d'écran ![](https://framalibre.org/sites/default/files/mastodon.png) @@ -21,13 +28,6 @@ Mastodon est un réseau social gratuit et open source. Une alternative décentra ### 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 -- cgit v1.2.3-70-g09d2