| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096 |
- // Copyright 2014 Unknwon
- // Copyright 2014 Torkel Ödegaard
- package setting
- import (
- "bytes"
- "errors"
- "fmt"
- "net/http"
- "net/url"
- "os"
- "path"
- "path/filepath"
- "regexp"
- "runtime"
- "strings"
- "time"
- "github.com/go-macaron/session"
- ini "gopkg.in/ini.v1"
- "github.com/grafana/grafana/pkg/infra/log"
- "github.com/grafana/grafana/pkg/util"
- )
- type Scheme string
- const (
- HTTP Scheme = "http"
- HTTPS Scheme = "https"
- HTTP2 Scheme = "h2"
- SOCKET Scheme = "socket"
- DEFAULT_HTTP_ADDR string = "0.0.0.0"
- )
- const (
- DEV = "development"
- PROD = "production"
- TEST = "test"
- APP_NAME = "Energy Link"
- APP_NAME_ENTERPRISE = "Grafana Enterprise"
- ME_HOME_PAGE_URL = "https://www.mercadoselectricos.com.sv/" //FHUEZO: Constante para URL de sitio oficial de MERELEC
- )
- var (
- ERR_TEMPLATE_NAME = "error"
- )
- var (
- // App settings.
- Env = DEV
- AppUrl string
- AppSubUrl string
- ServeFromSubPath bool
- InstanceName string
- MEHomePage = ME_HOME_PAGE_URL //FHUEZO: AppSetting para URL de sitio oficial de MERELEC
- // build
- BuildVersion string
- BuildCommit string
- BuildBranch string
- BuildStamp int64
- IsEnterprise bool
- ApplicationName string
- // packaging
- Packaging = "unknown"
- // Paths
- HomePath string
- PluginsPath string
- CustomInitPath = "conf/custom.ini"
- // Log settings.
- LogConfigs []util.DynMap
- // Http server options
- Protocol Scheme
- Domain string
- HttpAddr, HttpPort string
- SshPort int
- CertFile, KeyFile string
- SocketPath string
- RouterLogging bool
- DataProxyLogging bool
- DataProxyTimeout int
- StaticRootPath string
- EnableGzip bool
- EnforceDomain bool
- // Security settings.
- SecretKey string
- DisableGravatar bool
- EmailCodeValidMinutes int
- DataProxyWhiteList map[string]bool
- DisableBruteForceLoginProtection bool
- CookieSecure bool
- CookieSameSite http.SameSite
- AllowEmbedding bool
- XSSProtectionHeader bool
- ContentTypeProtectionHeader bool
- StrictTransportSecurity bool
- StrictTransportSecurityMaxAge int
- StrictTransportSecurityPreload bool
- StrictTransportSecuritySubDomains bool
- // Snapshots
- ExternalSnapshotUrl string
- ExternalSnapshotName string
- ExternalEnabled bool
- SnapShotRemoveExpired bool
- SnapshotPublicMode bool
- // Dashboard history
- DashboardVersionsToKeep int
- // User settings
- AllowUserSignUp bool
- AllowUserOrgCreate bool
- AutoAssignOrg bool
- AutoAssignOrgId int
- AutoAssignOrgRole string
- VerifyEmailEnabled bool
- LoginHint string
- PasswordHint string
- DefaultTheme string
- DisableLoginForm bool
- DisableSignoutMenu bool
- SignoutRedirectUrl string
- ExternalUserMngLinkUrl string
- ExternalUserMngLinkName string
- ExternalUserMngInfo string
- OAuthAutoLogin bool
- ViewersCanEdit bool
- // Http auth
- AdminUser string
- AdminPassword string
- LoginCookieName string
- LoginMaxLifetimeDays int
- AnonymousEnabled bool
- AnonymousOrgName string
- AnonymousOrgRole string
- // Auth proxy settings
- AuthProxyEnabled bool
- AuthProxyHeaderName string
- AuthProxyHeaderProperty string
- AuthProxyAutoSignUp bool
- AuthProxyLDAPSyncTtl int
- AuthProxyWhitelist string
- AuthProxyHeaders map[string]string
- // Basic Auth
- BasicAuthEnabled bool
- // Session settings.
- SessionOptions session.Options
- SessionConnMaxLifetime int64
- // Global setting objects.
- Raw *ini.File
- ConfRootPath string
- IsWindows bool
- // for logging purposes
- configFiles []string
- appliedCommandLineProperties []string
- appliedEnvOverrides []string
- ReportingEnabled bool
- CheckForUpdates bool
- GoogleAnalyticsId string
- GoogleTagManagerId string
- // LDAP
- LDAPEnabled bool
- LDAPConfigFile string
- LDAPSyncCron string
- LDAPAllowSignup bool
- LDAPActiveSyncEnabled bool
- // QUOTA
- Quota QuotaSettings
- // Alerting
- AlertingEnabled bool
- ExecuteAlerts bool
- AlertingRenderLimit int
- AlertingErrorOrTimeout string
- AlertingNoDataOrNullValues string
- AlertingEvaluationTimeout time.Duration
- AlertingNotificationTimeout time.Duration
- AlertingMaxAttempts int
- // Explore UI
- ExploreEnabled bool
- // Grafana.NET URL
- GrafanaComUrl string
- // S3 temp image store
- S3TempImageStoreBucketUrl string
- S3TempImageStoreAccessKey string
- S3TempImageStoreSecretKey string
- ImageUploadProvider string
- )
- // TODO move all global vars to this struct
- type Cfg struct {
- Raw *ini.File
- Logger log.Logger
- // HTTP Server Settings
- AppUrl string
- AppSubUrl string
- ServeFromSubPath bool
- // Paths
- ProvisioningPath string
- DataPath string
- LogsPath string
- // SMTP email settings
- Smtp SmtpSettings
- // Rendering
- ImagesDir string
- PhantomDir string
- RendererUrl string
- RendererCallbackUrl string
- RendererLimit int
- RendererLimitAlerting int
- // Security
- DisableBruteForceLoginProtection bool
- CookieSecure bool
- CookieSameSite http.SameSite
- TempDataLifetime time.Duration
- MetricsEndpointEnabled bool
- MetricsEndpointBasicAuthUsername string
- MetricsEndpointBasicAuthPassword string
- MetricsEndpointDisableTotalStats bool
- PluginsEnableAlpha bool
- PluginsAppsSkipVerifyTLS bool
- DisableSanitizeHtml bool
- EnterpriseLicensePath string
- // Auth
- LoginCookieName string
- LoginMaxInactiveLifetimeDays int
- LoginMaxLifetimeDays int
- TokenRotationIntervalMinutes int
- // SAML Auth
- SAMLEnabled bool
- // Dataproxy
- SendUserHeader bool
- // DistributedCache
- RemoteCacheOptions *RemoteCacheOptions
- EditorsCanAdmin bool
- ApiKeyMaxSecondsToLive int64
- FeatureToggles map[string]bool
- }
- type CommandLineArgs struct {
- Config string
- HomePath string
- Args []string
- }
- func init() {
- IsWindows = runtime.GOOS == "windows"
- }
- func parseAppUrlAndSubUrl(section *ini.Section) (string, string, error) {
- appUrl, err := valueAsString(section, "root_url", "http://localhost:3000/")
- if err != nil {
- return "", "", err
- }
- if appUrl[len(appUrl)-1] != '/' {
- appUrl += "/"
- }
- // Check if has app suburl.
- url, err := url.Parse(appUrl)
- if err != nil {
- log.Fatal(4, "Invalid root_url(%s): %s", appUrl, err)
- }
- appSubUrl := strings.TrimSuffix(url.Path, "/")
- return appUrl, appSubUrl, nil
- }
- func ToAbsUrl(relativeUrl string) string {
- return AppUrl + relativeUrl
- }
- func shouldRedactKey(s string) bool {
- uppercased := strings.ToUpper(s)
- return strings.Contains(uppercased, "PASSWORD") || strings.Contains(uppercased, "SECRET") || strings.Contains(uppercased, "PROVIDER_CONFIG")
- }
- func shouldRedactURLKey(s string) bool {
- uppercased := strings.ToUpper(s)
- return strings.Contains(uppercased, "DATABASE_URL")
- }
- func applyEnvVariableOverrides(file *ini.File) error {
- appliedEnvOverrides = make([]string, 0)
- for _, section := range file.Sections() {
- for _, key := range section.Keys() {
- sectionName := strings.ToUpper(strings.Replace(section.Name(), ".", "_", -1))
- keyName := strings.ToUpper(strings.Replace(key.Name(), ".", "_", -1))
- envKey := fmt.Sprintf("GF_%s_%s", sectionName, keyName)
- envValue := os.Getenv(envKey)
- if len(envValue) > 0 {
- key.SetValue(envValue)
- if shouldRedactKey(envKey) {
- envValue = "*********"
- }
- if shouldRedactURLKey(envKey) {
- u, err := url.Parse(envValue)
- if err != nil {
- return fmt.Errorf("could not parse environment variable. key: %s, value: %s. error: %v", envKey, envValue, err)
- }
- ui := u.User
- if ui != nil {
- _, exists := ui.Password()
- if exists {
- u.User = url.UserPassword(ui.Username(), "-redacted-")
- envValue = u.String()
- }
- }
- }
- appliedEnvOverrides = append(appliedEnvOverrides, fmt.Sprintf("%s=%s", envKey, envValue))
- }
- }
- }
- return nil
- }
- func applyCommandLineDefaultProperties(props map[string]string, file *ini.File) {
- appliedCommandLineProperties = make([]string, 0)
- for _, section := range file.Sections() {
- for _, key := range section.Keys() {
- keyString := fmt.Sprintf("default.%s.%s", section.Name(), key.Name())
- value, exists := props[keyString]
- if exists {
- key.SetValue(value)
- if shouldRedactKey(keyString) {
- value = "*********"
- }
- appliedCommandLineProperties = append(appliedCommandLineProperties, fmt.Sprintf("%s=%s", keyString, value))
- }
- }
- }
- }
- func applyCommandLineProperties(props map[string]string, file *ini.File) {
- for _, section := range file.Sections() {
- sectionName := section.Name() + "."
- if section.Name() == ini.DEFAULT_SECTION {
- sectionName = ""
- }
- for _, key := range section.Keys() {
- keyString := sectionName + key.Name()
- value, exists := props[keyString]
- if exists {
- appliedCommandLineProperties = append(appliedCommandLineProperties, fmt.Sprintf("%s=%s", keyString, value))
- key.SetValue(value)
- }
- }
- }
- }
- func getCommandLineProperties(args []string) map[string]string {
- props := make(map[string]string)
- for _, arg := range args {
- if !strings.HasPrefix(arg, "cfg:") {
- continue
- }
- trimmed := strings.TrimPrefix(arg, "cfg:")
- parts := strings.Split(trimmed, "=")
- if len(parts) != 2 {
- log.Fatal(3, "Invalid command line argument. argument: %v", arg)
- return nil
- }
- props[parts[0]] = parts[1]
- }
- return props
- }
- func makeAbsolute(path string, root string) string {
- if filepath.IsAbs(path) {
- return path
- }
- return filepath.Join(root, path)
- }
- func evalEnvVarExpression(value string) string {
- regex := regexp.MustCompile(`\${(\w+)}`)
- return regex.ReplaceAllStringFunc(value, func(envVar string) string {
- envVar = strings.TrimPrefix(envVar, "${")
- envVar = strings.TrimSuffix(envVar, "}")
- envValue := os.Getenv(envVar)
- // if env variable is hostname and it is empty use os.Hostname as default
- if envVar == "HOSTNAME" && envValue == "" {
- envValue, _ = os.Hostname()
- }
- return envValue
- })
- }
- func evalConfigValues(file *ini.File) {
- for _, section := range file.Sections() {
- for _, key := range section.Keys() {
- key.SetValue(evalEnvVarExpression(key.Value()))
- }
- }
- }
- func loadSpecifedConfigFile(configFile string, masterFile *ini.File) error {
- if configFile == "" {
- configFile = filepath.Join(HomePath, CustomInitPath)
- // return without error if custom file does not exist
- if !pathExists(configFile) {
- return nil
- }
- }
- userConfig, err := ini.Load(configFile)
- if err != nil {
- return fmt.Errorf("Failed to parse %v, %v", configFile, err)
- }
- userConfig.BlockMode = false
- for _, section := range userConfig.Sections() {
- for _, key := range section.Keys() {
- if key.Value() == "" {
- continue
- }
- defaultSec, err := masterFile.GetSection(section.Name())
- if err != nil {
- defaultSec, _ = masterFile.NewSection(section.Name())
- }
- defaultKey, err := defaultSec.GetKey(key.Name())
- if err != nil {
- defaultKey, _ = defaultSec.NewKey(key.Name(), key.Value())
- }
- defaultKey.SetValue(key.Value())
- }
- }
- configFiles = append(configFiles, configFile)
- return nil
- }
- func (cfg *Cfg) loadConfiguration(args *CommandLineArgs) (*ini.File, error) {
- var err error
- // load config defaults
- defaultConfigFile := path.Join(HomePath, "conf/defaults.ini")
- configFiles = append(configFiles, defaultConfigFile)
- // check if config file exists
- if _, err := os.Stat(defaultConfigFile); os.IsNotExist(err) {
- fmt.Println("Grafana-server Init Failed: Could not find config defaults, make sure homepath command line parameter is set or working directory is homepath")
- os.Exit(1)
- }
- // load defaults
- parsedFile, err := ini.Load(defaultConfigFile)
- if err != nil {
- fmt.Println(fmt.Sprintf("Failed to parse defaults.ini, %v", err))
- os.Exit(1)
- return nil, err
- }
- parsedFile.BlockMode = false
- // command line props
- commandLineProps := getCommandLineProperties(args.Args)
- // load default overrides
- applyCommandLineDefaultProperties(commandLineProps, parsedFile)
- // load specified config file
- err = loadSpecifedConfigFile(args.Config, parsedFile)
- if err != nil {
- err2 := cfg.initLogging(parsedFile)
- if err2 != nil {
- return nil, err2
- }
- log.Fatal(3, err.Error())
- }
- // apply environment overrides
- err = applyEnvVariableOverrides(parsedFile)
- if err != nil {
- return nil, err
- }
- // apply command line overrides
- applyCommandLineProperties(commandLineProps, parsedFile)
- // evaluate config values containing environment variables
- evalConfigValues(parsedFile)
- // update data path and logging config
- dataPath, err := valueAsString(parsedFile.Section("paths"), "data", "")
- if err != nil {
- return nil, err
- }
- cfg.DataPath = makeAbsolute(dataPath, HomePath)
- err = cfg.initLogging(parsedFile)
- if err != nil {
- return nil, err
- }
- return parsedFile, err
- }
- func pathExists(path string) bool {
- _, err := os.Stat(path)
- if err == nil {
- return true
- }
- if os.IsNotExist(err) {
- return false
- }
- return false
- }
- func setHomePath(args *CommandLineArgs) {
- if args.HomePath != "" {
- HomePath = args.HomePath
- return
- }
- HomePath, _ = filepath.Abs(".")
- // check if homepath is correct
- if pathExists(filepath.Join(HomePath, "conf/defaults.ini")) {
- return
- }
- // try down one path
- if pathExists(filepath.Join(HomePath, "../conf/defaults.ini")) {
- HomePath = filepath.Join(HomePath, "../")
- }
- }
- var skipStaticRootValidation = false
- func NewCfg() *Cfg {
- return &Cfg{
- Logger: log.New("settings"),
- Raw: ini.Empty(),
- }
- }
- func (cfg *Cfg) validateStaticRootPath() error {
- if skipStaticRootValidation {
- return nil
- }
- if _, err := os.Stat(path.Join(StaticRootPath, "build")); err != nil {
- cfg.Logger.Error("Failed to detect generated javascript files in public/build")
- }
- return nil
- }
- func (cfg *Cfg) Load(args *CommandLineArgs) error {
- setHomePath(args)
- iniFile, err := cfg.loadConfiguration(args)
- if err != nil {
- return err
- }
- cfg.Raw = iniFile
- // Temporary keep global, to make refactor in steps
- Raw = cfg.Raw
- ApplicationName = APP_NAME
- if IsEnterprise {
- ApplicationName = APP_NAME_ENTERPRISE
- }
- Env, err = valueAsString(iniFile.Section(""), "app_mode", "development")
- if err != nil {
- return err
- }
- InstanceName, err = valueAsString(iniFile.Section(""), "instance_name", "unknown_instance_name")
- if err != nil {
- return err
- }
- plugins, err := valueAsString(iniFile.Section("paths"), "plugins", "")
- if err != nil {
- return err
- }
- PluginsPath = makeAbsolute(plugins, HomePath)
- Provisioning, err := valueAsString(iniFile.Section("paths"), "provisioning", "")
- if err != nil {
- return err
- }
- cfg.ProvisioningPath = makeAbsolute(Provisioning, HomePath)
- server := iniFile.Section("server")
- AppUrl, AppSubUrl, err = parseAppUrlAndSubUrl(server)
- if err != nil {
- return err
- }
- ServeFromSubPath = server.Key("serve_from_sub_path").MustBool(false)
- cfg.AppUrl = AppUrl
- cfg.AppSubUrl = AppSubUrl
- cfg.ServeFromSubPath = ServeFromSubPath
- Protocol = HTTP
- protocolStr, err := valueAsString(server, "protocol", "http")
- if err != nil {
- return err
- }
- if protocolStr == "https" {
- Protocol = HTTPS
- CertFile = server.Key("cert_file").String()
- KeyFile = server.Key("cert_key").String()
- }
- if protocolStr == "h2" {
- Protocol = HTTP2
- CertFile = server.Key("cert_file").String()
- KeyFile = server.Key("cert_key").String()
- }
- if protocolStr == "socket" {
- Protocol = SOCKET
- SocketPath = server.Key("socket").String()
- }
- Domain, err = valueAsString(server, "domain", "localhost")
- if err != nil {
- return err
- }
- HttpAddr, err = valueAsString(server, "http_addr", DEFAULT_HTTP_ADDR)
- if err != nil {
- return err
- }
- HttpPort, err = valueAsString(server, "http_port", "3000")
- if err != nil {
- return err
- }
- RouterLogging = server.Key("router_logging").MustBool(false)
- EnableGzip = server.Key("enable_gzip").MustBool(false)
- EnforceDomain = server.Key("enforce_domain").MustBool(false)
- staticRoot, err := valueAsString(server, "static_root_path", "")
- if err != nil {
- return err
- }
- StaticRootPath = makeAbsolute(staticRoot, HomePath)
- if err := cfg.validateStaticRootPath(); err != nil {
- return err
- }
- // read data proxy settings
- dataproxy := iniFile.Section("dataproxy")
- DataProxyLogging = dataproxy.Key("logging").MustBool(false)
- DataProxyTimeout = dataproxy.Key("timeout").MustInt(30)
- cfg.SendUserHeader = dataproxy.Key("send_user_header").MustBool(false)
- // read security settings
- security := iniFile.Section("security")
- SecretKey, err = valueAsString(security, "secret_key", "")
- if err != nil {
- return err
- }
- DisableGravatar = security.Key("disable_gravatar").MustBool(true)
- cfg.DisableBruteForceLoginProtection = security.Key("disable_brute_force_login_protection").MustBool(false)
- DisableBruteForceLoginProtection = cfg.DisableBruteForceLoginProtection
- CookieSecure = security.Key("cookie_secure").MustBool(false)
- cfg.CookieSecure = CookieSecure
- samesiteString, err := valueAsString(security, "cookie_samesite", "lax")
- if err != nil {
- return err
- }
- validSameSiteValues := map[string]http.SameSite{
- "lax": http.SameSiteLaxMode,
- "strict": http.SameSiteStrictMode,
- "none": http.SameSiteDefaultMode,
- }
- if samesite, ok := validSameSiteValues[samesiteString]; ok {
- CookieSameSite = samesite
- cfg.CookieSameSite = CookieSameSite
- } else {
- CookieSameSite = http.SameSiteLaxMode
- cfg.CookieSameSite = CookieSameSite
- }
- AllowEmbedding = security.Key("allow_embedding").MustBool(false)
- ContentTypeProtectionHeader = security.Key("x_content_type_options").MustBool(false)
- XSSProtectionHeader = security.Key("x_xss_protection").MustBool(false)
- StrictTransportSecurity = security.Key("strict_transport_security").MustBool(false)
- StrictTransportSecurityMaxAge = security.Key("strict_transport_security_max_age_seconds").MustInt(86400)
- StrictTransportSecurityPreload = security.Key("strict_transport_security_preload").MustBool(false)
- StrictTransportSecuritySubDomains = security.Key("strict_transport_security_subdomains").MustBool(false)
- // read snapshots settings
- snapshots := iniFile.Section("snapshots")
- ExternalSnapshotUrl, err = valueAsString(snapshots, "external_snapshot_url", "")
- if err != nil {
- return err
- }
- ExternalSnapshotName, err = valueAsString(snapshots, "external_snapshot_name", "")
- if err != nil {
- return err
- }
- ExternalEnabled = snapshots.Key("external_enabled").MustBool(true)
- SnapShotRemoveExpired = snapshots.Key("snapshot_remove_expired").MustBool(true)
- SnapshotPublicMode = snapshots.Key("public_mode").MustBool(false)
- // read dashboard settings
- dashboards := iniFile.Section("dashboards")
- DashboardVersionsToKeep = dashboards.Key("versions_to_keep").MustInt(20)
- // read data source proxy white list
- DataProxyWhiteList = make(map[string]bool)
- securityStr, err := valueAsString(security, "data_source_proxy_whitelist", "")
- if err != nil {
- return err
- }
- for _, hostAndIp := range util.SplitString(securityStr) {
- DataProxyWhiteList[hostAndIp] = true
- }
- // admin
- AdminUser, err = valueAsString(security, "admin_user", "")
- if err != nil {
- return err
- }
- AdminPassword, err = valueAsString(security, "admin_password", "")
- if err != nil {
- return err
- }
- // users
- users := iniFile.Section("users")
- AllowUserSignUp = users.Key("allow_sign_up").MustBool(true)
- AllowUserOrgCreate = users.Key("allow_org_create").MustBool(true)
- AutoAssignOrg = users.Key("auto_assign_org").MustBool(true)
- AutoAssignOrgId = users.Key("auto_assign_org_id").MustInt(1)
- AutoAssignOrgRole = users.Key("auto_assign_org_role").In("Editor", []string{"Editor", "Admin", "Viewer"})
- VerifyEmailEnabled = users.Key("verify_email_enabled").MustBool(false)
- LoginHint, err = valueAsString(users, "login_hint", "")
- if err != nil {
- return err
- }
- PasswordHint, err = valueAsString(users, "password_hint", "")
- if err != nil {
- return err
- }
- DefaultTheme, err = valueAsString(users, "default_theme", "")
- if err != nil {
- return err
- }
- ExternalUserMngLinkUrl, err = valueAsString(users, "external_manage_link_url", "")
- if err != nil {
- return err
- }
- ExternalUserMngLinkName, err = valueAsString(users, "external_manage_link_name", "")
- if err != nil {
- return err
- }
- ExternalUserMngInfo, err = valueAsString(users, "external_manage_info", "")
- if err != nil {
- return err
- }
- ViewersCanEdit = users.Key("viewers_can_edit").MustBool(false)
- cfg.EditorsCanAdmin = users.Key("editors_can_admin").MustBool(false)
- // auth
- auth := iniFile.Section("auth")
- LoginCookieName, err = valueAsString(auth, "login_cookie_name", "grafana_session")
- cfg.LoginCookieName = LoginCookieName
- if err != nil {
- return err
- }
- cfg.LoginMaxInactiveLifetimeDays = auth.Key("login_maximum_inactive_lifetime_days").MustInt(7)
- LoginMaxLifetimeDays = auth.Key("login_maximum_lifetime_days").MustInt(30)
- cfg.LoginMaxLifetimeDays = LoginMaxLifetimeDays
- cfg.ApiKeyMaxSecondsToLive = auth.Key("api_key_max_seconds_to_live").MustInt64(-1)
- cfg.TokenRotationIntervalMinutes = auth.Key("token_rotation_interval_minutes").MustInt(10)
- if cfg.TokenRotationIntervalMinutes < 2 {
- cfg.TokenRotationIntervalMinutes = 2
- }
- DisableLoginForm = auth.Key("disable_login_form").MustBool(false)
- DisableSignoutMenu = auth.Key("disable_signout_menu").MustBool(false)
- OAuthAutoLogin = auth.Key("oauth_auto_login").MustBool(false)
- SignoutRedirectUrl, err = valueAsString(auth, "signout_redirect_url", "")
- if err != nil {
- return err
- }
- // SAML auth
- cfg.SAMLEnabled = iniFile.Section("auth.saml").Key("enabled").MustBool(false)
- // anonymous access
- AnonymousEnabled = iniFile.Section("auth.anonymous").Key("enabled").MustBool(false)
- AnonymousOrgName, err = valueAsString(iniFile.Section("auth.anonymous"), "org_name", "")
- if err != nil {
- return err
- }
- AnonymousOrgRole, err = valueAsString(iniFile.Section("auth.anonymous"), "org_role", "")
- if err != nil {
- return err
- }
- // auth proxy
- authProxy := iniFile.Section("auth.proxy")
- AuthProxyEnabled = authProxy.Key("enabled").MustBool(false)
- AuthProxyHeaderName, err = valueAsString(authProxy, "header_name", "")
- if err != nil {
- return err
- }
- AuthProxyHeaderProperty, err = valueAsString(authProxy, "header_property", "")
- if err != nil {
- return err
- }
- AuthProxyAutoSignUp = authProxy.Key("auto_sign_up").MustBool(true)
- AuthProxyLDAPSyncTtl = authProxy.Key("ldap_sync_ttl").MustInt()
- AuthProxyWhitelist, err = valueAsString(authProxy, "whitelist", "")
- if err != nil {
- return err
- }
- AuthProxyHeaders = make(map[string]string)
- headers, err := valueAsString(authProxy, "headers", "")
- if err != nil {
- return err
- }
- for _, propertyAndHeader := range util.SplitString(headers) {
- split := strings.SplitN(propertyAndHeader, ":", 2)
- if len(split) == 2 {
- AuthProxyHeaders[split[0]] = split[1]
- }
- }
- // basic auth
- authBasic := iniFile.Section("auth.basic")
- BasicAuthEnabled = authBasic.Key("enabled").MustBool(true)
- // Rendering
- renderSec := iniFile.Section("rendering")
- cfg.RendererUrl, err = valueAsString(renderSec, "server_url", "")
- if err != nil {
- return err
- }
- cfg.RendererCallbackUrl, err = valueAsString(renderSec, "callback_url", "")
- if err != nil {
- return err
- }
- if cfg.RendererCallbackUrl == "" {
- cfg.RendererCallbackUrl = AppUrl
- } else {
- if cfg.RendererCallbackUrl[len(cfg.RendererCallbackUrl)-1] != '/' {
- cfg.RendererCallbackUrl += "/"
- }
- _, err := url.Parse(cfg.RendererCallbackUrl)
- if err != nil {
- log.Fatal(4, "Invalid callback_url(%s): %s", cfg.RendererCallbackUrl, err)
- }
- }
- cfg.ImagesDir = filepath.Join(cfg.DataPath, "png")
- cfg.PhantomDir = filepath.Join(HomePath, "tools/phantomjs")
- cfg.TempDataLifetime = iniFile.Section("paths").Key("temp_data_lifetime").MustDuration(time.Second * 3600 * 24)
- cfg.MetricsEndpointEnabled = iniFile.Section("metrics").Key("enabled").MustBool(true)
- cfg.MetricsEndpointBasicAuthUsername, err = valueAsString(iniFile.Section("metrics"), "basic_auth_username", "")
- if err != nil {
- return err
- }
- cfg.MetricsEndpointBasicAuthPassword, err = valueAsString(iniFile.Section("metrics"), "basic_auth_password", "")
- if err != nil {
- return err
- }
- cfg.MetricsEndpointDisableTotalStats = iniFile.Section("metrics").Key("disable_total_stats").MustBool(false)
- analytics := iniFile.Section("analytics")
- ReportingEnabled = analytics.Key("reporting_enabled").MustBool(true)
- CheckForUpdates = analytics.Key("check_for_updates").MustBool(true)
- GoogleAnalyticsId = analytics.Key("google_analytics_ua_id").String()
- GoogleTagManagerId = analytics.Key("google_tag_manager_id").String()
- alerting := iniFile.Section("alerting")
- AlertingEnabled = alerting.Key("enabled").MustBool(true)
- ExecuteAlerts = alerting.Key("execute_alerts").MustBool(true)
- AlertingRenderLimit = alerting.Key("concurrent_render_limit").MustInt(5)
- AlertingErrorOrTimeout, err = valueAsString(alerting, "error_or_timeout", "alerting")
- if err != nil {
- return err
- }
- AlertingNoDataOrNullValues, err = valueAsString(alerting, "nodata_or_nullvalues", "no_data")
- if err != nil {
- return err
- }
- evaluationTimeoutSeconds := alerting.Key("evaluation_timeout_seconds").MustInt64(30)
- AlertingEvaluationTimeout = time.Second * time.Duration(evaluationTimeoutSeconds)
- notificationTimeoutSeconds := alerting.Key("notification_timeout_seconds").MustInt64(30)
- AlertingNotificationTimeout = time.Second * time.Duration(notificationTimeoutSeconds)
- AlertingMaxAttempts = alerting.Key("max_attempts").MustInt(3)
- explore := iniFile.Section("explore")
- ExploreEnabled = explore.Key("enabled").MustBool(true)
- panelsSection := iniFile.Section("panels")
- cfg.DisableSanitizeHtml = panelsSection.Key("disable_sanitize_html").MustBool(false)
- pluginsSection := iniFile.Section("plugins")
- cfg.PluginsEnableAlpha = pluginsSection.Key("enable_alpha").MustBool(false)
- cfg.PluginsAppsSkipVerifyTLS = pluginsSection.Key("app_tls_skip_verify_insecure").MustBool(false)
- // Read and populate feature toggles list
- featureTogglesSection := iniFile.Section("feature_toggles")
- cfg.FeatureToggles = make(map[string]bool)
- featuresTogglesStr, err := valueAsString(featureTogglesSection, "enable", "")
- if err != nil {
- return err
- }
- for _, feature := range util.SplitString(featuresTogglesStr) {
- cfg.FeatureToggles[feature] = true
- }
- // check old location for this option
- if panelsSection.Key("enable_alpha").MustBool(false) {
- cfg.PluginsEnableAlpha = true
- }
- cfg.readLDAPConfig()
- cfg.readSessionConfig()
- cfg.readSmtpSettings()
- cfg.readQuotaSettings()
- if VerifyEmailEnabled && !cfg.Smtp.Enabled {
- log.Warn("require_email_validation is enabled but smtp is disabled")
- }
- // check old key name
- GrafanaComUrl, err = valueAsString(iniFile.Section("grafana_net"), "url", "")
- if err != nil {
- return err
- }
- if GrafanaComUrl == "" {
- GrafanaComUrl, err = valueAsString(iniFile.Section("grafana_com"), "url", "https://grafana.com")
- if err != nil {
- return err
- }
- }
- imageUploadingSection := iniFile.Section("external_image_storage")
- ImageUploadProvider, err = valueAsString(imageUploadingSection, "provider", "")
- if err != nil {
- return err
- }
- enterprise := iniFile.Section("enterprise")
- cfg.EnterpriseLicensePath, err = valueAsString(enterprise, "license_path", filepath.Join(cfg.DataPath, "license.jwt"))
- if err != nil {
- return err
- }
- cacheServer := iniFile.Section("remote_cache")
- dbName, err := valueAsString(cacheServer, "type", "database")
- if err != nil {
- return err
- }
- connStr, err := valueAsString(cacheServer, "connstr", "")
- if err != nil {
- return err
- }
- cfg.RemoteCacheOptions = &RemoteCacheOptions{
- Name: dbName,
- ConnStr: connStr,
- }
- return nil
- }
- func valueAsString(section *ini.Section, keyName string, defaultValue string) (value string, err error) {
- defer func() {
- if err_ := recover(); err_ != nil {
- err = errors.New("Invalid value for key '" + keyName + "' in configuration file")
- }
- }()
- return section.Key(keyName).MustString(defaultValue), nil
- }
- type RemoteCacheOptions struct {
- Name string
- ConnStr string
- }
- func (cfg *Cfg) readLDAPConfig() {
- ldapSec := cfg.Raw.Section("auth.ldap")
- LDAPConfigFile = ldapSec.Key("config_file").String()
- LDAPSyncCron = ldapSec.Key("sync_cron").String()
- LDAPEnabled = ldapSec.Key("enabled").MustBool(false)
- LDAPActiveSyncEnabled = ldapSec.Key("active_sync_enabled").MustBool(false)
- LDAPAllowSignup = ldapSec.Key("allow_sign_up").MustBool(true)
- }
- func (cfg *Cfg) readSessionConfig() {
- sec, _ := cfg.Raw.GetSection("session")
- if sec != nil {
- cfg.Logger.Warn(
- "[Removed] Session setting was removed in v6.2, use remote_cache option instead",
- )
- }
- }
- func (cfg *Cfg) initLogging(file *ini.File) error {
- logModeStr, err := valueAsString(file.Section("log"), "mode", "console")
- if err != nil {
- return err
- }
- // split on comma
- logModes := strings.Split(logModeStr, ",")
- // also try space
- if len(logModes) == 1 {
- logModes = strings.Split(logModeStr, " ")
- }
- logsPath, err := valueAsString(file.Section("paths"), "logs", "")
- if err != nil {
- return err
- }
- cfg.LogsPath = makeAbsolute(logsPath, HomePath)
- log.ReadLoggingConfig(logModes, cfg.LogsPath, file)
- return nil
- }
- func (cfg *Cfg) LogConfigSources() {
- var text bytes.Buffer
- for _, file := range configFiles {
- cfg.Logger.Info("Config loaded from", "file", file)
- }
- if len(appliedCommandLineProperties) > 0 {
- for _, prop := range appliedCommandLineProperties {
- cfg.Logger.Info("Config overridden from command line", "arg", prop)
- }
- }
- if len(appliedEnvOverrides) > 0 {
- text.WriteString("\tEnvironment variables used:\n")
- for _, prop := range appliedEnvOverrides {
- cfg.Logger.Info("Config overridden from Environment variable", "var", prop)
- }
- }
- cfg.Logger.Info("Path Home", "path", HomePath)
- cfg.Logger.Info("Path Data", "path", cfg.DataPath)
- cfg.Logger.Info("Path Logs", "path", cfg.LogsPath)
- cfg.Logger.Info("Path Plugins", "path", PluginsPath)
- cfg.Logger.Info("Path Provisioning", "path", cfg.ProvisioningPath)
- cfg.Logger.Info("App mode " + Env)
- }
|