Compare commits

1 Commits
next ... master

Author SHA1 Message Date
3f7bc083d3 Update README.md
Some checks failed
Build release-tags / bake-latest (push) Has been cancelled
Test-Build Docker Image / bake-test (push) Has been cancelled
2024-10-03 14:00:53 +03:00

View File

@@ -38,7 +38,7 @@ This version of _py-kms_ is for itself a fork of the original implementation by
- Uses `sqlite` for persistent data storage (with a simple web-based explorer). - Uses `sqlite` for persistent data storage (with a simple web-based explorer).
## Documentation ## Documentation
The wiki has been completly reworked and is now available on [readthedocs.io](https://py-kms.readthedocs.io/en/latest/). It should provide you all the necessary information about how to setup and to use _py-kms_ , all without clumping this readme. The documentation also houses more details about activation with _py-kms_ and how to get GVLK keys. The wiki has been completly reworked and is now available on [readthedocs.io](https://py-kms-bm.readthedocs.io/en/latest/). It should provide you all the necessary information about how to setup and to use _py-kms_ , all without clumping this readme. The documentation also houses more details about activation with _py-kms_ and how to get GVLK keys.
## Quick start ## Quick start
- To start the server, execute `python3 pykms_Server.py [IPADDRESS] [PORT]`, the default _IPADDRESS_ is `::` ( 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. **In case your OS does not support IPv6, make sure to explicitly specify the legacy IPv4 of `0.0.0.0`!** - To start the server, execute `python3 pykms_Server.py [IPADDRESS] [PORT]`, the default _IPADDRESS_ is `::` ( 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. **In case your OS does not support IPv6, make sure to explicitly specify the legacy IPv4 of `0.0.0.0`!**