From 0545c89ff43f502640c95f018223ae9730f41f9b Mon Sep 17 00:00:00 2001 From: Benjamin Pracht Date: Mon, 11 Sep 2023 13:26:42 -0700 Subject: [PATCH] Update documentation about template serving (#485) --- README.md | 12 ++++++------ template-default/README.md | 2 +- template-default/package.json | 3 +-- 3 files changed, 8 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 5628c70c..43bb114a 100644 --- a/README.md +++ b/README.md @@ -64,9 +64,9 @@ debug_handler_port: port used to host http debug handlers (default 0) logging: level: debug, info, warn, or error (default info) json: true -template_base: can be used to host custom templates (default https://egress-composite.livekit.io) +template_base: can be used to host custom templates (default http://localhost:/) backup_storage: files will be moved here when uploads fail. location must have write access granted for all users -enable_chrome_sandbox: if true, egress will run Chrome with sandboxing enabled. This requires a specific Docker setup, see below. +enable_chrome_sandbox: if true, egress will run Chrome with sandboxing enabled. This requires a specific Docker setup, see below. cpu_cost: # optionally override cpu cost estimation, used when accepting or denying requests room_composite_cpu_cost: 3.0 web_cpu_cost: 3.0 @@ -182,7 +182,7 @@ You can then use our [cli](https://github.com/livekit/livekit-cli) to submit egr ### Chrome sandboxing By default, Room Composite and Web egresses run with Chrome sandboxing disabled. This is because the default docker security settings prevent Chrome from -switching to a different kernel namespace, which is needed by Chrome to setup its sandbox. +switching to a different kernel namespace, which is needed by Chrome to setup its sandbox. Chrome sandboxing within Egress can be reenabled by setting the the `enable_chrome_sandbox` option to `true` in the egress configuration, and launching docker using the [provided seccomp security profile](https://github.com/livekit/egress/blob/main/chrome-sandboxing-seccomp-profile.json): @@ -198,14 +198,14 @@ docker run --rm \ This profile is based on the [default docker seccomp security profile](https://github.com/moby/moby/blob/master/profiles/seccomp/default.json) and allows the 2 extra system calls (`clone` and `unshare`) that Chrome needs to setup the sandbox. -Note that kubernetes disables seccomp entirely by default, which means that running with Chrome sandboxing enabled is possible on a kubernetes with +Note that kubernetes disables seccomp entirely by default, which means that running with Chrome sandboxing enabled is possible on a kubernetes cluster with the default security settings. ## FAQ ### Can I store the files locally instead of uploading to cloud storage? -- Yes, you can mount a volume with your `docker run` command (e.g. `-v ~/livekit-egress:/out/`), and use the mounted -directory in your filenames (e.g. `/out/my-recording.mp4`). Since egress is not run as the root user, write permissions +- Yes, you can mount a volume with your `docker run` command (e.g. `-v ~/livekit-egress:/out/`), and use the mounted +directory in your filenames (e.g. `/out/my-recording.mp4`). Since egress is not run as the root user, write permissions will need to be enabled for all users. ### I get a `"no response from egress service"` error when sending a request diff --git a/template-default/README.md b/template-default/README.md index 00729586..1fde93b3 100644 --- a/template-default/README.md +++ b/template-default/README.md @@ -1,5 +1,5 @@ # Default LiveKit Recording Templates -This repo contains the default recording template used with LiveKit Egress. It's deployed to https://egress-composite.livekit.io. +This repo contains the default recording template used with LiveKit Egress. The templates are deployed alongside and served by the egress service. See docs [here](https://docs.livekit.io/guides/egress/room-composite/#default-layouts) diff --git a/template-default/package.json b/template-default/package.json index a6070e84..a0d0dcb8 100644 --- a/template-default/package.json +++ b/template-default/package.json @@ -19,8 +19,7 @@ "start": "react-scripts start", "build": "react-scripts build", "test": "react-scripts test", - "eject": "react-scripts eject", - "deploy": "yarn build && echo 'egress-composite.livekit.io' > ./build/CNAME && gh-pages -d build --no-history" + "eject": "react-scripts eject" }, "eslintConfig": { "extends": [