1
0
Fork 0

README update.

This commit is contained in:
Alexander Andreev 2023-02-04 20:45:43 +04:00
parent e5f20ea93a
commit 242fa48358
Signed by: Arav
GPG Key ID: 0388CC8FAA51063F
1 changed files with 6 additions and 6 deletions

View File

@ -1,11 +1,11 @@
# httpprocprobed Ver 2.0.0 # httpprocprobed Ver 2.0.1
License: MIT+NIGGER. License: MIT+NIGGER.
This utility provides a HTTP `/processes` GET endpoint that returns a list of This utility provides a HTTP `/processes` GET endpoint that returns a list of
processes, and if they are currently running or not. processes, and if they are currently running or not.
There are currently three output formats available: JSON, XML, plain text. There are currently three output formats available: JSON, XML, and plain text.
JSON is a default format if `Accept` header didn't provided, or did with JSON is a default format if `Accept` header didn't provided, or did with
value `application/json`. Its form is `{"process":true|false, ...}`. value `application/json`. Its form is `{"process":true|false, ...}`.
@ -16,10 +16,10 @@ XML is provided if `Accept: application/xml` header was given. Its form is
Plain text is provided if `Accept: text/plain` header was given. Its form is a Plain text is provided if `Accept: text/plain` header was given. Its form is a
comma separated list of ONLY running process' names. comma separated list of ONLY running process' names.
Configuration file is a simple key = value storage consisting of `listen_address` string Configuration file is a simple `key = value` storage consisting of
field in form `"[<ip|host>]:<port>"`. `indented_output` bool in form `true|false`, to `listen_address` string field in form `"[<ip|host>]:<port>"`. `indented_output`
enable indentation of JSON and XML output. And `processes` is a space separated array boolean in form `true|false`, to enable indentation of JSON and XML output.
of process names. And `processes` is a space separated array of process names.
## Installation ## Installation