mirror of
https://github.com/Py-KMS-Organization/py-kms.git
synced 2025-05-29 14:35:32 -04:00
27aa94a6e4
* Modified rtd template * Added current wiki files * Superseeded by index.rst * Removed dead links * Minor formatting * Moved usage to own topic * Reformatting... * Reformatting... * Formulations * New topic structure * Split into subsections * Heading changes * Ooops, missed a file * Reformatting * Changed file name * Link fixes * Topic level change * Minor title change * Formulations * Again more heading changes * Added todos * Removed old manual wiki copy * Table fix * Table fix chars * Reformulated * Formatting and reformulations * Heading change * Merged key files * Fixed heading problems * Added TODO * Added TODOs * Moinor formatting * Removed empty lines * Switched to local copies of images * Changed in-doc ref * Done Ref replacement * Key table reformat * Hidden TODOs * Moved manual section * Started moving into docs * Minimized * Moved readme file Merged docker section Pending still other readme sections at manual execution * Added one sentence regarding ipv4/ipv6 to docker * Merged manual execution information * Added some badges * Reworked fast run doc * Added note to the rest of options * Added changelog to docs * Added tables? * Added table support * removed test table * Finished TODO * Moved subtopic to top (old parent was not "logically connected") * Typo * Changed readme url to new docs * Fixed wrong docs badge uri * Changed doc title to link, so it is impossible to miss
52 lines
3.3 KiB
Markdown
52 lines
3.3 KiB
Markdown
# Readme
|
||
|
||
|
||
|
||
|
||
|
||
|
||
***
|
||
|
||
## History
|
||
_py-kms_ is a port of node-kms created by [cyrozap](http://forums.mydigitallife.info/members/183074-markedsword), which is a port of either the C#, C++, or .NET implementations of KMS Emulator. The original version was written by [CODYQX4](http://forums.mydigitallife.info/members/89933-CODYQX4) and is derived from the reverse-engineered code of Microsoft's official KMS.
|
||
|
||
## Features
|
||
- Responds to `v4`, `v5`, and `v6` KMS requests.
|
||
- Supports activating:
|
||
- Windows Vista
|
||
- Windows 7
|
||
- Windows 8
|
||
- Windows 8.1
|
||
- Windows 10 ( 1511 / 1607 / 1703 / 1709 / 1803 / 1809 )
|
||
- Windows 10 ( 1903 / 1909 / 20H1 )
|
||
- Windows Server 2008
|
||
- Windows Server 2008 R2
|
||
- Windows Server 2012
|
||
- Windows Server 2012 R2
|
||
- Windows Server 2016
|
||
- Windows Server 2019
|
||
- Microsoft Office 2010 ( Volume License )
|
||
- Microsoft Office 2013 ( Volume License )
|
||
- Microsoft Office 2016 ( Volume License )
|
||
- Microsoft Office 2019 ( Volume License )
|
||
- It's written in Python (tested with Python 3.6.7)
|
||
- Supports execution by `Docker`, `systemd`, `Upstart` and many more...
|
||
- Includes a GUI for simlpe managing
|
||
- Uses `sqlite` for persistent data storage
|
||
|
||
## [Documentation](https://py-kms.readthedocs.io/en/latest/)
|
||
The documentation has been completly reworked and is now available on [readthedocs.com](https://py-kms.readthedocs.io/en/latest/Usage.html#start-parameters). It should you provide all necessary information how to get py-kms up
|
||
and running using your favourite tools - all without clumping this readme up. The documentation also houses more information about activation with _py-kms_ and to how get GVLK keys.
|
||
|
||
## Get it running (fast)...
|
||
- To start the server manually, execute `python3 pykms_Server.py [IPADDRESS] [PORT]`, the default `IPADDRESS` is `::` ( all ipv6-interfaces ) and the default `PORT` is `1688`. Note that both the address and port are optional.
|
||
Also note that it is recommended to use an IPv6 address - even if you are just plan to use IPv4 (the kernel maps the incoming IPv4 requests automatically to IPv6)!
|
||
- To start the server automatically using Docker, execute `docker run -d --name py-kms --restart always -p 1688:1688 pykmsorg/py-kms`.
|
||
- 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.
|
||
|
||
_If you wish to learn more about using py-kms, please refer to the documentation [here](Getting Started.md)!_
|
||
|
||
## License
|
||
- _py-kms_ is [](https://github.com/SystemRage/py-kms/blob/master/LICENSE)
|
||
- _py-kms GUI_ is [](https://github.com/SystemRage/py-kms/blob/master/LICENSE.gui.md) © Matteo ℱan
|