mirror of
https://github.com/go-gitea/gitea.git
synced 2026-07-25 07:45:17 +02:00
1e42317b66
Adds a shared `[redis]` config section with a single `CONN_STR` key that acts as the default Redis connection for every redis-backed subsystem whose own connection string is empty: `[cache].HOST`, `[session].PROVIDER_CONFIG`, `[queue].CONN_STR` and `[global_lock].SERVICE_CONN_STR`. Precedence: per-subsystem value > shared `[redis].CONN_STR` > existing built-in defaults. Fully backward compatible: when `[redis]` is not set, every code path behaves exactly as before. Motivation: today an admin with one Redis instance has to repeat the same connection string in up to four places (five once WebSocket lands). Requested by @wxiaoguang in [this review discussion](https://github.com/go-gitea/gitea/pull/36965#discussion_r3613306976) as a prerequisite for #36965. This follows the pattern used by GitLab and Mastodon: one global Redis definition, per-subsystem overrides fall back to it. Since #12385 all identical connection strings already share one client via `nosql.Manager`, so pointing all subsystems at `[redis].CONN_STR` naturally converges onto a single shared connection pool. Covered by table-driven unit tests per subsystem (fallback applies, own value wins, absent `[redis]` = unchanged behavior). A config-cheat-sheet update for gitea/docs will follow once this is merged. --------- Co-authored-by: wxiaoguang <wxiaoguang@gmail.com> Co-authored-by: TheFox0x7 <thefox0x7@gmail.com>
86 lines
3.3 KiB
Go
86 lines
3.3 KiB
Go
// Copyright 2019 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package setting
|
|
|
|
import (
|
|
"net/http"
|
|
"path/filepath"
|
|
"strings"
|
|
|
|
"gitea.dev/modules/json"
|
|
"gitea.dev/modules/log"
|
|
"gitea.dev/modules/util"
|
|
)
|
|
|
|
// SessionConfig defines Session settings
|
|
var SessionConfig = struct {
|
|
OriginalProvider string
|
|
Provider string
|
|
// Provider configuration, it's corresponding to provider.
|
|
ProviderConfig string
|
|
// Cookie name to save session ID. Default is "MacaronSession".
|
|
CookieName string
|
|
// Cookie path to store. Default is "/".
|
|
CookiePath string
|
|
// GC interval time in seconds. Default is 3600.
|
|
Gclifetime int64
|
|
// Max life time in seconds. Default is whatever GC interval time is.
|
|
Maxlifetime int64
|
|
// Use HTTPS only. Default is false.
|
|
Secure bool
|
|
// Cookie domain name. Default is empty.
|
|
Domain string
|
|
// SameSite declares if your cookie should be restricted to a first-party or same-site context. Valid strings are "none", "lax", "strict". Default is "lax"
|
|
SameSite http.SameSite
|
|
}{
|
|
CookieName: "i_like_gitea",
|
|
Gclifetime: 86400,
|
|
Maxlifetime: 86400,
|
|
SameSite: http.SameSiteLaxMode,
|
|
}
|
|
|
|
func loadSessionFrom(rootCfg ConfigProvider) {
|
|
sec := rootCfg.Section("session")
|
|
SessionConfig.Provider = sec.Key("PROVIDER").In("memory", []string{"memory", "file", "redis", "mysql", "postgres", "couchbase", "memcache", "db"})
|
|
|
|
switch SessionConfig.Provider {
|
|
case "redis":
|
|
SessionConfig.ProviderConfig = sec.Key("PROVIDER_CONFIG").MustString(Redis.ConnStr)
|
|
case "file":
|
|
SessionConfig.ProviderConfig = sec.Key("PROVIDER_CONFIG").MustString(filepath.Join(AppDataPath, "sessions"))
|
|
if !filepath.IsAbs(SessionConfig.ProviderConfig) {
|
|
// Although the "data path" should be used as Gitea's "data" base directory (work path sometimes is not writable),
|
|
// document says the relative session path is based on the "work path", so keep the behavior
|
|
SessionConfig.ProviderConfig = filepath.Join(AppWorkPath, SessionConfig.ProviderConfig)
|
|
}
|
|
checkOverlappedPath("[session].PROVIDER_CONFIG", SessionConfig.ProviderConfig)
|
|
default:
|
|
SessionConfig.ProviderConfig = sec.Key("PROVIDER_CONFIG").String()
|
|
}
|
|
|
|
SessionConfig.CookieName = sec.Key("COOKIE_NAME").MustString("i_like_gitea")
|
|
// HINT: INSTALL-PAGE-COOKIE-INIT: the cookie system is not properly initialized on the Install page, so there is no CookiePath
|
|
SessionConfig.CookiePath = util.IfZero(AppSubURL, "/")
|
|
SessionConfig.Secure = sec.Key("COOKIE_SECURE").MustBool(strings.HasPrefix(strings.ToLower(AppURL), "https://"))
|
|
SessionConfig.Gclifetime = sec.Key("GC_INTERVAL_TIME").MustInt64(86400)
|
|
SessionConfig.Maxlifetime = sec.Key("SESSION_LIFE_TIME").MustInt64(86400)
|
|
SessionConfig.Domain = sec.Key("DOMAIN").String()
|
|
samesiteString := sec.Key("SAME_SITE").In("lax", []string{"none", "lax", "strict"})
|
|
switch strings.ToLower(samesiteString) {
|
|
case "none":
|
|
SessionConfig.SameSite = http.SameSiteNoneMode
|
|
case "strict":
|
|
SessionConfig.SameSite = http.SameSiteStrictMode
|
|
default:
|
|
SessionConfig.SameSite = http.SameSiteLaxMode
|
|
}
|
|
shadowConfig, err := json.Marshal(SessionConfig)
|
|
if err != nil {
|
|
log.Fatal("Can't shadow session config: %v", err)
|
|
}
|
|
SessionConfig.ProviderConfig = string(shadowConfig)
|
|
SessionConfig.OriginalProvider = SessionConfig.Provider
|
|
SessionConfig.Provider = "VirtualSession"
|
|
}
|