From 84f577af02e4e2bcfb5a7133891f07876a194eb8 Mon Sep 17 00:00:00 2001 From: OniriCorpe Date: Tue, 16 Jan 2024 18:48:20 +0100 Subject: [PATCH] rework docs --- doc/DISCLAIMER.md | 10 ---------- doc/DISCLAIMER_fr.md | 10 ---------- doc/DOCS.md | 5 +++++ doc/DOCS_fr.md | 5 +++++ doc/PRE_INSTALL.md | 9 +++++++++ doc/PRE_INSTALL_fr.md | 9 +++++++++ 6 files changed, 28 insertions(+), 20 deletions(-) create mode 100644 doc/PRE_INSTALL.md create mode 100644 doc/PRE_INSTALL_fr.md diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md index 4634159..9debe68 100644 --- a/doc/DISCLAIMER.md +++ b/doc/DISCLAIMER.md @@ -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. diff --git a/doc/DISCLAIMER_fr.md b/doc/DISCLAIMER_fr.md index 2859fa5..444a07d 100644 --- a/doc/DISCLAIMER_fr.md +++ b/doc/DISCLAIMER_fr.md @@ -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. diff --git a/doc/DOCS.md b/doc/DOCS.md index bf2f997..25a6035 100644 --- a/doc/DOCS.md +++ b/doc/DOCS.md @@ -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: diff --git a/doc/DOCS_fr.md b/doc/DOCS_fr.md index bc87f2e..defe223 100644 --- a/doc/DOCS_fr.md +++ b/doc/DOCS_fr.md @@ -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: diff --git a/doc/PRE_INSTALL.md b/doc/PRE_INSTALL.md new file mode 100644 index 0000000..6a5c546 --- /dev/null +++ b/doc/PRE_INSTALL.md @@ -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. diff --git a/doc/PRE_INSTALL_fr.md b/doc/PRE_INSTALL_fr.md new file mode 100644 index 0000000..ed2af3f --- /dev/null +++ b/doc/PRE_INSTALL_fr.md @@ -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.