YunoHost-Apps/gotosocial_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/gotosocial_ynh.git synced 2024-09-03 19:16:06 +02:00
Code Issues Activity Actions

rework docs

Browse source
This commit is contained in:
OniriCorpe 2024-01-16 18:48:20 +01:00
parent bc3ebc7bd5
commit 84f577af02
6 changed files with 28 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
doc/DISCLAIMER.md
View file

@ -1,11 +1 @@
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.

10
doc/DISCLAIMER_fr.md
View file

@ -1,11 +1 @@
GoToSocial est encore en alpha et **peut etre instable**. La beta est prévue pour 2024.
Vous pouvez consulter [la roadmap](https://github.com/superseriousbusiness/gotosocial/blob/main/ROADMAP.md) pour vérifier l'avancée des fonctionnalités de GoToSocial.
GoToSocial nécessite un **nom de domaine (ou sous domaine) dédié**, par exemple : gotosocial.example.com
Ce paquet ne fonctionne pas avec l'authentification unique (SSO) ou l'intégration LDAP.
Cependant, il peut être configuré pour utiliser le protocole OpenID Connect et Dex (un programme qui fait la liaison LDAP et OpenID Connect) pour permettra la connection avec vos utilisateurs YunoHost, pour cela, voir [la partie de la doc idoine](./doc/DOCS_fr.md#openid-connect).
Vous aurez un **compte séparé du reste de votre serveur Yunohost**, avec potentiellement un nom d'utilisateur et un mot de passe différent.
GoToSocial **ne dispose pas d'une interface utilisateur-ice**.
Vous devrez utiliser un client compatible avec Mastodon comme [Tusky](https://tusky.app/) sur Android, [Feditext](https://fedi.software/@Feditext) sur iOS ou une instance de [Semaphore](https://semaphore.social/) en Web.

5
doc/DOCS.md
View file

@ -76,6 +76,11 @@ And to promote them as an administrator of your instance:
## OpenID Connect
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.
You will have a **separate account from the rest of your Yunohost server**, potentially with a different username and password.
You can read the [official GoToSocial documentation about OpenID Connect](https://docs.gotosocial.org/en/latest/configuration/oidc/) in support if you want.
To use OpenID Connect, the YunoHost admin must:

5
doc/DOCS_fr.md
View file

@ -76,6 +76,11 @@ Et pour promouvoir un compte en tant qu'administrateur de votre instance :
## OpenID Connect
Ce paquet ne fonctionne pas avec l'authentification unique (SSO) ou l'intégration LDAP.
Cependant, il peut être configuré pour utiliser le protocole OpenID Connect et Dex (un programme qui fait la liaison LDAP et OpenID Connect) pour permettra la connection avec vos utilisateurs YunoHost.
Vous aurez un **compte séparé du reste de votre serveur Yunohost**, avec potentiellement un nom d'utilisateur et un mot de passe différent.
Vous pouvez regarder la [documentation officielle de GoToSocial au sujet de OpenID Connect](https://docs.gotosocial.org/en/latest/configuration/oidc/) en support si vous le souhaitez.
Pour utiliser OpenID Connect, l'admin YunoHost doit:

9
doc/PRE_INSTALL.md Normal file
View file

@ -0,0 +1,9 @@
GoToSocial require a **dedicated domain (or subdomain) name**, for example: gotosocial.example.com
Please note the following points:
- You will no longer be able to change this domain name once it has been set up GoToSocial.
- If you uninstall GoToSocial, you will no longer be able to use this domain name with another federated software installation, as it will be impossible to reuse the keys used to secure the federation.
- 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.

9
doc/PRE_INSTALL_fr.md Normal file
View file

@ -0,0 +1,9 @@
GoToSocial nécessite un **nom de domaine (ou sous domaine) dédié**, par exemple : gotosocial.example.com
Veuillez noter les points suivant :
- Vous ne pourrez plus changer ce nom de domaine une fois défini et GoToSocial installé.
- Vous ne pourrez plus utiliser ce nom de domaine avec une autre installation d'un logiciel de fédivers si vous désinstallez GoToSocial, en raison de l'impossibilité de réutiliser les clés servant à sécuriser la fédération.
- GoToSocial **ne dispose pas d'une interface utilisateur-ice**.
Vous devrez utiliser un client compatible avec Mastodon comme [Tusky](https://tusky.app/) sur Android, [Feditext](https://fedi.software/@Feditext) sur iOS ou une instance de [Semaphore](https://semaphore.social/) en Web.