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 glitchsoc 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 glitchsoc 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

A libre and federated social network, fork of Mastodon.

**Shipped version:** 3.4.0-rc2~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 Glich-Soc with admin rights. At the end of the installation a mail is sent to the user with the a generated password.
* LDAP authentication is activated. All YunoHost users can authenticate.
* It seems important to close the inscriptions for your Glitch-Soc, 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.


## 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
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			`---`
Complete README for after install 2017-04-16 16:33:17 +02:00
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
Update manifest.json and ran make_readme.py 2021-05-13 20:02:49 +02: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 glitchsoc 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
Update manifest.json and ran make_readme.py 2021-05-13 20:02:49 +02:00			`> *This package allows you to install glitchsoc 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.*`
[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
Update manifest.json and ran make_readme.py 2021-05-13 20:02:49 +02:00			`A libre and federated social network, fork of Mastodon.`
Remove admin instructions + TODO 2017-05-07 22:23:01 +02:00
Update to last master 2021-05-13 20:12:58 +02:00			`Shipped version: 3.4.0-rc2~ynh1`
Update README 2019-07-14 18:17:03 +02:00
Initial commit 2017-04-08 04:04:27 +02:00
[fix] Clear code & fix install 2017-04-16 16:08:42 +02:00
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
Update manifest.json and ran make_readme.py 2021-05-13 20:02:49 +02: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.`
			`* The user choosen during the installation is created in Glich-Soc with admin rights. At the end of the installation a mail is sent to the user with the a generated password.`
			`* LDAP authentication is activated. All YunoHost users can authenticate.`
			`* It seems important to close the inscriptions for your Glitch-Soc, 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.`
Remove sending mail 2019-08-04 00:50:29 +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			`## 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/`
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			`* 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`
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`