Release 1.0.0

aceberg · Jul 8, 2023 · 3ffab62 · 3ffab62
1 parent 280f9e1
commit 3ffab62
Show file tree

Hide file tree

Showing 5 changed files with 55 additions and 4 deletions.
diff --git a/.version b/.version
@@ -1 +1 @@
-VERSION=0.2.1
+VERSION=1.0.0
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,20 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [1.0.0] - 2023-07-08
+### Added
+- Uptime monitoring
+- Timeout for each panel
+- GUI config page for Uptime
+- Web page refresh interval
+- Notifications to services, supported by [Shoutrrr](https://containrrr.dev/shoutrrr/0.7/services/overview/)
+
+### Fixed
+- Error: concurrent map writes
+
+### Changed
+- Code refactoring
+
 ## [0.2.1] - 2023-06-28
 ### Added
 - Binary and Deb release

diff --git a/README.md b/README.md
@@ -6,10 +6,11 @@
 <h1><a href="https://github.com/aceberg/miniboard">
     <img src="https://raw.githubusercontent.com/aceberg/miniboard/main/assets/logo.png" width="20" />
 </a>miniboard</h1>
-<br/>
-Lightweight Dashboard with Tabs and online status check. Can be configured through GUI or yaml file.     
+Lightweight dashboard with tabs, uptime monitoring and notifications.<br>
+Can be configured through GUI or yaml file.     
 
 - [Quick start](https://github.com/aceberg/miniboard#quick-start)
+- [Install binary](docs/INSTALL-BIN.md)
 - [Usage](https://github.com/aceberg/miniboard#usage)
 - [Config](https://github.com/aceberg/miniboard#config)
 - [Options](https://github.com/aceberg/miniboard#options)
@@ -30,7 +31,8 @@ docker run --name miniboard \
 -p 8849:8849 \
 aceberg/miniboard
 ```
-Or use [docker-compose.yml](docker-compose.yml)
+Or use [docker-compose.yml](docker-compose.yml)   
+There is also [binary installation](docs/INSTALL-BIN.md) available.
 
 
 ## Usage
@@ -51,6 +53,7 @@ Configuration can be done through config file or environment variables
 | COLORON | Online host color | #89ff89 |
 | COLOROFF | Offline host color | #ff3232 |
 | BTNWIDTH | Adjust buttons to theme | 180px |
+| WEBREFRESH | Refresh interval for Tabs and Uptime pages (seconds) | 60 |
 
 ## Options
 | Key  | Description | Default | 

diff --git a/configs/board.yaml b/configs/board.yaml
@@ -12,6 +12,7 @@ panels:
     Panel2:   # Panel ID (string) must be the same as Panel Name
         name: Panel2    # Panel Name (string) must be the same as Panel ID
         scan: false     # Check if hosts of this panel are online (true or false)
+        timeout: "5"    # Minutes between scans (Default: 1)
         hosts:
             0:  # Host ID (integer), use them to sort hosts on Panel
                 name: /r/selfhosted     # Host Name (string)
@@ -35,3 +36,13 @@ panels:
                 port: ""
                 url: https://duckduckgo.com/
                 icon: ""
+uptime:
+    enabled: true   # Enable uptime monitoring
+    show: 30        # Lines to show on Uptime page (Default: 20)
+    notify:         # URLs to notify (See Shoutrrr docs: https://containrrr.dev/shoutrrr/0.7/services/overview/)
+        gotify: gotify://192.168.2.2:8083/A2MD-k4uzC8-zuA/?title=Host status changed&DisableTLS=yes # Gotify example
+    panels:     # Monitored panels
+        Panel2:         # Panel name
+            retries: 3  # Retries before notification is send
+            notify:     # Which services to notify
+                - gotify
diff --git a/docs/INSTALL-BIN.md b/docs/INSTALL-BIN.md
@@ -0,0 +1,23 @@
+# Install binary
+
+## From .deb repository (recommended)
+```sh
+curl -s --compressed "https://aceberg.github.io/ppa/KEY.gpg" | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/aceberg.gpg
+```
+```sh
+sudo curl -s --compressed -o /etc/apt/sources.list.d/aceberg.list "https://aceberg.github.io/ppa/aceberg.list"
+```
+```sh
+sudo apt update && sudo apt install miniboard
+```
+## From .deb file
+Download [latest](https://github.com/aceberg/miniboard/releases/latest) release, install with your package maneger
+
+## From .tar.gz
+Download [latest](https://github.com/aceberg/miniboard/releases/latest) release, then
+```sh
+tar xvzf miniboard-*.tar.gz
+cd miniboard
+sudo ./install.sh
+```
+