added README.md
This commit is contained in:
parent
873cfd64ed
commit
ac4f9c7990
77
README.md
Normal file
77
README.md
Normal file
@ -0,0 +1,77 @@
|
||||
# zabbixlaunch
|
||||
|
||||
## Summary
|
||||
|
||||
zabbixlaunch is a application that take control over a launchpad mini, and draw problems handled by Zabbix
|
||||
|
||||
|
||||
## Howto
|
||||
|
||||
### Sample config in config.json
|
||||
|
||||
```json
|
||||
{
|
||||
"server": "https://zabbix.acme.com/api_jsonrpc.php",
|
||||
"username": "bob",
|
||||
"password": "password",
|
||||
"authtoken": "token",
|
||||
"limit": 20
|
||||
}
|
||||
```
|
||||
|
||||
### Dev Run
|
||||
|
||||
```
|
||||
cargo run
|
||||
```
|
||||
|
||||
### Build
|
||||
|
||||
```bash
|
||||
cargo build --release
|
||||
```
|
||||
|
||||
### Prod Run
|
||||
|
||||
```bash
|
||||
./zabbixlaunch -c config.json
|
||||
```
|
||||
|
||||
|
||||
## TODO
|
||||
|
||||
* Implement a web interface
|
||||
* Group problems by criteria
|
||||
* Implement inputs
|
||||
|
||||
|
||||
## License
|
||||
|
||||
```text
|
||||
Copyright (c) 2021 PaulBSD
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are met:
|
||||
|
||||
1. Redistributions of source code must retain the above copyright notice, this
|
||||
list of conditions and the following disclaimer.
|
||||
2. Redistributions in binary form must reproduce the above copyright notice,
|
||||
this list of conditions and the following disclaimer in the documentation
|
||||
and/or other materials provided with the distribution.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
||||
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
||||
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
|
||||
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
||||
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
||||
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
||||
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
||||
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
The views and conclusions contained in the software and documentation are those
|
||||
of the authors and should not be interpreted as representing official policies,
|
||||
either expressed or implied, of this project.
|
||||
```
|
Loading…
Reference in New Issue
Block a user