n8n-sandbox-runner
Docker app from benjaminmue's Repository
Overview
Readme
View on GitHubn8n Sandbox Service
Isolated, on-demand execution environments behind a REST API. Each sandbox is a container (Docker/Sysbox runner) or a Firecracker microVM, with a small HTTP daemon inside that runs commands and handles files. Runners register with a central API, which places sandboxes and proxies requests to them.
Get started
| I want to… | Read |
|---|---|
| Run it on a Linux host with Sysbox | docs/quickstart-linux.md |
| Run the Firecracker runner on a KVM host | docs/quickstart-firecracker-linux.md |
| Develop on macOS | docs/quickstart-macos.md |
| Deploy to Kubernetes | docs/quickstart-k8s.md |
| Call the API | docs/API.md · TypeScript SDK |
| Build and test | docs/development.md |
The full index, including architecture, security model, configuration, operations and release process, is in docs/README.md.
License
Source under the Sustainable Use License. Files and directories with .ee in the name are under the n8n Enterprise License.
Categories
Related apps
Explore more like this
Explore allDetails
ghcr.io/n8n-io/n8n-sandbox-service-runner-dind:stableRuntime arguments
- Network
n8n-sandbox- Shell
sh- Privileged
- true
- Extra Params
--network-alias=n8n-sandbox-runner-1 --restart=unless-stopped
Template configuration
The runner/ subfolder of the TLS path of n8n-sandbox-api. Created there on the first start of n8n-sandbox-api.
- Target
- /tls/runner
- Default
- /mnt/user/appdata/n8n-sandbox/tls/runner
- Value
- /mnt/user/appdata/n8n-sandbox/tls/runner
Storage of the inner Docker engine. Must be a pool or disk path (/mnt/cache/..., /mnt/POOLNAME/...), NOT /mnt/user/...: the inner Docker fails on the user share file system.
- Target
- /var/lib/docker
- Default
- /mnt/cache/appdata/n8n-sandbox/docker
- Value
- /mnt/cache/appdata/n8n-sandbox/docker
Must be identical to Runner registration token in n8n-sandbox-api.
- Target
- SANDBOX_RUNNER_REGISTRATION_TOKEN
Must be identical to Runner key in n8n-sandbox-api.
- Target
- SANDBOX_RUNNER_API_KEYS
Image of the per-sandbox containers, pulled by the inner Docker on first use.
- Target
- SANDBOX_RUNNER_DOCKER_SANDBOX_IMAGE
- Default
- ghcr.io/n8n-io/n8n-sandbox-service-sandbox:stable
- Value
- ghcr.io/n8n-io/n8n-sandbox-service-sandbox:stable
Do not change.
- Target
- SANDBOX_RUNNER_ID
- Default
- runner-1
- Value
- runner-1
Registration endpoint of n8n-sandbox-api on the n8n-sandbox network. Do not change.
- Target
- SANDBOX_RUNNER_API_GRPC_ADDR
- Default
- n8n-sandbox-api:9090
- Value
- n8n-sandbox-api:9090
Name in the API certificate. Do not change.
- Target
- SANDBOX_RUNNER_REGISTRATION_GRPC_SERVER_NAME
- Default
- n8n-sandbox-api
- Value
- n8n-sandbox-api
Address under which n8n-sandbox-api reaches this runner. Do not change.
- Target
- SANDBOX_RUNNER_HTTP_BASE_URL
- Default
- https://n8n-sandbox-runner-1:8080
- Value
- https://n8n-sandbox-runner-1:8080
Do not change.
- Target
- SANDBOX_RUNNER_CONTROL_GRPC_LISTEN_ADDR
- Default
- :9091
- Value
- :9091
Do not change.
- Target
- SANDBOX_RUNNER_CONTROL_GRPC_ADVERTISE_ADDR
- Default
- n8n-sandbox-runner-1:9091
- Value
- n8n-sandbox-runner-1:9091
Do not change.
- Target
- SANDBOX_RUNNER_REGISTRATION_GRPC_CA_FILE
- Default
- /tls/runner/ca.crt
- Value
- /tls/runner/ca.crt
Do not change.
- Target
- SANDBOX_RUNNER_REGISTRATION_GRPC_CERT_FILE
- Default
- /tls/runner/grpc-client.crt
- Value
- /tls/runner/grpc-client.crt
Do not change.
- Target
- SANDBOX_RUNNER_REGISTRATION_GRPC_KEY_FILE
- Default
- /tls/runner/grpc-client.key
- Value
- /tls/runner/grpc-client.key
Do not change.
- Target
- SANDBOX_RUNNER_CONTROL_GRPC_TLS_CERT_FILE
- Default
- /tls/runner/control-grpc-server.crt
- Value
- /tls/runner/control-grpc-server.crt
Do not change.
- Target
- SANDBOX_RUNNER_CONTROL_GRPC_TLS_KEY_FILE
- Default
- /tls/runner/control-grpc-server.key
- Value
- /tls/runner/control-grpc-server.key
Do not change.
- Target
- SANDBOX_RUNNER_CONTROL_GRPC_TLS_CLIENT_CA_FILE
- Default
- /tls/runner/ca.crt
- Value
- /tls/runner/ca.crt