diff --git a/pages/04.applications/10.docs/gotosocial/app_gotosocial.md b/pages/04.applications/10.docs/gotosocial/app_gotosocial.md new file mode 100644 index 00000000..0a9552d7 --- /dev/null +++ b/pages/04.applications/10.docs/gotosocial/app_gotosocial.md @@ -0,0 +1,120 @@ +--- +title: GoToSocial +template: docs +taxonomy: + category: docs, apps +routes: + default: '/app_gotosocial' +--- + +[![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) + +[![Install GoToSocial with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=gotosocial) + +*[Lire cette page en français.](./app_gotosocial_fr.md)* + +Please note that this page **may be out of date**, you can go to [the documentation page of the package in the repository](https://github.com/YunoHost-Apps/gotosocial_ynh/blob/master/doc/DOCS.md) to consult the latest version. + +## Docs of the GoToSocial's package for YunoHost + +### Administration + +You can login with your admin user (the one automatically created during installation) to your-instance.com/**admin** to administrate your GoToSocial instance. +[The source code of this administration panel](https://github.com/superseriousbusiness/gotosocial-admin) is available on github. +[The GTS admin panel documentation](https://docs.gotosocial.org/en/latest/admin/settings/). + +In this administration interface, you can configure the following things: + +* The name of your instance and its description +* Your contact e-mail address +* The referring user +* Blocked domains (not to federate with) or allowed domains (for the allowlist federation mode) +* Custom emojis +* Moderation reports + +### Configuration + +You can configure your instance using the config panel integrated in Yunohost, you will find it in the web admin interface of your Yunohost by following these steps: +`Applications > GoToSocial > Config Panel` + +In this control panel you can configure the following things (non-exhaustive list): + +* Account configuration : + * Are registrations open? + * Manual validation of registrations? + * Required reason for registration? + * Allow user custom CSS? + * Custom CSS max length? +* Media configuration + * Maximum image size + * Maximum video size + * Minimum number of characters for media descriptions + * Maximum number of characters for media descriptions + * Number of days media can be cached +* Post configuration + * Maximum number of characters for a new post + * Maximum number of characters in a Content Warning / subject of a new post + * Maximum number of options for a poll + * Maximum number of characters for a poll option + * Maximum number of media that can be added to a post +* Instance config + * Federation mode to use for this instance (blocklist / allowlist) + * Landing page user + * Exposed API options +* SMTP config +* Cache settings +* Advanced settings + * SameSite attribute + * Rate limit + +Note: **Do NOT edit** the `config.yaml` file by hand. Always use this config panel instead. Otherwise your changes will be deleted at each update! + +### Command line (CLI) + +To use the GoToSocial command line, you first need to place yourself in the folder of your instance: +`cd /var/www/gotosocial/` or `cd /var/www/gotosocial__x/` (where `x` is the installation number of your instance, in the case of multi-installation). +Feel free to refer to the [GoToSocial command line documentation](https://docs.gotosocial.org/en/latest/admin/cli/). + +### User creation + +To create a new user, proceed as follows: + +```bash +./gotosocial --config-path config.yaml admin account create --username some_username --email someuser@example.com --password 'SomeLongAndComplicatedPassword' +``` + +And to promote them as an administrator of your instance: + +```bash +./gotosocial --config-path config.yaml admin account promote --username some_username +``` + +### OpenID Connect + +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: + +* Install the [Dex](https://apps.yunohost.org/app/dex) package (note that your server must compile it, which can be resource-intensive) +* Configure Dex properly during the installation (all entered information will be used in the next step, so keep it in a safe place) + * Domain: as you wish (may be a sub-domain of your GTS instance, like "dex.gts.example.com") + * Path: only `/` if you wish to install it on a sub-domain of your instance, otherwise as you wish + * Name of the app: "GoToSocial", "GTS-test", "YNH-GoToSocial" or anything that makes sense to you and does not contain a space (it will be used as "client ID" in the next step) + * OIDC secret: a long and random password of at least 30 characters + * Callback URI: `gts.example.com/auth/callback` by replacing the `gts.example.com` by the domain name of your GTS instance (without the `https://`!) +* Configure GTS using the config panel's OIDC form: `Applications > GoToSocial > Config Panel > OpenID Connect settings` + * Activate OpenID Connect: `true` + * Name of the OIDC IDP: "Dex" or any other name that makes sense + * Skip the normal verification flow of tokens returned: keep on `false` ( **never** change to `true` unless you know what you're doing!) + * OIDC issuer URI: the domain name to which you assigned Dex in the previous step, with the final slash `/`, e.g. `https://dex.gts.example.com/` (this is **NOT** the URL of your GTS instance) + * OIDC client ID: the app name defined at the Dex installation step (e.g. "GoToSocial", "GTS-test", "YNH-GoToSocial") + * OIDC client secret: the long password randomly generated during Dex's installation step + * Save, wait until GTS reboots and test! + +## Useful links + +* Website: +* Official user documentation: +* Official admin documentation: +* Upstream app code repository: +* Report a bug: diff --git a/pages/04.applications/10.docs/gotosocial/app_gotosocial_fr.md b/pages/04.applications/10.docs/gotosocial/app_gotosocial_fr.md new file mode 100644 index 00000000..60bc2c3a --- /dev/null +++ b/pages/04.applications/10.docs/gotosocial/app_gotosocial_fr.md @@ -0,0 +1,119 @@ +--- +title: GoToSocial +template: docs +taxonomy: + category: docs, apps +routes: + default: '/app_gotosocial' +--- + +[![Niveau d’intégration](https://dash.yunohost.org/integration/gotosocial.svg)](https://dash.yunohost.org/appci/app/gotosocial) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/gotosocial.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/gotosocial.maintain.svg) + +[![Installer GoToSocial avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=gotosocial) + +*[Read this page in english.](./app_gotosocial.md)* + +Veuillez noter que cette page **peut être obsolète**, vous pouve vous rendre sur [la page de documentation dans le dépôt du paquet](https://github.com/YunoHost-Apps/gotosocial_ynh/blob/master/doc/DOCS.md) pour consulter la dernière version. + +## Documentation du package GoToSocial pour YunoHost + +### Administration + +Vous pouvez vous connecter avec votre utilisateur admin (celui créé automatiquement lors de l'installation) à l'interface d'administration à l'adresse votre-instance.com/**admin** pour administrer votre insance GoToSocial. +[Le code source de cette interface d'administration](https://github.com/superseriousbusiness/gotosocial-admin) est consultable sur github. +[La documentation de l'interface d'administration de GoToSocial](https://docs.gotosocial.org/en/latest/admin/settings/). + +Dans cette interface d'administration, vous pouvez paramétrer les choses suivantes : + +* Le nom de votre instance et sa description +* Votre adresse e-mail de contact +* L'utilisateurice référent-e +* Les domaines bloqués (pour ne pas fédérer avec) ou autorisés (pour le mode de fédération par liste blanche) +* Les émojis personnalisés +* Les signalements pour la modération + +### Configuration + +Vous pouvez configurer votre instance en utilisant le panneau de configuration intégré à YuNohost, vous le trouverez dans l'interface d'administration Web de votre Yunohost en suivant ces étapes : +`Applications > GoToSocial > Panneau de configuration` + +Dans ce panneau de configuration, vous pouvez configurer les choses suivantes (liste non exhaustive) : + +* Configuration des comptes : + * Ouverture des inscriptions ? + * Validation manuelle des inscriptions ? + * Motif d'inscription requis ? + * Autoriser le CSS personnalisé des utilisateurices ? + * Longueur max du CSS personnalisé ? +* Configuration des médias + * Taille maximale des images + * Taille maximale des vidéos + * Nombre minimum de caractères pour les descriptions des médias + * Nombre maximum de caractères pour les descriptions des médias + * Nombre de jour de mise en cache des médias +* Configuration des posts + * Nombre maximum de caractères pour un nouveau post + * Nombre maximum de caractères dans un Content Warning / sujet d'un nouveau post + * Nombre maximum d'options pour un sondage + * Nombre maximum de caractères pour une option d'un sondage + * Nombre maximum de médias pouvant etre ajoutés à un post +* Configuration de l'instance + * Le mode de fédération à utiliser pour cette instance (blocklist / allowlist) + * Utilisateurice en tant que page d'accueil + * Options d'exposition de l'API +* Configuration SMTP +* Configuration du cache +* Configuration avancée + * SameSite attribute + * Rate limit + +N.B. : **N'éditez PAS** le fichier `config.yaml` à la main. Utilisez toujours ce panneau de configuration à la place. Sinon vos modifications seront effacées à chaque mise à jour ! + +### Ligne de commande + +Pour utiliser la ligne de commande de GoToSocial, vous devez d'abord vous placer dans le répertoire de votre instance : +`cd /var/www/gotosocial/` ou `cd /var/www/gotosocial__x/` (où `x` est le numéro de votre installation, dans la cas d'une installation de multiples instances). +N'hésitez pas à vous référer à la [documentation de la ligne de commande de GoToSocial](https://docs.gotosocial.org/en/latest/admin/cli/). + +### Création de compte utilisateur + +Pour créer un nouveau compte utilisateur, procédez comme suit : + +```bash +./gotosocial --config-path config.yaml admin account create --username nom_dutilisateur --email utilisateur@example.com --password 'UnMotDePasseTrèsComplexe' +``` + +Et pour promouvoir un compte en tant qu'administrateur de votre instance : + +```bash +./gotosocial --config-path config.yaml admin account promote --username nom_dutilisateur +``` + +### OpenID Connect + +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: + +* Installer le package [Dex](https://apps.yunohost.org/app/dex) (notez que votre serveur doit le compiler, ce qui peut être gourmand en ressources) +* Configurer Dex correctement durant l'installation (toutes les informations renseignées seront utilisées lors de l'étape suivante, donc conservez-les soigneusement) + * Nom de domaine : ce que vous voulez (peut-être un sous domaine de votre instance GTS, comme "dex.gts.example.com") + * Chemin : juste `/` si vous souhaitez l'installer sur un sous domaine de votre instance, sinon comme vous voulez + * Nom de l'app : "GoToSocial", "GTS-test", "YNH-GoToSocial" ou n'importe quel nom qui vous semble correct qui ne possède pas d'espace (sera utilisé comme "client ID" dans l'étape suivante) + * OIDC secret : un mot de passe long généré aléatoirement d'au minimum une trentaine de caractères + * Callback URI : `gts.example.com/auth/callback` en remplaçant `gts.example.com` par le nom de domaine de votre instance GTS (sans le `https://` !) +* Configurer GTS en utilisant le formulaire OIDC du panneau de configuration : `Applications > GoToSocial > Panneau de configuration > OpenID Connect settings` + * Activer OpenID Connect : `true` + * Nom de l'OIDC IDP : "Dex" ou n'importe quel nom qui vous semble correct + * Passer la vérification du flux des jetons renvoyés : laisser sur `false` (ne **jamais** passer à `true` sauf si vous savez ce que vous faites !) + * URI du fournisseur OIDC : le nom de domaine auquel vous avez assigné Dex lors de l'étape précédente, barre oblique `/` finale incluse, par exemple `https://dex.gts.example.com/` (ce **N'est PAS** l'URL de votre instance GTS) + * Client ID du fournisseur OIDC : le nom de l'app renseigné lors de l'étape d'installation de Dex (exemples : "GoToSocial", "GTS-test", "YNH-GoToSocial") + * Client secret du fournisseur OIDC : le long mot de passé généré aléatoirement lors de l'étape d'installation de Dex + * Sauvegardez, patientez le temps que GTS redémarre puis testez ! + +## liens utiles + +* Site officiel de l’app : +* Documentation officielle : +* Dépôt de code officiel de l’app : +* Signaler un bug :