luzifer/mondash
1
0
Fork 0
mirror of https://github.com/Luzifer/mondash.git synced 2024-09-19 17:02:58 +00:00
Code Issues Releases Wiki Activity
Public dashboard service without hazzle
77 Commits 14 Branches 33 Tags 19 MiB
Go 99.1%
Vue 0.5%
API Blueprint 0.2%
fd7056f82f
Go to file
Knut Ahlers fd7056f82f
Switch to dep for vendoring, update libraries 
Signed-off-by: Knut Ahlers <knut@ahlers.me>
2017-11-22 21:39:52 +01:00
client Fix: Use type Status instead of string 2016-09-06 18:51:00 +02:00
config Use rconfig package for CLI argument parsing 2016-03-27 18:29:47 +02:00
filters Fix: Do not try to load negative slice bounds 2016-01-23 13:22:33 +01:00
storage Fix: Was not storing data 2015-07-07 01:01:14 +02:00
templates Allow hiding of MAD by flag 2016-03-27 21:19:05 +02:00
vendor Switch to dep for vendoring, update libraries 2017-11-22 21:39:52 +01:00
.artifact_files Added artifact support for gobuild.luzifer.io 2015-02-07 20:03:39 +01:00
.gitignore Fixed docker build 2016-01-23 13:22:33 +01:00
apiary.apib Allow hiding of MAD by flag 2016-03-27 21:19:05 +02:00
Dockerfile Use golang:alpine (go1.6) for container 2016-03-27 18:02:14 +02:00
Gopkg.lock Switch to dep for vendoring, update libraries 2017-11-22 21:39:52 +01:00
Gopkg.toml Switch to dep for vendoring, update libraries 2017-11-22 21:39:52 +01:00
History.md prepare release v1.8.1 2016-09-06 19:09:41 +02:00
LICENSE Added license file 2015-05-25 20:29:52 +02:00
logResponseWriter.go Write access-log 2015-07-06 22:49:05 +02:00
main.go Added JSON version of dashboard 2016-03-27 23:02:29 +02:00
README.md Fixed docker build 2016-01-23 13:22:33 +01:00
strings.go Initial version 2015-02-07 19:32:44 +01:00
structs.go Added JSON version of dashboard 2016-03-27 23:02:29 +02:00
web_handlers.go Added JSON version of dashboard 2016-03-27 23:02:29 +02:00
welcome_runner.go Fix: Do not try to continue if error ocurred 2015-07-06 22:32:25 +02:00

README.md

Luzifer / mondash

MonDash is a service for everyone having to display monitoring results to people who have not the time or knowledge to get familar with Nagios / Icinga or similar monitoring systems. Therefore MonDash provides a simple API to submit monitoring results and a simple dashboard to view those results.

Hosted

There is an instance of MonDash running on mondash.org you can use for free. This means you can just head over there, create your own dashboard with one click and start to push your own metrics to your dashboard within 5 minutes. No registration, no fees, just your dashboard and you.

Installation

However maybe you want to use MonDash for data you don't like to have public visible on the internet. As it is open source you also can host your own instance: The most simple way to install your own instance is to download a binary distribution on gobuild.luzifer.io.

This archive will contain the binary you need to run your own instance and the template used for the display. If you want just edit the template, restart the daemon and you're done customizing MonDash. If you do so please do me one small favor: Include a hint to this repository / my instance.

To start MonDash you will need to make sure you configured your instance correctly:

# mondash -h
Usage of mondash:
      --api-token="": API Token used for the /welcome dashboard (you can choose your own)
      --baseurl="": The Base-URL the application is running on for example https://mondash.org
      --fileDirectory="./": Directory to use for plain text storage
      --listen=":3000": Address to listen on
      --s3Bucket="": Bucket to use for S3 storage
      --storage="s3": Storage engine to use (s3, file)
  1. If you want to store the data in S3:
  • Set AWS environment variables (AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_DEFAULT_REGION)
  • Specify --storage=s3 and --s3Bucket=<yourbucket>
  1. If you want to store the data in local file system:
  • Ensure the data directory is writable
  • Specify --storage=file and --fileDirectory=<yourdirectory>

In all cases you need to specify --api-token with a token containing more than 10 characters and --baseurl with the base-URL of your instance.

Docker

To launch it, just replace the variables in following command and start the container:

docker run \
         -e AWS_ACCESS_KEY_ID=myaccesskeyid \
         -e AWS_SECRET_ACCESS_KEY=mysecretaccesskey \
         -e S3Bucket=mybucketname \
         -e BASE_URL=http://mondash.org \
         -e API_TOKEN=yourownrandomtoken \
         -p 80:3000 \
         luzifer/mondash

Security

Just some words regarding security: MonDash was designed to be an open platform for creating dashboards without any hazzle. You just open a dashboard, send some data to it and you're already done. No need to think about OAuth or other authentication mechanisms.

The downpath of that concept is of course everyone can access every dashboard and see every data placed on it. So please don't use the public instances for private and/or secret data. You can just set up your own instance within 5 minutes (okay maybe 10 minutes if you want to do it right) and you can ensure that this instance is hidden from the internet.