mirror of
https://github.com/YunoHost-Apps/glitchsoc_ynh.git
synced 2024-09-03 19:15:59 +02:00
54 lines
No EOL
2.5 KiB
Markdown
54 lines
No EOL
2.5 KiB
Markdown
<!--
|
|
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
|
|
|
|
[](https://dash.yunohost.org/appci/app/glitchsoc)  
|
|
[](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.01.23~ynh2
|
|
|
|
|
|
|
|
## 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 activated. All YunoHost users can authenticate. Log-out from YunoHost's portal doesn't log-out from Glitch-Soc. See https://github.com/YunoHost/issues/issues/501
|
|
|
|
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 |