diff --git a/docs/DOCKER_COMPOSE.md b/docs/DOCKER_COMPOSE.md index 5653fc33..a59161ef 100755 --- a/docs/DOCKER_COMPOSE.md +++ b/docs/DOCKER_COMPOSE.md @@ -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` @@ -148,12 +149,12 @@ services: # 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:latest" - network_mode: "host" + + network_mode: "host" restart: unless-stopped - user: "${PUID}:${PGID}" volumes: - ${APP_FOLDER}/netalertx/config:/app/config - - ${APP_FOLDER}/netalertx/db:/app/db + - ${APP_FOLDER}/netalertx/db:/app/db # (optional) useful for debugging if you have issues setting up the container - ${APP_FOLDER}/netalertx/log:/app/log # (API: OPTION 1) default -> use for performance @@ -162,11 +163,13 @@ services: # (API: OPTION 2) use when debugging issues # - ${APP_FOLDER}/netalertx/api:/app/api environment: + - TZ=${TZ} - PORT=${PORT} - PUID=${PUID} - PGID=${PGID} - LISTEN_ADDR=${LISTEN_ADDR} +``` `.env` file @@ -174,8 +177,10 @@ services: APP_FOLDER=/path/to/local/NetAlertX/location #ENVIRONMENT VARIABLES + PUID=200 PGID=300 + TZ=America/New_York LISTEN_ADDR=0.0.0.0 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: # 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 + ``` To run the container execute: `sudo docker-compose --env-file /path/to/.env up`