feat: comment packaged agent and server configurations (#1)

This reverts commit 5c36955c13.

README.md

@@ -16,10 +16,6 @@ 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)

doc/README.md

@@ -8,35 +8,6 @@
 - (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
@@ -53,3 +24,7 @@ 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)
+
+### Other projects
+
+- [`emissary-firmware`](https://forge.cadoles.com/arcad/emissary-firmware) - Preconfigured OpenWRT firmwares with an agent

doc/fr/TODO.md

@@ -1,54 +0,0 @@
-# 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 |

doc/tutorials/fr/install-emmissary-only.md

@@ -1,17 +0,0 @@
-# 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)

misc/packaging/common/config-agent.yml

@@ -1,26 +1,55 @@
+# Emissary agent configuration
+
+# Logger configuration
 logger:
+  # Logging verbosity
+  # DEBUG: 0
+  # INFO: 1
+  # WARN: 2
+  # ERROR: 3
+  # CRITICAL: 4
   level: 1
+  # Logging format
+  # Possible values: human, json
   format: human
+
+# Agent configuration
 agent:
+  # Emissary server URL
   serverUrl: http://127.0.0.1:3000
+  # Agent private key path
   privateKeyPath: /var/lib/emissary/agent-key.json
-  reconciliationInterval: 5
+  # Agent reconciliation interval (in seconds)
+  reconciliationInterval: 30
+
+  # Controllers configuration
   controllers:
+    # Persistence controller configuration
     persistence:
       enabled: true
       stateFile: /var/lib/emissary/state.json
+
+    # Spec controller configuration
     spec:
       enabled: true
+    
+    # Proxy controller configuration
     proxy:
       enabled: true
+
+    # UCI controller configuration
     uci:
       enabled: true
       binPath: uci
       configBackupFile: /var/lib/emissary/uci-backup.conf
+    
+    # App controller configuration
     app:
       enabled: true
       dataDir: /var/lib/emissary/apps/data
       downloadDir: /var/lib/emissary/apps/bundles
+    
+    # Sysupgrade controller configuration
     sysupgrade:
       enabled: true
       sysupgradeCommand:
@@ -33,6 +62,8 @@ agent:
         - sh
         - -c
         - source /etc/openwrt_release && echo "$DISTRIB_ID-$DISTRIB_RELEASE-$DISTRIB_REVISION"
+  
+  # Collectors configuration
   collectors:
     - name: uname
       command: uname

misc/packaging/common/config-server.yml

@@ -1,13 +1,38 @@
+# Emissary server configuration
+
+# Logger configuration
 logger:
+  # Logging verbosity
+  # DEBUG: 0
+  # INFO: 1
+  # WARN: 2
+  # ERROR: 3
+  # CRITICAL: 4
   level: 1
+  # Logging format
+  # Possible values: human, json
   format: human
+
+# Server configuration
 server:
+  # HTTP server configuration
   http:
+    # Listening address (0.0.0.0 to listen on all interfaces)
     host: 0.0.0.0
+    # Listening port
     port: 3000
+  
+  # Database configuration
   database:
+    # Database driver
+    # Possible values: sqlite
     driver: sqlite
+    # Database DSN
+    # sqlite: see https://github.com/mattn/go-sqlite3#connection-string
     dsn: sqlite:///var/lib/emissary/data.sqlite?_pragma=foreign_keys(1)&_pragma=busy_timeout=60000
+  
+  # CORS configuration
+  # See https://developer.mozilla.org/en/docs/Glossary/CORS
   cors:
     allowedOrigins: []
     allowCredentials: true
@@ -22,12 +47,25 @@ server:
       - Content-Type
       - Authorization
       - Sentry-Trace
-  debug: false
+  
+  # Auth configuration
   auth:
+    # Local authentication configuration
     local:
       privateKeyPath: /var/lib/emissary/server-key.json
-    roleExtractionRules:
-      - "jwt.role != nil ? str(jwt.role) : ''"
+    
+    # Remote authentication configuration
+    # Disabled by default
     remote: ~
       # jwksUrl: https://my-server/.well-known/jwks.json
-    
+
+    # Role extraction rules
+    # Permit to derivate user's role 
+    # from the received JWT.
+    #
+    # The first rule returning a non empty
+    # string will define the role of the user.
+    #
+    # The role should be 'reader' or 'writer'.
+    roleExtractionRules:
+      - "jwt.role != nil ? str(jwt.role) : ''"