mirror of
https://github.com/YunoHost-Apps/glitchsoc_ynh.git
synced 2024-09-03 19:15:59 +02:00
84 lines
No EOL
3.1 KiB
Markdown
84 lines
No EOL
3.1 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` is a friendly [fork](https://en.wikipedia.org/wiki/Fork_(software_development)) of the open-source social media software [Mastodon](https://joinmastodon.org/), with the aim of providing additional features at the risk of potentially less stable software.
|
|
|
|
### What's different from Mastodon?
|
|
|
|
`glitch-soc` adds a number of experimental features to Mastodon, such as:
|
|
|
|
- Media improvements
|
|
- Images inside the CW spoiler
|
|
- fullwidth images
|
|
- scaling options
|
|
- Formatted toots
|
|
- Reply selection in lists
|
|
- Filter improvements
|
|
- Highlighting of misleading links
|
|
- Hiding follower count
|
|
- An app settings modal
|
|
- Collapsible toots
|
|
- Toot visibility icons
|
|
- Local-only toots
|
|
- Threaded mode
|
|
- `data-*` attributes on statuses
|
|
- Advanced theming via flavours+skins
|
|
- Doodle
|
|
|
|
See more [on the documentation](https://glitch-soc.github.io/docs/).
|
|
|
|
|
|
**Shipped version:** 2022.03.31~ynh1
|
|
|
|
|
|
|
|
## Disclaimers / important information
|
|
|
|
⚠️ Glitch-Soc is beta software, and under active development. Use at your own risk!
|
|
|
|
### Install
|
|
|
|
* 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 |