From e9f822305d314e4611f5a5d57e53833fe77bfd06 Mon Sep 17 00:00:00 2001
From: Travis Ralston <travpc@gmail.com>
Date: Thu, 15 Apr 2021 21:38:14 -0600
Subject: [PATCH] Disable log colours by default
Fixes https://github.com/turt2live/matrix-media-repo/issues/323
---
CHANGELOG.md | 4 ++++
cmd/media_repo/main.go | 2 +-
common/config/conf_main.go | 1 +
common/config/models_main.go | 1 +
common/logging/logger.go | 6 +++---
config.sample.yaml | 4 ++++
6 files changed, 14 insertions(+), 4 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 381cfea8..bfbde2f2 100644
--- a/CHANGELOG.md
+++ b/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
diff --git a/cmd/media_repo/main.go b/cmd/media_repo/main.go
index e8fb1197..2433e3c3 100644
--- a/cmd/media_repo/main.go
+++ b/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)
}
diff --git a/common/config/conf_main.go b/common/config/conf_main.go
index df20ad2d..e5537bc0 100644
--- a/common/config/conf_main.go
+++ b/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,
},
diff --git a/common/config/models_main.go b/common/config/models_main.go
index 8ef3d667..0690d1aa 100644
--- a/common/config/models_main.go
+++ b/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"`
}
diff --git a/common/logging/logger.go b/common/logging/logger.go
index 4ce3eaef..bbd95334 100644
--- a/common/logging/logger.go
+++ b/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,
},
diff --git a/config.sample.yaml b/config.sample.yaml
index db676e5f..69d5bb21 100644
--- a/config.sample.yaml
+++ b/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.
--
GitLab