Deployment guide

Webhood is deployed as a set of containers that run the backend, frontend, and scanner components. You can use any container engines such as containerd and Podman and orchestration tools such as Kubernetes to deploy Webhood.

To quickly get started with running your own instance, this example deployment guide will show you how to deploy Webhood using Docker Compose.

Prerequisites

• Docker (opens in a new tab)
• Docker Compose (opens in a new tab)
• Common cli tools (e.g. curl, wget)
• Git

Deployment

git clone https://github.com/webhood-io/webhood.git --depth=1 --branch=main
cd webhood

cp .env.example .env

   docker compose run backend migrate

   docker compose run backend create_scanner_token

docker compose up -d

   random=$(openssl rand -base64 16) # generate some random string, or just make your own password
   docker compose run backend create_user -u admin -p $random && echo "Password is:" $random for user 'admin'

Known issues

Invalid interpolation format for "environment" option...

Cause: The docker-compose.yaml file includes some interpolation (opens in a new tab) magic to set correct configuration values from the .env file if they exist. Support for interpolation may not exist in older docker-compose versions.

Solution: To resolve this error, you need to either:

1. Install the latest version of docker compose (opens in a new tab)

or

2. Remove / manually set environment variable of the lines that produce the error in the docker-compose.yaml file.

Next steps