Fix

1 files changed, 38 insertions, 0 deletions

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.