Merge pull request #102 from soulteary/feat-webui

[Feat] Built-in management interface

Author: looterz

.github/workflows/test.yml

@@ -19,6 +19,9 @@ jobs:
       with:
         go-version: 1.18
 
+    - name: Prepare Submodule
+      run: git submodule update --init
+
     - name: Build
       run: go build -v ./...
 

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "dashboard/reaper"]
+	path = dashboard/reaper
+	url = https://github.com/looterz/reaper.git

README.md

@@ -29,7 +29,7 @@ docker-compose up -d
 If ```grimd.toml``` is not found, it will be generated for you, below is the default configuration.
 ```toml
 # version this config was generated from
-version = "1.0.8"
+version = "1.0.9"
 
 # list of sources to pull blocklists from, stores them in ./sources
 sources = [
@@ -58,6 +58,9 @@ logconfig = "file:grimd.log@2,stderr@2"
 # apidebug enables the debug mode of the http api library
 apidebug = false
 
+# enable the web interface by default
+dashboard = true
+
 # address to bind to for the DNS server
 bind = "0.0.0.0:53"
 
@@ -144,6 +147,13 @@ curl -H "Accept: application/json" http://127.0.0.1:55006/application/active
 # Web API
 A restful json api is exposed by default on the local interface, allowing you to build web applications that visualize requests, blocks and the cache. [reaper](https://github.com/looterz/reaper) is the default grimd web frontend.
 
+
+If you want to enable the default dashboard, make sure the configuration file contains the following:
+
+```toml
+dashboard = true
+```
+
 ![reaper-example](http://i.imgur.com/oXLtqSz.png)
 
 # Speed

api.go

@@ -2,6 +2,8 @@ package main
 
 import (
 	"bufio"
+	"embed"
+	"io/fs"
 	"net"
 	"net/http"
 	"os"
@@ -13,6 +15,9 @@ import (
 	"gopkg.in/gin-contrib/cors.v1"
 )
 
+//go:embed dashboard/reaper
+var dashboardAssets embed.FS
+
 func isRunningInDockerContainer() bool {
 	// slightly modified from blog: https://paulbradley.org/indocker/
 	// docker creates a .dockerenv file at the root
@@ -53,6 +58,17 @@ func StartAPIServer(config *Config,
 
 	router.Use(cors.Default())
 
+	// Serves only if the user configuration enables the dashboard
+	if config.Dashboard {
+		router.GET("/", func(c *gin.Context) {
+			c.Redirect(http.StatusTemporaryRedirect, "/dashboard")
+			c.Abort()
+		})
+
+		dashboardAssets, _ := fs.Sub(dashboardAssets, "dashboard/reaper")
+		router.StaticFS("/dashboard", http.FS(dashboardAssets))
+	}
+
 	router.GET("/blockcache", func(c *gin.Context) {
 		special := make([]string, 0, len(blockCache.Special))
 		for k := range blockCache.Special {

config.go

@@ -16,7 +16,7 @@ import (
 var BuildVersion = "1.0.7"
 
 // ConfigVersion returns the version of grimd, this should be incremented every time the config changes so grimd presents a warning
-var ConfigVersion = "1.0.8"
+var ConfigVersion = "1.0.9"
 
 // Config holds the configuration parameters
 type Config struct {
@@ -41,6 +41,7 @@ type Config struct {
 	CustomDNSRecords  []string
 	ToggleName        string
 	ReactivationDelay uint
+	Dashboard         bool
 	APIDebug          bool
 	DoH               string
 	UseDrbl           int
@@ -80,6 +81,9 @@ logconfig = "file:grimd.log@2,stderr@2"
 # apidebug enables the debug mode of the http api library
 apidebug = false
 
+# enable the web interface by default
+dashboard = true
+
 # address to bind to for the DNS server
 bind = "0.0.0.0:53"
 

dashboard/reaper

@@ -2,9 +2,10 @@ FROM alpine:3.15.0 as certs
 RUN apk --update add ca-certificates
 
 FROM golang:1.18.0-alpine3.15 AS builder
-RUN apk add git bash gcc musl-dev upx
+RUN apk add git bash gcc musl-dev upx git
 WORKDIR /app
 COPY . .
+RUN git submodule update --init
 RUN go mod tidy
 RUN go test -v ./...
 ENV CGO_ENABLED=0