diff --git a/pages/docs/deployment.mdx b/pages/docs/deployment.mdx
index 6ee9734..79158db 100644
--- a/pages/docs/deployment.mdx
+++ b/pages/docs/deployment.mdx
@@ -1,5 +1,5 @@
import { Tab, Tabs } from "nextra-theme-docs"
-import { Card, Cards, FileTree } from 'nextra/components'
+import { Card, Cards, FileTree, Steps } from 'nextra/components'
import {Cog, Lock, RefreshCcw} from 'lucide-react'
import { Callout } from 'nextra/components'
@@ -18,7 +18,9 @@ import { Callout } from 'nextra/components'
## Deployment
-1. Clone the deployment repo
+
+
+### Clone the deployment repo
This git repo contains the `docker-compose.yml` file as well as other deployment-only related files.
```shell copy
@@ -26,7 +28,7 @@ git clone https://github.com/webhood-io/webhood.git --depth=1 --branch=main
cd webhood
```
-2. Copy the example `.env` file in the root directory of the project:
+### Copy the example `.env` file in the root directory of the project:
```shell copy
cp .env.example .env
@@ -34,7 +36,7 @@ cp .env.example .env
Next, we configure the only required variable `SCANNER_TOKEN`. Other variables are optional and can be set later as documented [here](reference/configuration).
-3. Create a service token for the scanner
+### Create a authentication token for the scanner
@@ -57,7 +59,7 @@ Next, we configure the only required variable `SCANNER_TOKEN`. Other variables a
Save this into your `.env` as `SCANNER_TOKEN`
-4. Run `docker compose up -d` to start the application
+### Run `docker compose up -d` to start the application
@@ -72,7 +74,7 @@ Save this into your `.env` as `SCANNER_TOKEN`
-5. Create a user
+### Create a user
@@ -89,10 +91,12 @@ Save this into your `.env` as `SCANNER_TOKEN`
-7. Start using it
+### Start using it
Navigate to [`https://localhost:8443`](https://localhost:8443) and login with the account you created in step `6`
+
+
## Known issues
### Invalid interpolation format for "environment" option...
diff --git a/pages/docs/guides/add_scanner.mdx b/pages/docs/guides/add_scanner.mdx
index bc02991..fec0cd0 100644
--- a/pages/docs/guides/add_scanner.mdx
+++ b/pages/docs/guides/add_scanner.mdx
@@ -1,5 +1,5 @@
import { Tab, Tabs } from "nextra-theme-docs"
-import { Callout } from 'nextra/components'
+import { Callout, Steps } from 'nextra/components'
# Add a scanner
@@ -17,11 +17,12 @@ This guide will show you how to add a scanner to connect to your console. Scanne
- docker-compose
- Connectivity from the scanner to the console. If you are running the scanner on a different network, you will need to open the console port to the scanner network. Default port for the console is `8000` if using the deployment guide.
-## Steps
+# Steps
-### In the console
+## In the console
-1. Run command to create the scanner
+
+### Run command to create the scanner
These commands assume you have deployed the console using the [docker-compose.yml](https://github.com/webhood-io/webhood/blob/main/docker-compose.yml).
@@ -47,10 +48,12 @@ This returns
```shell
SCANNER_TOKEN=ey....
```
+
-### In the scanner host
+## In the scanner host
-1. Create a `.env` file with the scanner token
+
+### Create a `.env` file with the scanner token
```shell copy
SCANNER_TOKEN=ey....
@@ -59,7 +62,7 @@ ENDPOINT=http://console-address:8000
Where `http://console-address:8000` is the address of the console. If you are running the console on a different port or network, you will need to change the `ENDPOINT` variable.
-2. Download the [seccomp](https://en.wikipedia.org/wiki/Seccomp) profile for the scanner
+### Download the [seccomp](https://en.wikipedia.org/wiki/Seccomp) profile for the scanner
```shell copy
curl -o chrome.json https://raw.githubusercontent.com/webhood-io/webhood/main/files/chrome.json
@@ -67,7 +70,7 @@ curl -o chrome.json https://raw.githubusercontent.com/webhood-io/webhood/main/fi
-3. Create a `docker-compose.yml` file with the scanner configuration
+### Create a `docker-compose.yml` file with the scanner configuration
```yaml copy
services:
@@ -83,7 +86,7 @@ services:
# This allows us to run chrome with sandboxing enabled without having to run the whole container as root
- seccomp=./chrome.json
```
-4. Run the scanner and check for any errors
+### Run the scanner and check for any errors
```shell copy
docker compose up
@@ -91,14 +94,14 @@ services:
It is a good idea to now initiate some scans in the console to see if the scanner is working correctly.
-5. If no errors, you can start the scanner as a daemon
+### If no errors, you can start the scanner as a daemon
```shell copy
docker compose up -d
```
-3. Create a `docker-compose.yml` file with the scanner configuration
+### Create a `docker-compose.yml` file with the scanner configuration
```yaml copy
services:
@@ -114,7 +117,7 @@ services:
# This allows us to run chrome with sandboxing enabled without having to run the whole container as root
- seccomp=./chrome.json
```
-4. Run the scanner and check for any errors
+### Run the scanner and check for any errors
```shell copy
docker-compose up
@@ -122,14 +125,14 @@ services:
It is a good idea to now initiate some scans in the console to see if the scanner is working correctly.
-5. If no errors, you can start the scanner as a daemon
+### If no errors, you can start the scanner as a daemon
```shell copy
docker-compose up -d
```
- 3. Start the scanner
+### Start the scanner
```shell copy
# docker run equivalent of the docker-compose.yml
@@ -143,6 +146,8 @@ It is a good idea to now initiate some scans in the console to see if the scanne
+
+
## Additional configuration
### Additional scanners