Make monitor configurable for #44

config/config.go

@@ -33,13 +33,15 @@ type POP3Config struct {
 
 // WebConfig contains the HTTP server configuration
 type WebConfig struct {
-	IP4address    net.IP
+	IP4address     net.IP
-	IP4port       int
+	IP4port        int
-	TemplateDir   string
+	TemplateDir    string
-	TemplateCache bool
+	TemplateCache  bool
-	PublicDir     string
+	PublicDir      string
-	GreetingFile  string
+	GreetingFile   string
-	CookieAuthKey string
+	CookieAuthKey  string
+	MonitorVisible bool
+	MonitorHistory int
 }
 
 // DataStoreConfig contains the mail store configuration
@@ -130,6 +132,8 @@ func LoadConfig(filename string) error {
 	requireOption(messages, "web", "template.dir")
 	requireOption(messages, "web", "template.cache")
 	requireOption(messages, "web", "public.dir")
+	requireOption(messages, "web", "monitor.visible")
+	requireOption(messages, "web", "monitor.history")
 	requireOption(messages, "datastore", "path")
 	requireOption(messages, "datastore", "retention.minutes")
 	requireOption(messages, "datastore", "retention.sleep.millis")
@@ -349,6 +353,19 @@ func parseWebConfig() error {
 	}
 	webConfig.GreetingFile = str
 
+	option = "monitor.visible"
+	flag, err = Config.Bool(section, option)
+	if err != nil {
+		return fmt.Errorf("Failed to parse [%v]%v: '%v'", section, option, err)
+	}
+	webConfig.MonitorVisible = flag
+
+	option = "monitor.history"
+	webConfig.MonitorHistory, err = Config.Int(section, option)
+	if err != nil {
+		return fmt.Errorf("Failed to parse [%v]%v: '%v'", section, option, err)
+	}
+
 	option = "cookie.auth.key"
 	if Config.HasOption(section, option) {
 		str, err = Config.String(section, option)

etc/devel.conf

@@ -91,6 +91,18 @@ greeting.file=%(install.dir)s/themes/greeting.html
 # and previous sessions will be invalidated.
 cookie.auth.key=secret-inbucket-session-cookie-key
 
+# Enable or disable the live message monitor tab for the web UI. This will let
+# anybody see all messages delivered to Inbucket.  This setting has no impact
+# on the availability of the underlying WebSocket.
+monitor.visible=true
+
+# How many historical message headers should be cached for display by new
+# monitor connections.  It does not limit the number of messages displayed by
+# the browser once the monitor is open; all freshly received messages will be
+# appended to the on screen list.  This setting also affects the underlying
+# API/WebSocket.
+monitor.history=30
+
 #############################################################################
 [datastore]
 

etc/docker/defaults/inbucket.conf

@@ -93,6 +93,18 @@ greeting.file=/con/configuration/greeting.html
 # and previous sessions will be invalidated.
 #cookie.auth.key=secret-inbucket-session-cookie-key
 
+# Enable or disable the live message monitor tab for the web UI. This will let
+# anybody see all messages delivered to Inbucket.  This setting has no impact
+# on the availability of the underlying WebSocket.
+monitor.visible=true
+
+# How many historical message headers should be cached for display by new
+# monitor connections.  It does not limit the number of messages displayed by
+# the browser once the monitor is open; all freshly received messages will be
+# appended to the on screen list.  This setting also affects the underlying
+# API/WebSocket.
+monitor.history=30
+
 #############################################################################
 [datastore]
 

etc/homebrew/inbucket.conf

@@ -93,6 +93,18 @@ greeting.file=%(themes.dir)s/greeting.html
 # and previous sessions will be invalidated.
 cookie.auth.key=secret-inbucket-session-cookie-key
 
+# Enable or disable the live message monitor tab for the web UI. This will let
+# anybody see all messages delivered to Inbucket.  This setting has no impact
+# on the availability of the underlying WebSocket.
+monitor.visible=true
+
+# How many historical message headers should be cached for display by new
+# monitor connections.  It does not limit the number of messages displayed by
+# the browser once the monitor is open; all freshly received messages will be
+# appended to the on screen list.  This setting also affects the underlying
+# API/WebSocket.
+monitor.history=30
+
 #############################################################################
 [datastore]
 

etc/inbucket.conf

@@ -91,6 +91,18 @@ greeting.file=%(install.dir)s/themes/greeting.html
 # and previous sessions will be invalidated.
 #cookie.auth.key=secret-inbucket-session-cookie-key
 
+# Enable or disable the live message monitor tab for the web UI. This will let
+# anybody see all messages delivered to Inbucket.  This setting has no impact
+# on the availability of the underlying WebSocket.
+monitor.visible=true
+
+# How many historical message headers should be cached for display by new
+# monitor connections.  It does not limit the number of messages displayed by
+# the browser once the monitor is open; all freshly received messages will be
+# appended to the on screen list.  This setting also affects the underlying
+# API/WebSocket.
+monitor.history=30
+
 #############################################################################
 [datastore]
 

etc/unix-sample.conf

@@ -91,6 +91,18 @@ greeting.file=%(install.dir)s/themes/greeting.html
 # and previous sessions will be invalidated.
 #cookie.auth.key=secret-inbucket-session-cookie-key
 
+# Enable or disable the live message monitor tab for the web UI. This will let
+# anybody see all messages delivered to Inbucket.  This setting has no impact
+# on the availability of the underlying WebSocket.
+monitor.visible=true
+
+# How many historical message headers should be cached for display by new
+# monitor connections.  It does not limit the number of messages displayed by
+# the browser once the monitor is open; all freshly received messages will be
+# appended to the on screen list.  This setting also affects the underlying
+# API/WebSocket.
+monitor.history=30
+
 #############################################################################
 [datastore]
 

etc/win-sample.conf

@@ -91,6 +91,18 @@ greeting.file=%(install.dir)s\themes\greeting.html
 # and previous sessions will be invalidated.
 #cookie.auth.key=secret-inbucket-session-cookie-key
 
+# Enable or disable the live message monitor tab for the web UI. This will let
+# anybody see all messages delivered to Inbucket.  This setting has no impact
+# on the availability of the underlying WebSocket.
+monitor.visible=true
+
+# How many historical message headers should be cached for display by new
+# monitor connections.  It does not limit the number of messages displayed by
+# the browser once the monitor is open; all freshly received messages will be
+# appended to the on screen list.  This setting also affects the underlying
+# API/WebSocket.
+monitor.history=30
+
 #############################################################################
 [datastore]
 

httpd/context.go

@@ -6,6 +6,7 @@ import (
 
 	"github.com/gorilla/mux"
 	"github.com/gorilla/sessions"
+	"github.com/jhillyerd/inbucket/config"
 	"github.com/jhillyerd/inbucket/msghub"
 	"github.com/jhillyerd/inbucket/smtpd"
 )
@@ -16,6 +17,7 @@ type Context struct {
 	Session   *sessions.Session
 	DataStore smtpd.DataStore
 	MsgHub    *msghub.Hub
+	WebConfig config.WebConfig
 	IsJSON    bool
 }
 
@@ -59,6 +61,7 @@ func NewContext(req *http.Request) (*Context, error) {
 		Session:   sess,
 		DataStore: DataStore,
 		MsgHub:    msgHub,
+		WebConfig: webConfig,
 		IsJSON:    headerMatch(req, "Accept", "application/json"),
 	}
 	return ctx, err

inbucket.go

@@ -97,7 +97,7 @@ func main() {
 	}
 
 	// Create message hub
-	msgHub := msghub.New(rootCtx, 30)
+	msgHub := msghub.New(rootCtx, config.GetWebConfig().MonitorHistory)
 
 	// Grab our datastore
 	ds := smtpd.DefaultFileDataStore()

themes/bootstrap/templates/_base.html

@@ -48,7 +48,9 @@
               </ul>
             </li>
             {{end}}
+            {{if .ctx.WebConfig.MonitorVisible}}
             <li id="nav-monitor"><a href="/monitor" accesskey="2">Monitor</a></li>
+            {{end}}
             <li id="nav-status"><a href="/status" accesskey="3">Status</a></li>
           </ul>
           <form class="navbar-form navbar-right" action="{{reverse "MailboxIndex"}}" method="GET">

webui/root_controller.go

@@ -31,6 +31,12 @@ func RootIndex(w http.ResponseWriter, req *http.Request, ctx *httpd.Context) (er
 
 // RootMonitor serves the Inbucket monitor page
 func RootMonitor(w http.ResponseWriter, req *http.Request, ctx *httpd.Context) (err error) {
+	if !config.GetWebConfig().MonitorVisible {
+		ctx.Session.AddFlash("Monitor is disabled in configuration", "errors")
+		_ = ctx.Session.Save(req, w)
+		http.Redirect(w, req, httpd.Reverse("RootIndex"), http.StatusSeeOther)
+		return nil
+	}
 	// Get flash messages, save session
 	errorFlash := ctx.Session.Flashes("errors")
 	if err = ctx.Session.Save(req, w); err != nil {