From 4680df5d3bca90fe847dbb1eccec667720ddd5d6 Mon Sep 17 00:00:00 2001 From: Issif Date: Thu, 11 Feb 2021 20:03:31 +0100 Subject: [PATCH] update readme with badges and details Signed-off-by: Issif --- README.md | 31 ++++++++++++++++++++++++++----- 1 file changed, 26 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index e11edce..0f9fa23 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,18 @@ # Falcosidekick-ui -![falcosidekick-ui](https://github.com/falcosecurity/falcosidekick-ui/raw/master/imgs/webui_01.png) +![release](https://flat.badgen.net/github/release/falcosecurity/falcosidekick-ui/latest?color=green) ![last commit](https://flat.badgen.net/github/last-commit/falcosecurity/falcosidekick-ui) ![licence](https://flat.badgen.net/badge/license/Apache/blue) ![docker pulls](https://flat.badgen.net/docker/pulls/falcosecurity/falcosidekick-ui?icon=docker) [![falcosidekick-ui](https://circleci.com/gh/falcosecurity/falcosidekick-ui.svg?style=shield)](https://circleci.com/gh/falcosecurity/falcosidekick-ui) -*Disclaimer: This project is a WIP* +![falcosidekick-ui](https://github.com/falcosecurity/falcosidekick-ui/raw/master/imgs/webui_01.png) ## Description A simple WebUI for displaying latest events from [Falco](https://falco.org). It works as output for [Falcosidekick](https://github.com/falcosecurity/falcosidekick). -## Endpoints - -The UI is reachable at `http://localhost:2802/ui`. ## Usage +### Options + ```shell -a string Listen Address (default "0.0.0.0") @@ -23,6 +22,28 @@ The UI is reachable at `http://localhost:2802/ui`. Number of events to keep in retention (default 50) ``` +### Run with docker + +```shell +docker run -d falcosecurity/falcosidekick-ui -p 2802:2802 +``` + +### Run + +``` +git clone https://github.com/falcosecurity/falcosidekick-ui.git +cd ./falcosidekick-ui + +go run main.go +#or +make falcosidekick-ui && ./falcosidekick-ui + +``` + +### Endpoint + +The UI is reachable by default at `http://localhost:2802/ui`. + ## Development ### Build