7x31
/
py-kms
mirror of https://github.com/SystemRage/py-kms.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #103 from Py-KMS-Organization/next 

Fixed docs
This commit is contained in:
simonmicro 2024-01-18 18:06:12 +01:00 committed by GitHub
parent 8c2350d28b fa6e536aa7
commit 35fbc766ca
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
7 changed files with 470 additions and 483 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.readthedocs.yaml
View File

@ -9,6 +9,4 @@ python:
install: install:
- requirements: docs/requirements.txt - requirements: docs/requirements.txt
formats: formats: all
- pdf
- epub

84
CHANGELOG.md
View File

@ -1,19 +1,19 @@
# Changelog # Changelog
### py-kms_2022-12-16 ## py-kms_2022-12-16
- Added support for new web-gui into Docker - Added support for new web-gui into Docker
- Implemented whole-new web-based GUI with Flask - Implemented whole-new web-based GUI with Flask
- Removed old GUI (Etrigan) from code and resources - Removed old GUI (Etrigan) from code and resources
- Removed sqliteweb - Removed sqliteweb
- Removed Etrigan (GUI) - Removed Etrigan (GUI)
### py-kms_2022-12-07 ## py-kms_2022-12-07
- Added warning about Etrigan (GUI) being deprecated - Added warning about Etrigan (GUI) being deprecated
- More docs (do not run on same machine as client) - More docs (do not run on same machine as client)
- Added Docker support for multiple listen IPs - Added Docker support for multiple listen IPs
- Added graceful Docker shutdowns - Added graceful Docker shutdowns
### py-kms_2021-12-23 ## py-kms_2021-12-23
- More Windows 10/11 keys - More Windows 10/11 keys
- Fixed some deprecation warnings - Fixed some deprecation warnings
- Fixed SO_REUSEPORT platform checks - Fixed SO_REUSEPORT platform checks
@ -22,7 +22,7 @@
- Added UID/GID change support for Docker - Added UID/GID change support for Docker
- Dependabot alerts - Dependabot alerts
### py-kms_2021-10-22 ## py-kms_2021-10-22
- Integrated Office 2021 GLVK keys & database - Integrated Office 2021 GLVK keys & database
- Docker entrypoint fixes - Docker entrypoint fixes
- Updated docs to include SQLite stuff - Updated docs to include SQLite stuff
@ -30,12 +30,12 @@
- Removed LOGFILE extension checks - Removed LOGFILE extension checks
- Added support for Windows 11 - Added support for Windows 11
### py-kms_2021-10-07 ## py-kms_2021-10-07
- Helm charts for Kubernetes deployment - Helm charts for Kubernetes deployment
- Windows 2022 updates - Windows 2022 updates
- Faster Github Action builds - Faster Github Action builds
### py-kms_2021-11-12 ## py-kms_2021-11-12
- Addded GHCR support - Addded GHCR support
- Docs table reformatted - Docs table reformatted
- Updated GUI - Updated GUI
@ -44,27 +44,27 @@
- Docker multiarch - Docker multiarch
- Reshot screenshots in docs - Reshot screenshots in docs
### py-kms_2020-10-01 ## py-kms_2020-10-01
- Sql database path customizable. - Sql database path customizable.
- Sql database file keeps different AppId. - Sql database file keeps different AppId.
- Support for multi-address connection. - Support for multi-address connection.
- Added timeout send / receive. - Added timeout send / receive.
### py-kms_2020-07-01 ## py-kms_2020-07-01
- py-kms Gui: now matches all cli options, added modes onlyserver / onlyclient, - py-kms Gui: now matches all cli options, added modes onlyserver / onlyclient,
added some animations. added some animations.
- Added suboptions FILEOFF and STDOUTOFF of -F. - Added suboptions FILEOFF and STDOUTOFF of -F.
- Created option for asynchronous messages. - Created option for asynchronous messages.
- Cleaned options parsing process. - Cleaned options parsing process.
### py-kms_2020-02-02 ## py-kms_2020-02-02
- Optimized pretty-print messages process. - Optimized pretty-print messages process.
- Added -F FILESTDOUT option. - Added -F FILESTDOUT option.
- Added deamonization options (via [Etrigan](https://github.com/SystemRage/Etrigan) project). - Added deamonization options (via [Etrigan](https://github.com/SystemRage/Etrigan) project).
- py-kms GUI resurrected (and improved). - py-kms GUI resurrected (and improved).
- Cleaned, cleaned, cleaned. - Cleaned, cleaned, cleaned.
### py-kms_2019-05-15 ## py-kms_2019-05-15
- Merging for Python2 / Python3 compatibility all-in-one. - Merging for Python2 / Python3 compatibility all-in-one.
- Added new options: - Added new options:
- timeout, [logsize](https://github.com/SystemRage/py-kms/pull/21). - timeout, [logsize](https://github.com/SystemRage/py-kms/pull/21).
@ -76,7 +76,7 @@
- Fixed activation threshold. - Fixed activation threshold.
- Renamed files, cosmetics and many other little big adjustments. - Renamed files, cosmetics and many other little big adjustments.
### py-kms_2018-11-15 ## py-kms_2018-11-15
- Implemented some good modifications inspired by [this](https://github.com/ThunderEX/py-kms) other fork. - Implemented some good modifications inspired by [this](https://github.com/ThunderEX/py-kms) other fork.
- Clean up code ( deleted no longer useful files randomHWID.py, randomEPID.py, timezones.py; - Clean up code ( deleted no longer useful files randomHWID.py, randomEPID.py, timezones.py;
erased useless functions and import modules ) erased useless functions and import modules )
@ -85,128 +85,128 @@
- Improved random EPID generation. - Improved random EPID generation.
- Corrected [this](https://github.com/SystemRage/py-kms/issues/8) in kmsBase.py - Corrected [this](https://github.com/SystemRage/py-kms/issues/8) in kmsBase.py
### py-kms_2018-03-01 ## py-kms_2018-03-01
- *py-kms NOW is for Python3 too ( py3-kms ), the previous one ( written with Python2 ) is renamed py2-kms* - *py-kms NOW is for Python3 too ( py3-kms ), the previous one ( written with Python2 ) is renamed py2-kms*
- *Repaired logging messages* - *Repaired logging messages*
- *Added pretty processing messages* - *Added pretty processing messages*
### py-kms_2017-06-01 ## py-kms_2017-06-01
- *Added option verbose logging in a file* - *Added option verbose logging in a file*
- *Updated "kmsBase.py" with new SKUIDs* - *Updated "kmsBase.py" with new SKUIDs*
- *Added a brief guide "py-kms-Guide.pdf" ( replaced "client-activation.txt" )* - *Added a brief guide "py-kms-Guide.pdf" ( replaced "client-activation.txt" )*
- *Added a well formatted and more complete list of volume keys "py-kms-ClientKeys.pdf" ( replaced "client-keys.txt" )* - *Added a well formatted and more complete list of volume keys "py-kms-ClientKeys.pdf" ( replaced "client-keys.txt" )*
### py-kms_2016-12-30 ## py-kms_2016-12-30
- *Updated kmsBase.py (Matches LicenseManager 4.6.0 by Hotbird64 HGM)* - *Updated kmsBase.py (Matches LicenseManager 4.6.0 by Hotbird64 HGM)*
### py-kms_2016-08-13 ## py-kms_2016-08-13
- *Fixed major bug on Response function* - *Fixed major bug on Response function*
- *Fixed Random PID Generator (thanks: mkuba50)* - *Fixed Random PID Generator (thanks: mkuba50)*
### py-kms_2016-08-12 ## py-kms_2016-08-12
- *Added missing UUID, credits: Hotbird64* - *Added missing UUID, credits: Hotbird64*
- *Added Windows Server 2016 in random PID generator* - *Added Windows Server 2016 in random PID generator*
### py-kms_2016-08-11 ## py-kms_2016-08-11
- *Added Windows Server 2016 UUID* - *Added Windows Server 2016 UUID*
- *Fixed GroupID and PIDRange* - *Fixed GroupID and PIDRange*
- *Added Office 2016 CountKMSID* - *Added Office 2016 CountKMSID*
### py-kms_2015-07-29 ## py-kms_2015-07-29
- *Added Windows 10 UUID* - *Added Windows 10 UUID*
### py-kms_2014-10-13 build 3: ## py-kms_2014-10-13 build 3:
- *Added Client Activation Examples: "client-activation.txt"* - *Added Client Activation Examples: "client-activation.txt"*
- *Added Volume Keys: "client-keys.txt"* - *Added Volume Keys: "client-keys.txt"*
### py-kms_2014-10-13 build 2: ## py-kms_2014-10-13 build 2:
- *Added missing skuIds in file "kmsbase.py". Thanks (user_hidden)* - *Added missing skuIds in file "kmsbase.py". Thanks (user_hidden)*
### py-kms_2014-10-13 build 1: ## py-kms_2014-10-13 build 1:
- *The server now outputs the hwid in use.* - *The server now outputs the hwid in use.*
- *The server hwid can be random by using parameter: "-w random". Example: "python server.py -w random"* - *The server hwid can be random by using parameter: "-w random". Example: "python server.py -w random"*
- *Included file "randomHWID.py" to generate random hwid on demand.* - *Included file "randomHWID.py" to generate random hwid on demand.*
- *Included file "randomPID.py" to generate random epid and hwid on demand.* - *Included file "randomPID.py" to generate random epid and hwid on demand.*
### py-kms_2014-03-21T232943Z: ## py-kms_2014-03-21T232943Z:
- *The server HWID can now be specified on the command line.* - *The server HWID can now be specified on the command line.*
- *The client will print the HWID when using the v6 protocol.* - *The client will print the HWID when using the v6 protocol.*
### py-kms_2014-01-03T032458Z: ## py-kms_2014-01-03T032458Z:
- *Made the sqlite3 module optional.* - *Made the sqlite3 module optional.*
- *Changed the "log" flag to an "sqlite" flag and made a real log flag in preparation for when real request logging is implemented.* - *Changed the "log" flag to an "sqlite" flag and made a real log flag in preparation for when real request logging is implemented.*
### py-kms_2014-01-03T025524Z: ## py-kms_2014-01-03T025524Z:
- *Added RPC response decoding to the KMS client emulator.* - *Added RPC response decoding to the KMS client emulator.*
### py-kms_2013-12-30T064443Z: ## py-kms_2013-12-30T064443Z:
- *The v4 hash now uses the proper pre-expanded key.* - *The v4 hash now uses the proper pre-expanded key.*
### py-kms_2013-12-28T073506Z: ## py-kms_2013-12-28T073506Z:
- *Modified the v4 code to use the custom aes module in order to make it more streamlined and efficient.* - *Modified the v4 code to use the custom aes module in order to make it more streamlined and efficient.*
### py-kms_2013-12-20T051257Z: ## py-kms_2013-12-20T051257Z:
- *Removed the need for the pre-computed table (tablecomplex.py) for v4 CMAC calculation, cutting the zip file size in half.* - *Removed the need for the pre-computed table (tablecomplex.py) for v4 CMAC calculation, cutting the zip file size in half.*
### py-kms_2013-12-16T214638Z: ## py-kms_2013-12-16T214638Z:
- *Switched to getting the to-be-logged request time from the KMS server instead of the client.* - *Switched to getting the to-be-logged request time from the KMS server instead of the client.*
### py-kms_2013-12-16T030001Z: ## py-kms_2013-12-16T030001Z:
- *You can now specify the CMID and the Machine Name to use with the client emulator.* - *You can now specify the CMID and the Machine Name to use with the client emulator.*
### py-kms_2013-12-16T021215Z: ## py-kms_2013-12-16T021215Z:
- *Added a request-logging feature to the server. It stores requests in an SQLite database and uses the ePIDs stored there on a per-CMID basis.* - *Added a request-logging feature to the server. It stores requests in an SQLite database and uses the ePIDs stored there on a per-CMID basis.*
- *The client emulator now works for v4, v5, and v6 requests.* - *The client emulator now works for v4, v5, and v6 requests.*
- *The client emulator now also verifies the KMS v4 responses it receives.* - *The client emulator now also verifies the KMS v4 responses it receives.*
### py-kms_2013-12-14T230215Z ## py-kms_2013-12-14T230215Z
- *Added a client (work in progress) that right now can only generate and send RPC bind requests.* - *Added a client (work in progress) that right now can only generate and send RPC bind requests.*
- *Added a bunch of new classes to handle RPC client stuff, but I might just end up moving their functions back into the old classes at some point.* - *Added a bunch of new classes to handle RPC client stuff, but I might just end up moving their functions back into the old classes at some point.*
- *Lots of other code shuffling.* - *Lots of other code shuffling.*
- *Made the verbose and debug option help easier to read.* - *Made the verbose and debug option help easier to read.*
- *Added some server error messages.* - *Added some server error messages.*
### py-kms_2013-12-08T051332Z: ## py-kms_2013-12-08T051332Z:
- *Made some really huge internal changes to streamline packet parsing.* - *Made some really huge internal changes to streamline packet parsing.*
### py-kms_2013-12-06T034100Z: ## py-kms_2013-12-06T034100Z:
- *Added tons of new SKU IDs* - *Added tons of new SKU IDs*
### py-kms_2013-12-05T044849Z: ## py-kms_2013-12-05T044849Z:
- *Added Office SKU IDs* - *Added Office SKU IDs*
- *Small internal changes* - *Small internal changes*
### py-kms_2013-12-04T010942Z: ## py-kms_2013-12-04T010942Z:
- *Made the rpcResponseArray in rpcRequest output closer to spec* - *Made the rpcResponseArray in rpcRequest output closer to spec*
### py-kms_2013-12-01T063938Z: ## py-kms_2013-12-01T063938Z:
- *SKUID conversion: Converts the SKUID UUID into a human-readable product version for SKUIDs in its SKUID dictionary.* - *SKUID conversion: Converts the SKUID UUID into a human-readable product version for SKUIDs in its SKUID dictionary.*
- *Fancy new timezone conversion stuff.* - *Fancy new timezone conversion stuff.*
- *Enabled setting custom LCIDs.* - *Enabled setting custom LCIDs.*
- *Data parsing is now handled by structure.py.* - *Data parsing is now handled by structure.py.*
- *Some other minor stuff you probably won't notice.* - *Some other minor stuff you probably won't notice.*
### py-kms_2013-11-27T061658Z: ## py-kms_2013-11-27T061658Z:
- *Got rid of custom functions module (finally)* - *Got rid of custom functions module (finally)*
### py-kms_2013-11-27T054744Z: ## py-kms_2013-11-27T054744Z:
- *Simplified custom functions module* - *Simplified custom functions module*
- *Got rid of "v4" subfolder* - *Got rid of "v4" subfolder*
- *Cleaned up a bunch of code* - *Cleaned up a bunch of code*
### py-kms_2013-11-23T044244Z: ## py-kms_2013-11-23T044244Z:
- *Added timestamps to verbose output* - *Added timestamps to verbose output*
- *Made the verbose output look better* - *Made the verbose output look better*
### py-kms_2013-11-21T014002Z: ## py-kms_2013-11-21T014002Z:
- *Moved some stuff into verbose output* - *Moved some stuff into verbose output*
- *Enabled server ePIDs of arbitrary length* - *Enabled server ePIDs of arbitrary length*
### py-kms_2013-11-20T180347Z: ## py-kms_2013-11-20T180347Z:
- *Permanently fixed machineName decoding* - *Permanently fixed machineName decoding*
- *Adheres closer to the DCE/RPC protocol spec* - *Adheres closer to the DCE/RPC protocol spec*
- *Added client info to program output* - *Added client info to program output*
- *Small formatting changes* - *Small formatting changes*
### py-kms_2013-11-13: ## py-kms_2013-11-13:
- *First working release added to the Mega folder.* - *First working release added to the Mega folder.*

4
docs/Getting Started.md
View File

@ -2,7 +2,6 @@
What follows are some guides how to start the `pykms_Server.py` script, which provides the emulated server. What follows are some guides how to start the `pykms_Server.py` script, which provides the emulated server.
## Running as a service ## Running as a service
***
You can simply manage a daemon that runs as a background process. This can be achieved by using any of the notes below or by writing your own solution. You can simply manage a daemon that runs as a background process. This can be achieved by using any of the notes below or by writing your own solution.
### Docker ### Docker
@ -56,7 +55,7 @@ services:
``` ```
#### Parameters #### Parameters
Below is a little bit more extended 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. Below is a little bit more extended run command, detailing all the different supported environment variables to set. For further reference see the [start parameters](#docker-environment) for the docker environment.
```bash ```bash
docker run -it -d --name py3-kms \ docker run -it -d --name py3-kms \
-p 8080:8080 \ -p 8080:8080 \
@ -156,7 +155,6 @@ They might be useful to you:
- [FreeBSD](https://github.com/SystemRage/py-kms/issues/89) - [FreeBSD](https://github.com/SystemRage/py-kms/issues/89)
## Manual Execution ## Manual Execution
***
### Dependencies ### Dependencies
- Python 3.x. - Python 3.x.

40
docs/Keys.md
View File

@ -3,20 +3,19 @@ These are keys, which can be used to activate a product with _py-kms_ (note this
sometimes even reject it by itself (often due too many uses - in that case try to use an other one). sometimes even reject it by itself (often due too many uses - in that case try to use an other one).
## Windows ## Windows
***
### Windows Server 2022 ### Windows Server 2022
| Product | GVLK | | Product | GVLK |
| --- | --- | | -------------------------------------------- | ------------------------------- |
| Windows Server 2022 Datacenter | `WX4NM-KYWYW-QJJR4-XV3QB-6VM33` | | Windows Server 2022 Datacenter | `WX4NM-KYWYW-QJJR4-XV3QB-6VM33` |
| Windows Server 2022 Datacenter Azure Edition | `NTBV8-9K7Q8-V27C6-M2BTV-KHMXV` |
| Windows Server 2022 Standard | `VDYBN-27WPP-V4HQT-9VMD4-VMK7H` | | Windows Server 2022 Standard | `VDYBN-27WPP-V4HQT-9VMD4-VMK7H` |
| Windows Server 2022 Datacenter Azure Edition | `NTBV8-9K7Q8-V27C6-M2BTV-KHMXV` |
### Windows Server 2019 ### Windows Server 2019
| Product | GVLK | | Product | GVLK |
| --- | --- | | ----------------------------------------------------------- | ------------------------------- |
| Windows Server 2019 Datacenter | `WMDGN-G9PQG-XVVXX-R3X43-63DFG` | | Windows Server 2019 Datacenter | `WMDGN-G9PQG-XVVXX-R3X43-63DFG` |
| Windows Server 2019 Standard | `N69G4-B89J2-4G8F4-WWYCC-J464C` | | Windows Server 2019 Standard | `N69G4-B89J2-4G8F4-WWYCC-J464C` |
| Windows Server 2019 Essentials | `WVDHN-86M7X-466P6-VHXV7-YY726` | | Windows Server 2019 Essentials | `WVDHN-86M7X-466P6-VHXV7-YY726` |
@ -28,7 +27,7 @@ sometimes even reject it by itself (often due too many uses - in that case try t
### Windows Server 2016 ### Windows Server 2016
| Product | GVLK | | Product | GVLK |
| --- | --- | | ----------------------------------------------------------- | ------------------------------------------------------------------ |
| Windows Server 2016 Standard Semi-Annual Channel (v.1803) | `PTXN8-JFHJM-4WC78-MPCBR-9W4KR` | | Windows Server 2016 Standard Semi-Annual Channel (v.1803) | `PTXN8-JFHJM-4WC78-MPCBR-9W4KR` |
| Windows Server 2016 Datacenter Semi-Annual Channel (v.1803) | `2HXDN-KRXHB-GPYC7-YCKFJ-7FVDG` | | Windows Server 2016 Datacenter Semi-Annual Channel (v.1803) | `2HXDN-KRXHB-GPYC7-YCKFJ-7FVDG` |
| Windows Server 2016 Datacenter Semi-Annual Channel (v.1709) | `6Y6KB-N82V8-D8CQV-23MJW-BWTG6` | | Windows Server 2016 Datacenter Semi-Annual Channel (v.1709) | `6Y6KB-N82V8-D8CQV-23MJW-BWTG6` |
@ -43,7 +42,7 @@ sometimes even reject it by itself (often due too many uses - in that case try t
### Windows 10 & Windows 11 ### Windows 10 & Windows 11
| Product | GVLK | | Product | GVLK |
| --- | --- | | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| Windows 10/11 Professional Workstation | `NRG8B-VKK3Q-CXVCJ-9G2XF-6Q84J` | | Windows 10/11 Professional Workstation | `NRG8B-VKK3Q-CXVCJ-9G2XF-6Q84J` |
| Windows 10/11 Professional Workstation N | `9FNHH-K3HBT-3W4TD-6383H-6XYWF` | | Windows 10/11 Professional Workstation N | `9FNHH-K3HBT-3W4TD-6383H-6XYWF` |
| Windows 10/11 Enterprise G | `YYVX9-NTFWV-6MDM3-9PT4T-4M68B` | | Windows 10/11 Enterprise G | `YYVX9-NTFWV-6MDM3-9PT4T-4M68B` |
@ -75,7 +74,7 @@ sometimes even reject it by itself (often due too many uses - in that case try t
### Windows Server 2012 R2 ### Windows Server 2012 R2
| Product | GVLK | | Product | GVLK |
| --- | --- | | ------------------------------------ | ------------------------------- |
| Windows Server 2012 R2 Standard | `D2N9P-3P6X9-2R39C-7RTCD-MDVJX` | | Windows Server 2012 R2 Standard | `D2N9P-3P6X9-2R39C-7RTCD-MDVJX` |
| Windows Server 2012 R2 Datacenter | `W3GGN-FT8W3-Y4M27-J84CP-Q3VJ9` | | Windows Server 2012 R2 Datacenter | `W3GGN-FT8W3-Y4M27-J84CP-Q3VJ9` |
| Windows Server 2012 R2 Essentials | `KNC87-3J2TX-XB4WP-VCPJV-M4FWM` | | Windows Server 2012 R2 Essentials | `KNC87-3J2TX-XB4WP-VCPJV-M4FWM` |
@ -84,7 +83,7 @@ sometimes even reject it by itself (often due too many uses - in that case try t
### Windows 8.1 ### Windows 8.1
| Product | GVLK | | Product | GVLK |
| --- | --- | | ------------------------------------------- | ------------------------------------------------------------------ |
| Windows 8.1 Professional | `GCRJD-8NW9H-F2CDX-CCM8D-9D6T9` | | Windows 8.1 Professional | `GCRJD-8NW9H-F2CDX-CCM8D-9D6T9` |
| Windows 8.1 Professional N | `HMCNV-VVBFX-7HMBH-CTY9B-B4FXY` | | Windows 8.1 Professional N | `HMCNV-VVBFX-7HMBH-CTY9B-B4FXY` |
| Windows 8.1 Professional WMC | `789NJ-TQK6T-6XTH8-J39CJ-J8D3P` | | Windows 8.1 Professional WMC | `789NJ-TQK6T-6XTH8-J39CJ-J8D3P` |
@ -108,7 +107,7 @@ sometimes even reject it by itself (often due too many uses - in that case try t
### Windows Server 2012 ### Windows Server 2012
| Product | GVLK | | Product | GVLK |
| --- | --- | | ----------------------------------------------------------------------- | ------------------------------- |
| Windows Server 2012<br>Windows 8 Core | `BN3D2-R7TKB-3YPBD-8DRP2-27GG4` | | Windows Server 2012<br>Windows 8 Core | `BN3D2-R7TKB-3YPBD-8DRP2-27GG4` |
| Windows Server 2012 N<br>Windows 8 Core N | `8N2M2-HWPGY-7PGT9-HGDD8-GVGGY` | | Windows Server 2012 N<br>Windows 8 Core N | `8N2M2-HWPGY-7PGT9-HGDD8-GVGGY` |
| Windows Server 2012 Single Language<br>Windows 8 Core Single Language | `2WN2H-YGCQR-KFX6K-CD6TF-84YXQ` | | Windows Server 2012 Single Language<br>Windows 8 Core Single Language | `2WN2H-YGCQR-KFX6K-CD6TF-84YXQ` |
@ -121,7 +120,7 @@ sometimes even reject it by itself (often due too many uses - in that case try t
### Windows 8 ### Windows 8
| Product | GVLK | | Product | GVLK |
| --- | --- | | ----------------------------------------------------------------------- | ------------------------------------------------------------------ |
| Windows 8 Professional | `NG4HW-VH26C-733KW-K6F98-J8CK4` | | Windows 8 Professional | `NG4HW-VH26C-733KW-K6F98-J8CK4` |
| Windows 8 Professional N | `XCVCF-2NXM9-723PB-MHCB7-2RYQQ` | | Windows 8 Professional N | `XCVCF-2NXM9-723PB-MHCB7-2RYQQ` |
| Windows 8 Professional WMC | `GNBB8-YVD74-QJHX6-27H4K-8QHDG`<br>`NQ3PX-BBY8Y-RRHMM-TBHFW-PJ866` | | Windows 8 Professional WMC | `GNBB8-YVD74-QJHX6-27H4K-8QHDG`<br>`NQ3PX-BBY8Y-RRHMM-TBHFW-PJ866` |
@ -138,7 +137,7 @@ sometimes even reject it by itself (often due too many uses - in that case try t
### Windows Server 2008 R2 ### Windows Server 2008 R2
| Product | GVLK | | Product | GVLK |
| --- | --- | | ------------------------------------------------ | ------------------------------- |
| Windows MultiPoint Server 2010 | `736RG-XDKJK-V34PF-BHK87-J6X3K` | | Windows MultiPoint Server 2010 | `736RG-XDKJK-V34PF-BHK87-J6X3K` |
| Windows Server 2008 R2 Web | `6TPJF-RBVHG-WBW2R-86QPH-6RTM4` | | Windows Server 2008 R2 Web | `6TPJF-RBVHG-WBW2R-86QPH-6RTM4` |
| Windows Server 2008 R2 HPC edition | `TT8MH-CG224-D3D7Q-498W2-9QCTX` | | Windows Server 2008 R2 HPC edition | `TT8MH-CG224-D3D7Q-498W2-9QCTX` |
@ -150,7 +149,7 @@ sometimes even reject it by itself (often due too many uses - in that case try t
### Windows 7 ### Windows 7
| Product | GVLK | | Product | GVLK |
| --- | --- | | --------------------------- | ------------------------------------------------------------------ |
| Windows 7 Professional | `FJ82H-XT6CR-J8D7P-XQJJ2-GPDD4`<br>`MYKDJ-XV4CV-M2D3P-KDVY4-MPTW8` | | Windows 7 Professional | `FJ82H-XT6CR-J8D7P-XQJJ2-GPDD4`<br>`MYKDJ-XV4CV-M2D3P-KDVY4-MPTW8` |
| Windows 7 Professional N | `MRPKT-YTG23-K7D7T-X2JMM-QY7MG` | | Windows 7 Professional N | `MRPKT-YTG23-K7D7T-X2JMM-QY7MG` |
| Windows 7 Professional E | `W82YF-2Q76Y-63HXB-FGJG9-GF7QX` | | Windows 7 Professional E | `W82YF-2Q76Y-63HXB-FGJG9-GF7QX` |
@ -164,7 +163,7 @@ sometimes even reject it by itself (often due too many uses - in that case try t
### Windows Server 2008 ### Windows Server 2008
| Product | GVLK | | Product | GVLK |
| --- | --- | | -------------------------------------------------- | ------------------------------- |
| Windows Server 2008 Web | `WYR28-R7TFJ-3X2YQ-YCY4H-M249D` | | Windows Server 2008 Web | `WYR28-R7TFJ-3X2YQ-YCY4H-M249D` |
| Windows Server 2008 Standard | `TM24T-X9RMF-VWXK6-X8JC9-BFGM2` | | Windows Server 2008 Standard | `TM24T-X9RMF-VWXK6-X8JC9-BFGM2` |
| Windows Server 2008 Standard without Hyper-V | `W7VD6-7JFBR-RX26B-YKQ3Y-6FFFJ` | | Windows Server 2008 Standard without Hyper-V | `W7VD6-7JFBR-RX26B-YKQ3Y-6FFFJ` |
@ -178,7 +177,7 @@ sometimes even reject it by itself (often due too many uses - in that case try t
### Windows Vista ### Windows Vista
| Product | GVLK | | Product | GVLK |
| --- | --- | | -------------------------- | ------------------------------- |
| Windows Vista Business | `YFKBB-PQJJV-G996G-VWGXY-2V3X8` | | Windows Vista Business | `YFKBB-PQJJV-G996G-VWGXY-2V3X8` |
| Windows Vista Business N | `HMBQG-8H2RH-C77VX-27R82-VMQBT` | | Windows Vista Business N | `HMBQG-8H2RH-C77VX-27R82-VMQBT` |
| Windows Vista Enterprise | `VKK3X-68KWM-X2YGT-QR4M6-4BWMV` | | Windows Vista Enterprise | `VKK3X-68KWM-X2YGT-QR4M6-4BWMV` |
@ -187,7 +186,7 @@ sometimes even reject it by itself (often due too many uses - in that case try t
### Windows Previews ### Windows Previews
| Product | GVLK | | Product | GVLK |
| --- | --- | | ---------------------------------------------------------- | ------------------------------------------------------------------ |
| Windows Server 2019 Datacenter [Preview] | `6XBNX-4JQGW-QX6QG-74P76-72V67` | | Windows Server 2019 Datacenter [Preview] | `6XBNX-4JQGW-QX6QG-74P76-72V67` |
| Windows Server 2019 Standard [Preview] | `MFY9F-XBN2F-TYFMP-CCV49-RMYVH` | | Windows Server 2019 Standard [Preview] | `MFY9F-XBN2F-TYFMP-CCV49-RMYVH` |
| Windows 10 Home / Core [Pre-Release] | `?????-?????-?????-?????-?????` | | Windows 10 Home / Core [Pre-Release] | `?????-?????-?????-?????-?????` |
@ -281,12 +280,11 @@ sometimes even reject it by itself (often due too many uses - in that case try t
| Windows Next Professional S N [Pre-Release] | `?????-?????-?????-?????-?????` | | Windows Next Professional S N [Pre-Release] | `?????-?????-?????-?????-?????` |
## Office ## Office
***
### Office 2021 ### Office 2021
| Product | GVLK | | Product | GVLK |
| --- | --- | | ----------------------------------- | ------------------------------- |
| Office Access LTSC 2021 | `WM8YG-YNGDD-4JHDC-PG3F4-FC4T4` | | Office Access LTSC 2021 | `WM8YG-YNGDD-4JHDC-PG3F4-FC4T4` |
| Office Excel LTSC 2021 | `NWG3X-87C9K-TC7YY-BC2G7-G6RVC` | | Office Excel LTSC 2021 | `NWG3X-87C9K-TC7YY-BC2G7-G6RVC` |
| Office Outlook LTSC 2021 | `C9FM6-3N72F-HFJXB-TM3V9-T86R9` | | Office Outlook LTSC 2021 | `C9FM6-3N72F-HFJXB-TM3V9-T86R9` |
@ -304,7 +302,7 @@ sometimes even reject it by itself (often due too many uses - in that case try t
### Office 2019 ### Office 2019
| Product | GVLK | | Product | GVLK |
| --- | --- | | ------------------------------- | ------------------------------- |
| Professional Plus 2019 [C2R] | `VQ9DP-NVHPH-T9HJC-J9PDT-KTQRG` | | Professional Plus 2019 [C2R] | `VQ9DP-NVHPH-T9HJC-J9PDT-KTQRG` |
| Professional Plus 2019 | `NMMKJ-6RK4F-KMJVX-8D9MJ-6MWKP` | | Professional Plus 2019 | `NMMKJ-6RK4F-KMJVX-8D9MJ-6MWKP` |
| Standard 2019 | `6NWWJ-YQWMR-QKGCB-6TMB3-9D9HK` | | Standard 2019 | `6NWWJ-YQWMR-QKGCB-6TMB3-9D9HK` |
@ -325,7 +323,7 @@ sometimes even reject it by itself (often due too many uses - in that case try t
### Office 2016 ### Office 2016
| Product | GVLK | | Product | GVLK |
| --- | --- | | ------------------------------- | ------------------------------- |
| Professional Plus 2016 | `XQNVK-8JYDB-WJ9W3-YJ8YR-WFG99` | | Professional Plus 2016 | `XQNVK-8JYDB-WJ9W3-YJ8YR-WFG99` |
| Standard 2016 | `JNRGM-WHDWX-FJJG3-K47QV-DRTFM` | | Standard 2016 | `JNRGM-WHDWX-FJJG3-K47QV-DRTFM` |
| Project Professional 2016 | `YG9NW-3K39V-2T3HJ-93F3Q-G83KT` | | Project Professional 2016 | `YG9NW-3K39V-2T3HJ-93F3Q-G83KT` |
@ -350,7 +348,7 @@ sometimes even reject it by itself (often due too many uses - in that case try t
### Office 2013 ### Office 2013
| Product | GVLK | | Product | GVLK |
| --- | --- | | ----------------------------------------------------- | ------------------------------- |
| Professional Plus 2013 [Preview] | `PGD67-JN23K-JGVWV-KTHP4-GXR9G` | | Professional Plus 2013 [Preview] | `PGD67-JN23K-JGVWV-KTHP4-GXR9G` |
| Professional Plus 2013 | `YC7DK-G2NP3-2QQC3-J6H88-GVGXT` | | Professional Plus 2013 | `YC7DK-G2NP3-2QQC3-J6H88-GVGXT` |
| Standard 2013 | `KBKQT-2NMXY-JJWGP-M62JB-92CD4` | | Standard 2013 | `KBKQT-2NMXY-JJWGP-M62JB-92CD4` |
@ -391,7 +389,7 @@ sometimes even reject it by itself (often due too many uses - in that case try t
### Office 2010 ### Office 2010
| Product | GVLK | | Product | GVLK |
| --- | --- | | ------------------------------------------- | ------------------------------- |
| Professional Plus 2010 | `VYBBJ-TRJPB-QFQRF-QFT4D-H3GVB` | | Professional Plus 2010 | `VYBBJ-TRJPB-QFQRF-QFT4D-H3GVB` |
| Standard 2010 | `V7QKV-4XVVR-XYV4D-F7DFM-8R6BM` | | Standard 2010 | `V7QKV-4XVVR-XYV4D-F7DFM-8R6BM` |
| Project Professional 2010 | `YGX6F-PGV49-PGW3J-9BTGG-VHKC6` | | Project Professional 2010 | `YGX6F-PGV49-PGW3J-9BTGG-VHKC6` |

13
docs/Usage.md
View File

@ -1,8 +1,8 @@
# Usage # Usage
## Start Parameters ## Start Parameters
***
(pykms-server-py)=
### pykms_Server.py ### pykms_Server.py
Follows a list of usable parameters: Follows a list of usable parameters:
@ -93,7 +93,7 @@ Mon, 12 Jun 2017 22:09:00 INFO HWID: 58C4F4E53AE14224
You can also enable other suboptions of `-F` doing what is reported in the following table: You can also enable other suboptions of `-F` doing what is reported in the following table:
| command | pretty msg | logging msg | logfile | | command | pretty msg | logging msg | logfile |
| --- | --- | --- | --- | | ------------------------- | ---------- | ----------- | ------- |
| `-F <logfile>` | ON | OFF | ON | | `-F <logfile>` | ON | OFF | ON |
| `-F STDOUT` | OFF | ON | OFF | | `-F STDOUT` | OFF | ON | OFF |
| `-F FILESTDOUT <logfile>` | OFF | ON | ON | | `-F FILESTDOUT <logfile>` | OFF | ON | ON |
@ -103,7 +103,7 @@ You can also enable other suboptions of `-F` doing what is reported in the follo
-S or --logsize <MAXSIZE> -S or --logsize <MAXSIZE>
> Use this flag to set a maximum size (in MB) to the output log file. Deactivated by default. > Use this flag to set a maximum size (in MB) to the output log file. Deactivated by default.
##### subparser `connect` #### subparser `connect`
-n or --listen <'IP,PORT'> -n or --listen <'IP,PORT'>
> Use this option to add multiple listening ip address - port couples. Note the format with the comma between the ip address and the port number. You can use this option more than once. > Use this option to add multiple listening ip address - port couples. Note the format with the comma between the ip address and the port number. You can use this option more than once.
@ -123,7 +123,7 @@ If used it refers to all addresses (main and additional). Deactivated by default
examples (with fictitious addresses and ports): examples (with fictitious addresses and ports):
| command | address (main) | backlog (main) | reuse port (main) | address (listen) | backlog (listen) | reuse port (listen) | dualstack (main / listen) | | command | address (main) | backlog (main) | reuse port (main) | address (listen) | backlog (listen) | reuse port (listen) | dualstack (main / listen) |
| --- | --- | --- | --- | --- | --- | --- | --- | | ----------------------------------------------------------------------------------------------- | -------------- | -------------- | ----------------- | ------------------------------------------------ | ---------------- | ------------------- | ------------------------- |
| `python3 pykms_Server.py connect -b 12` | ('::', 1688) | 12 | True | [] | [] | [] | False | | `python3 pykms_Server.py connect -b 12` | ('::', 1688) | 12 | True | [] | [] | [] | False |
| `python3 pykms_Server.py :: connect -b 12 -u -d` | ('::', 1688) | 12 | False | [] | [] | [] | True | | `python3 pykms_Server.py :: connect -b 12 -u -d` | ('::', 1688) | 12 | False | [] | [] | [] | True |
| `python3 pykms_Server.py connect -n 1.1.1.1,1699 -b 10` | ('::', 1688) | 5 | True | [('1.1.1.1', 1699)] | [10] | [True] | False | | `python3 pykms_Server.py connect -n 1.1.1.1,1699 -b 10` | ('::', 1688) | 5 | True | [('1.1.1.1', 1699)] | [10] | [True] | False |
@ -197,8 +197,9 @@ You can enable same _pykms_Server.py_ suboptions of `-F`.
-S or --logsize <MAXSIZE> -S or --logsize <MAXSIZE>
> Use this flag to set a maximum size (in MB) to the output log file. Deactivated by default. > Use this flag to set a maximum size (in MB) to the output log file. Deactivated by default.
(docker-environment)=
## Docker Environment ## Docker Environment
This are the currently used `ENV` statements from the Dockerfile(s). For further references what exactly the parameters mean, please see the start parameters for the [server](Usage.html#pykms-server-py). This are the currently used `ENV` statements from the Dockerfile(s). For further references what exactly the parameters mean, please see the start parameters for the [server](#pykms-server-py).
``` ```
# IP-address # IP-address
# The IP address to listen on. The default is "::" (all interfaces). # The IP address to listen on. The default is "::" (all interfaces).
@ -252,7 +253,6 @@ ENV LOGSIZE ""
The product asks for a key during installation, so it needs you to enter the GVLK. Then the user can set connection parameters, while KMS server must already be running on server machine. Finally with specific commands, activation occurs automatically and can be extended later every time for another 180 (or 30 or 45) days. The product asks for a key during installation, so it needs you to enter the GVLK. Then the user can set connection parameters, while KMS server must already be running on server machine. Finally with specific commands, activation occurs automatically and can be extended later every time for another 180 (or 30 or 45) days.
### Windows ### Windows
***
The `//nologo` option of `cscript` was used only to hide the startup logo. The `//nologo` option of `cscript` was used only to hide the startup logo.
![win1](img/win1.png) ![win1](img/win1.png)
@ -270,7 +270,6 @@ The `//nologo` option of `cscript` was used only to hide the startup logo.
6. View license informations (optional). 6. View license informations (optional).
### Office ### Office
***
Note that you’ll have to install a volume license (VL) version of Office. Office versions downloaded from MSDN and / or Technet are non-VL. Note that you’ll have to install a volume license (VL) version of Office. Office versions downloaded from MSDN and / or Technet are non-VL.
![off1](img/off1.png) ![off1](img/off1.png)

114
docs/conf.py
View File

@ -18,29 +18,23 @@ import os
# If extensions (or modules to document with autodoc) are in another directory, # If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the # add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here. # documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.')) # sys.path.insert(0, os.path.abspath('.'))
# -- General configuration ------------------------------------------------ # -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here. # If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0' # needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be # Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones. # ones.
extensions = ['recommonmark', 'sphinx_markdown_tables'] extensions = ['myst_parser', 'sphinx_markdown_tables', 'sphinx_rtd_theme']
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates'] # templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = {
'.rst': 'restructuredtext',
'.md': 'markdown',
}
# The encoding of source files. # The encoding of source files.
#source_encoding = 'utf-8-sig' # source_encoding = 'utf-8-sig'
# The master toctree document. # The master toctree document.
master_doc = 'index' master_doc = 'index'
@ -54,19 +48,19 @@ copyright = u'2020, SystemRage'
# built documents. # built documents.
# #
# The short X.Y version. # The short X.Y version.
version = '1.0' # version = '1.0'
# The full version, including alpha/beta/rc tags. # The full version, including alpha/beta/rc tags.
release = '1.0' # release = '1.0'
# The language for content autogenerated by Sphinx. Refer to documentation # The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages. # for a list of supported languages.
#language = None # language = None
# There are two options for replacing |today|: either, you set today to some # There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used: # non-false value, then it is used:
#today = '' # today = ''
# Else, today_fmt is used as the format for a strftime call. # Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y' # today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and # List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files. # directories to ignore when looking for source files.
@ -74,109 +68,109 @@ exclude_patterns = ['_build']
# The reST default role (used for this markup: `text`) to use for all # The reST default role (used for this markup: `text`) to use for all
# documents. # documents.
#default_role = None # default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text. # If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True # add_function_parentheses = True
# If true, the current module name will be prepended to all description # If true, the current module name will be prepended to all description
# unit titles (such as .. function::). # unit titles (such as .. function::).
#add_module_names = True # add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the # If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default. # output. They are ignored by default.
#show_authors = False # show_authors = False
# The name of the Pygments (syntax highlighting) style to use. # The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx' pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting. # A list of ignored prefixes for module index sorting.
#modindex_common_prefix = [] # modindex_common_prefix = []
# If true, keep warnings as "system message" paragraphs in the built documents. # If true, keep warnings as "system message" paragraphs in the built documents.
#keep_warnings = False # keep_warnings = False
# -- Options for HTML output ---------------------------------------------- # -- Options for HTML output ----------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # a list of builtin themes.
html_theme = 'default' html_theme = 'sphinx_rtd_theme'
# Theme options are theme-specific and customize the look and feel of a theme # Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the # further. For a list of options available for each theme, see the
# documentation. # documentation.
#html_theme_options = {} # html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory. # Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = [] # html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to # The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation". # "<project> v<release> documentation".
#html_title = None # html_title = None
# A shorter title for the navigation bar. Default is the same as html_title. # A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None # html_short_title = None
# The name of an image file (relative to this directory) to place at the top # The name of an image file (relative to this directory) to place at the top
# of the sidebar. # of the sidebar.
#html_logo = None # html_logo = None
# The name of an image file (within the static path) to use as favicon of the # The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large. # pixels large.
#html_favicon = None # html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here, # Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files, # relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css". # so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static'] # html_static_path = ['_static']
# Add any extra paths that contain custom files (such as robots.txt or # Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied # .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation. # directly to the root of the documentation.
#html_extra_path = [] # html_extra_path = []
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format. # using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y' # html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to # If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities. # typographically correct entities.
#html_use_smartypants = True # html_use_smartypants = True
# Custom sidebar templates, maps document names to template names. # Custom sidebar templates, maps document names to template names.
#html_sidebars = {} # html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to # Additional templates that should be rendered to pages, maps page names to
# template names. # template names.
#html_additional_pages = {} # html_additional_pages = {}
# If false, no module index is generated. # If false, no module index is generated.
#html_domain_indices = True # html_domain_indices = True
# If false, no index is generated. # If false, no index is generated.
#html_use_index = True # html_use_index = True
# If true, the index is split into individual pages for each letter. # If true, the index is split into individual pages for each letter.
#html_split_index = False # html_split_index = False
# If true, links to the reST sources are added to the pages. # If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True # html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True # html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True # html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will # If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the # contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served. # base URL from which the finished HTML is served.
#html_use_opensearch = '' # html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml"). # This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None # html_file_suffix = None
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = 'py-kms' htmlhelp_basename = 'py-kms'
@ -185,14 +179,14 @@ htmlhelp_basename = 'py-kms'
# -- Options for LaTeX output --------------------------------------------- # -- Options for LaTeX output ---------------------------------------------
latex_elements = { latex_elements = {
# The paper size ('letterpaper' or 'a4paper'). # The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper', # 'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt'). # The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt', # 'pointsize': '10pt',
# Additional stuff for the LaTeX preamble. # Additional stuff for the LaTeX preamble.
#'preamble': '', # 'preamble': '',
} }
# Grouping the document tree into LaTeX files. List of tuples # Grouping the document tree into LaTeX files. List of tuples
@ -205,23 +199,23 @@ latex_documents = [
# The name of an image file (relative to this directory) to place at the top of # The name of an image file (relative to this directory) to place at the top of
# the title page. # the title page.
#latex_logo = None # latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts, # For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters. # not chapters.
#latex_use_parts = False # latex_use_parts = False
# If true, show page references after internal links. # If true, show page references after internal links.
#latex_show_pagerefs = False # latex_show_pagerefs = False
# If true, show URL addresses after external links. # If true, show URL addresses after external links.
#latex_show_urls = False # latex_show_urls = False
# Documents to append as an appendix to all manuals. # Documents to append as an appendix to all manuals.
#latex_appendices = [] # latex_appendices = []
# If false, no module index is generated. # If false, no module index is generated.
#latex_domain_indices = True # latex_domain_indices = True
# -- Options for manual page output --------------------------------------- # -- Options for manual page output ---------------------------------------
@ -234,7 +228,7 @@ man_pages = [
] ]
# If true, show URL addresses after external links. # If true, show URL addresses after external links.
#man_show_urls = False # man_show_urls = False
# -- Options for Texinfo output ------------------------------------------- # -- Options for Texinfo output -------------------------------------------
@ -249,13 +243,13 @@ texinfo_documents = [
] ]
# Documents to append as an appendix to all manuals. # Documents to append as an appendix to all manuals.
#texinfo_appendices = [] # texinfo_appendices = []
# If false, no module index is generated. # If false, no module index is generated.
#texinfo_domain_indices = True # texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'. # How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote' # texinfo_show_urls = 'footnote'
# If true, do not generate a @detailmenu in the "Top" node's menu. # If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False # texinfo_no_detailmenu = False

10
docs/requirements.txt
View File

@ -1,5 +1,5 @@
Sphinx==5.3.0 Sphinx~=7.2.6
sphinx-rtd-theme==1.1.1 sphinx-rtd-theme~=2.0.0
readthedocs-sphinx-search==0.1.2 readthedocs-sphinx-search~=0.3.2
sphinx-markdown-tables==0.0.17 sphinx-markdown-tables~=0.0.17
recommonmark==0.7.1 myst-parser~=2.0.0