emissary/doc/README.md

56 lines
1.8 KiB
Markdown
Raw Permalink Normal View History

2023-02-02 10:55:24 +01:00
# Documentation
2023-05-23 14:48:49 +02:00
- (FR) - [Introduction](./fr/introduction.md)
2023-02-02 10:55:24 +01:00
## Tutorials
- (FR) - [Premiers pas](./tutorials/fr/first-steps.md)
2023-05-25 21:22:56 +02:00
- (FR) - [Déployer un serveur mandataire inverse sur un agent](./tutorials/fr/deploy-reverse-proxy.md)
- (FR) - [Déployer une configuration UCI personnalisée sur un agent](./tutorials/fr/deploy-uci-configuration.md)
2023-02-02 10:55:24 +01:00
Emplacement des différentes documentation pour installation emissary.
- (FR) -[Différentes méthodes pour installer emissary](./tutorials/fr/install-emmissary-only.md)
## Emissary-agent
### borne
- [banana-bpi](https://forge.cadoles.com/arcad/emissary-firmware/src/branch/bananapi-r3/doc/Hardware-Sheet/banana-rpi-sheet.md)
- raspberry (a venir)
- linksys (a venir)
### BUILD
- [Compiler un firmware](https://forge.cadoles.com/arcad/emissary-firmware/src/branch/master/doc/tutorials/firmware-compilation.md)
- Compiler un firmware préconfiguré
- Créer une nouvelle cible de construction
- [flasher une borne](https://forge.cadoles.com/arcad/emissary-firmware/src/branch/bananapi-r3/doc/tutorials/device-flashing.md)
## DEBUG
### emissary-server
> TODO
### emissary-agent
> TODO
2023-02-02 10:55:24 +01:00
## References
2023-05-23 14:48:49 +02:00
### Specifications
2023-03-09 15:37:29 +01:00
2023-05-23 14:48:49 +02:00
- [Schéma `app.emissary.cadoles.com`](../internal/agent/controller/app/spec/schema.json)
- [Schéma `proxy.emissary.cadoles.com`](../internal/spec/proxy/schema.json)
- [Schéma `mdns.emissary.cadoles.com`](../internal/agent/controller/mdns/spec/schema.json)
2023-03-09 15:37:29 +01:00
- [Schéma `uci.emissary.cadoles.com`](../internal/spec/uci/schema.json)
2023-05-23 14:48:49 +02:00
- [Schéma `sysupgrade.openwrt.emissary.cadoles.com`](../internal/agent/controller/openwrt/spec/sysupgrade/schema.json)
2023-03-09 15:37:29 +01:00
2023-02-02 10:55:24 +01:00
### Configuration
See:
- [`misc/packaging/common/config-agent.yml`](../misc/packaging/common/config-agent.yml)
- [`misc/packaging/common/config-server.yml`](../misc/packaging/common/config-server.yml)