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

Switch from pulls-limited Docker Hub to Github Container Registry

Browse source
This commit is contained in:
Simon Beginn 2021-10-21 13:26:34 +02:00
parent eb42224bf1
commit 5df5487604
No known key found for this signature in database
GPG key ID: 033A4D4CE4E063D6
2 changed files with 6 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -41,7 +41,7 @@ The wiki has been completly reworked and is now available on [readthedocs.com](h
## Quick start ## Quick start
- To start the server, execute `python3 pykms_Server.py [IPADDRESS] [PORT]`, the default _IPADDRESS_ is `0.0.0.0` ( all interfaces ) and the default _PORT_ is `1688`. Note that both the address and port are optional. It's allowed to use IPv4 and IPv6 addresses. If you have a IPv6-capable dual-stack OS, a dual-stack socket is created when using a IPv6 address. - To start the server, execute `python3 pykms_Server.py [IPADDRESS] [PORT]`, the default _IPADDRESS_ is `0.0.0.0` ( all interfaces ) and the default _PORT_ is `1688`. Note that both the address and port are optional. It's allowed to use IPv4 and IPv6 addresses. If you have a IPv6-capable dual-stack OS, a dual-stack socket is created when using a IPv6 address.
- To start the server automatically using Docker, execute `docker run -d --name py-kms --restart always -p 1688:1688 pykmsorg/py-kms`. - To start the server automatically using Docker, execute `docker run -d --name py-kms --restart always -p 1688:1688 ghcr.io/py-kms-organization/py-kms`.
- To show the help pages type: `python3 pykms_Server.py -h` and `python3 pykms_Client.py -h`. - To show the help pages type: `python3 pykms_Server.py -h` and `python3 pykms_Client.py -h`.
- For launching _py-kms_ GUI make the file `pykms_Server.py` executable with `chmod +x /path/to/folder/py-kms/pykms_Server.py`, then simply run `pykms_Server.py` by double-clicking. - For launching _py-kms_ GUI make the file `pykms_Server.py` executable with `chmod +x /path/to/folder/py-kms/pykms_Server.py`, then simply run `pykms_Server.py` by double-clicking.

10
docs/Getting Started.md
View file

@ -15,10 +15,10 @@ If you wish to get _py-kms_ just up and running without installing any dependenc
Docker also solves problems regarding the explicit IPv4 and IPv6 usage (it just supports both). The following Docker also solves problems regarding the explicit IPv4 and IPv6 usage (it just supports both). The following
command will download, "install" and start _py-kms_ and also keep it alive after any service disruption. command will download, "install" and start _py-kms_ and also keep it alive after any service disruption.
```bash ```bash
docker run -d --name py-kms --restart always -p 1688:1688 -v /etc/localtime:/etc/localtime:ro pykmsorg/py-kms docker run -d --name py-kms --restart always -p 1688:1688 -v /etc/localtime:/etc/localtime:ro ghcr.io/py-kms-organization/py-kms
``` ```
If you just want to use the image and don't want to build them yourself, you can always use the official image at the [Docker Hub](https://hub.docker.com/r/pykmsorg/py-kms) (`pykmsorg/py-kms`). To ensure that you are using always the If you just want to use the image and don't want to build them yourself, you can always use the official image at the [Docker Hub](https://hub.docker.com/r/pykmsorg/py-kms) (`pykmsorg/py-kms`) or [GitHub Container Registry](https://github.com/Py-KMS-Organization/py-kms/pkgs/container/py-kms) (`ghcr.io/py-kms-organization/py-kms`). To ensure that you are using always the
latest version you should check something like [watchtower](https://github.com/containrrr/watchtower) out ! latest version you should check something like [watchtower](https://github.com/containrrr/watchtower) out!
#### Tags #### Tags
There are currently three tags of the image available (select one just by appending `:<tag>` to the image from above): There are currently three tags of the image available (select one just by appending `:<tag>` to the image from above):
@ -43,7 +43,7 @@ version: '3'
services: services:
kms: kms:
image: pykmsorg/py-kms:python3 image: ghcr.io/py-kms-organization/py-kms:python3
ports: ports:
- 1688:1688 - 1688:1688
- 8080:8080 - 8080:8080
@ -67,7 +67,7 @@ docker run -it -d --name py3-kms \
-p 1688:1688 \ -p 1688:1688 \
-e SQLITE=true \ -e SQLITE=true \
-v /etc/localtime:/etc/localtime:ro \ -v /etc/localtime:/etc/localtime:ro \
--restart unless-stopped pykmsorg/py-kms:[TAG] --restart unless-stopped ghcr.io/py-kms-organization/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. 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.