Skip to content

Commit 7bec8c8

Browse files
committed
Update readme
1 parent 1943ce0 commit 7bec8c8

File tree

1 file changed

+47
-50
lines changed

1 file changed

+47
-50
lines changed

README.md

Lines changed: 47 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,47 @@
1-
# Readme
2-
![repo-size](https://img.shields.io/github/repo-size/SystemRage/py-kms)
3-
![open-issues](https://img.shields.io/github/issues/SystemRage/py-kms)
4-
![last-commit](https://img.shields.io/github/last-commit/SystemRage/py-kms/master)
5-
![docker-status](https://img.shields.io/docker/cloud/build/pykmsorg/py-kms)
6-
![docker-pulls](https://img.shields.io/docker/pulls/pykmsorg/py-kms)
7-
![read-the-docs](https://img.shields.io/readthedocs/py-kms)
8-
***
9-
10-
## History
11-
_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.
12-
13-
## Features
14-
- Responds to `v4`, `v5`, and `v6` KMS requests.
15-
- Supports activating:
16-
- Windows Vista
17-
- Windows 7
18-
- Windows 8
19-
- Windows 8.1
20-
- Windows 10 ( 1511 / 1607 / 1703 / 1709 / 1803 / 1809 )
21-
- Windows 10 ( 1903 / 1909 / 20H1 )
22-
- Windows Server 2008
23-
- Windows Server 2008 R2
24-
- Windows Server 2012
25-
- Windows Server 2012 R2
26-
- Windows Server 2016
27-
- Windows Server 2019
28-
- Windows Server 2022 (at least datacenter)
29-
- Microsoft Office 2010 ( Volume License )
30-
- Microsoft Office 2013 ( Volume License )
31-
- Microsoft Office 2016 ( Volume License )
32-
- Microsoft Office 2019 ( Volume License )
33-
- Microsoft Office 2021 ( Volume License )
34-
- It's written in Python (tested with Python 3.6.9).
35-
- Supports execution by `Docker`, `systemd`, `Upstart` and many more...
36-
- Includes a GUI for simple managing.
37-
- Uses `sqlite` for persistent data storage.
38-
39-
## Documentation
40-
The wiki has been completly reworked and is now available on [readthedocs.com](https://py-kms.readthedocs.io/en/latest/). It should you provide all necessary information 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.
41-
42-
## Quick start
43-
- 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.
44-
- To start the server automatically using Docker, execute `docker run -d --name py-kms --restart always -p 1688:1688 pykmsorg/py-kms`.
45-
- To show the help pages type: `python3 pykms_Server.py -h` and `python3 pykms_Client.py -h`.
46-
- 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.
47-
48-
## License
49-
- _py-kms_ is [![Unlicense](https://img.shields.io/badge/license-unlicense-lightgray.svg)](https://github.com/SystemRage/py-kms/blob/master/LICENSE)
50-
- _py-kms GUI_ is [![MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/SystemRage/py-kms/blob/master/LICENSE.gui.md) © Matteo ℱan
1+
# Readme
2+
![repo-size](https://img.shields.io/github/repo-size/SkylarKaede/py-kms)
3+
![last-commit](https://img.shields.io/github/last-commit/SkylarKaede/py-kms/master)
4+
***
5+
6+
## History
7+
_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. Forked for ongoing maintenance.
8+
9+
## Features
10+
- Responds to `v4`, `v5`, and `v6` KMS requests.
11+
- Supports activating:
12+
- Windows Vista
13+
- Windows 7
14+
- Windows 8
15+
- Windows 8.1
16+
- Windows 10 ( 1511 / 1607 / 1703 / 1709 / 1803 / 1809 )
17+
- Windows 10 ( 1903 / 1909 / 20H1 )
18+
- Windows Server 2008
19+
- Windows Server 2008 R2
20+
- Windows Server 2012
21+
- Windows Server 2012 R2
22+
- Windows Server 2016
23+
- Windows Server 2019
24+
- Windows Server 2022 (at least datacenter)
25+
- Windows Server 2025 (at least datacenter)
26+
- Microsoft Office 2010 ( Volume License )
27+
- Microsoft Office 2013 ( Volume License )
28+
- Microsoft Office 2016 ( Volume License )
29+
- Microsoft Office 2019 ( Volume License )
30+
- Microsoft Office 2021 ( Volume License )
31+
- It's written in Python (tested with Python 3.6.9).
32+
- Supports execution by `Docker`, `systemd`, `Upstart` and many more...
33+
- Includes a GUI for simple managing.
34+
- Uses `sqlite` for persistent data storage.
35+
36+
## Documentation
37+
The wiki has been completly reworked and is now available on [readthedocs.com](https://py-kms.readthedocs.io/en/latest/). It should you provide all necessary information 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.
38+
39+
## Quick start
40+
- 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.
41+
- To start the server automatically using Docker, execute `docker run -d --name py-kms --restart always -p 1688:1688 pykmsorg/py-kms`.
42+
- To show the help pages type: `python3 pykms_Server.py -h` and `python3 pykms_Client.py -h`.
43+
- 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.
44+
45+
## License
46+
- _py-kms_ is [![Unlicense](https://img.shields.io/badge/license-unlicense-lightgray.svg)](https://github.com/SystemRage/py-kms/blob/master/LICENSE)
47+
- _py-kms GUI_ is [![MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/SystemRage/py-kms/blob/master/LICENSE.gui.md) © Matteo ℱan

0 commit comments

Comments
 (0)