mirror of
https://github.com/Py-KMS-Organization/py-kms.git
synced 2025-05-27 13:34:39 -04:00
Merged docker/README.md into docs (#103)
* Merged docker/README.md into docs * Minor reformulations Added references * Moved docker section one up, because they are not really start parameters * Fix links * Moved the supported products section into documentation, as it does not fit the usage topic
This commit is contained in:
parent
de1c115967
commit
c979f42da9
4 changed files with 103 additions and 122 deletions
116
docker/README.md
116
docker/README.md
|
@ -1,116 +0,0 @@
|
|||
# Usage
|
||||
```
|
||||
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 /var/log:/var/log:rw \
|
||||
--restart unless-stopped pykmsorg/py-kms:[TAG]
|
||||
```
|
||||
_Make sure to insert at `[TAG]` your wanted edition! The default is `latest`, which does not include SQLite support. For all available tag check [this](https://hub.docker.com/r/pykmsorg/py-kms/tags)._
|
||||
Therefore you can omit the `-e SQLITE=...` and `-p 8080:8080` option if you plan to use the `minimal` or `latest` image.
|
||||
|
||||
## Docker-compose
|
||||
|
||||
You can use docker-compose instead of Dockerfile. The following compose file will deploy `latest` image into your local directory.
|
||||
|
||||
```
|
||||
version: '3'
|
||||
|
||||
services:
|
||||
kms:
|
||||
image: pykmsorg/py-kms:latest
|
||||
ports:
|
||||
- 1688:1688
|
||||
environment:
|
||||
- IP=0.0.0.0
|
||||
- SQLITE=true
|
||||
- HWID=RANDOM
|
||||
- LOGLEVEL=INFO
|
||||
- LOGSIZE=2
|
||||
- LOGFILE=/var/log/pykms_logserver.log
|
||||
restart: always
|
||||
volumes:
|
||||
- /etc/localtime:/etc/localtime:ro
|
||||
- ./:/var/log:rw
|
||||
```
|
||||
|
||||
# Sqlite-web
|
||||
A web-based SQLite database browser written in Python.
|
||||
Start on http://example.com:8080/ in read-only mode for _pykms_database.db_.
|
||||
|
||||
# Options
|
||||
```
|
||||
# EN: Variables
|
||||
# RU: Переменные
|
||||
|
||||
# EN: IP-address
|
||||
# RU: IP-адрес
|
||||
ENV IP 0.0.0.0
|
||||
# The IP address to listen on. The default is "0.0.0.0" (all interfaces).
|
||||
|
||||
# EN: TCP-port
|
||||
# RU: TCP-порт
|
||||
ENV PORT 1688
|
||||
# The network port to listen on. The default is "1688".
|
||||
|
||||
# EN: ePID
|
||||
# RU: ePID
|
||||
ENV EPID ""
|
||||
# Use this flag to manually specify an ePID to use. If no ePID is specified, a random ePID will be generated.
|
||||
|
||||
# EN: lcid
|
||||
# RU: lcid
|
||||
ENV LCID 1033
|
||||
# Use this flag to manually specify an LCID for use with randomly generated ePIDs. Default is 1033 (en-us).
|
||||
|
||||
# EN: the current client count
|
||||
# RU: текущий счётчик запросов на активацию продуктов от Microsoft
|
||||
ENV CLIENT_COUNT 26
|
||||
# Use this flag to specify the current client count. Default is 26.
|
||||
# A number >=25 is required to enable activation of client OSes; for server OSes and Office >=5.
|
||||
|
||||
# EN: the activation interval (in minutes)
|
||||
# RU: интервал активации (в минутах)
|
||||
ENV ACTIVATION_INTERVAL 120
|
||||
# Use this flag to specify the activation interval (in minutes). Default is 120 minutes (2 hours).
|
||||
|
||||
# EN: the renewal interval (in minutes)
|
||||
# RU: интервал обновления (в минутах)
|
||||
ENV RENEWAL_INTERVAL 10080
|
||||
# Use this flag to specify the renewal interval (in minutes). Default is 10080 minutes (7 days).
|
||||
|
||||
# EN: Use SQLITE
|
||||
# RU: Использовать РСУБД SQLITE
|
||||
ENV SQLITE false
|
||||
# Use this flag to store request information from unique clients in an SQLite database.
|
||||
|
||||
# EN: hwid
|
||||
# RU: hwid
|
||||
ENV HWID 364F463A8863D35F
|
||||
# Use this flag to specify a HWID.
|
||||
# The HWID must be an 16-character string of hex characters.
|
||||
# The default is "364F463A8863D35F" or type "RANDOM" to auto generate the HWID.
|
||||
|
||||
# EN: log level ("CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG")
|
||||
# RU: Уровень логирования ("CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG")
|
||||
ENV LOGLEVEL ERROR
|
||||
# Use this flag to set a Loglevel. The default is "ERROR".
|
||||
|
||||
# EN: log file
|
||||
# RU: Лог-файл
|
||||
ENV LOGFILE /var/log/pykms_logserver.log
|
||||
# Use this flag to set an output Logfile. The default is "/var/log/pykms_logserver.log".
|
||||
|
||||
# EN: log file size in MB
|
||||
# RU: Максимальный размер Лог-файл в мегабайтах
|
||||
ENV LOGSIZE ""
|
||||
# Use this flag to set a maximum size (in MB) to the output log file. Deactivated by default.
|
||||
```
|
Loading…
Add table
Add a link
Reference in a new issue