YunoHost-Apps/ladder_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/ladder_ynh.git synced 2024-09-03 19:26:23 +02:00
Code Issues Activity Actions

Added documentation and warnings

Browse source
This commit is contained in:
Gildas 2023-12-12 16:28:31 +01:00
parent 9c03beda8f
commit 81c9ac6cdc
5 changed files with 9 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
doc/ADMIN.md
View file

@ -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 binary is located in `__INSTALL_DIR__`.
The app uses the default ruleset : https://t.ly/14PSf 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.

4
doc/ADMIN_fr.md
View file

@ -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__` Le binaire est téélchargé dans le dossier `__INSTALL_DIR__`
L'application utilise le "ruleset" par défaut : https://t.ly/14PSf 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é.

2
doc/PRE_INSTALL.md
View file

@ -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. 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.

2
doc/PRE_INSTALL_fr.md
View file

@ -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. 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.

2
manifest.toml
View file

@ -35,7 +35,7 @@ ram.runtime = "20M"
[install.init_main_permission] [install.init_main_permission]
type = "group" type = "group"
default = "visitors" default = "all_users"
[install.ruleset] [install.ruleset]
type = "url" type = "url"