diff --git a/README.md b/README.md index 33a53be..0a3d34b 100644 --- a/README.md +++ b/README.md @@ -16,16 +16,14 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in ## Overview -GoToSocial is an [ActivityPub](https://activitypub.rocks/) social network server, written in Golang. +GoToSocial is a fast [ActivityPub](https://activitypub.rocks/) social network server, written in Golang. With GoToSocial, you can keep in touch with your friends, post, read, and share images and articles. All without being tracked or advertised to! -![GoToSocial's logo, a stylized sloth head](./doc/logo_sloth.png) - Documentation is at [docs.gotosocial.org](https://docs.gotosocial.org). -**Shipped version:** 0.12.0~ynh1 +**Shipped version:** 0.12.0~ynh2 ## Screenshots @@ -35,21 +33,21 @@ Documentation is at [docs.gotosocial.org](https://docs.gotosocial.org). 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. +GoToSocial require a **dedicated domain (or subdomain) name**, for example: gotosocial.example.com 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. +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 #### 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. +You can login with your admin user (the one automatically created at the instalaltion) 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/admin_panel/). +[The GTS admin panel documentation](https://docs.gotosocial.org/en/latest/admin/settings/). In this administration interface, you can configure the following things: @@ -61,15 +59,17 @@ In this administration interface, you can configure the following things: #### 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)` +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: +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 @@ -82,26 +82,35 @@ In this control panel you can configure the following things: * 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! +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) +`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' +```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 +```bash ./gotosocial --config-path config.yaml admin account promote --username some_username ``` diff --git a/README_fr.md b/README_fr.md index 73720b2..fccafe2 100644 --- a/README_fr.md +++ b/README_fr.md @@ -16,16 +16,14 @@ Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) po ## Vue d’ensemble -Un serveur de réseau social basé sur [ActivityPub](https://activitypub.rocks/) écrit en Golang. +Un serveur de réseau social véloce basé sur [ActivityPub](https://activitypub.rocks/) écrit en Golang. Avec GoToSocial, vous pouvez rester en contact avec vos amis, publier, lire et partager des images et des articles. Tout cela sans être pisté ni subir de publicité ! -![Le logo de GoToSocial, une tête de paresseux stylisée](./doc/logo_sloth.png) - Vous pouvez consulter la documentation à l'adresse : [docs.gotosocial.org](https://docs.gotosocial.org). -**Version incluse :** 0.12.0~ynh1 +**Version incluse :** 0.12.0~ynh2 ## Captures d’écran @@ -35,21 +33,21 @@ Vous pouvez consulter la documentation à l'adresse : [docs.gotosocial.org](http 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. +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. 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. +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 #### 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. +Vous pouvez vous connecter avec votre utilisateur admin (celui créé automatiquement à 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/admin_panel/). +[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 : @@ -61,15 +59,17 @@ Dans cette interface d'administration, vous pouvez paramétrer les choses suivan #### 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)` +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 : +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 @@ -82,26 +82,35 @@ Dans ce panneau de configuration, vous pouvez configurer les choses suivantes : * 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 ! +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) +`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' +```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 +```bash ./gotosocial --config-path config.yaml admin account promote --username nom_dutilisateur ``` diff --git a/config_panel.toml b/config_panel.toml index b6fa790..a3325eb 100644 --- a/config_panel.toml +++ b/config_panel.toml @@ -50,8 +50,8 @@ help.fr = "Les demandes d'inscription doivent-elles être motivées (par exemple type = "select" [main.accounts.accounts_allow_custom_css] -ask.en = "Allow custom CSS?" -ask.fr = "Autoriser le CSS personnalisé ?" +ask.en = "Allow user custom CSS?" +ask.fr = "Autoriser le CSS personnalisé des utilisateurices ?" bind = "accounts-allow-custom-css:__FINALPATH__/config.yaml" choices = ["true", "false"] default = "false" @@ -66,8 +66,8 @@ Quelle que soit la valeur de ce paramètre, tout CSS téléchargé ne sera pas f type = "select" [main.accounts.accounts_custom_css_length] -ask.en = "Custom CSS length?" -ask.fr = "Longueur du CSS personnalisé ?" +ask.en = "Custom CSS max length?" +ask.fr = "Longueur max du CSS personnalisé ?" bind = "accounts-custom-css-length:__FINALPATH__/config.yaml" default = "10000" help.en = "If accounts-allow-custom-css is 'true', this is the permitted length in characters for CSS uploaded by accounts on this instance. No effect if accounts-allow-custom-css is 'false'. Default: 10000" diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md index a88cd39..119d06e 100644 --- a/doc/DESCRIPTION.md +++ b/doc/DESCRIPTION.md @@ -1,7 +1,5 @@ -GoToSocial is an [ActivityPub](https://activitypub.rocks/) social network server, written in Golang. +GoToSocial is a fast [ActivityPub](https://activitypub.rocks/) social network server, written in Golang. With GoToSocial, you can keep in touch with your friends, post, read, and share images and articles. All without being tracked or advertised to! -![GoToSocial's logo, a stylized sloth head](./doc/logo_sloth.png) - Documentation is at [docs.gotosocial.org](https://docs.gotosocial.org). diff --git a/doc/DESCRIPTION_fr.md b/doc/DESCRIPTION_fr.md index ca48934..8e0ca51 100644 --- a/doc/DESCRIPTION_fr.md +++ b/doc/DESCRIPTION_fr.md @@ -1,7 +1,5 @@ -Un serveur de réseau social basé sur [ActivityPub](https://activitypub.rocks/) écrit en Golang. +Un serveur de réseau social véloce basé sur [ActivityPub](https://activitypub.rocks/) écrit en Golang. Avec GoToSocial, vous pouvez rester en contact avec vos amis, publier, lire et partager des images et des articles. Tout cela sans être pisté ni subir de publicité ! -![Le logo de GoToSocial, une tête de paresseux stylisée](./doc/logo_sloth.png) - Vous pouvez consulter la documentation à l'adresse : [docs.gotosocial.org](https://docs.gotosocial.org). diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md index f13fb16..60a64c3 100644 --- a/doc/DISCLAIMER.md +++ b/doc/DISCLAIMER.md @@ -1,20 +1,20 @@ 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. +GoToSocial require a **dedicated domain (or subdomain) name**, for example: gotosocial.example.com 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. +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 #### 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. +You can login with your admin user (the one automatically created at the instalaltion) 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/admin_panel/). +[The GTS admin panel documentation](https://docs.gotosocial.org/en/latest/admin/settings/). In this administration interface, you can configure the following things: @@ -26,15 +26,17 @@ In this administration interface, you can configure the following things: #### 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)` +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: +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 @@ -47,25 +49,34 @@ In this control panel you can configure the following things: * 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! +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) +`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' +```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 +```bash ./gotosocial --config-path config.yaml admin account promote --username some_username ``` diff --git a/doc/DISCLAIMER_fr.md b/doc/DISCLAIMER_fr.md index 5d1e78b..2b922a3 100644 --- a/doc/DISCLAIMER_fr.md +++ b/doc/DISCLAIMER_fr.md @@ -1,20 +1,20 @@ 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. +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. 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. +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 #### 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. +Vous pouvez vous connecter avec votre utilisateur admin (celui créé automatiquement à 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/admin_panel/). +[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 : @@ -26,15 +26,17 @@ Dans cette interface d'administration, vous pouvez paramétrer les choses suivan #### 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)` +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 : +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 @@ -47,25 +49,34 @@ Dans ce panneau de configuration, vous pouvez configurer les choses suivantes : * 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 ! +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) +`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' +```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 +```bash ./gotosocial --config-path config.yaml admin account promote --username nom_dutilisateur ``` diff --git a/doc/logo_sloth.png b/doc/logo_sloth.png deleted file mode 100644 index 2e46dbe..0000000 Binary files a/doc/logo_sloth.png and /dev/null differ diff --git a/manifest.json b/manifest.json index 35f812b..13a6a11 100644 --- a/manifest.json +++ b/manifest.json @@ -6,7 +6,7 @@ "en": "ActivityPub social network server", "fr": "Serveur de réseau social basé sur ActivityPub" }, - "version": "0.12.0~ynh1", + "version": "0.12.0~ynh2", "url": "https://github.com/superseriousbusiness/gotosocial", "upstream": { "license": "AGPL-3.0-only", @@ -106,4 +106,4 @@ } ] } -} +} \ No newline at end of file