From 2a9a24e45073e1a58e2f45b8eb5dcd3e29ea43db Mon Sep 17 00:00:00 2001 From: aceberg <1502200+aceberg@users.noreply.github.com> Date: Thu, 3 Aug 2023 12:12:53 +0700 Subject: [PATCH] Release v1.0.0 --- CHANGELOG.md | 8 +++++--- README.md | 25 ++++++++++++++----------- internal/web/templates/version | 2 +- 3 files changed, 20 insertions(+), 15 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index df8187f..5b571d2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,9 +1,11 @@ # Change Log All notable changes to this project will be documented in this file. - -The format is based on [Keep a Changelog](http://keepachangelog.com/) -and this project adheres to [Semantic Versioning](http://semver.org/). + + +## [v1.0.0] - 2023-08-03 +### Changed +- Migrated to YAML config file format ## [v0.9.4] - 2023-06-26 ### Added diff --git a/README.md b/README.md index 5def160..59fdbf3 100644 --- a/README.md +++ b/README.md @@ -53,19 +53,22 @@ Configuration can be done through config file or environment variables | LOGLEVEL | How much log output you want to see ("short" or "verbose") | verbose | ## Config file +> [!WARNING] +> Config file format has been migrated to YAML in release v1.0.0. -Config file path is `/data/config`. +Config file path is `/data/config.yaml`. All variables could be set there. Example: -```sh -IFACE="enp2s0 wg0" -DBPATH="/data/hosts.db" -GUIIP="192.168.2.1" # To access from LAN -GUIPORT="8840" -TIMEOUT="300" # 5 minutes -SHOUTRRR_URL="gotify://192.168.2.1:8083/AwQqpAae.rrl5Ob/?title=Unknown host detected&DisableTLS=yes" # Url to notify -THEME="darkly" -IGNOREIP="no" -LOGLEVEL="short" +```yaml +color: light +dbpath: /data/db.sqlite +guiip: 192.168.2.1 +guiport: "8840" +iface: enp1s0 +ignoreip: "no" +loglevel: short +shoutrrr_url: gotify://192.168.2.1:8083/AwQqpAae.rrl5Ob/?title=Unknown host detected&DisableTLS=yes +theme: solar +timeout: 120 ``` ## Options diff --git a/internal/web/templates/version b/internal/web/templates/version index 9c155dc..4ff1268 100644 --- a/internal/web/templates/version +++ b/internal/web/templates/version @@ -1 +1 @@ -VERSION=0.9.4 \ No newline at end of file +VERSION=1.0.0 \ No newline at end of file