vh/NetAlertX
1
0
Fork 0
mirror of https://github.com/jokob-sk/NetAlertX.git synced 2025-12-07 09:36:05 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge branch 'main' into main

Browse Source
This commit is contained in:
Jokob @NetAlertX
2025-09-02 15:22:04 +10:00
committed by GitHub
parent 1d74398337 a9d7ca8809
commit 7dd860b2ab
1 changed files with 10 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/DOCKER_COMPOSE.md
View File

@@ -137,7 +137,8 @@ networks:
``` ```
### Example 5: same as 3 but with a single top level folder, fixed log ready to drop in portainer
### Example 5: same as 3 but with a top-level root directory; also works in Portainer as-is
`docker-compose.yml` `docker-compose.yml`
@@ -148,9 +149,9 @@ services:
# use the below line if you want to test the latest dev image instead of the stable release # use the below line if you want to test the latest dev image instead of the stable release
# image: "ghcr.io/jokob-sk/netalertx-dev:latest" # image: "ghcr.io/jokob-sk/netalertx-dev:latest"
image: "ghcr.io/jokob-sk/netalertx:latest" image: "ghcr.io/jokob-sk/netalertx:latest"
network_mode: "host" network_mode: "host"
restart: unless-stopped restart: unless-stopped
user: "${PUID}:${PGID}"
volumes: volumes:
- ${APP_FOLDER}/netalertx/config:/app/config - ${APP_FOLDER}/netalertx/config:/app/config
- ${APP_FOLDER}/netalertx/db:/app/db - ${APP_FOLDER}/netalertx/db:/app/db
@@ -162,11 +163,13 @@ services:
# (API: OPTION 2) use when debugging issues # (API: OPTION 2) use when debugging issues
# - ${APP_FOLDER}/netalertx/api:/app/api # - ${APP_FOLDER}/netalertx/api:/app/api
environment: environment:
- TZ=${TZ} - TZ=${TZ}
- PORT=${PORT} - PORT=${PORT}
- PUID=${PUID} - PUID=${PUID}
- PGID=${PGID} - PGID=${PGID}
- LISTEN_ADDR=${LISTEN_ADDR} - LISTEN_ADDR=${LISTEN_ADDR}
```
`.env` file `.env` file
@@ -174,8 +177,10 @@ services:
APP_FOLDER=/path/to/local/NetAlertX/location APP_FOLDER=/path/to/local/NetAlertX/location
#ENVIRONMENT VARIABLES #ENVIRONMENT VARIABLES
PUID=200 PUID=200
PGID=300 PGID=300
TZ=America/New_York TZ=America/New_York
LISTEN_ADDR=0.0.0.0 LISTEN_ADDR=0.0.0.0
PORT=20211 PORT=20211
@@ -192,6 +197,7 @@ PORT=20211
# you can create multiple env files called .env.dev1, .env.dev2 etc and use them by running: # you can create multiple env files called .env.dev1, .env.dev2 etc and use them by running:
# docker compose --env-file .env.dev1 up -d # docker compose --env-file .env.dev1 up -d
# you can then clone multiple dev copies of NetAlertX just make sure to change the APP_FOLDER and PORT variables in each .env.devX file # you can then clone multiple dev copies of NetAlertX just make sure to change the APP_FOLDER and PORT variables in each .env.devX file
``` ```
To run the container execute: `sudo docker-compose --env-file /path/to/.env up` To run the container execute: `sudo docker-compose --env-file /path/to/.env up`