A simple service watchdog, designed to be lightweight and performant.
It is now in active development and is not yet functional.
v0.1.0 will be released soon!
Hiko is designed to work in headless mode, users are highly encouraged to build their own control panel using the
provided api (building documentation) or directly access through web requests.Anyhow, an example version was provided at ./frontend directory.
Frontend control panel development plan canceled
- self-configured script execution
- provide json api and cli control
- Task System (update if needed)
- Log
- Config Reading (update if needed)
- Database (update if needed)
- JSON API (in progress)
- Documentation (in progress)
- MySQL / MariaDB
- mail account (for notification) [Optional]
Considering: Docker, native deployment
At /Config.toml (can be configured), see more details in the document.
[General]
port = 3000
task_refresh_rate = 5 # in secs
notification_refresh_rate = 30 # in secs
#log_path = ""
[Database]
url = "localhost/hiko" # <addr>/<db_name>
user = "hiko"
password = "password"
[Task]
timeout = 5000
[Mail]
smtp_username = "[email protected]"
smtp_password = "password"
smtp_server = "smtp.example.com"
smtp_port = 587
target_email = "[email protected]"
This project is licensed under the Mozilla Public License, Version 2.0. A copy of the license can be found in the LICENSE file.
Warning: The project is in active development currently and will be unstable. The APIs could be changed without prior notice.
Rebuilding Document...