2021-08-15 21:48:06 +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.
|
|
|
|
-->
|
|
|
|
|
2022-03-07 20:54:00 +01:00
|
|
|
# GoToSocial for YunoHost
|
2021-08-15 21:48:06 +02:00
|
|
|
|
2023-02-07 22:18:48 +01:00
|
|
|
[![Integration level](https://dash.yunohost.org/integration/gotosocial.svg)](https://dash.yunohost.org/appci/app/gotosocial) ![Working status](https://ci-apps.yunohost.org/ci/badges/gotosocial.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/gotosocial.maintain.svg)
|
2023-02-18 18:41:05 +01:00
|
|
|
|
2022-03-07 20:54:00 +01:00
|
|
|
[![Install GoToSocial with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=gotosocial)
|
2021-08-15 21:48:06 +02:00
|
|
|
|
|
|
|
*[Lire ce readme en français.](./README_fr.md)*
|
|
|
|
|
2022-03-07 20:54:00 +01:00
|
|
|
> *This package allows you to install GoToSocial quickly and simply on a YunoHost server.
|
2021-08-15 21:48:06 +02:00
|
|
|
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
|
|
|
|
|
|
|
## Overview
|
|
|
|
|
2023-10-24 00:12:20 +02:00
|
|
|
GoToSocial is a fast [ActivityPub](https://activitypub.rocks/) social network server, written in Golang.
|
2022-03-14 03:14:34 +01:00
|
|
|
|
|
|
|
With GoToSocial, you can keep in touch with your friends, post, read, and share images and articles. All without being tracked or advertised to!
|
|
|
|
|
2023-11-05 05:46:30 +01:00
|
|
|
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**!
|
2022-03-14 03:14:34 +01:00
|
|
|
|
2023-02-21 22:40:23 +01:00
|
|
|
|
2024-01-16 03:47:38 +01:00
|
|
|
**Shipped version:** 0.13.1~ynh1
|
2022-08-12 01:15:57 +02:00
|
|
|
|
2021-08-15 21:48:06 +02:00
|
|
|
## Screenshots
|
|
|
|
|
2023-07-21 22:56:36 +02:00
|
|
|
![Screenshot of GoToSocial](./doc/screenshots/screenshot.png)
|
2021-08-15 21:48:06 +02:00
|
|
|
|
|
|
|
## Disclaimers / important information
|
|
|
|
|
2023-10-25 18:19:52 +02:00
|
|
|
You can read [the roadmap](https://github.com/superseriousbusiness/gotosocial/blob/main/ROADMAP.md) to check the progress of GoToSocial's features.
|
2022-03-18 18:44:18 +01:00
|
|
|
|
2022-10-05 00:00:03 +02:00
|
|
|
## :red_circle: Antifeatures
|
|
|
|
|
2022-11-09 19:27:57 +01:00
|
|
|
- **Alpha software**: Early development stage. May contain changing or unstable features, bugs, and security vulnerability.
|
2022-10-05 00:00:03 +02:00
|
|
|
|
2021-08-15 21:48:06 +02:00
|
|
|
## Documentation and resources
|
|
|
|
|
2023-02-26 21:29:31 +01:00
|
|
|
* Official app website: <https://gotosocial.org/>
|
2022-05-28 06:17:23 +02:00
|
|
|
* 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>
|
2023-11-05 05:46:30 +01:00
|
|
|
* YunoHost Store: <https://apps.yunohost.org/app/gotosocial>
|
2022-05-28 06:17:23 +02:00
|
|
|
* Report a bug: <https://github.com/YunoHost-Apps/gotosocial_ynh/issues>
|
2021-08-15 21:48:06 +02:00
|
|
|
|
|
|
|
## Developer info
|
|
|
|
|
2022-03-07 20:54:00 +01:00
|
|
|
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/gotosocial_ynh/tree/testing).
|
2021-08-15 21:48:06 +02:00
|
|
|
|
|
|
|
To try the testing branch, please proceed like that.
|
2022-05-28 06:17:23 +02:00
|
|
|
|
|
|
|
``` bash
|
2022-03-07 20:54:00 +01:00
|
|
|
sudo yunohost app install https://github.com/YunoHost-Apps/gotosocial_ynh/tree/testing --debug
|
2021-08-15 21:48:06 +02:00
|
|
|
or
|
2022-03-07 20:54:00 +01:00
|
|
|
sudo yunohost app upgrade gotosocial -u https://github.com/YunoHost-Apps/gotosocial_ynh/tree/testing --debug
|
2021-08-15 21:48:06 +02:00
|
|
|
```
|
|
|
|
|
2022-05-28 06:17:23 +02:00
|
|
|
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|