SwissKnife Docs
Get started

Get started

Choose the right installation path for your environment.

SwissKnife can be started in three ways. Every path produces the same static application.

PathWhen to use itPage
docker-compose.ymlhomelab instance using the GHCR imageDocker installation
docker-compose.build.ymlbuild the current checkoutDocker installation
Tags and recoverable pinslatest plus sha-<commit> / digestGHCR image
Vitedevelop or contributeLocal development

The public demo is not a fourth installation method. It is a dedicated build mode of the same product, already hosted at demo.swissknife.lucas-homelab.fr.

  1. Check the requirements.
  2. Install with Docker, using the GHCR image by default.
  3. Before publishing outside your LAN, read Reverse proxy: COOP and COEP headers must be preserved.
  4. Read the actual limitations before diagnosing a failed conversion.

On this page