From 7b8165a0ec3a3dfa3e52a4f2266e2c769ed05e6f Mon Sep 17 00:00:00 2001
From: William Petit <wpetit@cadoles.com>
Date: Wed, 24 Apr 2024 12:13:28 +0200
Subject: [PATCH] doc: add documentation link in readme + configuration
 reference

---
 README.md            |  4 ++++
 doc/README.md        |  5 +++++
 doc/configuration.md | 50 ++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 59 insertions(+)
 create mode 100644 doc/README.md
 create mode 100644 doc/configuration.md

diff --git a/README.md b/README.md
index 3c54ec0..46c14c6 100644
--- a/README.md
+++ b/README.md
@@ -37,3 +37,7 @@ Avoir [Chromium](https://www.chromium.org/chromium-projects/) (ou `Google Chrome
 #### Dernière version
 
 - Linux: [`amd64`](https://forge.cadoles.com/arcad/arcast/releases/download/latest/arcad_player_linux_amd64), [`arm`](https://forge.cadoles.com/arcad/arcast/releases/download/latest/arcad_player_linux_arm), [`arm64`](https://forge.cadoles.com/arcad/arcast/releases/download/latest/arcad_player_linux_arm64)
+
+## Documentation
+
+Voir le répertoire [`doc`](./doc)
diff --git a/doc/README.md b/doc/README.md
new file mode 100644
index 0000000..03b972a
--- /dev/null
+++ b/doc/README.md
@@ -0,0 +1,5 @@
+# Documentation
+
+- [Configuration](./configuration.md)
+- [API HTTP](./http-api.md)
+- [mDNS](./mdns.md)
diff --git a/doc/configuration.md b/doc/configuration.md
new file mode 100644
index 0000000..249b3ce
--- /dev/null
+++ b/doc/configuration.md
@@ -0,0 +1,50 @@
+# Configuration
+
+Le server Arcast utilise un fichier de configuration permettant de personnaliser son comportement.
+Par défaut, ce fichier de configuration est créé aux emplacements suivants au lancement de l'application:
+
+- **Linux Desktop**:
+  - `${HOME}/.config/arcast-player/config.json`
+- **Android**:
+  - `/storage/emulated/0/Android/data/com.cadoles.arcast_player`
+  - `/data/user/0/com.cadoles.arcast_player/files/config.json` (si le premier chemin n'est pas accessible en lecture/écriture)
+
+Voici un exemple commenté du fichier de configuration:
+
+```json
+{
+  // Identifiant de l'instance
+  "instanceId": "<instance_id>",
+  // Configuration du serveur HTTP
+  "http": {
+    // Couple <address>:<port> d'écoute
+    // Par défaut ":" i.e. toutes les adresses avec port aléatoire
+    "address": ":"
+  },
+  // Configuration du serveur HTTPS
+  "https": {
+    // Couple <address>:<port> d'écoute
+    // Par défaut ":" i.e. toutes les adresses avec port aléatoire
+    "address": ":",
+    // Certificat x509 (format PEM, encodé en base64)
+    "cert": "<base64_encoded_pem_cert>",
+    // Clé privée du certificat (format PEM, encodé en base64)
+    "key": "<base64_encoded_pem_key>",
+    // Configuration de la génération du certificat autosigné
+    "selfSigned": {
+      // Activer/désactiver la génération du certificat auto-signé
+      "enabled": true,
+      // Empreinte réseau associée au certificat autosigné
+      // Permet de détecter si il y a eu un changement sur les adresses IPs du player
+      "networkFingerprint": "40f4cd914c6163657fe4e37128f90b501b768221c77b5dbfa35ca74a84b8732a"
+    }
+  },
+  // Configuration des applications embarquées
+  "apps": {
+    // Activer/désactiver les applications embarquées
+    "enabled": true,
+    // Application par défaut
+    "defaultApp": "home"
+  }
+}
+```