YunoHost/doc
1
0
Fork 0
mirror of https://github.com/YunoHost/doc.git synced 2024-09-03 20:06:26 +02:00
Code Issues Projects Releases Packages Wiki Activity

stretch-unstable -> dev

Browse source
This commit is contained in:
Alexandre Aubin 2021-09-16 03:57:44 +02:00
parent 4e7e0bdf91
commit dab2a28f35
4 changed files with 22 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
pages/01.administrate/07.specific_use_cases/12.api/admin_api.fr.md
View file

@ -8,7 +8,7 @@ routes:
--- ---
Toutes les actions exécutables en ligne de commande le sont également via une API. L’API est accessible à l’adresse https://votre.serveur/yunohost/api. Toutes les actions exécutables en ligne de commande le sont également via une API. L’API est accessible à l’adresse https://votre.serveur/yunohost/api.
Pour le moment, il n'existe pas de documentation des différentes routes... mais vous pouvez trouver l'actionmap [ici](https://github.com/YunoHost/yunohost/blob/stretch-unstable/data/actionsmap/yunohost.yml) (en particulier les clefs `api`) Pour le moment, il n'existe pas de documentation des différentes routes... mais vous pouvez trouver l'actionmap [ici](https://github.com/YunoHost/yunohost/blob/dev/data/actionsmap/yunohost.yml) (en particulier les clefs `api`)
## Avec cURL ## Avec cURL

2
pages/01.administrate/07.specific_use_cases/12.api/admin_api.md
View file

@ -7,7 +7,7 @@ routes:
default: '/admin_api' default: '/admin_api'
--- ---
All command line actions can also be ran from the web API. The API is available at https://your.server/yunohost/api. For now there's no documentation on the various routes... but you can get an idea by looking at the actionmap [here](https://github.com/YunoHost/yunohost/blob/stretch-unstable/data/actionsmap/yunohost.yml) (in particular the `api` stuff). All command line actions can also be ran from the web API. The API is available at https://your.server/yunohost/api. For now there's no documentation on the various routes... but you can get an idea by looking at the actionmap [here](https://github.com/YunoHost/yunohost/blob/dev/data/actionsmap/yunohost.yml) (in particular the `api` stuff).
## Using cURL ## Using cURL

20
pages/04.contribute/05.dev/dev.fr.md
View file

@ -27,7 +27,7 @@ Si vous cherchez quelque chose à implémenter ou un bug à réparer, le bug tra
##### Moulinette ##### Moulinette
C'est un petit framework "fait maison". [Son rôle principal](https://moulinette.readthedocs.io/en/latest/actionsmap.html) est de permettre de construire une API Web et une API en ligne de commande à partir d'un même code Python et d'un schéma YAML que nous appelons [l'actionmap](https://github.com/YunoHost/yunohost/blob/stretch-unstable/data/actionsmap/yunohost.yml). C'est un petit framework "fait maison". [Son rôle principal](https://moulinette.readthedocs.io/en/latest/actionsmap.html) est de permettre de construire une API Web et une API en ligne de commande à partir d'un même code Python et d'un schéma YAML que nous appelons [l'actionmap](https://github.com/YunoHost/yunohost/blob/dev/data/actionsmap/yunohost.yml).
Il prend en charge d'autres mécanismes tels que l'authentification, l'internationalisation et des petites fonctions utilitaires techniques (par ex. lecture/écriture de fichiers JSON). Il prend en charge d'autres mécanismes tels que l'authentification, l'internationalisation et des petites fonctions utilitaires techniques (par ex. lecture/écriture de fichiers JSON).
@ -36,17 +36,17 @@ Moulinette dispose de sa propre documentation [ici](https://moulinette.readthedo
##### YunoHost ##### YunoHost
C'est le cœur même de YunoHost. Il contient : C'est le cœur même de YunoHost. Il contient :
- [le code Python](https://github.com/YunoHost/yunohost/tree/stretch-unstable/src/yunohost) qui gère les utilisateurs, domaines, applications, services et autres - [le code Python](https://github.com/YunoHost/yunohost/tree/dev/src/yunohost) qui gère les utilisateurs, domaines, applications, services et autres
- des [helpers bash](https://github.com/YunoHost/yunohost/tree/stretch-unstable/data/helpers.d) principalement utilisés par les packageurs d'applications dans les scripts de ces applications - des [helpers bash](https://github.com/YunoHost/yunohost/tree/dev/data/helpers.d) principalement utilisés par les packageurs d'applications dans les scripts de ces applications
- des [hooks](https://github.com/YunoHost/yunohost/tree/stretch-unstable/data/hooks) et [templates](https://github.com/YunoHost/yunohost/tree/stretch-unstable/data/templates) qui sont utilisés pour configurer les différents éléments de l'écosystème tels que NGINX, Postfix... - des [hooks](https://github.com/YunoHost/yunohost/tree/dev/data/hooks) et [templates](https://github.com/YunoHost/yunohost/tree/dev/data/templates) qui sont utilisés pour configurer les différents éléments de l'écosystème tels que NGINX, Postfix...
- des [chaînes internationalisées](https://github.com/YunoHost/yunohost/tree/stretch-unstable/locales) - des [chaînes internationalisées](https://github.com/YunoHost/yunohost/tree/dev/locales)
- des [tests](https://github.com/YunoHost/yunohost/tree/stretch-unstable/src/yunohost/tests) - des [tests](https://github.com/YunoHost/yunohost/tree/dev/src/yunohost/tests)
##### SSOwat ##### SSOwat
C'est le système de connexion unique (single sign-on) de YunoHost. Il contient principalement : C'est le système de connexion unique (single sign-on) de YunoHost. Il contient principalement :
- [du code LUA](https://github.com/YunoHost/ssowat) interfacé directement avec NGINX et qui gère tous les aspects "techniques" de l'authentification et de la gestion des accès aux ressources. - [du code LUA](https://github.com/YunoHost/ssowat) interfacé directement avec NGINX et qui gère tous les aspects "techniques" de l'authentification et de la gestion des accès aux ressources.
- le [portail web utilisateur](https://github.com/YunoHost/SSOwat/tree/stretch-unstable/portal) qui est l'interface finale visible par les utilisateurs de YunoHost. - le [portail web utilisateur](https://github.com/YunoHost/SSOwat/tree/dev/portal) qui est l'interface finale visible par les utilisateurs de YunoHost.
SSOwat est configuré via `/etc/ssowat/conf.json` qui est généré par YunoHost. SSOwat est configuré via `/etc/ssowat/conf.json` qui est généré par YunoHost.
@ -55,9 +55,9 @@ SSOwat est configuré via `/etc/ssowat/conf.json` qui est généré par YunoHost
C'est une dépendance *optionnelle* de YunoHost et correspond à une interface pour l'API web créée par YunoHost et Moulinette (service `yunohost-api`). C'est une dépendance *optionnelle* de YunoHost et correspond à une interface pour l'API web créée par YunoHost et Moulinette (service `yunohost-api`).
Il contient essentiellement : Il contient essentiellement :
- [des templates pour les vues](https://github.com/YunoHost/yunohost-admin/tree/stretch-unstable/src/views) - [des templates pour les vues](https://github.com/YunoHost/yunohost-admin/tree/dev/src/views)
- les [contrôleurs JavaScript](https://github.com/YunoHost/yunohost-admin/tree/stretch-unstable/src/js/yunohost/controllers) correspondants, qui interagissent avec l'API YunoHost - les [contrôleurs JavaScript](https://github.com/YunoHost/yunohost-admin/tree/dev/src/js/yunohost/controllers) correspondants, qui interagissent avec l'API YunoHost
- et ses [chaînes internationalisées](https://github.com/YunoHost/yunohost-admin/tree/stretch-unstable/src/locales) - et ses [chaînes internationalisées](https://github.com/YunoHost/yunohost-admin/tree/dev/src/locales)
### Travailler sur le cœur Python / ligne de commande ### Travailler sur le cœur Python / ligne de commande

20
pages/04.contribute/05.dev/dev.md
View file

@ -38,7 +38,7 @@ If you're looking for stuff to implement or fix, the bug-tracker is
It is a small "homemade" framework. [Its major role](https://moulinette.readthedocs.io/en/latest/actionsmap.html) It is a small "homemade" framework. [Its major role](https://moulinette.readthedocs.io/en/latest/actionsmap.html)
is to allow us to build both a web API and a command-line API from the same is to allow us to build both a web API and a command-line API from the same
Python code thanks to a YAML schema which we call Python code thanks to a YAML schema which we call
[the actionmap](https://github.com/YunoHost/yunohost/blob/stretch-unstable/data/actionsmap/yunohost.yml). [the actionmap](https://github.com/YunoHost/yunohost/blob/dev/data/actionsmap/yunohost.yml).
It handles other mechanisms like authentication, internationalization and It handles other mechanisms like authentication, internationalization and
small technical utilitary functions (e.g. reading/writing JSON). small technical utilitary functions (e.g. reading/writing JSON).
@ -48,17 +48,17 @@ Moulinette has its own documentation available [here](https://moulinette.readthe
#### YunoHost #### YunoHost
This piece is the very core of YunoHost. It contains: This piece is the very core of YunoHost. It contains:
- [the Python code](https://github.com/YunoHost/yunohost/tree/stretch-unstable/src/yunohost) that manages users, domains, apps, services and other things - [the Python code](https://github.com/YunoHost/yunohost/tree/dev/src/yunohost) that manages users, domains, apps, services and other things
- [bash helpers](https://github.com/YunoHost/yunohost/tree/stretch-unstable/data/helpers.d) mainly used by application packagers to package applications - [bash helpers](https://github.com/YunoHost/yunohost/tree/dev/data/helpers.d) mainly used by application packagers to package applications
- [hooks](https://github.com/YunoHost/yunohost/tree/stretch-unstable/data/hooks) and [templates](https://github.com/YunoHost/yunohost/tree/stretch-unstable/data/templates) that are used to configure the various pieces of the ecosystem such as NGINX, Postfix... - [hooks](https://github.com/YunoHost/yunohost/tree/dev/data/hooks) and [templates](https://github.com/YunoHost/yunohost/tree/dev/data/templates) that are used to configure the various pieces of the ecosystem such as NGINX, Postfix...
- [internationalized strings](https://github.com/YunoHost/yunohost/tree/stretch-unstable/locales) - [internationalized strings](https://github.com/YunoHost/yunohost/tree/dev/locales)
- [tests](https://github.com/YunoHost/yunohost/tree/stretch-unstable/src/yunohost/tests) - [tests](https://github.com/YunoHost/yunohost/tree/dev/src/yunohost/tests)
#### SSOwat #### SSOwat
This is the single sign-on system of YunoHost. It both contains: This is the single sign-on system of YunoHost. It both contains:
- [Lua scripts](https://github.com/YunoHost/ssowat) that are directly interfaced with NGINX and handle all the "technical" aspects of authentication and route accesses - [Lua scripts](https://github.com/YunoHost/ssowat) that are directly interfaced with NGINX and handle all the "technical" aspects of authentication and route accesses
- the web [user portal](https://github.com/YunoHost/SSOwat/tree/stretch-unstable/portal) which is the interface used by YunoHost's end users to log in and browse installed apps - the web [user portal](https://github.com/YunoHost/SSOwat/tree/dev/portal) which is the interface used by YunoHost's end users to log in and browse installed apps
SSOwat is configured through `/etc/ssowat/conf.json` which is generated by YunoHost. SSOwat is configured through `/etc/ssowat/conf.json` which is generated by YunoHost.
@ -67,9 +67,9 @@ SSOwat is configured through `/etc/ssowat/conf.json` which is generated by YunoH
It is an *optional* dependency of YunoHost and corresponds to an interface for the web API created by YunoHost and Moulinette (c.f. the `yunohost-api` service). It is an *optional* dependency of YunoHost and corresponds to an interface for the web API created by YunoHost and Moulinette (c.f. the `yunohost-api` service).
It essentially contains: It essentially contains:
- [view templates](https://github.com/YunoHost/yunohost-admin/tree/stretch-unstable/src/views) - [view templates](https://github.com/YunoHost/yunohost-admin/tree/dev/src/views)
- corresponding [JavaScript controllers](https://github.com/YunoHost/yunohost-admin/tree/stretch-unstable/src/js/yunohost/controllers) that interact with the YunoHost API - corresponding [JavaScript controllers](https://github.com/YunoHost/yunohost-admin/tree/dev/src/js/yunohost/controllers) that interact with the YunoHost API
- and [internationalized strings](https://github.com/YunoHost/yunohost-admin/tree/stretch-unstable/src/locales) - and [internationalized strings](https://github.com/YunoHost/yunohost-admin/tree/dev/src/locales)
### Working on the YunoHost Python/CLI core ### Working on the YunoHost Python/CLI core