the_hub

Version, currently master branch1 version
  • master branchlatestMar 28, 2020

github.com/cyberarm/the_hub

Yet a another Dashboard thingy, written in Crystal.

0 stars
0 dependents
License: MIT

Installation

# Add this to your shard.yml
dependencies:
  the_hub:
    github: cyberarm/the_hub
    branch: master

master is a branch, not a release, so this tracks it rather than pinning a version.

Then run:

shards install

shard.yml

Crystal
0.33.0
License
MIT
Author
Cyberarm
Target
  • the_hub from src/the_hub.cr

Dependencies

Runtime Dependencies

  • sass~> 0.5.0github: straight-shoota/sass.cr
  • kemal~> 0.26.1github: kemalcr/kemal
  • slang~> 1.7.0github: jeromegn/slang
  • halite~> 0.10.4github: icyleaf/halite
  • mcping*github: Syfaro/mcping
  • granite~> 0.19.0github: amberframework/granite
  • micrate~> 0.6.0github: amberframework/micrate
  • sqlite3~> 0.15.0github: crystal-lang/crystal-sqlite3
  • hardware*github: crystal-community/hardware

README

The Hub

Note: The Hub is still in active development and isn't ready for production use yet.

A dashboard for monitoring the host system, web servers, game servers, and sensors/iot/services.

Supported Monitors:

  1. System (Monitor host system cpu/network load/memory)
  2. HTTP(S) Servers
  3. Command & Conquer: Renegade (GameSpy Query)
  4. Minecraft
  5. Minetest (Only able to detect if server is responsive)
  6. Sensors/IoT/Services (Which report into the Hub)

Installation

  1. Have a Linux/Unix system
  2. Install crystal
  3. Install libsass and dnsutils
  4. Run shards install
  • dnsuntils is required for the dig command to be available to HubDNS::SRV for Minecraft monitor.

Usage

  1. Run crystal src/the_hub.cr
  2. On first run the database will be created and you'll be asked to enter credentials to create the Administrator account

Development

TODO: Write development instructions here

API

TODO: Write API docs here

Contributing

  1. Fork it (https://github.com/cyberarm/the_hub/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Code of Conduct

"Matz is nice so we are nice."

Contributors

  • Cyberarm Cyberarm - creator, maintainer