mirrors/py-kms
1
0
Fork 0
mirror of https://github.com/Py-KMS-Organization/py-kms.git synced 2025-05-28 05:54:54 -04:00
Code Issues Projects Releases Packages Wiki Activity

Merged docker/README.md into docs (#103)

Browse source 
* 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:
Simonmicro 2020-10-16 22:58:56 +02:00 • committed by GitHub
parent de1c115967
commit c979f42da9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 103 additions and 122 deletions
Download patch file Download diff file Expand all files Collapse all files

44
docs/Getting Started.md
View file

@ -24,7 +24,7 @@ latest version you should check something like [watchtower](https://github.com/c
There are currently three tags of the image available (select one just by appending `:<tag>` to the image from above):
* `latest`, currently the same like `minimal`.
* `minimal`, which is based on the python3 minimal configuration of py-kms. _This tag does NOT include `sqlite` support !_
* `python3`, which is fully configurable and equipped with `sqlite` support and a web interface for management.
* `python3`, which is fully configurable and equipped with `sqlite` support and a web interface (make sure to expose port 8080) for management.
#### Architectures
There are currently the following architectures available (if you need an other, feel free to open an issue):
@ -35,6 +35,48 @@ There are currently the following architectures available (if you need an other,
_Please note that any architecture other than the classic `amd64` is slightly bigger (~4 MB), caused by the use of qemu during building._
#### Docker Compose
You can use `docker-compose` instead of building and running the Dockerfile, so you do not need to respecify your settings again and again. The following Docker Compose file will deploy the `latest` image with the log into your local directory.
```yaml
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
```
#### 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.
```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 /var/log:/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.
### Systemd
If you are running a Linux distro using `systemd`, create the file: `sudo nano /etc/systemd/system/py3-kms.service`, then add the following (change it where needed) and save:
```systemd