aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSalamandar <6552989+Salamandar@users.noreply.github.com>2024-05-27 14:56:29 +0200
committerGitHub <noreply@github.com>2024-05-27 14:56:29 +0200
commit8003baea29c5a5679c7475078ef16263e911b116 (patch)
treecf5d2bb10ddb7e32b53ba0de888007b6f8341782 /README.md
parenta75e6726bca8d3b8a076da4164cd7a18ed29d06e (diff)
parent7727e250c3c616bc59c311f20ec6d3e7f773d5da (diff)
downloadmastodon_ynh-8003baea29c5a5679c7475078ef16263e911b116.tar.gz
mastodon_ynh-8003baea29c5a5679c7475078ef16263e911b116.tar.bz2
mastodon_ynh-8003baea29c5a5679c7475078ef16263e911b116.zip
Merge pull request #449 from YunoHost-Apps/testing
Testing Packaging v2
Diffstat (limited to 'README.md')
-rw-r--r--README.md51
1 files changed, 5 insertions, 46 deletions
diff --git a/README.md b/README.md
index dd0321d..ba9f08b 100644
--- a/README.md
+++ b/README.md
@@ -9,16 +9,18 @@ It shall NOT be edited by hand.
[![Install Mastodon with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=mastodon)
-*[Read this README is other languages.](./ALL_README.md)*
+*[Read this README in other languages.](./ALL_README.md)*
> *This package allows you to install Mastodon quickly and simply on a YunoHost server.*
> *If you don't have YunoHost, please consult [the guide](https://yunohost.org/install) to learn how to install it.*
## Overview
-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.
+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.
-**Shipped version:** 4.2.8~ynh1
+
+**Shipped version:** 4.2.8~ynh2
**Demo:** <https://joinmastodon.org/>
@@ -26,49 +28,6 @@ Mastodon is a free, open-source microblogging social network. It is a decentrali
![Screenshot of Mastodon](./doc/screenshots/mastodon.png)
-## Disclaimers / important information
-
-## 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 tootctl
-
-`$ (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.
-
-Log-out from YunoHost's portal doesn't log out from Mastodon. See https://github.com/YunoHost/issues/issues/501
-
## Documentation and resources
- Official app website: <https://joinmastodon.org/>