chore: rename listen addr config variable

b3n4kh · Nov 4, 2021 · 2455bbb · 2455bbb
1 parent 06ef3f7
commit 2455bbb
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -165,7 +165,7 @@ You can specify configuration options either via a config file (`config.yml`) or
 |---------------------------|---------------------------|--------------|---------------------------------------------------------------------|
 | `env`                           | `MW_ENV`            | `dev`             | Whether to use development- or production settings |
 | `mail.domain`                   | `MW_MAIL_DOMAIN`    | -                 | Default domain for sending mails |
-| `web.listen_v4`                 | `MW_WEB_LISTEN_V4`  | `127.0.0.1:3000`  | IP and port for the web server to listen on |
+| `web.listen_addr`               | `MW_WEB_LISTEN_ADDR`| `127.0.0.1:3000`  | IP and port for the web server to listen on (can be IPv4 or IPv6) |
 | `web.cors_origin`               | -                   | [`http://localhost:5000`] | List of URLs which to accept CORS requests for |
 | `web.public_url`                | `MW_PUBLIC_URL`     | `http://localhost:3000` | The URL under which your MailWhale server is available from the public internet |
 | `smtp.host`                     | `MW_SMTP_HOST`      | -                 | SMTP relay host name or IP |

diff --git a/config/config.go b/config/config.go
@@ -35,7 +35,8 @@ type smtpConfig struct {
 }
 
 type webConfig struct {
-	ListenV4    string   `yaml:"listen_v4" default:"127.0.0.1:3000" env:"MW_WEB_LISTEN_V4"`
+	ListenV4    string   `yaml:"listen_v4" env:"MW_WEB_LISTEN_V4"` // deprecated, use ListenAddr
+	ListenAddr  string   `yaml:"listen_addr" default:"127.0.0.1:3000" env:"MW_WEB_LISTEN_ADDR"`
 	CorsOrigins []string `yaml:"cors_origins" env:"MW_WEB_CORS_ORIGINS"`
 	PublicUrl   string   `yaml:"public_url" default:"http://localhost:3000" env:"MW_WEB_PUBLIC_URL"`
 }
@@ -82,9 +83,14 @@ func Load() *Config {
 
 	config.Version = readVersion()
 
-	if config.Web.ListenV4 == "" {
-		logbuch.Fatal("config option 'listen4' must be specified")
+	if config.Web.ListenV4 != "" {
+		config.Web.ListenAddr = config.Web.ListenV4 // for backwards-compatbility
 	}
+
+	if config.Web.ListenAddr == "" {
+		logbuch.Fatal("config option 'listen_addr' must be specified")
+	}
+
 	if !config.Mail.SystemSender().Valid() {
 		logbuch.Fatal("system sender address is invalid")
 	}

diff --git a/main.go b/main.go
@@ -81,13 +81,13 @@ func listen(handler http.Handler, config *conf.Config) {
 
 	s4 = &http.Server{
 		Handler:      handler,
-		Addr:         config.Web.ListenV4,
+		Addr:         config.Web.ListenAddr,
 		ReadTimeout:  10 * time.Second,
 		WriteTimeout: 10 * time.Second,
 	}
 
 	go func() {
-		logbuch.Info("web server started, listening on %s", config.Web.ListenV4)
+		logbuch.Info("web server started, listening on %s", config.Web.ListenAddr)
 		if err := s4.ListenAndServe(); err != nil {
 			logbuch.Fatal("failed to start web server: %v", err)
 		}

diff --git a/version.txt b/version.txt
@@ -1 +1 @@
-0.11.2
+0.11.3