diff --git a/README.md b/README.md
index c24b2ac5..a0d52ee2 100644
--- a/README.md
+++ b/README.md
@@ -238,6 +238,7 @@ If you want to test it locally, see [Docker](#docker).
| `ui.buttons` | List of buttons to display below the header. | `[]` |
| `ui.buttons[].name` | Text to display on the button. | Required `""` |
| `ui.buttons[].link` | Link to open when the button is clicked. | Required `""` |
+| `ui.custom-css` | Custom CSS | `""` |
| `maintenance` | [Maintenance configuration](#maintenance). | `{}` |
If you want more verbose logging, you may set the `GATUS_LOG_LEVEL` environment variable to `DEBUG`.
diff --git a/api/api.go b/api/api.go
index acaccbeb..1ac604a1 100644
--- a/api/api.go
+++ b/api/api.go
@@ -6,6 +6,7 @@ import (
"os"
"github.com/TwiN/gatus/v5/config"
+ "github.com/TwiN/gatus/v5/config/ui"
"github.com/TwiN/gatus/v5/config/web"
static "github.com/TwiN/gatus/v5/web"
"github.com/TwiN/health"
@@ -31,6 +32,10 @@ func New(cfg *config.Config) *API {
logr.Warnf("[api.New] nil web config passed as parameter. This should only happen in tests. Using default web configuration")
cfg.Web = web.GetDefaultConfig()
}
+ if cfg.UI == nil {
+ logr.Warnf("[api.New] nil ui config passed as parameter. This should only happen in tests. Using default ui configuration")
+ cfg.UI = ui.GetDefaultConfig()
+ }
api.router = api.createRouter(cfg)
return api
}
@@ -87,6 +92,8 @@ func (a *API) createRouter(cfg *config.Config) *fiber.App {
statusCode, body := healthHandler.GetResponseStatusCodeAndBody()
return c.Status(statusCode).Send(body)
})
+ // Custom CSS
+ app.Get("/css/custom.css", CustomCSSHandler{customCSS: cfg.UI.CustomCSS}.GetCustomCSS)
// Everything else falls back on static content
app.Use(redirect.New(redirect.Config{
Rules: map[string]string{
diff --git a/api/api_test.go b/api/api_test.go
index c8fdcd70..713f6b7d 100644
--- a/api/api_test.go
+++ b/api/api_test.go
@@ -25,6 +25,17 @@ func TestNew(t *testing.T) {
Path: "/health",
ExpectedCode: fiber.StatusOK,
},
+ {
+ Name: "custom.css",
+ Path: "/css/custom.css",
+ ExpectedCode: fiber.StatusOK,
+ },
+ {
+ Name: "custom.css-gzipped",
+ Path: "/css/custom.css",
+ ExpectedCode: fiber.StatusOK,
+ Gzip: true,
+ },
{
Name: "metrics",
Path: "/metrics",
diff --git a/api/custom_css.go b/api/custom_css.go
new file mode 100644
index 00000000..79229435
--- /dev/null
+++ b/api/custom_css.go
@@ -0,0 +1,14 @@
+package api
+
+import (
+ "github.com/gofiber/fiber/v2"
+)
+
+type CustomCSSHandler struct {
+ customCSS string
+}
+
+func (handler CustomCSSHandler) GetCustomCSS(c *fiber.Ctx) error {
+ c.Set("Content-Type", "text/css")
+ return c.Status(200).SendString(handler.customCSS)
+}
diff --git a/config/ui/ui.go b/config/ui/ui.go
index e61440af..c735c313 100644
--- a/config/ui/ui.go
+++ b/config/ui/ui.go
@@ -14,6 +14,7 @@ const (
defaultHeader = "Health Status"
defaultLogo = ""
defaultLink = ""
+ defaultCustomCSS = ""
)
var (
@@ -28,6 +29,7 @@ type Config struct {
Logo string `yaml:"logo,omitempty"` // Logo to display on the page
Link string `yaml:"link,omitempty"` // Link to open when clicking on the logo
Buttons []Button `yaml:"buttons,omitempty"` // Buttons to display below the header
+ CustomCSS string `yaml:"custom-css,omitempty"` // Custom CSS to include in the page
}
// Button is the configuration for a button on the UI
@@ -52,6 +54,7 @@ func GetDefaultConfig() *Config {
Header: defaultHeader,
Logo: defaultLogo,
Link: defaultLink,
+ CustomCSS: defaultCustomCSS,
}
}
@@ -66,8 +69,14 @@ func (cfg *Config) ValidateAndSetDefaults() error {
if len(cfg.Header) == 0 {
cfg.Header = defaultHeader
}
- if len(cfg.Header) == 0 {
- cfg.Header = defaultLink
+ if len(cfg.Logo) == 0 {
+ cfg.Logo = defaultLogo
+ }
+ if len(cfg.Link) == 0 {
+ cfg.Link = defaultLink
+ }
+ if len(cfg.CustomCSS) == 0 {
+ cfg.CustomCSS = defaultCustomCSS
}
for _, btn := range cfg.Buttons {
if err := btn.Validate(); err != nil {
@@ -80,9 +89,5 @@ func (cfg *Config) ValidateAndSetDefaults() error {
return err
}
var buffer bytes.Buffer
- err = t.Execute(&buffer, cfg)
- if err != nil {
- return err
- }
- return nil
+ return t.Execute(&buffer, cfg)
}
diff --git a/web/app/public/index.html b/web/app/public/index.html
index 5d161303..8c5e0ba1 100644
--- a/web/app/public/index.html
+++ b/web/app/public/index.html
@@ -13,6 +13,7 @@
+
diff --git a/web/static/index.html b/web/static/index.html
index 53eb80fc..1eaca839 100644
--- a/web/static/index.html
+++ b/web/static/index.html
@@ -1 +1 @@
-{{ .Title }}
+{{ .Title }}
\ No newline at end of file