Skip to content

Commit

Permalink
docs: added more detail about autopauase rootless usage (#2814)
Browse files Browse the repository at this point in the history
  • Loading branch information
itzg authored May 4, 2024
1 parent d6cc103 commit 7153e14
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions docs/misc/autopause-autostop/autopause.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,9 @@ The following environment variables define the behaviour of auto-pausing:

## Rootless Auto-Pause

If you're running the container as rootless, you might need to set change the default port forwarder from RootlessKit to slirp4netns.
If you're running the container as rootless, then it is necessary to add the `CAP_NET_RAW` capability to the container, such as using [the `cap_add` service field](https://docs.docker.com/compose/compose-file/05-services/#cap_add) in a compose file or [`--cap-add` docker run argument](https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities). It may also be necessary to set the environment variable `SKIP_SUDO` to "true".

You might need to set change the default port forwarder from RootlessKit to slirp4netns.

For Docker, see the following for setup:

Expand All @@ -54,8 +56,9 @@ For Docker, see the following for setup:

For Podman, see the following for setup:
- https://rootlesscontaine.rs/getting-started/podman/#changing-the-port-forwarder
- Run with

```
-e AUTOPAUSE_KNOCK_INTERFACE=tap0 --cap-add=CAP_NET_RAW --network slirp4netns:port_handler=slirp4netns
```

!!! example "Using docker run"

-e AUTOPAUSE_KNOCK_INTERFACE=tap0 --cap-add=CAP_NET_RAW --network slirp4netns:port_handler=slirp4netns

0 comments on commit 7153e14

Please sign in to comment.