summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorShulhan <ms@kilabit.info>2022-08-19 01:36:53 +0700
committerShulhan <ms@kilabit.info>2022-08-19 01:36:53 +0700
commit6038b712e4c6aac917b7daeecfd7439d91c75223 (patch)
tree14f8c681362094c807ad110a796d0ee77e30b948
parent9b370e0e7fe8ec89bd588ae23a4223428383b814 (diff)
downloadhaminer-6038b712e4c6aac917b7daeecfd7439d91c75223.tar.xz
all: restructure the README
While at it, mention how to install it using pre-build Arch Linux package through build.kilabit.info.
-rw-r--r--README.adoc40
1 files changed, 26 insertions, 14 deletions
diff --git a/README.adoc b/README.adoc
index f542a2e..060e9f0 100644
--- a/README.adoc
+++ b/README.adoc
@@ -7,26 +7,18 @@
Library and program to parse and forward HAProxy logs.
-Supported forwarder,
+Supported forwarder: Influxdb, QuestDB.
-* Influxdb
+== Installation
-== Requirements
+=== Building from source
+
+*Requirements*
* https://golang.org[Go^] for building from source code
* https://git-scm.com/[git^] for downloading source code
-One of supported time series database for storing HAProxy log, either
-
-* https://portal.influxdata.com/downloads[InfluxDB^]
-* https://questdb.io[QuestDB^]
-
-
-== Building
-
-This steps assume that you already installed `Go` and `git`.
-
Get the source code using git,
----
@@ -38,6 +30,21 @@ $ make
The binary name is `haminer` build in the current directory.
+=== Pre-build package
+
+The Arch Linux package is available at build.kilabit.info.
+Add the following repository to your pacman.conf,
+
+----
+[build.kilabit.info]
+Server = https://build.kilabit.info/aur
+----
+
+To install it,
+
+ $ sudo pacman -Sy --noconfirm haminer-git
+
+
== Configuration
haminer by default will load it's config from `/etc/haminer.conf`, if not
@@ -109,7 +116,7 @@ url = udp://127.0.0.1:9009
We did not need to create the table, questdb will handled that automatically.
-== Installation
+== Deployment
. Copy configuration from `$SOURCE/cmd/haminer/haminer/conf` to
`/etc/haminer.conf`
@@ -150,6 +157,11 @@ $ haminer
or use a
https://git.sr.ht/~shulhan/haminer/tree/main/item/cmd/haminer/haminer.service[systemd
service^].
+
+----
+$ sudo systemctl enable haminer
+$ sudo systemctl start haminer
+----
--