1
0
httpprocprobed/README.md

46 lines
1.4 KiB
Markdown
Raw Normal View History

# httpprocprobed Ver 2.0.0
2021-03-13 03:17:30 +04:00
2022-01-02 05:15:29 +04:00
License: MIT+NIGGER.
2021-12-24 23:47:07 +04:00
This utility provides a HTTP `/processes` GET endpoint that returns a list of
2022-01-02 21:56:53 +04:00
processes, and if they are currently running or not.
2021-03-13 03:17:30 +04:00
2022-01-02 21:56:53 +04:00
There are currently three output formats available: JSON, XML, plain text.
2021-03-13 03:17:30 +04:00
JSON is a default format if `Accept` header didn't provided, or did with
2022-01-02 21:56:53 +04:00
value `application/json`. Its form is `{"process":true|false, ...}`.
2021-03-13 03:17:30 +04:00
2022-01-02 21:56:53 +04:00
XML is provided if `Accept: application/xml` header was given. Its form is
`<ProcessList><Process name="process">true|false</Process>...</ProcessList>`.
2021-12-24 23:47:07 +04:00
2022-01-02 21:56:53 +04:00
Plain text is provided if `Accept: text/plain` header was given. Its form is a
comma separated list of ONLY running process' names.
2021-12-24 23:47:07 +04:00
2022-01-02 21:56:53 +04:00
Configuration file is a simple key = value storage consisting of `listen_address` string
field in form `"[<ip|host>]:<port>"`. `indented_output` bool in form `true|false`, to
enable indentation of JSON and XML output. And `processes` is a space separated array
2022-01-03 02:22:41 +04:00
of process names.
## Installation
### Manually
Run these commands one after the other.
```console
$ make
$ make install
```
In order to uninstall run these commands:
```console
# systemctl stop httpprocprobed
# systemctl disable httpprocprobed
2022-01-03 02:22:41 +04:00
$ make uninstall
# systemctl daemon-reload
```
### For ArchLinux
You can take a [PKGBUILD](/Arav/httpprocprobed/raw/branch/master/build/archlinux/PKGBUILD) file and in a directory with it run `makepkg -i`.