From 81c9ac6cdc8ded0a0c7f63d48c199a9cc5ab7fb7 Mon Sep 17 00:00:00 2001 From: Gildas <25692645+Gildas-GH@users.noreply.github.com> Date: Tue, 12 Dec 2023 16:28:31 +0100 Subject: [PATCH] Added documentation and warnings --- doc/ADMIN.md | 4 +++- doc/ADMIN_fr.md | 4 +++- doc/PRE_INSTALL.md | 2 +- doc/PRE_INSTALL_fr.md | 2 +- manifest.toml | 2 +- 5 files changed, 9 insertions(+), 5 deletions(-) diff --git a/doc/ADMIN.md b/doc/ADMIN.md index a21fcf5..d0f5f76 100644 --- a/doc/ADMIN.md +++ b/doc/ADMIN.md @@ -2,4 +2,6 @@ This application downloads a binary from Ladder's GitHub repository and runs it The binary is located in `__INSTALL_DIR__`. -The app uses the default ruleset : https://t.ly/14PSf \ No newline at end of file +The app uses the default ruleset : https://github.com/everywall/ladder-rules/blob/main/ruleset.yaml + +To change the ruleset, you need to reinstall the app and change the URL when asked. \ No newline at end of file diff --git a/doc/ADMIN_fr.md b/doc/ADMIN_fr.md index c22e46b..ad92b6e 100644 --- a/doc/ADMIN_fr.md +++ b/doc/ADMIN_fr.md @@ -2,4 +2,6 @@ Cette application télécharge un binaire depuis le dépot GitHub de Ladder et l Le binaire est téélchargé dans le dossier `__INSTALL_DIR__` -L'application utilise le "ruleset" par défaut : https://t.ly/14PSf \ No newline at end of file +L'application utilise le "ruleset" par défaut : https://github.com/everywall/ladder-rules/blob/main/ruleset.yaml + +Pour le changer, réinstaller l'application et changez l'URL lorsque c'est proposé. \ No newline at end of file diff --git a/doc/PRE_INSTALL.md b/doc/PRE_INSTALL.md index 4e2841e..7901d73 100644 --- a/doc/PRE_INSTALL.md +++ b/doc/PRE_INSTALL.md @@ -1 +1 @@ -If your instance will be publicly accessible, make sure to enable Basic Auth. This will prevent unauthorized users from using your proxy. If you do not enable Basic Auth, anyone can use your proxy to browse nasty/illegal stuff. And you will be responsible for it. \ No newline at end of file +It is advised not to set Ladder as publicly available. You should allow access only to logged-in YunoHost users. If you do not enable auth, anyone can use your proxy to browse nasty/illegal stuff. And you will be responsible for it. \ No newline at end of file diff --git a/doc/PRE_INSTALL_fr.md b/doc/PRE_INSTALL_fr.md index f5336a7..6df2683 100644 --- a/doc/PRE_INSTALL_fr.md +++ b/doc/PRE_INSTALL_fr.md @@ -1 +1 @@ -Si votre instance est destinée à être accessible publiquement, assurez-vous d'activer l'authentification de base (Basic Auth). Cela empêchera les utilisateurs non autorisés d'utiliser votre proxy. Si vous n'activez pas l'authentification de base, n'importe qui peut utiliser votre proxy pour accéder à du contenu désagréable/illégal. Vous en seriez alors responsable. \ No newline at end of file +Il est conseillé de ne pas rendre Ladder accessible publiquement. Assurez-vous de restreindre l'application aux utilisateurs YunoHost connectés. Si vous n'activez pas l'authentification, n'importe qui peut utiliser votre proxy pour accéder à du contenu désagréable/illégal. Vous en seriez alors responsable. \ No newline at end of file diff --git a/manifest.toml b/manifest.toml index eddbaf8..bff742c 100644 --- a/manifest.toml +++ b/manifest.toml @@ -35,7 +35,7 @@ ram.runtime = "20M" [install.init_main_permission] type = "group" - default = "visitors" + default = "all_users" [install.ruleset] type = "url"