mastodon_ynh/README.md

<!--
N.B.: This README was automatically generated by <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
It shall NOT be edited by hand.
-->

# Mastodon for YunoHost

[![Integration level](https://apps.yunohost.org/badge/integration/mastodon)](https://ci-apps.yunohost.org/ci/apps/mastodon/)
![Working status](https://apps.yunohost.org/badge/state/mastodon)
![Maintenance status](https://apps.yunohost.org/badge/maintained/mastodon)

[![Install Mastodon with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=mastodon)

*[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.


**Shipped version:** 4.3.5~ynh1

**Demo:** <https://joinmastodon.org/>

## Screenshots

![Screenshot of Mastodon](./doc/screenshots/mastodon.png)

## 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](https://github.com/YunoHost-Apps/mastodon_ynh/tree/testing).

To try the `testing` branch, please proceed like that:

```bash
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>
Auto-update README 2021-12-08 10:14:56 +00:00			`<!--`
Auto-update README 2024-03-29 06:11:55 +00:00			`N.B.: This README was automatically generated by <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>`
Auto-update README 2021-12-08 10:14:56 +00:00			`It shall NOT be edited by hand.`
			`-->`

Initial commit 2017-04-08 02:04:27 +00:00			`# Mastodon for YunoHost`

Auto-update READMEs 2024-12-06 12:57:02 +00:00			`[![Integration level](https://apps.yunohost.org/badge/integration/mastodon)](https://ci-apps.yunohost.org/ci/apps/mastodon/)`
			`![Working status](https://apps.yunohost.org/badge/state/mastodon)`
			`![Maintenance status](https://apps.yunohost.org/badge/maintained/mastodon)`
Auto-update README 2023-02-23 22:37:45 +00:00
Set badge to SVG 2021-01-09 15:21:48 +00:00			`[![Install Mastodon with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=mastodon)`
Apply example_ynh 2019-03-18 03:22:38 +00:00
Auto-update READMEs 2024-05-27 09:58:14 +00:00			`[Read this README in other languages.](./ALL_README.md)`
Apply example_ynh 2019-03-18 03:22:38 +00:00
Auto-update README 2024-03-29 06:11:55 +00:00			`> 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.`
Apply example_ynh 2019-03-18 03:22:38 +00:00
			`## Overview`
Auto-update README 2021-12-08 10:14:56 +00:00
Auto-update README 2024-02-24 22:41:06 +00:00			`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.`
Packaging v2 (#399) * Convert to v2 (#383) * convert script * v2 * Auto-update README * Update documentation cc @panomaki * Bump ruby version from 3.0.6 to 3.2.2 * v2 * Auto-update README * woops * v2 * v2 * s/final_path/install_dir * Update PRE_INSTALL.md * too soon... * v2 * v2 * v2 * Update tests.toml * Update doc/PRE_INSTALL.md Co-authored-by: Alexandre Aubin <alex.aubin@mailoo.org> * Update doc/PRE_INSTALL_fr.md Co-authored-by: Alexandre Aubin <alex.aubin@mailoo.org> * Update tests.toml Co-authored-by: Alexandre Aubin <alex.aubin@mailoo.org> * Update tests.toml Co-authored-by: Alexandre Aubin <alex.aubin@mailoo.org> * Update doc/PRE_INSTALL.md Co-authored-by: Alexandre Aubin <alex.aubin@mailoo.org> * Update doc/PRE_INSTALL_fr.md Co-authored-by: Alexandre Aubin <alex.aubin@mailoo.org> * Apply suggestions * Update manifest.toml * Auto-update README * Update manifest.toml * Update scripts * Auto-update README * Remove SSO integration * Use new mail mechanism * cleaning * Update manifest.toml --------- Co-authored-by: yunohost-bot <yunohost@yunohost.org> Co-authored-by: Alexandre Aubin <alex.aubin@mailoo.org> Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com> * Bump ynh version * Auto-update README * Update manifest.toml * Update doc/PRE_INSTALL.md Co-authored-by: Alexandre Aubin <alex.aubin@mailoo.org> * Add service setting for app shell * Use logrotate * smtp config follow-up Sidekiq service can be properly hardened since it doesn't use sendmail anymore o/ * Fix mkdir failing if /var/log/mastodon already exists * upgrade: Rename database to match packaging v2 * Bump 4.1.6~ynh2 * Auto-update README * Disable install.private test * remove full_domain * 4.1.7 (#403) * 4.1.7 * Auto-update README * Update manifest.toml * Auto-update README --------- Co-authored-by: yunohost-bot <yunohost@yunohost.org> Co-authored-by: Tagada <36127788+Tagadda@users.noreply.github.com> * fix * fix * Don't swap when running on a LXC * Hardcore the needed RAM * Auto-update README * Auto-update README * Update manifest.toml * Auto-update README * Update _common.sh * Auto-update README * cleaning * cleaning * Auto-update README * Auto-update README * Update tests.toml * Fix restore * Fix manifest.toml * Auto-update README * Auto-update README * add `tootctl self-destruct` info * format * Auto-update README * lol autotranslate * break line * break lines * translation from french * update version * Auto-update README * Update manifest.toml --------- Co-authored-by: yunohost-bot <yunohost@yunohost.org> Co-authored-by: Alexandre Aubin <alex.aubin@mailoo.org> Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com> Co-authored-by: ericgaspar <junk.eg@free.fr> Co-authored-by: OniriCorpe <oniricorpe@disroot.org> 2024-02-24 22:28:27 +00:00
Initial commit 2017-04-08 02:04:27 +00:00
Auto-update READMEs 2025-03-10 23:14:19 +00:00			`Shipped version: 4.3.5~ynh1`
Auto-update README 2021-12-08 10:14:56 +00:00
Auto-update README 2024-03-29 06:11:55 +00:00			`Demo: <https://joinmastodon.org/>`
Auto-update README 2021-12-08 10:14:56 +00:00
			`## Screenshots`

Auto-update README 2022-05-26 22:20:07 +00:00			`![Screenshot of Mastodon](./doc/screenshots/mastodon.png)`
Auto-update README 2021-12-08 10:14:56 +00:00
			`## Documentation and resources`
Apply example_ynh 2019-03-18 03:22:38 +00:00
Auto-update README 2024-03-29 06:11:55 +00:00			`- 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>`
Apply example_ynh 2019-03-18 03:22:38 +00:00
Apply last example_ynh 2021-02-17 18:22:07 +00:00			`## Developer info`
Apply example_ynh 2019-03-18 03:22:38 +00:00
Auto-update README 2024-03-29 06:11:55 +00:00			Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/mastodon_ynh/tree/testing).
Apply example_ynh 2019-03-18 03:22:38 +00:00
Auto-update README 2024-03-29 06:11:55 +00:00			To try the `testing` branch, please proceed like that:
Auto-update README 2022-05-26 22:20:07 +00:00
Auto-update README 2024-03-29 06:11:55 +00:00			```bash
Apply example_ynh 2019-03-18 03:22:38 +00:00			`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`
			```
Auto-update README 2021-12-08 10:14:56 +00:00
Auto-update README 2024-03-29 06:11:55 +00:00			`More info regarding app packaging: <https://yunohost.org/packaging_apps>`