Skip to content

Commit

Permalink
Update documentation about template serving (#485)
Browse files Browse the repository at this point in the history
  • Loading branch information
biglittlebigben authored Sep 11, 2023
1 parent 6507083 commit 0545c89
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 9 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:<template_port>/)
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
Expand Down Expand Up @@ -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):
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion template-default/README.md
Original file line number Diff line number Diff line change
@@ -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)
3 changes: 1 addition & 2 deletions template-default/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": [
Expand Down

0 comments on commit 0545c89

Please sign in to comment.