documentation #2

Open
lseys wants to merge 8 commits from documentation into develop
2 changed files with 66 additions and 4 deletions
Showing only changes of commit f802e28d26 - Show all commits

View File

@ -1,8 +1,8 @@
- [Configuration](#configuration)
- [Personnalisation](#personnalisation)
- [Personnalisation de l'apparence](#personnalisation-de-lapparence)
- [Exemple](#exemple)
- [index.gohtml exemple](#indexgohtml-exemple)
- [Configuration arcast-player](#configuration-arcast-player)
# Configuration
@ -58,7 +58,7 @@ Voici un exemple commenté du fichier de configuration:
}
```
## Personnalisation
## Personnalisation de l'apparence
Il est possible de personnaliser la page d'accueil du player Arcast en créant des fichiers dans le répertoire définit par l'attribut de configuration `http.customDir`.
@ -123,4 +123,49 @@ Une fois les fichiers dûments remplis, il suffit de lancer, ou re-lancer arcast
Exemple de rendu avec logo cadoles.
![exemple](./resources/arcast-exemple.png)
![exemple](./resources/arcast-exemple.png)
## Configuration arcast-player
Comme constaté lors de l'affichage de l'aide pour `arcast-player run -help` il est possible d'utiliser les flags chrome pour paramétrer plus finement l'affichage.
Liens pour une liste des flags disponible à destination de chrome : [liens falgs chrome](https://peter.sh/experiments/chromium-command-line-switches/)
rappel :
```Shell
[computer@user ~]$ arcast-player run -help
NAME:
arcast run
USAGE:
arcast run [command options] [arguments...]
OPTIONS:
--config value (default: "/home/panda/.config/arcast-player/config.json") [$ARCAST_DESKTOP_CONFIG]
--additional-chrome-arg value [ --additional-chrome-arg value ] (default: "incognito") [$ARCAST_DESKTOP_ADDITIONAL_CHROME_ARGS]
--instance-id value [$ARCAST_DESKTOP_INSTANCE_ID]
--address value (default: ":") [$ARCAST_DESKTOP_ADDRESS]
--https-address value (default: ":") [$ARCAST_DESKTOP_HTTPS_ADDRESS]
--window-height value (default: 0) [$ARCAST_DESKTOP_WINDOW_HEIGHT]
--apps (default: false) [$ARCAST_DESKTOP_APPS]
--window-width value (default: 0) [$ARCAST_DESKTOP_WINDOW_WIDTH]
--allowed-origins value [ --allowed-origins value ] [$ARCAST_DESKTOP_ALLOWED_ORIGINS]
--custom-files-dir value [$ARCAST_DESKTOP_CUSTOM_FILES_DIR]
--dummy-browser (default: false) [$ARCAST_DESKTOP_DUMMY_BROWSER]
--help, -h show help
```
Exemple pour lancer chrome en ligne de commande avec le mode kiosk.
Deux possibilités :
```Shell
arcast-player run --additional-chrome-arg incognito --additional-chrome-arg kiosk
```
Il est aussi possible d'utiliser une variable d'environnement comme indiqué dans l'aide.
```Shell
ARCAST_DESKTOP_ADDITIONAL_CHROME_ARGS="incognito,kiosk" arcast-player run
```

View File

@ -1,6 +1,7 @@
- [Usage](#usage)
- [Linux](#linux)
- [Arcast-player en ligne de commande](#arcast-player-en-ligne-de-commande)
- [Kiosk mode](#kiosk-mode)
- [Arcast-client en ligne de commande](#arcast-client-en-ligne-de-commande)
- [Démarrer un cast](#démarrer-un-cast)
- [Scan](#scan)
@ -29,6 +30,22 @@ arcast-player run
arcast-player run -help
```
#### Kiosk mode
Pour lancer arcast-player en mode kiosk via la ligne de commande :
```Shell
arcast-player run --additional-chrome-arg incognito --additional-chrome-arg kiosk
```
Il est aussi possible d'utiliser une variable d'environnement.
```Shell
ARCAST_DESKTOP_ADDITIONAL_CHROME_ARGS="incognito,kiosk" arcast-player run
```
Liste des command pour chrome, permet d'avoir les informations nécessaire sur les flags disponible au lancement du cast. [link](https://peter.sh/experiments/chromium-command-line-switches/)
### Arcast-client en ligne de commande
Afficher les commandes disponibles: