hosting/ynh-lydra-ansible-yunohost
1
0
Fork 0
Code Issues 2 Activity

Merge branch '70-docs-add-details-regarding-is_public-and-api-calls' into 'main'

Browse source 
Resolve "docs: add details regarding is_public and API calls"

Closes #70

See merge request lydra/yunohost/ansible-yunohost!50
This commit is contained in:
Thomas Michel 2022-10-13 08:52:50 +00:00
commit f4cf0b73e9
2 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
roles/ynh_apps/README-FR.md
View file

@ -52,7 +52,7 @@ ynh_apps:
- `domain` est obligatoire. Il faut choisir un des domaines de son instance Yunohost.
- `path` est obligatoire. Il faut choisir une URL pour accéder à son application comme `domain.tld/my_app`. Utilisez juste `/` si l'application doit s'installer sur un sous-domaine.
- `is_public` est un argument qu'on retrouve souvent. Paramétré sur `yes`, l'application sera accessible à tout le monde, même sans authentification sur le portail SSO Yunohost. Paramétré sur `no`, l'application ne sera accessible qu'après authentification.
- `is_public` est un argument qu'on retrouve souvent. Paramétré sur `yes`, l'application sera accessible à tout le monde, même sans authentification sur le portail SSO Yunohost. Paramétré sur `no`, l'application ne sera accessible qu'après authentification depuis le SSO YunoHost. Enfin, si l'application a une API qu'on peut interroger, que l'argument `is_public` soit sur `yes` ou `no` ne change rien. Les appels API ne sont pas bloqués par le SSO YunoHost mais nécessitent toujours une authentification par token si l'application le requiert.
Pour les autres arguments, il faut se référer au `manifest.json` disponible dans le dépôt de l'application Yunohost qu'on installe. Vous pouvez en apprendre plus sur cette partie [ici](https://yunohost.org/fr/packaging_apps_manifest).

2
roles/ynh_apps/README.md
View file

@ -52,7 +52,7 @@ ynh_apps:
- `domain` is essential. You have to choose one of the domains of your Yunohost instance.
- `path` is required. You have to choose a URL to access your application like `domain.tld/my_app`. Just use `/` if the application is to be installed on a subdomain.
- `is_public` argument is a common one. Set to `yes`, the application will be accessible to everyone, even without authentication to the Yunohost SSO portal. Set to `no`, the application will be accessible only after authentication.
- `is_public` argument is a common one. Set to `yes`, the application will be accessible to everyone, even without authentication to the Yunohost SSO portal. Set to `no`, the application will only be accessible after authentication from the YunoHost SSO. Finally, if the application has an API that can be called, whether the `is_public` argument is set to `yes` or `no` makes no difference. API calls are not blocked by YunoHost SSO but still require token authentication if the application requires it.
For the other arguments, you have to refer to the `manifest.json` available in the repository of the Yunohost application you install. You can learn more about this part [here](https://yunohost.org/fr/packaging_apps_manifest).