diff --git a/README.md b/README.md index eca101f..090d06c 100644 --- a/README.md +++ b/README.md @@ -31,80 +31,6 @@ Documentation is at [docs.gotosocial.org](https://docs.gotosocial.org). ![Screenshot of GoToSocial](./doc/screenshots/screenshot.jpg) -## Disclaimers / important information - -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 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 with your admin user (the one automatically created at the instalaltion) to your-instance.com/**admin** or using the public instance [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 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 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.org --password 'SomeLongAndComplicatedPassword' -``` - -And to promote them as an administrator of your instance: - -``` bash -./gotosocial --config-path config.yaml admin account promote --username some_username -``` - ## :red_circle: Antifeatures - **Alpha software**: Early development stage. May contain changing or unstable features, bugs, and security vulnerability. diff --git a/README_fr.md b/README_fr.md index b0c72d0..2df53b1 100644 --- a/README_fr.md +++ b/README_fr.md @@ -31,80 +31,6 @@ Vous pouvez consulter la documentation à l'adresse : [docs.gotosocial.org](http ![Capture d’écran de GoToSocial](./doc/screenshots/screenshot.jpg) -## Avertissements / informations importantes - -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. - -Ce paquet ne fonctionne pas avec l'authentification unique (SSO) ou l'intégration LDAP. -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 ou une instance de [Pinafore](https://pinafore.social/) en Web. - -### Choses à savoir - -#### Administration - -Vous pouvez vous connecter avec votre utilisateur admin (celui créé automatiquement à l'installation) à l'interface d'administration à l'adresse votre-instance.com/**admin** ou sur l'instance publique [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. -[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. 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.org --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 -``` - ## :red_circle: Fonctions indésirables - **Alpha software**: Early development stage. May contain changing or unstable features, bugs, and security vulnerability.