Disable log colours by default

Fixes https://github.com/turt2live/matrix-media-repo/issues/323

CHANGELOG.md

@@ -7,6 +7,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ## [Unreleased]
 
+### Changed
+
+* Turned color-coded logs off by default. This can be changed in the config.
+
 ## [1.2.6] - March 25th, 2021
 
 ### Added

cmd/media_repo/main.go

@@ -59,7 +59,7 @@ func main() {
 	assets.SetupTemplates(*templatesPath)
 	assets.SetupAssets(*assetsPath)
 
-	err := logging.Setup(config.Get().General.LogDirectory)
+	err := logging.Setup(config.Get().General.LogDirectory, config.Get().General.LogColors)
 	if err != nil {
 		panic(err)
 	}

common/config/conf_main.go

@@ -24,6 +24,7 @@ func NewDefaultMainConfig() MainRepoConfig {
 			BindAddress:      "127.0.0.1",
 			Port:             8000,
 			LogDirectory:     "logs",
+			LogColors:        false,
 			TrustAnyForward:  false,
 			UseForwardedHost: true,
 		},

common/config/models_main.go

@@ -4,6 +4,7 @@ type GeneralConfig struct {
 	BindAddress      string `yaml:"bindAddress"`
 	Port             int    `yaml:"port"`
 	LogDirectory     string `yaml:"logDirectory"`
+	LogColors        bool   `yaml:"logColors"`
 	TrustAnyForward  bool   `yaml:"trustAnyForwardedAddress"`
 	UseForwardedHost bool   `yaml:"useForwardedHost"`
 }

common/logging/logger.go

@@ -19,13 +19,13 @@ func (f utcFormatter) Format(entry *logrus.Entry) ([]byte, error) {
 	return f.Formatter.Format(entry)
 }
 
-func Setup(dir string) error {
+func Setup(dir string, colors bool) error {
 	formatter := &utcFormatter{
 		&logrus.TextFormatter{
 			TimestampFormat:  "2006-01-02 15:04:05.000 Z07:00",
 			FullTimestamp:    true,
-			ForceColors:      true,
-			DisableColors:    false,
+			ForceColors:      colors,
+			DisableColors:    !colors,
 			DisableTimestamp: false,
 			QuoteEmptyFields: true,
 		},

config.sample.yaml

@@ -11,6 +11,10 @@ repo:
   # live reloaded.
   logDirectory: logs
 
+  # Set to true to enable color coding in your logs. Note that this may cause escape sequences to
+  # appear in logs which render them unreadable, which is why colors are disabled by default.
+  logColors: false
+
   # If true, the media repo will accept any X-Forwarded-For header without validation. In most cases
   # this option should be left as "false". Note that the media repo already expects an X-Forwarded-For
   # header, but validates it to ensure the IP being given makes sense.