jitsi-component-*, docs: update instructions

jitsi-contrib · Feb 29, 2024 · 6d803bf · 6d803bf
1 parent cf41f62
commit 6d803bf
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 3 deletions.
diff --git a/jitsi-component-selector/README.md b/jitsi-component-selector/README.md
@@ -5,13 +5,15 @@
 - This service needs `Redis` and `ASAP key server`.
 - Assumed that the host IP is `172.17.17.1`.
 
-Run the following in this folder but in a different shell to simulate ASAP key
-server.
+Run the following command in this folder but in a different shell to simulate
+ASAP key server.
 
 ```bash
 python3 -m http.server -d ../files/asap 8000
 ```
 
+Pull the image and run:
+
 ```bash
 docker run -d -p 6379:6379 redis
 

diff --git a/jitsi-component-sidecar/README.md b/jitsi-component-sidecar/README.md
@@ -2,7 +2,21 @@
 
 ## Run
 
-Assumed that `jitsi-component-selector`'s IP address is `172.17.17.1`.
+- Assumed that `jitsi-component-selector`'s IP address is `172.17.17.1`.
+
+```bash
+docker pull ghcr.io/jitsi-contrib/docker-images/jitsi-component-sidecar:latest
+
+docker run \
+  -e COMPONENT_TYPE='SIP-JIBRI' \
+  -e ENABLE_STOP_INSTANCE=true \
+  -e WS_SERVER_URL='ws://172.17.17.1:8015' \
+  -e ASAP_SIGNING_KEY_FILE=/app/asap.key \
+  -v ${PWD}/../files/asap/asap.key:/app/asap.key \
+  ghcr.io/jitsi-contrib/docker-images/jitsi-component-sidecar
+```
+
+## Build and Run
 
 ```bash
 docker image build -t jitsi-component-sidecar .