-
Notifications
You must be signed in to change notification settings - Fork 3
Running the NUTCase container
Arthur Mitchell edited this page Mar 7, 2024
·
8 revisions
NUTCase is used as a Docker container and can be pulled from DockerHub. The most basic requirements to run NUTCase are:
- A volume mapping to the location you place the configuration file and to which the log is written
- A port mapping to expose the container end-point
docker run -d \
--name NUTCase \
-v /path/to/config_dir:/config \
-e TZ=Europe/London \
-p 9995:9995 \
--restart always \
kronos443/nutcase:latest
The minimal configuration:
Tip
This assumes you have set the appropriate variables for docker compose
---
version: '3.9'
services:
nutcase:
image: kronos443/nutcase:latest
container_name: NUTCase
restart: always
ports:
- "$NUTEXPORT_PORT:9995"
volumes:
- '$DOCKER_DIR/config_dir:/config'
environment:
TZ: $TZ
Parameter | Function | Notes |
---|---|---|
Volume mappings | ||
/path/to/config:/config | The directory on your host that is shared with the container. The log file will be generated here. | Required |
Environment variables | ||
TZ | Time zone, e.g. Europe/London. | Optional but specifying this means the log times will be in the local time zone rather than UT |
LOG_LEVEL | Sets the log detail. |
Optional This value is overridden if the configuration file specifies log_level: in settings
|
Tip
To help diagnostics and see what information the server is returning about the UPS you can use optional variables such as LOG_LEVEL.
---
version: '3.9'
services:
nutcase:
image: kronos443/nutcase:latest
container_name: NUTCase
restart: always
ports:
- "$NUTEXPORT_PORT:9995"
volumes:
- '$DOCKER_DIR/nutcase:/config'
environment:
TZ: $TZ
# LOG_LEVEL - DEBUGVV DEBUGV DEBUG INFO WARNING ERROR CRITICAL & FATAL are the options
LOG_LEVEL: INFO
healthcheck:
test: wget --spider -q http://127.0.0.1:$NUTEXPORT_PORT/help
interval: 3m30s
timeout: 10s
retries: 2
start_period: 30s
Note
By default the log files will rotate when the reach 250KB and up to 5 versions will be kept with the extensions .log.1, .log.2, .log.3, .log.4, .log.5. This can be custominsed in the configuration file.
Getting Started
Using NUTCase
Advanced useage
Other Issues