diff --git a/Dockerfile b/Dockerfile index ef9c3a8..48e3921 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,16 +1,18 @@ -FROM python:2.7 -LABEL org.opencontainers.image.authors="Eric Taieb Walch " - -RUN mkdir /app && \ -cd /app && \ -git clone https://github.com/rshipp/python-nut2.git && \ -cd python-nut2 && \ -python setup.py install && \ -cd .. && \ -git clone https://github.com/rshipp/webNUT.git && cd webNUT && \ -pip install -e . - +FROM python:3.11-alpine +RUN apk update \ +&& apk upgrade --available \ +&& apk add git tzdata \ +&& mkdir /app \ +&& cd /app \ +&& git clone https://github.com/rshipp/python-nut2.git \ +&& cd python-nut2 \ +&& python setup.py install \ +&& cd .. \ +&& git clone https://github.com/rshipp/webNUT.git \ +&& cd webNUT \ +&& pip install -e . \ +&& rm -rf /var/cache/apk/* COPY /docker-entrypoint.sh /docker-entrypoint.sh RUN chmod +x /docker-entrypoint.sh diff --git a/README.md b/README.md index a94847e..74e438b 100644 --- a/README.md +++ b/README.md @@ -6,20 +6,33 @@ webNUT (UPS network monitoring web ui) dockerized. More infos on webNUT: https://github.com/rshipp/webNUT -Set the following environment variables: +## Environment Variables -**UPS_HOST** with NUT server host IP *(default: 127.0.0.1)* +| Variable | Description | Default | +|-------------------------------|----------------------------------------------------------------------------|----------------------------------| +| UPS_HOST | The NUT server host IP | 127.0.0.1 | +| UPS_PORT | The NUT server port | 3493 | +| UPS_USER | The NUT server username | monuser | +| UPS_PASSWORD | The NUT server password | secret | -**UPS_PORT** with NUT server port *(default: 3493)* +## Compose file -**UPS_USER** with NUT server username *(default: monuser)* - -**UPS_PASSWORD** with NUT server password *(default: secret)* +```sh +version: '3.3' +services: + nut: + image: ghcr.io/davidclaeysquinones/webnut + environment: + # adjust these variable as needed + - UPS_HOST=10.11.12.13 + - UPS_PORT=3493 + - UPS_USER="monuser" + - UPS_PASSWORD="secret" + restart: unless-stopped + security_opt: + - no-new-privileges:true + ports: + - 6543:6543 +``` - - -Run with: - -> docker run -e UPS_HOST="10.11.12.13" -e UPS_PORT="3493" -e UPS_USER="monuser" -e UPS_PASSWORD="secret" -p 6543:6543 teknologist/webnut:latest -