From c0268b4ee71cec7a0cb576ae2596737372b3bd20 Mon Sep 17 00:00:00 2001 From: Simon Beginn Date: Sat, 1 Aug 2020 13:14:10 +0200 Subject: [PATCH] Started moving into docs --- README.md | 20 +------------------- 1 file changed, 1 insertion(+), 19 deletions(-) diff --git a/README.md b/README.md index fd72b95..17023a3 100644 --- a/README.md +++ b/README.md @@ -29,32 +29,14 @@ _py-kms_ is a port of node-kms created by [cyrozap](http://forums.mydigitallife. - Python 3.x. - Tkinter module (for the GUI). - If the `tzlocal` module is installed, the "Request Time" in the verbose output will be converted into local time. Otherwise, it will be in UTC. -- It can use the `sqlite3` module so you can use the database function, storing activation data so it can be recalled again. -- Installation example on Ubuntu / Mint: - - `sudo apt-get update` - - `sudo apt-get install python3-tk python3-pip` - - `sudo pip3 install tzlocal pysqlite3` +- It can use the `sqlite3` module so you can use the database function, storing activation data so it can be recalled again. ## Usage - 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. Also note that you have to use an IPv6 address - even if you are just plan to use IPv4 (the kernel maps the incoming IPv4 requests automatically to IPv6), otherwise you will get unsupported address family exceptions! - To run the client (only for testing purposes), use `python3 pykms_Client.py [IPADDRESS] [PORT]`, with the same defaults of `pykms_Server.py`. - To show the help pages type: `python3 pykms_Server.py -h` and `python3 pykms_Client.py -h`. -- To generate a random HWID use `-w` option: `python3 pykms_Server.py -w RANDOM`. -- To get the HWID from any server use the client, for example type: `python3 pykms_Client.py :: 1688 -m Windows8.1 -V INFO`. -- To change your logfile path use `-F` option, for example: `python3 pykms_Server.py -F /path/to/your/logfile.log -V DEBUG`. -- To view a minimal set of logging information use `-V MINI` option, for example: `python3 pykms_Server.py -F /path/to/your/logfile.log -V MINI`. -- To redirect logging on stdout use `-F STDOUT` option, for example: `python3 pykms_Server.py -F STDOUT -V DEBUG`. -- You can create logfile and view logging information on stdout at the same time with `-F FILESTDOUT` option, for example: `python3 pykms_Server.py -F FILESTDOUT /path/to/your/logfile.log -V DEBUG`. -- With `-F STDOUTOFF` you disable all stdout messages (but a logfile will be created), for example: `python3 pykms_Server.py -F STDOUTOFF /path/to/your/logfile.log -V DEBUG`. -- With `-F FILEOFF` you disable logfile creation. - -- Select timeout (seconds) for py-kms with `-t0` option, for example `python3 pykms_Server.py -t0 10`. -- Option `-y` enables printing asynchronously of messages (pretty / logging). - For launching py-kms GUI make executable `pykms_Server.py` file with `chmod +x /path/to/folder/py-kms/pykms_Server.py`, then simply run `pykms_Server.py` double-clicking. -- You can run py-kms daemonized (via [Etrigan](https://github.com/SystemRage/Etrigan)) using a command like: `python3 pykms_Server.py etrigan start` and stop it with: `python3 pykms_Server.py etrigan stop`. -- With Etrigan you have another way to launch py-kms GUI (specially suitable if you're using a virtualenv), so: `python3 pykms_Server.py etrigan start -g` -and stop the GUI with `python3 pykms_Server.py etrigan stop` (or interact with the EXIT button). ## Docker ![auto-docker](https://img.shields.io/docker/cloud/automated/pykmsorg/py-kms)