Get started
Requirements
Software, ports and decisions to prepare before installation.
Recommended Docker installation
- Docker Engine and Docker Compose v2;
- command-line access with permission to run containers;
- TCP port
2501available on the host, or another chosen host port; - no persistent storage to provision because SwissKnife writes no application volume.
Development from source
- Node.js 22, as declared by the product
package.jsonenginesfield; - npm 10 or newer, using the repository lockfile (
npm ci).
Decisions to make
| Question | Recommended choice |
|---|---|
| How should I install it? | docker-compose.yml with the GHCR image for an instance; docker-compose.build.yml to validate a checkout |
| Which port? | host 2501 by default, on all interfaces; use 127.0.0.1:2501:2501 for localhost only |
| Remote access? | default Compose is already LAN-reachable; put an HTTPS reverse proxy in front before leaving a trusted network; preserve COOP and COEP |
| Public demo? | use the official URL instead of exposing your own instance |
Check Docker Compose
docker version
docker compose version