Compare commits

...

3 Commits

Author SHA1 Message Date
a1ec5b87c8 doc: proposed structure for documentation => one place to see them all. Add in doc/readme.md all the source for documentation include emissary-agent
All checks were successful
arcad/emissary/pipeline/head This commit looks good
2023-08-25 13:29:29 +02:00
5c36955c13 doc: add one file to stack all documentation source for install emissary (local, package, ansible)
All checks were successful
arcad/emissary/pipeline/head This commit looks good
2023-08-25 11:24:16 +02:00
6cf01adb61 chore: tidy deps
All checks were successful
arcad/emissary/pipeline/head This commit looks good
2023-08-14 14:49:41 -06:00
5 changed files with 105 additions and 1 deletions

View File

@ -16,6 +16,10 @@ Download the pre-compiled binaries from the [releases page](https://forge.cadole
See [`doc`](./doc/README.md)
## Avancée
See [TODO](./doc/fr/TODO.md)
## Licence & mentions
[AGPL-3.0](https://www.gnu.org/licenses/agpl-3.0.html#license-text)

View File

@ -8,6 +8,35 @@
- (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)
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
## References
### Specifications

54
doc/fr/TODO.md Normal file
View File

@ -0,0 +1,54 @@
# document de suivi des évolutions et test
## tableau de suivi
| etat | action | détail |
| :- | :-: | :- |
| OK | construction d'un firmware (bpi-r3) | #valide2023-08-02 |
| OK | documentation construction d'un firmware pour les autres version | #valide2023-08-02 |
| OK | installation d'un firmware sur bananapi bpi-r3 | #valide2023-08-16 |
| OK | validation firmware pour bananapi bpi-r3 | #valide2023-08-18 |
| OK | test appairage banana pi bpi-r3 | #valide2023-08 |
| OK | validation firmware pour bananapi bpi-r3 | #valide |
| EnCours | pousser dans la branche master construction d'un firmware (bpi-r3) | - |
| EnCours | installation d'un firmware sur raspberry3 | - |
| EnCours | validation firmware pour raspberry3 | fonctionnement avant apparaige |
| NEXT | test appairage raspberry3 | implique réalisation d'une doc |
| NEXT | validation firmware pour raspberry3 | fonctionnement après apparaige |
| NEXT | test appairage pour raspberry3 | fonctionnement après apparaige |
| NEXT | validation/réalisation documentation | - |
| NOK | construction d'un firmware sur lynksys | - |
| NOK | installation d'un firmware sur lynksys | - |
| NOK | - | - |
| NOK | - | - |
| NOK | chaîne de validation avant/après apparairage | implique réalisation d'une doc |
| Server| SERVER | server |
| OK | installation emissary server en locale | via tar.gz #valide2023-08-02 |
| OK | validation installation du server en locale | #valide2023-08 |
| OK | installation emissary server sur ubuntu mint 21.0 | via paquet .deb #valide2023-08-02 |
| OK | installation emissary server sur ubuntu 22.04 | via paquet .deb #valide2023-08-02 |
| OK | validation installation du server | #valide2023-08 |
| OK | appairage borne (bpi-r3) sur emissary-server (ubuntu) | #valide2023-08 |
| OK | appairage documentation (ubuntu) borne (bpi-r3) | #valide2023-08 |
| OK | validation ansible | #valide2023-08 alpine3.16 |
| OK | validation ansible | #valide2023-08 alpine3.18 |
| OK | validation ansible documentation | #valide2023-08 |
| OK | appairage borne (bpi-r3) sur emissary-server (alpine 3.16 & 3.18) | #valide2023-08 |
| OK | appairage documentation (ansible alpine) borne (bpi-r3) | #valide2023-08 |
| OK | modification conf uci d'une borne | #valide2023-08 |
| OK | documentation modification conf uci d'une borne | #valide2023-08 |
| autre | AUTRE | autre |
| EnCours | relecture doc officiel | implique application des actions mentionné |
| EnCours | création d'un point de redirection pour toute la documentation | |
## demande supplémentaire
Stipuler l'émetteur permet de savoir à qui s'adresser pour en discuter.
| STATUS | action | détail | emetteur|
|:- | :-: | :- | :- |
installation/debug emissary-server | lseys |
| Proposition | CODE | script de validation installation/debug emissary-agent | lseys |
| Proposition | CODE | script de validation
| Proposition | DOC | debug/astuce emissary-server | lseys |
| Proposition | DOC | debug/astuce emissary-agent | lseys |

View File

@ -0,0 +1,17 @@
# installation
processus d'installation
Il y a à ce jours trois méthode différente d'installation !
1. via le paquet.deb disponible sur la forge (pour installation sur un serveur)
cf : [doc-emissary](./first-steps.md) (chapitre : Installer le serveur Emissary)
2. via l'archive disponible sur la forge (pour installation sur une machine locale a des fin de test ou autre)
cf : [doc-emissary-firmware](https://forge.cadoles.com/arcad/emissary-firmware/src/branch/master/doc/tutorials/first-steps.md) (chapitre : Récupérer et lancer un serveur Emissary sur sa machine)
3. via ansible (uniquement alpine pour le moment) (cf: [arcad-ansible](https://forge.cadoles.com/arcad/ansible))
cf : [doc-arcad-ansible](https://forge.cadoles.com/arcad/ansible/src/branch/master/doc/deploy-new-env.md) (Chapitre : Préparation de l'environnement)

2
go.mod
View File

@ -7,6 +7,7 @@ require (
github.com/Masterminds/sprig/v3 v3.2.3
github.com/alecthomas/participle/v2 v2.0.0-beta.5
github.com/andreyvit/diff v0.0.0-20170406064948-c7f18ee00883
github.com/antonmedv/expr v1.12.7
github.com/brutella/dnssd v1.2.6
github.com/btcsuite/btcd/btcutil v1.1.3
github.com/davecgh/go-spew v1.1.1
@ -33,7 +34,6 @@ require (
require (
github.com/Masterminds/goutils v1.1.1 // indirect
github.com/Masterminds/semver/v3 v3.2.0 // indirect
github.com/antonmedv/expr v1.12.7 // indirect
github.com/barnybug/go-cast v0.0.0-20201201064555-a87ccbc26692 // indirect
github.com/dop251/goja_nodejs v0.0.0-20230320130059-dcf93ba651dd // indirect
github.com/gabriel-vasile/mimetype v1.4.1 // indirect