mirrors/py-kms
1
0
Fork 0
mirror of https://github.com/Py-KMS-Organization/py-kms.git synced 2024-09-19 07:18:51 -04:00
Code Issues Projects Releases Packages Wiki Activity

Extended docs for SQLITE stuff

Browse source
This commit is contained in:
Simon Beginn 2021-10-14 13:17:51 +02:00
parent 0630b22611
commit fba768bd51
No known key found for this signature in database
GPG key ID: 033A4D4CE4E063D6
2 changed files with 5 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
docs/Getting Started.md
View file

@ -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.

4
docs/Usage.md
View file

@ -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.