mirror of https://github.com/YunoHost-Apps/mastodon_ynh.git synced 2024-09-03 19:46:02 +02:00

Free, open-source social network for YunoHost

closember communication mastodon social-network yunohost yunohost-apps

Find a file

yunohost-bot 7337804c24 Auto-update README		2023-12-06 06:10:48 +00:00
.github	[autopatch] Upgrade auto-updater	2023-02-23 23:37:42 +01:00
conf	Upgrade to v4.2.3	2023-12-06 06:10:38 +00:00
doc	typo s/tooctl/tootctl (#400 )	2023-08-08 22:12:17 +02:00
scripts	Upgrade to version 4.2.1 (#415 )	2023-10-11 14:40:36 +02:00
.travis.yml	Adding automations	2019-05-10 11:37:32 +02:00
check_process	Update check_process	2023-04-12 11:13:14 +02:00
LICENSE	Initial commit	2017-04-08 04:04:27 +02:00
manifest.json	Upgrade to v4.2.3	2023-12-06 06:10:38 +00:00
README.md	Auto-update README	2023-12-06 06:10:48 +00:00
README_fr.md	Auto-update README	2023-12-06 06:10:48 +00:00

README.md

Mastodon for YunoHost

Lire ce readme en français.

This package allows you to install Mastodon quickly and simply on a YunoHost server. If you don't have YunoHost, please consult the guide 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.

Shipped version: 4.2.3~ynh1

Demo: https://joinmastodon.org/

Screenshots

Disclaimers / important information

Important points to read before installing

Mastodon require a dedicated root domain, eg. mastodon.domain.tld
The user choosen during the installation is automatically created in Mastodon with admin rights
At the end of the installation a mail is sent to the user with the automatically generated password
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/
Official admin documentation: https://docs.joinmastodon.org/
Upstream app code repository: https://github.com/mastodon/mastodon
YunoHost Store: https://apps.yunohost.org/app/mastodon
Report a bug: https://github.com/YunoHost-Apps/mastodon_ynh/issues

Developer info

Please send your pull request to the testing branch.

To try the testing branch, please proceed like that.

sudo yunohost app install https://github.com/YunoHost-Apps/mastodon_ynh/tree/testing --debug
or
sudo yunohost app upgrade mastodon -u https://github.com/YunoHost-Apps/mastodon_ynh/tree/testing --debug

More info regarding app packaging: https://yunohost.org/packaging_apps