diff --git a/docs/10_Introduction.md b/docs/10_Introduction.md index c7192b0356901838530053e8a43e97daa605c705..ddbcb3ca0ff2be96eaf651bc1f3b2491ba207892 100644 --- a/docs/10_Introduction.md +++ b/docs/10_Introduction.md @@ -8,14 +8,23 @@ All our web projects running with PHP were simple to integrate. But what about a This project was initiated to create a compiled client from PHP sources that can be configured with an ini file to perform needed checks. Such a binary is independent from any programming language. -### Requirements +### The result -#### For usage of the client +A single binary without dependencies can be put on a Linux target host. +It can perform all checks that the current Appmonitor client as Php client can execute. + +With command line parameter `--ini=<INIFILE>` it processes the checks that are defined there. + + + +## Requirements + +### For usage of the client * A binary for your platform must be available for download or must be built. Linux x86_64 is the 1st target platform -* no other requirements +* no other requirements/ dependencies -#### To built a new binary +### To built a new binary * git * wget diff --git a/docs/20_Installation.md b/docs/20_Installation.md index 321a7af64e4e11708738d16d2878898bf1f5d804..26c45c1b218b4ac84127cdc31d583731ff909728 100644 --- a/docs/20_Installation.md +++ b/docs/20_Installation.md @@ -1,6 +1,6 @@ ## Installation -TODO +TODO: there is no uploaded binary yet. You need a local copy of the compiled single binary. diff --git a/docs/30_Usage.md b/docs/30_Usage.md index b3ced142c9eafa7cab3d3560050c7fb6d2d14d05..9fa5cfdfc9e2acf89a3534f68503f73ad2e55be6 100644 --- a/docs/30_Usage.md +++ b/docs/30_Usage.md @@ -2,7 +2,7 @@ ```text ./src/amcli -h -IML Appmonitor as CLI client 0.1 +IML Appmonitor as CLI client 0.2 This client performs appmonitor checks and puts the results as JSON to stdout. You can use the compiled binary on non PHP systems. @@ -108,7 +108,7 @@ The binary uses the php function `parse_ini_file` - see <https://www.php.net/man * a string with letters, digits, underscore * Use multiple `<VARNAME>[]` to create an an array with list items - * `<VARNAME>[<KEY>]` is unused so far + * `<VARNAME>[<KEY>]` is used for slack notifications and one of the possible options for [check] -> params * **values** diff --git a/docs/images/screesnhot_test_php_modules.png b/docs/images/screesnhot_test_php_modules.png new file mode 100644 index 0000000000000000000000000000000000000000..dc9d132452e4f37f12f328c57396de4d3de9fe1d Binary files /dev/null and b/docs/images/screesnhot_test_php_modules.png differ diff --git a/readme.md b/readme.md index 7fddf1345f3644db2fcc1a9b1775e8aa12101c2d..9eb11c329159638daceea49e2cd71e32b30e2ae2 100644 --- a/readme.md +++ b/readme.md @@ -2,67 +2,13 @@ 💡 **Idea**: For non PHP systems we prepare a compiled binary containing all written PHP checks. Then those non PHP systems do not need to implement the checks again. -## Requirements +👤 Author: Axel Hahn; Institute for Medical Education; University of Bern \ +📄 Source: <https://git-repo.iml.unibe.ch/iml-open-source/appmonitor-cli-client> \ +📜 License: GNU GPL 3.0 \ +📗 Docs: <https://os-docs.iml.unibe.ch/appmonitor-cli-client/> -* wget -* git -* PHP 8 cli (no webserver needed) +## Screenshots -## Installation - -How to bring up this project to live: - -Clone this repository. - -You get this initial structure: - -```txt -. -├── build.php -├── inc_functions.php -├── inc_vars.php -├── installer.php -├── readme.md -└── src - └── amcli.php -``` - -Run the `./installer.php` to download spc and prepare the micro build. - -The newly created dirs: - -```txt -. -├── build << working directory for builds -│ -├── external -│ ├── appmonitor << cloned IML appmonitor project -│ └── bin -│ └── spc << downloaded spc binary -: -``` - -## Update - -Run the installer again. - -if you want to install a newer version of spc: remove the external/bin/ directory and run the installer again. - -## Start over - -Remove the dirs - -- built_packages -- build -- external - -And this file - -- src/include_checks.php - -Then start `./installer.php` and `./build.php` - -## Compile - -To compile `src/amcli.php`to `built_packages/amcli` start the `./build.php` +The binary has parameter support. It parses an ini file that containes metadata and all checks. + \ No newline at end of file