glitchsoc_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.
-->

# Glitch-Soc for YunoHost

[![Integration level](https://dash.yunohost.org/integration/glitchsoc.svg)](https://dash.yunohost.org/appci/app/glitchsoc) ![](https://ci-apps.yunohost.org/ci/badges/glitchsoc.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/glitchsoc.maintain.svg)  
[![Install Glitch-Soc with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=glitchsoc)

*[Lire ce readme en français.](./README_fr.md)*

> *This package allows you to install Glitch-Soc 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

Glitch-Soc, a fork of 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:** 2022.02.12~ynh1


## Disclaimers / important information

⚠️ Glitch-Soc is beta software, and under active development. Use at your own risk!

* This app require a dedicated domain or subdomain.
* The user choosen during the installation is created in Glitch-Soc with admin rights.

LDAP authentication and SSO are enabled. All YunoHost users can authenticate.

We invite you to block remote malicious instances from the administration interface. You can also add text on your home page.

### Known issues

* When logged in with SSO, log-out from YunoHost's portal don't log-out from Glitch-Soc. See https://github.com/YunoHost/issues/issues/501

## Documentation and resources

* Official app website: https://glitch-soc.github.io/docs/
* Upstream app code repository: https://github.com/glitch-soc/mastodon
* YunoHost documentation for this app: https://yunohost.org/app_glitchsoc
* Report a bug: https://github.com/YunoHost-Apps/glitchsoc_ynh/issues

## Developer info

Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/glitchsoc_ynh/tree/testing).

To try the testing branch, please proceed like that.
```
sudo yunohost app install https://github.com/YunoHost-Apps/glitchsoc_ynh/tree/testing --debug
or
sudo yunohost app upgrade glitchsoc -u https://github.com/YunoHost-Apps/glitchsoc_ynh/tree/testing --debug
```

**More info regarding app packaging:** https://yunohost.org/packaging_apps
Update manifest.json and ran make_readme.py 2021-05-13 20:02:49 +02:00			`<!--`
			`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.`
			`-->`
update README 2019-07-14 18:43:25 +02:00
What a typo... 2021-05-13 20:53:08 +02:00			`# Glitch-Soc for YunoHost`
update README 2019-07-14 18:43:25 +02:00
Auto-update README 2021-11-22 23:15:10 +01:00			`[![Integration level](https://dash.yunohost.org/integration/glitchsoc.svg)](https://dash.yunohost.org/appci/app/glitchsoc) ![](https://ci-apps.yunohost.org/ci/badges/glitchsoc.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/glitchsoc.maintain.svg)`
			`[![Install Glitch-Soc with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=glitchsoc)`
Initial commit 2017-04-08 04:04:27 +02:00
Update manifest.json and ran make_readme.py 2021-05-13 20:02:49 +02:00			`[Lire ce readme en français.](./README_fr.md)`
Initial commit 2017-04-08 04:04:27 +02:00
Auto-update README 2021-11-22 23:15:10 +01:00			`> *This package allows you to install Glitch-Soc quickly and simply on a YunoHost server.`
Update manifest.json and ran make_readme.py 2021-05-13 20:02:49 +02:00			`If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*`
[fix] Clear code & fix install 2017-04-16 16:08:42 +02:00
Update manifest.json and ran make_readme.py 2021-05-13 20:02:49 +02:00			`## Overview`
Update README 2019-07-14 18:17:03 +02:00
Auto-update README 2022-01-11 20:33:20 +01:00			`Glitch-Soc, a fork of 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.`

[fix] Clear code & fix install 2017-04-16 16:08:42 +02:00
Auto-update README 2022-02-13 07:19:57 +01:00			`Shipped version: 2022.02.12~ynh1`
fix #237 2021-05-01 14:32:17 +02:00

Apply example_ynh 2019-03-18 04:22:38 +01:00
Update manifest.json and ran make_readme.py 2021-05-13 20:02:49 +02:00			`## Disclaimers / important information`
Apply example_ynh 2019-03-18 04:22:38 +01:00
Auto-update README 2022-02-14 09:59:03 +01:00			`⚠️ Glitch-Soc is beta software, and under active development. Use at your own risk!`
Apply example_ynh 2019-03-18 04:22:38 +01:00
Update manifest.json and ran make_readme.py 2021-05-13 20:02:49 +02:00			`* This app require a dedicated domain or subdomain.`
Some typo again... 2021-05-16 22:44:47 +02:00			`* The user choosen during the installation is created in Glitch-Soc with admin rights.`
Update doc 2021-05-16 18:41:27 +02:00
Auto-update README 2022-02-14 09:59:03 +01:00			`LDAP authentication and SSO are enabled. All YunoHost users can authenticate.`
Auto-update README 2022-01-11 18:40:13 +01:00
			`We invite you to block remote malicious instances from the administration interface. You can also add text on your home page.`
Remove sending mail 2019-08-04 00:50:29 +02:00
Auto-update README 2022-02-14 09:59:03 +01:00			`### Known issues`

			`* When logged in with SSO, log-out from YunoHost's portal don't log-out from Glitch-Soc. See https://github.com/YunoHost/issues/issues/501`

Update manifest.json and ran make_readme.py 2021-05-13 20:02:49 +02:00			`## Documentation and resources`
Apply example_ynh 2019-03-18 04:22:38 +01:00
Update manifest.json and ran make_readme.py 2021-05-13 20:02:49 +02:00			`* Official app website: https://glitch-soc.github.io/docs/`
Auto-update README 2021-11-22 23:15:10 +01:00			`* Upstream app code repository: https://github.com/glitch-soc/mastodon`
Update manifest.json and ran make_readme.py 2021-05-13 20:02:49 +02:00			`* YunoHost documentation for this app: https://yunohost.org/app_glitchsoc`
			`* Report a bug: https://github.com/YunoHost-Apps/glitchsoc_ynh/issues`
Apply example_ynh 2019-03-18 04:22:38 +01:00
Apply last example_ynh 2021-02-17 19:22:07 +01:00			`## Developer info`
Apply example_ynh 2019-03-18 04:22:38 +01:00
Update manifest.json and ran make_readme.py 2021-05-13 20:02:49 +02:00			`Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/glitchsoc_ynh/tree/testing).`
Apply example_ynh 2019-03-18 04:22:38 +01:00
			`To try the testing branch, please proceed like that.`
			```
Update manifest.json and ran make_readme.py 2021-05-13 20:02:49 +02:00			`sudo yunohost app install https://github.com/YunoHost-Apps/glitchsoc_ynh/tree/testing --debug`
Apply example_ynh 2019-03-18 04:22:38 +01:00			`or`
Update manifest.json and ran make_readme.py 2021-05-13 20:02:49 +02:00			`sudo yunohost app upgrade glitchsoc -u https://github.com/YunoHost-Apps/glitchsoc_ynh/tree/testing --debug`
Apply example_ynh 2019-03-18 04:22:38 +01:00			```
Update manifest.json and ran make_readme.py 2021-05-13 20:02:49 +02:00
			`More info regarding app packaging: https://yunohost.org/packaging_apps`