doc: add documentation link in readme + configuration reference
Some checks reported warnings
arcad/arcast/pipeline/head This commit is unstable
Some checks reported warnings
arcad/arcast/pipeline/head This commit is unstable
This commit is contained in:
parent
654134e2d0
commit
7b8165a0ec
@ -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)
|
||||
|
5
doc/README.md
Normal file
5
doc/README.md
Normal file
@ -0,0 +1,5 @@
|
||||
# Documentation
|
||||
|
||||
- [Configuration](./configuration.md)
|
||||
- [API HTTP](./http-api.md)
|
||||
- [mDNS](./mdns.md)
|
50
doc/configuration.md
Normal file
50
doc/configuration.md
Normal file
@ -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"
|
||||
}
|
||||
}
|
||||
```
|
Loading…
Reference in New Issue
Block a user