README.md

CLOSER Event Dashboard

This project is an easy-to-install web dashboard which collects and visualizes events from CLOSER webhook.

---

Components

• Nginx: HTTP and reverse proxy server
• PostgreSQL: Relational database that supports arbitrary JSON column
• Grafana: Metric analytics & monitoring tool

Prerequisites

• docker (https://docs.docker.com/installation/)
• docker-compose (https://docs.docker.com/compose/install/)

Usage

1. Clone this repository:

   $ git clone https://github.com/sini-company/closer-event-dashboard.git

2. Run docker-compose to run http server (-d: run in daemon mode)

   $ docker-compose up [-d]

3. Access dashboard via HTTP endpoints

   • GET /: Grafana dashboard (※ Initial credential: admin / admin )
   • POST /webhook-endpoint: Webhook endpoint

4. Register your webhook endpoint to the CLOSER Bot Settings > Webhook

   

5. Customize your dashboard

   • See included samples: grafana/dashboards
   • Grafana tutorial: http://docs.grafana.org/guides/getting_started/