mirror of
https://github.com/jokob-sk/NetAlertX.git
synced 2026-02-27 12:46:07 -05:00
115 lines
4.0 KiB
Markdown
Executable File
115 lines
4.0 KiB
Markdown
Executable File
# Deploying NetAlertX in Portainer (via Stacks)
|
||
|
||
This guide shows you how to set up **NetAlertX** using Portainer’s **Stacks** feature.
|
||
|
||
|
||
|
||
---
|
||
|
||
## 1. Prepare Your Host
|
||
|
||
Before deploying, make sure you have a folder on your Docker host for NetAlertX data. Replace `APP_FOLDER` with your preferred location, for example `/local_data_dir` here:
|
||
|
||
```bash
|
||
mkdir -p /local_data_dir/netalertx/config
|
||
mkdir -p /local_data_dir/netalertx/db
|
||
mkdir -p /local_data_dir/netalertx/log
|
||
```
|
||
|
||
---
|
||
|
||
## 2. Open Portainer Stacks
|
||
|
||
1. Log in to your **Portainer UI**.
|
||
2. Navigate to **Stacks** → **Add stack**.
|
||
3. Give your stack a name (e.g., `netalertx`).
|
||
|
||
---
|
||
|
||
## 3. Paste the Stack Configuration
|
||
|
||
Copy and paste the following YAML into the **Web editor**:
|
||
|
||
```yaml
|
||
services:
|
||
netalertx:
|
||
container_name: netalertx
|
||
# Use this line for stable release
|
||
image: "ghcr.io/netalertx/netalertx:latest"
|
||
# Or, use this for the latest development build
|
||
# image: "ghcr.io/netalertx/netalertx-dev:latest"
|
||
network_mode: "host"
|
||
restart: unless-stopped
|
||
cap_drop: # Drop all capabilities for enhanced security
|
||
- ALL
|
||
cap_add: # Re-add necessary capabilities
|
||
- NET_RAW
|
||
- NET_ADMIN
|
||
- NET_BIND_SERVICE
|
||
- CHOWN
|
||
- SETUID
|
||
- SETGID
|
||
volumes:
|
||
- ${APP_FOLDER}/netalertx/config:/data/config
|
||
- ${APP_FOLDER}/netalertx/db:/data/db
|
||
# to sync with system time
|
||
- /etc/localtime:/etc/localtime:ro
|
||
tmpfs:
|
||
# All writable runtime state resides under /tmp; comment out to persist logs between restarts
|
||
- "/tmp:uid=20211,gid=20211,mode=1700,rw,noexec,nosuid,nodev,async,noatime,nodiratime"
|
||
environment:
|
||
- PORT=${PORT}
|
||
- APP_CONF_OVERRIDE=${APP_CONF_OVERRIDE}
|
||
```
|
||
|
||
---
|
||
|
||
## 4. Configure Environment Variables
|
||
|
||
In the **Environment variables** section of Portainer, add the following:
|
||
|
||
* `APP_FOLDER=/local_data_dir` (or wherever you created the directories in step 1)
|
||
* `PORT=22022` (or another port if needed)
|
||
* `APP_CONF_OVERRIDE={"GRAPHQL_PORT":"22023"}` (optional advanced settings, otherwise the backend API server PORT defaults to `20212`)
|
||
|
||
Additional environment variables (advanced / testing):
|
||
|
||
* `SKIP_TESTS=1` — when set, the container entrypoint will skip all startup checks and print the message `Skipping startup checks as SKIP_TESTS is set.`. Useful for automated test runs or CI where the container should not perform environment-specific checks.
|
||
* `SKIP_STARTUP_CHECKS="<check names>"` — space-delimited list of specific startup checks to skip. Names are the human-friendly names derived from files in `/entrypoint.d` (remove the leading numeric prefix and file extension). Example: `SKIP_STARTUP_CHECKS="mandatory folders"` will skip `30-mandatory-folders.sh`.
|
||
|
||
Note: these variables are primarily useful for non-production scenarios (testing, CI, or specific deployments) and are processed by the entrypoint scripts. See `entrypoint.sh` and `entrypoint.d/*` for exact behaviour and available check names.
|
||
|
||
---
|
||
|
||
## 5. Ensure permissions
|
||
|
||
> [!TIP]
|
||
> If you are facing permissions issues run the following commands on your server. This will change the owner and assure sufficient access to the database and config files that are stored in the `/local_data_dir/db` and `/local_data_dir/config` folders (replace `local_data_dir` with the location where your `/db` and `/config` folders are located).
|
||
>
|
||
> `sudo chown -R 20211:20211 /local_data_dir`
|
||
>
|
||
> `sudo chmod -R a+rwx /local_data_dir`
|
||
>
|
||
|
||
|
||
---
|
||
|
||
## 6. Deploy the Stack
|
||
|
||
1. Scroll down and click **Deploy the stack**.
|
||
2. Portainer will pull the image and start NetAlertX.
|
||
3. Once running, access the app at:
|
||
|
||
```
|
||
http://<your-docker-host-ip>:22022
|
||
```
|
||
|
||
---
|
||
|
||
## 7. Verify and Troubleshoot
|
||
|
||
* Check logs via Portainer → **Containers** → `netalertx` → **Logs**.
|
||
* Logs are stored under `${APP_FOLDER}/netalertx/log` if you enabled that volume.
|
||
|
||
Once the application is running, configure it by reading the [initial setup](INITIAL_SETUP.md) guide, or [troubleshoot common issues](COMMON_ISSUES.md).
|