miniboard-1.0.2

aceberg · Jul 10, 2023 · b84f231 · b84f231
1 parent 01462b3
commit b84f231
Show file tree

Hide file tree

Showing 6 changed files with 36 additions and 6 deletions.
diff --git a/.version b/.version
@@ -1 +1 @@
-VERSION=1.0.1
+VERSION=1.0.2
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,12 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [1.0.2] - 2023-07-10
+### Added
+- Binary user guide
+### Fixed
+- Send test notification bug
+
 ## [1.0.1] - 2023-07-09
 ### Added
 - Button to automatically create panel from Docker containers (On `Edit panels` page)

diff --git a/docs/INSTALL-BIN.md b/docs/INSTALL-BIN.md
@@ -20,4 +20,28 @@ tar xvzf miniboard-*.tar.gz
 cd miniboard
 sudo ./install.sh
 ```
+<br>
+
+# Usage
+## Systemd as user (recommended)
+Enable and start service, replace `MYUSER` with your username
+```sh
+sudo systemctl enable miniboard@MYUSER.service
+sudo systemctl start miniboard@MYUSER.service
+```
+Web GUI will be available at [http://0.0.0.0:8849](http://0.0.0.0:8849)   
+Config files are stored at `/home/MYUSER/.config/miniboard/`   
+
+
+## Systemd as root
+Enable and start service
+```sh
+sudo systemctl enable miniboard.service
+sudo systemctl start miniboard.service
+```
+Web GUI will be available at [http://0.0.0.0:8849](http://0.0.0.0:8849)   
+Config files are stored at `/etc/miniboard/`
+
+## From command line
+Just run `miniboard`. Be mindful of the config files paths listed in [options](https://github.com/aceberg/miniboard#options) section.
 
diff --git a/internal/notify/shoutrrr.go b/internal/notify/shoutrrr.go
@@ -26,7 +26,7 @@ func Notify(panelName, host, state string, uptime models.Uptime) {
 }
 
 // Test - send test notification
-func Test(urlName string, uptime models.Uptime) {
+func SendTest(urlName string, uptime models.Uptime) {
 
 	err := shoutrrr.Send(uptime.Notify[urlName], "MiniBoard: test notification")
 	log.Println("INFO: Sending test notification to", urlName)

diff --git a/internal/web/templates/uptime-edit.html b/internal/web/templates/uptime-edit.html
@@ -52,7 +52,7 @@ <h4>Notifications (<a href="https://containrrr.dev/shoutrrr/0.7/services/overvie
                         <td>{{ $name }}</td>
                         <td>{{ $value }}</td>
                         <td>
-                            <a href="/uptime_edit/?notify={{ $name }}">
+                            <a href="/uptime_edit/?testnotify={{ $name }}">
                                 <button type="submit" class="btn btn-outline-success">Test</button>
                             </a>
                         </td>

diff --git a/internal/web/uptime-edit.go b/internal/web/uptime-edit.go
@@ -23,7 +23,7 @@ func uptimeEditHandler(w http.ResponseWriter, r *http.Request) {
 	link := r.FormValue("link")
 	newpanel := r.FormValue("newpanel")
 	show := r.FormValue("show")
-	notif := r.FormValue("notify")
+	testNotify := r.FormValue("testnotify")
 
 	if enable == "yes" {
 		AllLinks.Uptime.Enabled = true
@@ -52,8 +52,8 @@ func uptimeEditHandler(w http.ResponseWriter, r *http.Request) {
 	if show != "" {
 		AllLinks.Uptime.Show, _ = strconv.Atoi(show)
 	}
-	if notif != "" {
-		notify.Test(notif, AllLinks.Uptime)
+	if testNotify != "" {
+		notify.SendTest(testNotify, AllLinks.Uptime)
 	}
 
 	guiData.Links = AllLinks