aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authoryalh76 <yalh@yahoo.com>2019-08-04 19:24:56 +0200
committerGitHub <noreply@github.com>2019-08-04 19:24:56 +0200
commitf273be5f8d9d1d7f7e00e4226bddccb508e7af0d (patch)
tree9009f7849e9fd3bfe7c5729d96837787b05725cc /README.md
parent8dc3494bfef5b9d27b63168b18018e7ae64f27b2 (diff)
parent5c325134b146e75b388f83df5730b988d096fdc4 (diff)
downloadmastodon_ynh-f273be5f8d9d1d7f7e00e4226bddccb508e7af0d.tar.gz
mastodon_ynh-f273be5f8d9d1d7f7e00e4226bddccb508e7af0d.tar.bz2
mastodon_ynh-f273be5f8d9d1d7f7e00e4226bddccb508e7af0d.zip
Merge branch 'testing' into ldap
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 10 insertions, 9 deletions
diff --git a/README.md b/README.md
index 1f48b9b..e1f295b 100644
--- a/README.md
+++ b/README.md
@@ -8,19 +8,26 @@
> *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: This app can work now on ARM, but installation takes several hours and you must add a swapfile of 1GB.
-
## 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.
**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)
## Configuration
+### Install
+
#### Adding "swapfile" If you have less than 2Go of RAM
```
sudo dd if=/dev/zero of=/swapfile bs=1024 count=1024000
@@ -33,7 +40,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
@@ -47,16 +53,11 @@ $ screen -r
```
### 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/