mirror of
https://github.com/YunoHost-Apps/gotosocial_ynh.git
synced 2024-09-03 19:16:06 +02:00
72 lines
3.6 KiB
Markdown
72 lines
3.6 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.
|
|
-->
|
|
|
|
# GoToSocial for YunoHost
|
|
|
|
[](https://dash.yunohost.org/appci/app/gotosocial)  
|
|
|
|
[](https://install-app.yunohost.org/?app=gotosocial)
|
|
|
|
*[Lire ce readme en français.](./README_fr.md)*
|
|
|
|
> *This package allows you to install GoToSocial 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
|
|
|
|
GoToSocial is a fast [ActivityPub](https://activitypub.rocks/) social network server, written in Golang.
|
|
|
|
With GoToSocial, you can keep in touch with your friends, post, read, and share images and articles. All without being tracked or advertised to!
|
|
|
|
The official documentation is at [docs.gotosocial.org](https://docs.gotosocial.org).
|
|
The documentation for this YunoHost package [can be read here](./doc/DOCS.md) and the admin is **strongly encouraged to read it**!
|
|
|
|
|
|
**Shipped version:** 0.13.1~ynh1
|
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
## Disclaimers / important information
|
|
|
|
GoToSocial is still in alpha and **may be unstable**. The beta is planned for 2024.
|
|
You can read [the roadmap](https://github.com/superseriousbusiness/gotosocial/blob/main/ROADMAP.md) to check the progress of GoToSocial's features.
|
|
|
|
GoToSocial require a **dedicated domain (or subdomain) name**, for example: gotosocial.example.com
|
|
|
|
This package is not-working with the SSO (single-sign on) or LDAP integration.
|
|
However, it can be configured to use the OpenID Connect protocol and Dex (a program that links LDAP and OpenID Connect) to enable connection with your YunoHost users, see [the relevant part of the doc](./doc/DOCS.md#openid-connect).
|
|
You will have a **separate account from the rest of your Yunohost server**, potentially with a different username and password.
|
|
|
|
GoToSocial **does not provide a user interface**.
|
|
You will need to use a Mastodon-compatible client such as [Tusky](https://tusky.app/) on Android, [Feditext](https://fedi.software/@Feditext) for iOS or an instance of [Semaphore](https://semaphore.social/) on the Web.
|
|
|
|
## :red_circle: Antifeatures
|
|
|
|
- **Alpha software**: Early development stage. May contain changing or unstable features, bugs, and security vulnerability.
|
|
|
|
## Documentation and resources
|
|
|
|
* Official app website: <https://gotosocial.org/>
|
|
* Official user documentation: <https://docs.gotosocial.org/en/latest/>
|
|
* Official admin documentation: <https://docs.gotosocial.org/en/latest/>
|
|
* Upstream app code repository: <https://github.com/superseriousbusiness/gotosocial>
|
|
* YunoHost Store: <https://apps.yunohost.org/app/gotosocial>
|
|
* Report a bug: <https://github.com/YunoHost-Apps/gotosocial_ynh/issues>
|
|
|
|
## Developer info
|
|
|
|
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/gotosocial_ynh/tree/testing).
|
|
|
|
To try the testing branch, please proceed like that.
|
|
|
|
``` bash
|
|
sudo yunohost app install https://github.com/YunoHost-Apps/gotosocial_ynh/tree/testing --debug
|
|
or
|
|
sudo yunohost app upgrade gotosocial -u https://github.com/YunoHost-Apps/gotosocial_ynh/tree/testing --debug
|
|
```
|
|
|
|
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|