1
0
Fork 0

Updated README.

This commit is contained in:
Alexander Andreev 2021-12-24 23:47:07 +04:00
parent d9087102fd
commit 82ecb23a62
Signed by: Arav
GPG Key ID: 1327FE8A374CC86F
1 changed files with 11 additions and 8 deletions

View File

@ -1,12 +1,15 @@
# httpprocwatchd
# httpprocwatchd Ver 1.2
It is a process watcher that gives processes' statuses in a JSON format via HTTP
GET request on /processes endpoint.
This utility provides a HTTP `/processes` GET endpoint that returns a list of
processes and if they are currently running or not.
A JSON object looks like this: `{ "<process name>":<true|false>, ... }`.
A list of processes could be in JSON or XML format, By default JSON being returned.
To get XML you need to provide a `Accept: application/xml` header in GET reqest.
A configuration file is in JSON format as well. There are two options:
`listen_address` is a string that looks like `"[<ip|host>]:<port>"` and an array
of process names.
A JSON object looks like this: `{ "process": true|false, ... }`.
An example configuration is stored in `config.example.json` file.
And XML `<ProcessList><Process name="process">true|false</Process>...</ProcessList>`.
Configuration file is a simple JSON object consisting of `listen_address` string field
in form `"[<ip|host>]:<port>"`. And `processes` array of process names.