Clean up readme

config/config.go

@@ -8,10 +8,10 @@ import (
 
 // Defines default config settings
 const (
-	DefaultListenHTTP            = ":80"
-	DefaultMessageBufferDuration = 12 * time.Hour
-	DefaultKeepaliveInterval     = 30 * time.Second
-	DefaultManagerInterval       = time.Minute
+	DefaultListenHTTP        = ":80"
+	DefaultCacheDuration     = 12 * time.Hour
+	DefaultKeepaliveInterval = 30 * time.Second
+	DefaultManagerInterval   = time.Minute
 )
 
 // Defines all the limits
@@ -28,9 +28,9 @@ var (
 // Config is the main config struct for the application. Use New to instantiate a default config struct.
 type Config struct {
 	ListenHTTP               string
-	CacheFile          string
 	FirebaseKeyFile          string
-	MessageBufferDuration    time.Duration
+	CacheFile                string
+	CacheDuration            time.Duration
 	KeepaliveInterval        time.Duration
 	ManagerInterval          time.Duration
 	GlobalTopicLimit         int
@@ -43,9 +43,9 @@ type Config struct {
 func New(listenHTTP string) *Config {
 	return &Config{
 		ListenHTTP:               listenHTTP,
-		CacheFile: "",
 		FirebaseKeyFile:          "",
-		MessageBufferDuration:    DefaultMessageBufferDuration,
+		CacheFile:                "",
+		CacheDuration:            DefaultCacheDuration,
 		KeepaliveInterval:        DefaultKeepaliveInterval,
 		ManagerInterval:          DefaultManagerInterval,
 		GlobalTopicLimit:         defaultGlobalTopicLimit,

config/config.yml

@@ -10,10 +10,15 @@
 #
 # firebase-key-file: <filename>
 
+# If set, messages are cached in a local SQLite database instead of only in-memory. This
+# allows for service restarts without losing messages in support of the since= parameter.
+#
+# cache-file: <filename>
+
 # Duration for which messages will be buffered before they are deleted.
 # This is required to support the "since=..." and "poll=1" parameter.
 #
-# message-buffer-duration: 12h
+# cache-duration: 12h
 
 # Interval in which keepalive messages are sent to the client. This is to prevent
 # intermediaries closing the connection for inactivity.