docs: add project description, installation steps, and todo list to README

Browse Source
This commit is contained in:
retoor 2024-11-27 14:38:07 +00:00
parent ecc98142bf
commit d88961c906
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md Normal file
View File

@ -0,0 +1,13 @@
# Zhurnal
Application for running and monitoring multiple applications.
The monitoring goes trough web.
The web interface will show life updates of stdout and stderr of configured applications.
## Instalation
1. Run `make`. This will build envionment and will install the application.
2. Run Zhurnal with the commands as parameters followed by the host / port to serve on. `./.venv/bin/zhurnal "ping google.nl" "ping google.nl" --host=127.0.0.1 --port=8081`
## Todo
1. Optional Basic Auth configurable trough command line.
2. Process filtering in web interface by pressing a digit. Escape to show all processes.