mirror of https://github.com/Luzifer/mondash.git synced 2024-11-09 16:10:01 +00:00

Public dashboard service without hazzle

Find a file

Knut Ahlers 72d90f5fbe Added check for configuration		2015-07-06 23:23:07 +02:00
config	Added check for configuration	2015-07-06 23:23:07 +02:00
docker	Replaced URL to use apex	2015-03-12 23:53:33 +01:00
Godeps	Refreshed Godeps	2015-07-06 21:44:45 +02:00
storage	Added support for local file storage	2015-07-06 22:08:56 +02:00
templates	Added abbreviation to MAD	2015-07-06 23:06:11 +02:00
.artifact_files	Added artifact support for gobuild.luzifer.io	2015-02-07 20:03:39 +01:00
.gitignore	Fix: New dashboards were not storable	2015-07-06 23:07:04 +02:00
apiary.apib	Added "value" parameter to API documentation and welcome runner	2015-07-06 20:35:51 +02:00
History.md	Prepared release 1.3.0	2015-07-06 20:32:27 +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	Write access-log	2015-07-06 22:49:05 +02:00
README.md	Updated README	2015-07-06 23:15:13 +02:00
strings.go	Initial version	2015-02-07 19:32:44 +01:00
structs.go	LINT: Documented source code	2015-07-06 21:44:13 +02:00
web_handlers.go	Fix: New dashboards were not storable	2015-07-06 23:07:04 +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)

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>

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.

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.