From d9f6b4ccacf9193a48d48d65911ed616d1d008a0 Mon Sep 17 00:00:00 2001 From: Shizun Ge Date: Sat, 30 Oct 2021 19:52:09 -0700 Subject: [PATCH] Move image of dashboard to the top of README --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a0a3c85..942c8f0 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ A golang implementation of [endlessh](https://nullprogram.com/blog/2019/03/22/) exporting Prometheus metrics, visualized by a Grafana dashboard. +![screenshot](dashboard/screenshot.png) + ## Introduction Endlessh is a great idea that not only blocks the brute force SSH attacks, but also wastes attackers time as a kind of counter-attack. Besides trapping the attackers, I also want to visualize the Geolocations and other statistics of the sources of attacks. Unfortunately the wonderful original [C implementation of endlessh](https://github.com/skeeto/endlessh) only provides text based log, but I do not like the solution that writing extra scripts to parse the log outputs, then exporting the results to a dashboard, because it would introduce extra layers in my current setup and it would depend on the format of the text log file rather than some structured data. Thus I create this golang implementation of endlessh to export [Prometheus](https://prometheus.io/) metrics and a [Grafana](https://grafana.com/) dashboard to visualize them. @@ -33,7 +35,7 @@ ssh -p 2222 localhost If you want log like the [C implementation](https://github.com/skeeto/endlessh), you need to set both CLI arguments `-logtostderr` and `-v=1`, then the log will go to stderr. You can set different log destinations via CLI arguments. -Also check out [examples](./examples/README.md). +Also check out [examples](./examples/README.md) for the setup of the full stack. ## Usage @@ -95,8 +97,6 @@ The endlessh-go server stores the geohash of attackers as a label on `endlessh_c ## Dashboard -![screenshot](dashboard/screenshot.png) - The dashboard requires Grafana 8.2. You can import the dashboard from Grafana.com using ID [15156](https://grafana.com/grafana/dashboards/15156)