mirror of
https://github.com/YunoHost-Apps/gotosocial_ynh.git
synced 2024-09-03 19:16:06 +02:00
added instructions for administration
This commit is contained in:
OniriCorpe
parent
8006ef3f26
commit
d51f820fcb
4 changed files with 254 additions and 10 deletions
67
README.md
67
README.md
|
|
@ -34,18 +34,79 @@ Documentation is at [docs.gotosocial.org](https://docs.gotosocial.org).
|
|||
|
||||
## Disclaimers / important information
|
||||
|
||||
GoToSocial is still in alpha and **may be unstable**.
|
||||
GoToSocial is still in alpha and **may be unstable**. 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 root domain**, for example: gotosocial.domain.tld.
|
||||
|
||||
This package is not-working single-sign on or LDAP integration.
|
||||
This package is not-working SSO (single-sign on) or LDAP integration.
|
||||
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 or an instance of [Pinafore](https://pinafore.social/) on the Web.
|
||||
|
||||
### Things to know
|
||||
|
||||
#### Administration
|
||||
|
||||
You can login to [gts.superseriousbusiness.org/admin](https://gts.superseriousbusiness.org/admin/) to administrate your GoToSocial instance.
|
||||
The [source code of this administration panel](https://github.com/superseriousbusiness/gotosocial-admin) is available on github.
|
||||
[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/admin_panel/).
|
||||
|
||||
In this administration interface, you can configure the following things:
|
||||
|
||||
- The name of your instance
|
||||
- Its description
|
||||
- Your contact e-mail address
|
||||
- The referring user
|
||||
- Blocked domains (not to federate with)
|
||||
|
||||
#### Configuration
|
||||
|
||||
You can configure your instance using the config panel integrated in Yunohost, you will find it in the admin interface of your Yunohost by following these steps:
|
||||
`Applications > gotosocial > Configure this app (Config Panel)`
|
||||
|
||||
In this control panel you can configure the following things:
|
||||
|
||||
- Account configuration :
|
||||
- Are registrations open?
|
||||
- Manual validation of registrations?
|
||||
- Required reason for registration?
|
||||
- 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
|
||||
|
||||
Note: **Do not edit** the `config.yaml` file by hand. Always use this control panel instead.
|
||||
|
||||
#### 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 [https://docs.gotosocial.org/en/latest/admin/cli/](GoToSocial command line documentation).
|
||||
|
||||
#### User creation
|
||||
|
||||
To create a new user, proceed as follows:
|
||||
|
||||
``` bash
|
||||
gotosocial admin account create --username some_username --email someuser@example.org --password 'somelongandcomplicatedpassword'
|
||||
|
||||
gotosocial admin account confirm --username some_username
|
||||
```
|
||||
|
||||
And to promote them as an administrator of your instance:
|
||||
|
||||
``` bash
|
||||
gotosocial admin account promote --username some_username
|
||||
```
|
||||
|
||||
## Documentation and resources
|
||||
|
||||
|
|
|
|||
65
README_fr.md
65
README_fr.md
|
|
@ -30,7 +30,7 @@ Vous pouvez consulter la documentation à l'adresse : [docs.gotosocial.org](http
|
|||
|
||||
## Avertissements / informations importantes
|
||||
|
||||
GoToSocial est encore en alpha et **peut etre instable**.
|
||||
GoToSocial est encore en alpha et **peut etre instable**. 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 dédié**, par exemple : gotosocial.domain.tld.
|
||||
|
||||
|
|
@ -40,8 +40,69 @@ Vous aurez un compte séparé du reste de votre serveur Yunohost, avec potentiel
|
|||
GoToSocial **ne dispose pas d'une interface utilisateur-ice**.
|
||||
Vous devrez utiliser un client compatible avec Mastodon comme [Tusky](https://tusky.app/) sur Android ou une instance de [Pinafore](https://pinafore.social/) en Web.
|
||||
|
||||
### Choses à savoir
|
||||
|
||||
#### Administration
|
||||
|
||||
Vous pouvez vous connecter sur [gts.superseriousbusiness.org/admin](https://gts.superseriousbusiness.org/admin/) pour administrer votre insance GoToSocial.
|
||||
Le [code source de cette interface d'administration](https://github.com/superseriousbusiness/gotosocial-admin) est consultable sur github.
|
||||
[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/admin_panel/).
|
||||
|
||||
Dans cette interface d'administration, vous pouvez paramétrer les choses suivantes :
|
||||
|
||||
- Le nom de votre instance
|
||||
- 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)
|
||||
|
||||
#### Configuration
|
||||
|
||||
Vous pouvez configurer votre instance en utilisant le panneau de configuration intégré à YuNohost, vous le trouverez dans l'interface d'administration de votre Yunohost en suivant ces étapes :
|
||||
`Applications > gotosocial > Configurez cette application (Panneau de configuration)`
|
||||
|
||||
Dans ce panneau de configuration, vous pouvez configurer les choses suivantes :
|
||||
|
||||
- Configuration des comptes :
|
||||
- Ouverture des inscriptions ?
|
||||
- Validation manuelle des inscriptions ?
|
||||
- Motif d'inscription requis ?
|
||||
- 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
|
||||
|
||||
N.B. : **N'éditez pas** le fichier `config.yaml` à la main. Utilisez toujours ce panneau de configuration à la place.
|
||||
|
||||
#### 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 [https://docs.gotosocial.org/en/latest/admin/cli/](documentation de la ligne de commande de GoToSocial).
|
||||
|
||||
#### Création de compte utilisateur
|
||||
|
||||
Pour créer un nouveau compte utilisateur, procédez comme suit :
|
||||
|
||||
``` bash
|
||||
gotosocial admin account create --username nom_dutilisateur --email utilisateur@example.org --password 'UnMotDePasseTrèsComplexe'
|
||||
|
||||
gotosocial admin account confirm --username nom_dutilisateur
|
||||
```
|
||||
|
||||
Et pour promouvoir un compte en tant qu'administrateur de votre instance :
|
||||
|
||||
``` bash
|
||||
gotosocial admin account promote --username nom_dutilisateur
|
||||
```
|
||||
|
||||
## Documentations et ressources
|
||||
|
||||
|
|
|
|||
|
|
@ -1,12 +1,73 @@
|
|||
GoToSocial is still in alpha and **may be unstable**.
|
||||
GoToSocial is still in alpha and **may be unstable**. 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 root domain**, for example: gotosocial.domain.tld.
|
||||
|
||||
This package is not-working single-sign on or LDAP integration.
|
||||
This package is not-working SSO (single-sign on) or LDAP integration.
|
||||
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 or an instance of [Pinafore](https://pinafore.social/) on the Web.
|
||||
|
||||
### Things to know
|
||||
|
||||
#### Administration
|
||||
|
||||
You can login to [gts.superseriousbusiness.org/admin](https://gts.superseriousbusiness.org/admin/) to administrate your GoToSocial instance.
|
||||
The [source code of this administration panel](https://github.com/superseriousbusiness/gotosocial-admin) is available on github.
|
||||
[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/admin_panel/).
|
||||
|
||||
In this administration interface, you can configure the following things:
|
||||
|
||||
- The name of your instance
|
||||
- Its description
|
||||
- Your contact e-mail address
|
||||
- The referring user
|
||||
- Blocked domains (not to federate with)
|
||||
|
||||
#### Configuration
|
||||
|
||||
You can configure your instance using the config panel integrated in Yunohost, you will find it in the admin interface of your Yunohost by following these steps:
|
||||
`Applications > gotosocial > Configure this app (Config Panel)`
|
||||
|
||||
In this control panel you can configure the following things:
|
||||
|
||||
- Account configuration :
|
||||
- Are registrations open?
|
||||
- Manual validation of registrations?
|
||||
- Required reason for registration?
|
||||
- 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
|
||||
|
||||
Note: **Do not edit** the `config.yaml` file by hand. Always use this control panel instead.
|
||||
|
||||
#### 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 [https://docs.gotosocial.org/en/latest/admin/cli/](GoToSocial command line documentation).
|
||||
|
||||
#### User creation
|
||||
|
||||
To create a new user, proceed as follows:
|
||||
|
||||
``` bash
|
||||
gotosocial admin account create --username some_username --email someuser@example.org --password 'somelongandcomplicatedpassword'
|
||||
|
||||
gotosocial admin account confirm --username some_username
|
||||
```
|
||||
|
||||
And to promote them as an administrator of your instance:
|
||||
|
||||
``` bash
|
||||
gotosocial admin account promote --username some_username
|
||||
```
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
GoToSocial est encore en alpha et **peut etre instable**.
|
||||
GoToSocial est encore en alpha et **peut etre instable**. 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 dédié**, par exemple : gotosocial.domain.tld.
|
||||
|
||||
|
|
@ -8,5 +8,66 @@ Vous aurez un compte séparé du reste de votre serveur Yunohost, avec potentiel
|
|||
GoToSocial **ne dispose pas d'une interface utilisateur-ice**.
|
||||
Vous devrez utiliser un client compatible avec Mastodon comme [Tusky](https://tusky.app/) sur Android ou une instance de [Pinafore](https://pinafore.social/) en Web.
|
||||
|
||||
### Choses à savoir
|
||||
|
||||
#### Administration
|
||||
|
||||
Vous pouvez vous connecter sur [gts.superseriousbusiness.org/admin](https://gts.superseriousbusiness.org/admin/) pour administrer votre insance GoToSocial.
|
||||
Le [code source de cette interface d'administration](https://github.com/superseriousbusiness/gotosocial-admin) est consultable sur github.
|
||||
[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/admin_panel/).
|
||||
|
||||
Dans cette interface d'administration, vous pouvez paramétrer les choses suivantes :
|
||||
|
||||
- Le nom de votre instance
|
||||
- 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)
|
||||
|
||||
#### Configuration
|
||||
|
||||
Vous pouvez configurer votre instance en utilisant le panneau de configuration intégré à YuNohost, vous le trouverez dans l'interface d'administration de votre Yunohost en suivant ces étapes :
|
||||
`Applications > gotosocial > Configurez cette application (Panneau de configuration)`
|
||||
|
||||
Dans ce panneau de configuration, vous pouvez configurer les choses suivantes :
|
||||
|
||||
- Configuration des comptes :
|
||||
- Ouverture des inscriptions ?
|
||||
- Validation manuelle des inscriptions ?
|
||||
- Motif d'inscription requis ?
|
||||
- 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
|
||||
|
||||
N.B. : **N'éditez pas** le fichier `config.yaml` à la main. Utilisez toujours ce panneau de configuration à la place.
|
||||
|
||||
#### 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 [https://docs.gotosocial.org/en/latest/admin/cli/](documentation de la ligne de commande de GoToSocial).
|
||||
|
||||
#### Création de compte utilisateur
|
||||
|
||||
Pour créer un nouveau compte utilisateur, procédez comme suit :
|
||||
|
||||
``` bash
|
||||
gotosocial admin account create --username nom_dutilisateur --email utilisateur@example.org --password 'UnMotDePasseTrèsComplexe'
|
||||
|
||||
gotosocial admin account confirm --username nom_dutilisateur
|
||||
```
|
||||
|
||||
Et pour promouvoir un compte en tant qu'administrateur de votre instance :
|
||||
|
||||
``` bash
|
||||
gotosocial admin account promote --username nom_dutilisateur
|
||||
```
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue