mirror of
https://github.com/YunoHost-Apps/gotosocial_ynh.git
synced 2024-09-03 19:16:06 +02:00
move the docs in a separate file (it's getting long)
This commit is contained in:
OniriCorpe
parent
9053ecb7c9
commit
151c8f735a
6 changed files with 170 additions and 324 deletions
82
README.md
82
README.md
|
|
@ -43,87 +43,7 @@ You will have a **separate account from the rest of your Yunohost server**, pote
|
||||||
GoToSocial **does not provide a user interface**.
|
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.
|
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.
|
||||||
|
|
||||||
### Things to know
|
The docs [can be read here](./doc/DOCS.md) and the admin is **strongly encouraged to read it**!
|
||||||
|
|
||||||
#### 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
|
|
||||||
|
|
||||||
To use OpenID Connect, the YunoHost admin must:
|
|
||||||
|
|
||||||
* install the [dex_ynh](https://github.com/YunoHost-Apps/dex_ynh) package
|
|
||||||
* configure Dex properly during the installation (all entered information will be used in the next step, so keep it in a safe place)
|
|
||||||
* configure GTS using the config panel's OIDC form: `Applications > GoToSocial > Config Panel > OpenID Connect settings`
|
|
||||||
|
|
||||||
## :red_circle: Antifeatures
|
## :red_circle: Antifeatures
|
||||||
|
|
||||||
|
|
|
||||||
82
README_fr.md
82
README_fr.md
|
|
@ -43,87 +43,7 @@ Vous aurez un **compte séparé du reste de votre serveur Yunohost**, avec poten
|
||||||
GoToSocial **ne dispose pas d'une interface utilisateur-ice**.
|
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.
|
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.
|
||||||
|
|
||||||
### Choses à savoir
|
La documentation [est lisible ici](./doc/DOCS_fr.md) et l'admin est **vivement encouragé-e à la lire** !
|
||||||
|
|
||||||
#### 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
|
|
||||||
|
|
||||||
Pour utiliser OpenID Connect, l'admin YunoHost doit:
|
|
||||||
|
|
||||||
* installer le package [dex_ynh](https://github.com/YunoHost-Apps/dex_ynh)
|
|
||||||
* configurer Dex correctement durant l'installation (toutes les informations renseignées seront utilisées lors de l'étape suivante, donc conservez-les soigneusement)
|
|
||||||
* configurer GTS en utilisant le formulaire OIDC du panneau de configuration : `Applications > GoToSocial > Panneau de configuration > OpenID Connect settings`
|
|
||||||
|
|
||||||
## :red_circle: Fonctions indésirables
|
## :red_circle: Fonctions indésirables
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -10,84 +10,4 @@ You will have a **separate account from the rest of your Yunohost server**, pote
|
||||||
GoToSocial **does not provide a user interface**.
|
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.
|
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.
|
||||||
|
|
||||||
### Things to know
|
The docs [can be read here](./doc/DOCS.md) and the admin is **strongly encouraged to read it**!
|
||||||
|
|
||||||
#### 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
|
|
||||||
|
|
||||||
To use OpenID Connect, the YunoHost admin must:
|
|
||||||
|
|
||||||
* install the [dex_ynh](https://github.com/YunoHost-Apps/dex_ynh) package
|
|
||||||
* configure Dex properly during the installation (all entered information will be used in the next step, so keep it in a safe place)
|
|
||||||
* configure GTS using the config panel's OIDC form: `Applications > GoToSocial > Config Panel > OpenID Connect settings`
|
|
||||||
|
|
|
||||||
|
|
@ -10,84 +10,4 @@ Vous aurez un **compte séparé du reste de votre serveur Yunohost**, avec poten
|
||||||
GoToSocial **ne dispose pas d'une interface utilisateur-ice**.
|
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.
|
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.
|
||||||
|
|
||||||
### Choses à savoir
|
La documentation [est lisible ici](./doc/DOCS_fr.md) et l'admin est **vivement encouragé-e à la lire** !
|
||||||
|
|
||||||
#### 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
|
|
||||||
|
|
||||||
Pour utiliser OpenID Connect, l'admin YunoHost doit:
|
|
||||||
|
|
||||||
* installer le package [dex_ynh](https://github.com/YunoHost-Apps/dex_ynh)
|
|
||||||
* configurer Dex correctement durant l'installation (toutes les informations renseignées seront utilisées lors de l'étape suivante, donc conservez-les soigneusement)
|
|
||||||
* configurer GTS en utilisant le formulaire OIDC du panneau de configuration : `Applications > GoToSocial > Panneau de configuration > OpenID Connect settings`
|
|
||||||
|
|
|
||||||
83
doc/DOCS.md
Normal file
83
doc/DOCS.md
Normal file
|
|
@ -0,0 +1,83 @@
|
||||||
|
# Docs of the GoToSocial's package for YunoHost
|
||||||
|
|
||||||
|
*[Lire cette documentation en français.](./doc/DOCS_fr.md)*
|
||||||
|
|
||||||
|
## 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
|
||||||
|
|
||||||
|
To use OpenID Connect, the YunoHost admin must:
|
||||||
|
|
||||||
|
* install the [dex_ynh](https://github.com/YunoHost-Apps/dex_ynh) package
|
||||||
|
* configure Dex properly during the installation (all entered information will be used in the next step, so keep it in a safe place)
|
||||||
|
* configure GTS using the config panel's OIDC form: `Applications > GoToSocial > Config Panel > OpenID Connect settings`
|
||||||
83
doc/DOCS_fr.md
Normal file
83
doc/DOCS_fr.md
Normal file
|
|
@ -0,0 +1,83 @@
|
||||||
|
# Documentation du package GoToSocial pour YunoHost
|
||||||
|
|
||||||
|
*[Read this docs in english.](./doc/DOCS.md)*
|
||||||
|
|
||||||
|
## 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
|
||||||
|
|
||||||
|
Pour utiliser OpenID Connect, l'admin YunoHost doit:
|
||||||
|
|
||||||
|
* installer le package [dex_ynh](https://github.com/YunoHost-Apps/dex_ynh)
|
||||||
|
* configurer Dex correctement durant l'installation (toutes les informations renseignées seront utilisées lors de l'étape suivante, donc conservez-les soigneusement)
|
||||||
|
* configurer GTS en utilisant le formulaire OIDC du panneau de configuration : `Applications > GoToSocial > Panneau de configuration > OpenID Connect settings`
|
||||||
Loading…
Add table
Reference in a new issue