From fba768bd512397f09be69aa408bfc6efb3a72954 Mon Sep 17 00:00:00 2001 From: Simon Beginn Date: Thu, 14 Oct 2021 13:17:51 +0200 Subject: [PATCH] Extended docs for SQLITE stuff --- docs/Getting Started.md | 9 +-------- docs/Usage.md | 4 ++++ 2 files changed, 5 insertions(+), 8 deletions(-) diff --git a/docs/Getting Started.md b/docs/Getting Started.md index 45e9b29..96553f2 100644 --- a/docs/Getting Started.md +++ b/docs/Getting Started.md @@ -60,20 +60,13 @@ services: ``` #### Parameters -Below is a fully expanded run command, detailing all the different supported environment variables to set. For further reference see the [start parameters](Usage.html#docker-environment) for the docker environment. +Below is a little bit more extended run command, detailing all the different supported environment variables to set. For further reference see the [start parameters](Usage.html#docker-environment) for the docker environment. ```bash docker run -it -d --name py3-kms \ -p 8080:8080 \ -p 1688:1688 \ - -e IP=0.0.0.0 \ - -e PORT=1688 \ -e SQLITE=true \ - -e HWID=RANDOM \ - -e LOGLEVEL=INFO \ - -e LOGSIZE=2 \ - -e LOGFILE=/var/log/pykms_logserver.log \ -v /etc/localtime:/etc/localtime:ro \ - -v ./logs:/var/log:rw \ --restart unless-stopped pykmsorg/py-kms:[TAG] ``` You can omit the `-e SQLITE=...` and `-p 8080:8080` option if you plan to use the `minimal` or `latest` image, which does not include the respective module support. diff --git a/docs/Usage.md b/docs/Usage.md index 7e27ba9..a0ab9d4 100644 --- a/docs/Usage.md +++ b/docs/Usage.md @@ -230,6 +230,10 @@ ENV RENEWAL_INTERVAL 10080 # Use this flag to store request information from unique clients in an SQLite database. ENV SQLITE false +# TCP-port +# The network port to listen with the web interface on. The default is "8080". +ENV SQLITE_PORT 8080 + # hwid # Use this flag to specify a HWID. # The HWID must be an 16-character string of hex characters.