Compare commits

3 Commits

Author SHA1 Message Date
f802e28d26 doc: add kiosk mode
All checks were successful
arcad/arcast/pipeline/pr-develop This commit looks good
2024-05-02 11:50:33 +02:00
16f5e1873d doc: text correction
All checks were successful
arcad/arcast/pipeline/pr-develop This commit looks good
2024-04-30 16:28:45 +02:00
a4784e9226 doc: add img for exemple 2024-04-30 16:27:42 +02:00
4 changed files with 93 additions and 25 deletions

View File

@ -1,8 +1,8 @@
- [Configuration](#configuration) - [Configuration](#configuration)
- [Personnalisation](#personnalisation) - [Personnalisation de l'apparence](#personnalisation-de-lapparence)
- [Exemple](#exemple) - [Exemple](#exemple)
- [index.gohtml exemple](#indexgohtml-exemple) - [index.gohtml exemple](#indexgohtml-exemple)
- [Configuration arcast-player](#configuration-arcast-player)
# Configuration # 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`. 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`.
@ -76,7 +76,7 @@ ${HOME}/.config/arcast-player/
└── custom └── custom
``` ```
Nous avons une image **logo.png**, un fichier css pour l'apparence **exemple.css**, et un templates **index.gohtml** dans le dossier _templates, contenant le texte à afficher, et sa position dans la fenêtre. Nous avons une image **logo.png**, un fichier css pour l'apparence **exemple.css**, et un template **index.gohtml** dans le dossier `_templates`, contenant le texte à afficher, et sa position dans la fenêtre.
Soit : Soit :
@ -120,3 +120,52 @@ Une fois les fichiers dûments remplis, il suffit de lancer, ou re-lancer arcast
{{ template "base" . }} {{ template "base" . }}
{{ end }} {{ end }}
``` ```
Exemple de rendu avec logo cadoles.
![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

@ -8,7 +8,7 @@
# Installation # Installation
Les paquets sont actuellement générés, et fonctionnel pour : Les paquets sont actuellement générés, et fonctionnels pour :
architecture : architecture :
@ -24,7 +24,7 @@ OS :
- android - android
- .apk - .apk
Leur téléchargement pour les version linux sont disponible sur : [arcast-cadoles](https://forge.cadoles.com/arcad/arcast/releases) Leurs téléchargements pour les versions linux sont disponibles sur : [arcast-cadoles](https://forge.cadoles.com/arcad/arcast/releases)
**arcast-client**: permet d'envoyer des flux sur les players **arcast-client**: permet d'envoyer des flux sur les players
@ -34,9 +34,9 @@ Leur téléchargement pour les version linux sont disponible sur : [arcast-cadol
L'App android est déployée sur [https://fdroid.cadol.es/repo/](https://fdroid.cadol.es/repo/) L'App android est déployée sur [https://fdroid.cadol.es/repo/](https://fdroid.cadol.es/repo/)
Pour ajouter ce repo utilisez F-droid. (paramètre/depôt cliquer sur **+**) Pour ajouter ce repo utilisez [F-droid](https://f-droid.org/fr/). (paramètre/depôt cliquer sur **+**)
Arcast Player apparaîtra dans les nouveautées. Une fois installé, ouvrir f-droid, Arcast Player apparaîtra dans les nouveautées.
## Arcast-player & client ## Arcast-player & client

Binary file not shown.

After

Width:  |  Height:  |  Size: 53 KiB

View File

@ -1,22 +1,23 @@
- [Usage](#usage) - [Usage](#usage)
- [Linux](#linux) - [Linux](#linux)
- [Arcast-player en ligne de commande](#arcast-player-en-ligne-de-commande) - [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) - [Arcast-client en ligne de commande](#arcast-client-en-ligne-de-commande)
- [démarrer un cast](#démarrer-un-cast) - [Démarrer un cast](#démarrer-un-cast)
- [scan](#scan) - [Scan](#scan)
- [status](#status) - [Status](#status)
- [reset](#reset) - [Reset](#reset)
- [Arcast-player affichage](#arcast-player-affichage) - [Arcast-player affichage](#arcast-player-affichage)
# Usage # Usage
## Linux ## Linux
Vous pouvez lancer arcast grâce à son icone depuis l'interface graphique. Si vous souhaitez avoir un mode fullscreen/kiosk il suffit d'effectuer un clic droit sur l'icône de l'application et choisir le mode sus-mentionné. Vous pouvez lancer arcast grâce à son icône depuis l'interface graphique. Si vous souhaitez avoir un mode fullscreen/kiosk il suffit d'effectuer un clic droit sur l'icône de l'application et de choisir le mode sus-mentionné.
### Arcast-player en ligne de commande ### Arcast-player en ligne de commande
Pour afficher les commandes disponible : Pour afficher les commandes disponibles :
`arcast-player -help` `arcast-player -help`
@ -29,13 +30,29 @@ arcast-player run
arcast-player run -help 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 ### Arcast-client en ligne de commande
Afficher les commandes disponibles: Afficher les commandes disponibles:
`arcast-client -help` `arcast-client -help`
Il y a quatre commande disponibles hors help : Il y a quatre commandes disponibles hors help :
- cast - cast
- reset - reset
@ -43,9 +60,9 @@ Il y a quatre commande disponibles hors help :
- status - status
- help - help
chaucune peut prendre des options particulière, pour les voir `arcast-client [commande] -help` Chacune peut prendre des options particulières, pour les consulter `arcast-client [commande] -help`
#### démarrer un cast #### Démarrer un cast
Effectuer un scan pour avoir les informations du client ciblé puis lancer la commande : `arcast-client cast --player-address x.x.x.x:port https://macible` Effectuer un scan pour avoir les informations du client ciblé puis lancer la commande : `arcast-client cast --player-address x.x.x.x:port https://macible`
@ -55,7 +72,7 @@ exemple :
user@localhost$ arcast-client cast --player-address 192.168.10.197:45555 https://www.cadoles.com user@localhost$ arcast-client cast --player-address 192.168.10.197:45555 https://www.cadoles.com
``` ```
#### scan #### Scan
Vous pouvez scanner le réseau actuel pour détecter tous les **arcast-player** en route. Vous pouvez scanner le réseau actuel pour détecter tous les **arcast-player** en route.
@ -69,9 +86,9 @@ user@localhost$ arcast-client scan
+-----------------------+-----------------------------------+-------+ +-----------------------+-----------------------------------+-------+
``` ```
#### status #### Status
De même, il est possible d'afficher les arcast-player utilisé, et afficher ce qui est casté. De même, il est possible d'afficher les arcast-player utilisés, et afficher ce qui est casté.
```Shell ```Shell
user@localhost$ arcast-client status user@localhost$ arcast-client status
@ -83,9 +100,9 @@ user@localhost$ arcast-client status
+-----------------------+----------------------+---------+-------------------+--------------------------+ +-----------------------+----------------------+---------+-------------------+--------------------------+
``` ```
#### reset #### Reset
Vous pouvez stopper tous les caste en cours. Vous pouvez stopper tous les castes en cours.
```Shell ```Shell
user@localhost$ arcast-client reset user@localhost$ arcast-client reset
@ -98,13 +115,15 @@ user@localhost$ arcast-client reset
## Arcast-player affichage ## Arcast-player affichage
Rappel, pour lancer un player : `arcast-player run`
Vous avez démarré un player, une fenêtre c'est ouverte comme suivant : Vous avez démarré un player, une fenêtre c'est ouverte comme suivant :
![image-arcast-player](./resources/arcast-player-run.png) ![image-arcast-player](./resources/arcast-player-run.png)
Dans les zones **Address** et **Apps** vous avez les IP sur lesquelles le cast est disponible. Dans les zones **Address** et **Apps** vous avez les IP sur lesquelles le cast est disponible.
Depuis votre poste, ou un autre entré l'adresse qui correspond à votre réseau et qui ce trouve sous **Apps**. Depuis votre poste, ou un autre entrer l'adresse qui correspond à votre réseau et qui ce trouve sous **Apps**.
Accepter le risk, (advanced/accept the risk and continue). Vous aurez la même page, cliquer sur l'adresse dans **Apps** qui correspond. Accepter le risk, (advanced/accept the risk and continue). Vous aurez la même page, cliquer sur l'adresse dans **Apps** qui correspond.
@ -112,6 +131,6 @@ Accepter le risk, (advanced/accept the risk and continue). Vous aurez la même p
Vous pourrez depuis cette interface : Vous pourrez depuis cette interface :
1. soit partager votre écran, pour cela cliquer sur **Screen sharing**, puis choississez ce que vous voulez partager. 1. Soit partager votre écran, pour cela cliquer sur **Screen sharing**, puis choississez ce que vous voulez partager.
2. Soit entrer une adresse web, et lancer un cast de la page choisit 2. Soit entrer une adresse web, et lancer un cast de la page choisit
3. Soit désactiver un cast en cliquant sur reset 3. Soit désactiver un cast en cliquant sur reset