summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorShulhan <ms@kilabit.info>2025-12-29 15:48:47 +0700
committerShulhan <ms@kilabit.info>2025-12-29 15:48:47 +0700
commitdf9ab9327a6fa88ebb3880214b3194a28377a3ce (patch)
treeff4baab6b45d5d621ff6713f5ed234dd818af78f /README.md
parent76df394598f5953a2cba14ca0f95c4d9e52e9469 (diff)
downloadhaminer-df9ab9327a6fa88ebb3880214b3194a28377a3ce.tar.xz
Release haminer v0.3.0 (2025-12-29)v0.3.0
**💧 Group documentation into _doc/ directory**. This is so we can serve the documentation under https://kilabit.info/project/haminer. In the Makefile, we add task `serve-doc` to preview the documentation. **💧 Replace module "share" with "pakakeh.go"** The "share" module has been renamed to "pakakeh.go" and moved to different git repository. **💧 Realign struct HttpLog and questdbClient** The HttpLog realign from 304 to 288 bytes. The questdbClient realign from 56 to 24 bytes. **🪵 Comply with all linters recommendations** Some of breaking changes, * Field [Config.HttpUrl] renamed to [Config.HTTPURL] * Field [ConfigForwarder.Url] renamed to [ConfigForwarder.URL] * Struct [HttpLog] renamed to [HTTPLog] **💧 _ops/haminer-test: setup container for development using mkosi** The container run HAProxy and PostgreSQL servers. We also create new dummy backend to test backend in HAProxy. The haminer-dummy-backend run in container and serve two ports in HTTP and TCP modes. **🌱 all: implement forwarder for Postgresql** The Postgresql forwarder accept single option "URL", [forwarder "postgresql"] url = postgres://<user>:<pass>@<host>/<database>?sslmode=<> The user and database must already created first, manually. **🌼 Do not log ServerName with invalid connection '<NOSRV>'** **🌼 _AUR: fix installation of binary in package function** **Add linter gocheck** Program gocheck implement go static analysis using [Analyzer] that are not included in the default go vet. See package [lib/goanalysis] for more information. [Analyzer]: https://pkg.go.dev/golang.org/x/tools/go/analysis#hdr-Analyzer + [lib/goanalysis]: https://pkg.go.dev/git.sr.ht/~shulhan/pakakeh.go/lib/goanalysis/
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 5 insertions, 11 deletions
diff --git a/README.md b/README.md
index 7a27fa7..1990831 100644
--- a/README.md
+++ b/README.md
@@ -75,7 +75,6 @@ $ make
The binary name is `haminer` build in the current directory.
-
### Pre-build package
The Arch Linux package is available at build.kilabit.info.
@@ -88,8 +87,7 @@ Server = https://build.kilabit.info/aur
To install it,
- $ sudo pacman -Sy --noconfirm haminer-git
-
+ $ sudo pacman -Sy --noconfirm haminer-git
## Configuration
@@ -100,11 +98,10 @@ See
[haminer.conf](https://git.sr.ht/~shulhan/haminer/tree/main/item/cmd/haminer/haminer.conf)
for an example of possible configuration and their explanation.
-
### Forwarders
Currently, there are several database where haminer can forward the parsed
-log: Influxdb, Questdb, and Postgresql.
+log: Influxdb, Questdb, and Postgresql.
Haminer support Influxdb v1 and v2.
#### Influxdb v1
@@ -179,7 +176,6 @@ The configuration only need the Data Source Name (DSN),
url = postgres://<user>:<pass>@<host>/<database>?sslmode=<require|verify-full|verify-ca|disable>
```
-
## Deployment
Copy configuration from `$SOURCE/cmd/haminer/haminer/conf` to
@@ -223,8 +219,7 @@ $ sudo systemctl enable haminer
$ sudo systemctl start haminer
```
-
-## Development
+## Development
<https://git.sr.ht/~shulhan/haminer>:: Link to the source code.
@@ -237,8 +232,7 @@ feedback, or request for new feature.
[Changelog](https://kilabit.info/project/haminer/CHANGELOG.html):: History
of each release.
-
-## License
+## License
Copyright (C) 2018-2025 M. Shulhan &lt;ms@kilabit.info&gt;
@@ -248,7 +242,7 @@ Foundation, either version 3 of the License, or any later version.
This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
details.
You should have received a copy of the GNU General Public License along with