setting.go 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865
  1. // Copyright 2014 Unknwon
  2. // Copyright 2014 Torkel Ödegaard
  3. package setting
  4. import (
  5. "bytes"
  6. "fmt"
  7. "net/http"
  8. "net/url"
  9. "os"
  10. "path"
  11. "path/filepath"
  12. "regexp"
  13. "runtime"
  14. "strings"
  15. "time"
  16. "github.com/go-macaron/session"
  17. "github.com/grafana/grafana/pkg/log"
  18. "github.com/grafana/grafana/pkg/util"
  19. ini "gopkg.in/ini.v1"
  20. )
  21. type Scheme string
  22. const (
  23. HTTP Scheme = "http"
  24. HTTPS Scheme = "https"
  25. SOCKET Scheme = "socket"
  26. DEFAULT_HTTP_ADDR string = "0.0.0.0"
  27. )
  28. const (
  29. DEV = "development"
  30. PROD = "production"
  31. TEST = "test"
  32. APP_NAME = "Grafana"
  33. APP_NAME_ENTERPRISE = "Grafana Enterprise"
  34. )
  35. var (
  36. ERR_TEMPLATE_NAME = "error"
  37. )
  38. var (
  39. // App settings.
  40. Env = DEV
  41. AppUrl string
  42. AppSubUrl string
  43. InstanceName string
  44. // build
  45. BuildVersion string
  46. BuildCommit string
  47. BuildBranch string
  48. BuildStamp int64
  49. IsEnterprise bool
  50. ApplicationName string
  51. // packaging
  52. Packaging = "unknown"
  53. // Paths
  54. HomePath string
  55. PluginsPath string
  56. CustomInitPath = "conf/custom.ini"
  57. // Log settings.
  58. LogConfigs []util.DynMap
  59. // Http server options
  60. Protocol Scheme
  61. Domain string
  62. HttpAddr, HttpPort string
  63. SshPort int
  64. CertFile, KeyFile string
  65. SocketPath string
  66. RouterLogging bool
  67. DataProxyLogging bool
  68. DataProxyTimeout int
  69. StaticRootPath string
  70. EnableGzip bool
  71. EnforceDomain bool
  72. // Security settings.
  73. SecretKey string
  74. DisableGravatar bool
  75. EmailCodeValidMinutes int
  76. DataProxyWhiteList map[string]bool
  77. DisableBruteForceLoginProtection bool
  78. CookieSecure bool
  79. CookieSameSite http.SameSite
  80. // Snapshots
  81. ExternalSnapshotUrl string
  82. ExternalSnapshotName string
  83. ExternalEnabled bool
  84. SnapShotRemoveExpired bool
  85. // Dashboard history
  86. DashboardVersionsToKeep int
  87. // User settings
  88. AllowUserSignUp bool
  89. AllowUserOrgCreate bool
  90. AutoAssignOrg bool
  91. AutoAssignOrgId int
  92. AutoAssignOrgRole string
  93. VerifyEmailEnabled bool
  94. LoginHint string
  95. PasswordHint string
  96. DefaultTheme string
  97. DisableLoginForm bool
  98. DisableSignoutMenu bool
  99. SignoutRedirectUrl string
  100. ExternalUserMngLinkUrl string
  101. ExternalUserMngLinkName string
  102. ExternalUserMngInfo string
  103. OAuthAutoLogin bool
  104. ViewersCanEdit bool
  105. // Http auth
  106. AdminUser string
  107. AdminPassword string
  108. LoginCookieName string
  109. LoginMaxLifetimeDays int
  110. AnonymousEnabled bool
  111. AnonymousOrgName string
  112. AnonymousOrgRole string
  113. // Auth proxy settings
  114. AuthProxyEnabled bool
  115. AuthProxyHeaderName string
  116. AuthProxyHeaderProperty string
  117. AuthProxyAutoSignUp bool
  118. AuthProxyLdapSyncTtl int
  119. AuthProxyWhitelist string
  120. AuthProxyHeaders map[string]string
  121. // Basic Auth
  122. BasicAuthEnabled bool
  123. // Plugin settings
  124. PluginAppsSkipVerifyTLS bool
  125. // Session settings.
  126. SessionOptions session.Options
  127. SessionConnMaxLifetime int64
  128. // Global setting objects.
  129. Raw *ini.File
  130. ConfRootPath string
  131. IsWindows bool
  132. // for logging purposes
  133. configFiles []string
  134. appliedCommandLineProperties []string
  135. appliedEnvOverrides []string
  136. ReportingEnabled bool
  137. CheckForUpdates bool
  138. GoogleAnalyticsId string
  139. GoogleTagManagerId string
  140. // LDAP
  141. LdapEnabled bool
  142. LdapConfigFile string
  143. LdapAllowSignup = true
  144. // QUOTA
  145. Quota QuotaSettings
  146. // Alerting
  147. AlertingEnabled bool
  148. ExecuteAlerts bool
  149. AlertingRenderLimit int
  150. AlertingErrorOrTimeout string
  151. AlertingNoDataOrNullValues string
  152. // Explore UI
  153. ExploreEnabled bool
  154. // logger
  155. logger log.Logger
  156. // Grafana.NET URL
  157. GrafanaComUrl string
  158. // S3 temp image store
  159. S3TempImageStoreBucketUrl string
  160. S3TempImageStoreAccessKey string
  161. S3TempImageStoreSecretKey string
  162. ImageUploadProvider string
  163. )
  164. // TODO move all global vars to this struct
  165. type Cfg struct {
  166. Raw *ini.File
  167. // HTTP Server Settings
  168. AppUrl string
  169. AppSubUrl string
  170. // Paths
  171. ProvisioningPath string
  172. DataPath string
  173. LogsPath string
  174. // SMTP email settings
  175. Smtp SmtpSettings
  176. // Rendering
  177. ImagesDir string
  178. PhantomDir string
  179. RendererUrl string
  180. RendererCallbackUrl string
  181. RendererLimit int
  182. RendererLimitAlerting int
  183. // Security
  184. DisableBruteForceLoginProtection bool
  185. CookieSecure bool
  186. CookieSameSite http.SameSite
  187. TempDataLifetime time.Duration
  188. MetricsEndpointEnabled bool
  189. MetricsEndpointBasicAuthUsername string
  190. MetricsEndpointBasicAuthPassword string
  191. EnableAlphaPanels bool
  192. DisableSanitizeHtml bool
  193. EnterpriseLicensePath string
  194. // Auth
  195. LoginCookieName string
  196. LoginMaxInactiveLifetimeDays int
  197. LoginMaxLifetimeDays int
  198. TokenRotationIntervalMinutes int
  199. // Dataproxy
  200. SendUserHeader bool
  201. // DistributedCache
  202. RemoteCacheOptions *RemoteCacheOptions
  203. EditorsCanAdmin bool
  204. }
  205. type CommandLineArgs struct {
  206. Config string
  207. HomePath string
  208. Args []string
  209. }
  210. func init() {
  211. IsWindows = runtime.GOOS == "windows"
  212. logger = log.New("settings")
  213. }
  214. func parseAppUrlAndSubUrl(section *ini.Section) (string, string) {
  215. appUrl := section.Key("root_url").MustString("http://localhost:3000/")
  216. if appUrl[len(appUrl)-1] != '/' {
  217. appUrl += "/"
  218. }
  219. // Check if has app suburl.
  220. url, err := url.Parse(appUrl)
  221. if err != nil {
  222. log.Fatal(4, "Invalid root_url(%s): %s", appUrl, err)
  223. }
  224. appSubUrl := strings.TrimSuffix(url.Path, "/")
  225. return appUrl, appSubUrl
  226. }
  227. func ToAbsUrl(relativeUrl string) string {
  228. return AppUrl + relativeUrl
  229. }
  230. func shouldRedactKey(s string) bool {
  231. uppercased := strings.ToUpper(s)
  232. return strings.Contains(uppercased, "PASSWORD") || strings.Contains(uppercased, "SECRET") || strings.Contains(uppercased, "PROVIDER_CONFIG")
  233. }
  234. func shouldRedactURLKey(s string) bool {
  235. uppercased := strings.ToUpper(s)
  236. return strings.Contains(uppercased, "DATABASE_URL")
  237. }
  238. func applyEnvVariableOverrides(file *ini.File) error {
  239. appliedEnvOverrides = make([]string, 0)
  240. for _, section := range file.Sections() {
  241. for _, key := range section.Keys() {
  242. sectionName := strings.ToUpper(strings.Replace(section.Name(), ".", "_", -1))
  243. keyName := strings.ToUpper(strings.Replace(key.Name(), ".", "_", -1))
  244. envKey := fmt.Sprintf("GF_%s_%s", sectionName, keyName)
  245. envValue := os.Getenv(envKey)
  246. if len(envValue) > 0 {
  247. key.SetValue(envValue)
  248. if shouldRedactKey(envKey) {
  249. envValue = "*********"
  250. }
  251. if shouldRedactURLKey(envKey) {
  252. u, err := url.Parse(envValue)
  253. if err != nil {
  254. return fmt.Errorf("could not parse environment variable. key: %s, value: %s. error: %v", envKey, envValue, err)
  255. }
  256. ui := u.User
  257. if ui != nil {
  258. _, exists := ui.Password()
  259. if exists {
  260. u.User = url.UserPassword(ui.Username(), "-redacted-")
  261. envValue = u.String()
  262. }
  263. }
  264. }
  265. appliedEnvOverrides = append(appliedEnvOverrides, fmt.Sprintf("%s=%s", envKey, envValue))
  266. }
  267. }
  268. }
  269. return nil
  270. }
  271. func applyCommandLineDefaultProperties(props map[string]string, file *ini.File) {
  272. appliedCommandLineProperties = make([]string, 0)
  273. for _, section := range file.Sections() {
  274. for _, key := range section.Keys() {
  275. keyString := fmt.Sprintf("default.%s.%s", section.Name(), key.Name())
  276. value, exists := props[keyString]
  277. if exists {
  278. key.SetValue(value)
  279. if shouldRedactKey(keyString) {
  280. value = "*********"
  281. }
  282. appliedCommandLineProperties = append(appliedCommandLineProperties, fmt.Sprintf("%s=%s", keyString, value))
  283. }
  284. }
  285. }
  286. }
  287. func applyCommandLineProperties(props map[string]string, file *ini.File) {
  288. for _, section := range file.Sections() {
  289. sectionName := section.Name() + "."
  290. if section.Name() == ini.DEFAULT_SECTION {
  291. sectionName = ""
  292. }
  293. for _, key := range section.Keys() {
  294. keyString := sectionName + key.Name()
  295. value, exists := props[keyString]
  296. if exists {
  297. appliedCommandLineProperties = append(appliedCommandLineProperties, fmt.Sprintf("%s=%s", keyString, value))
  298. key.SetValue(value)
  299. }
  300. }
  301. }
  302. }
  303. func getCommandLineProperties(args []string) map[string]string {
  304. props := make(map[string]string)
  305. for _, arg := range args {
  306. if !strings.HasPrefix(arg, "cfg:") {
  307. continue
  308. }
  309. trimmed := strings.TrimPrefix(arg, "cfg:")
  310. parts := strings.Split(trimmed, "=")
  311. if len(parts) != 2 {
  312. log.Fatal(3, "Invalid command line argument. argument: %v", arg)
  313. return nil
  314. }
  315. props[parts[0]] = parts[1]
  316. }
  317. return props
  318. }
  319. func makeAbsolute(path string, root string) string {
  320. if filepath.IsAbs(path) {
  321. return path
  322. }
  323. return filepath.Join(root, path)
  324. }
  325. func evalEnvVarExpression(value string) string {
  326. regex := regexp.MustCompile(`\${(\w+)}`)
  327. return regex.ReplaceAllStringFunc(value, func(envVar string) string {
  328. envVar = strings.TrimPrefix(envVar, "${")
  329. envVar = strings.TrimSuffix(envVar, "}")
  330. envValue := os.Getenv(envVar)
  331. // if env variable is hostname and it is empty use os.Hostname as default
  332. if envVar == "HOSTNAME" && envValue == "" {
  333. envValue, _ = os.Hostname()
  334. }
  335. return envValue
  336. })
  337. }
  338. func evalConfigValues(file *ini.File) {
  339. for _, section := range file.Sections() {
  340. for _, key := range section.Keys() {
  341. key.SetValue(evalEnvVarExpression(key.Value()))
  342. }
  343. }
  344. }
  345. func loadSpecifedConfigFile(configFile string, masterFile *ini.File) error {
  346. if configFile == "" {
  347. configFile = filepath.Join(HomePath, CustomInitPath)
  348. // return without error if custom file does not exist
  349. if !pathExists(configFile) {
  350. return nil
  351. }
  352. }
  353. userConfig, err := ini.Load(configFile)
  354. if err != nil {
  355. return fmt.Errorf("Failed to parse %v, %v", configFile, err)
  356. }
  357. userConfig.BlockMode = false
  358. for _, section := range userConfig.Sections() {
  359. for _, key := range section.Keys() {
  360. if key.Value() == "" {
  361. continue
  362. }
  363. defaultSec, err := masterFile.GetSection(section.Name())
  364. if err != nil {
  365. defaultSec, _ = masterFile.NewSection(section.Name())
  366. }
  367. defaultKey, err := defaultSec.GetKey(key.Name())
  368. if err != nil {
  369. defaultKey, _ = defaultSec.NewKey(key.Name(), key.Value())
  370. }
  371. defaultKey.SetValue(key.Value())
  372. }
  373. }
  374. configFiles = append(configFiles, configFile)
  375. return nil
  376. }
  377. func (cfg *Cfg) loadConfiguration(args *CommandLineArgs) (*ini.File, error) {
  378. var err error
  379. // load config defaults
  380. defaultConfigFile := path.Join(HomePath, "conf/defaults.ini")
  381. configFiles = append(configFiles, defaultConfigFile)
  382. // check if config file exists
  383. if _, err := os.Stat(defaultConfigFile); os.IsNotExist(err) {
  384. fmt.Println("Grafana-server Init Failed: Could not find config defaults, make sure homepath command line parameter is set or working directory is homepath")
  385. os.Exit(1)
  386. }
  387. // load defaults
  388. parsedFile, err := ini.Load(defaultConfigFile)
  389. if err != nil {
  390. fmt.Println(fmt.Sprintf("Failed to parse defaults.ini, %v", err))
  391. os.Exit(1)
  392. return nil, err
  393. }
  394. parsedFile.BlockMode = false
  395. // command line props
  396. commandLineProps := getCommandLineProperties(args.Args)
  397. // load default overrides
  398. applyCommandLineDefaultProperties(commandLineProps, parsedFile)
  399. // load specified config file
  400. err = loadSpecifedConfigFile(args.Config, parsedFile)
  401. if err != nil {
  402. cfg.initLogging(parsedFile)
  403. log.Fatal(3, err.Error())
  404. }
  405. // apply environment overrides
  406. err = applyEnvVariableOverrides(parsedFile)
  407. if err != nil {
  408. return nil, err
  409. }
  410. // apply command line overrides
  411. applyCommandLineProperties(commandLineProps, parsedFile)
  412. // evaluate config values containing environment variables
  413. evalConfigValues(parsedFile)
  414. // update data path and logging config
  415. cfg.DataPath = makeAbsolute(parsedFile.Section("paths").Key("data").String(), HomePath)
  416. cfg.initLogging(parsedFile)
  417. return parsedFile, err
  418. }
  419. func pathExists(path string) bool {
  420. _, err := os.Stat(path)
  421. if err == nil {
  422. return true
  423. }
  424. if os.IsNotExist(err) {
  425. return false
  426. }
  427. return false
  428. }
  429. func setHomePath(args *CommandLineArgs) {
  430. if args.HomePath != "" {
  431. HomePath = args.HomePath
  432. return
  433. }
  434. HomePath, _ = filepath.Abs(".")
  435. // check if homepath is correct
  436. if pathExists(filepath.Join(HomePath, "conf/defaults.ini")) {
  437. return
  438. }
  439. // try down one path
  440. if pathExists(filepath.Join(HomePath, "../conf/defaults.ini")) {
  441. HomePath = filepath.Join(HomePath, "../")
  442. }
  443. }
  444. var skipStaticRootValidation = false
  445. func validateStaticRootPath() error {
  446. if skipStaticRootValidation {
  447. return nil
  448. }
  449. if _, err := os.Stat(path.Join(StaticRootPath, "build")); err != nil {
  450. logger.Error("Failed to detect generated javascript files in public/build")
  451. }
  452. return nil
  453. }
  454. func NewCfg() *Cfg {
  455. return &Cfg{
  456. Raw: ini.Empty(),
  457. }
  458. }
  459. func (cfg *Cfg) Load(args *CommandLineArgs) error {
  460. setHomePath(args)
  461. iniFile, err := cfg.loadConfiguration(args)
  462. if err != nil {
  463. return err
  464. }
  465. cfg.Raw = iniFile
  466. // Temporary keep global, to make refactor in steps
  467. Raw = cfg.Raw
  468. ApplicationName = APP_NAME
  469. if IsEnterprise {
  470. ApplicationName = APP_NAME_ENTERPRISE
  471. }
  472. Env = iniFile.Section("").Key("app_mode").MustString("development")
  473. InstanceName = iniFile.Section("").Key("instance_name").MustString("unknown_instance_name")
  474. PluginsPath = makeAbsolute(iniFile.Section("paths").Key("plugins").String(), HomePath)
  475. cfg.ProvisioningPath = makeAbsolute(iniFile.Section("paths").Key("provisioning").String(), HomePath)
  476. server := iniFile.Section("server")
  477. AppUrl, AppSubUrl = parseAppUrlAndSubUrl(server)
  478. cfg.AppUrl = AppUrl
  479. cfg.AppSubUrl = AppSubUrl
  480. Protocol = HTTP
  481. if server.Key("protocol").MustString("http") == "https" {
  482. Protocol = HTTPS
  483. CertFile = server.Key("cert_file").String()
  484. KeyFile = server.Key("cert_key").String()
  485. }
  486. if server.Key("protocol").MustString("http") == "socket" {
  487. Protocol = SOCKET
  488. SocketPath = server.Key("socket").String()
  489. }
  490. Domain = server.Key("domain").MustString("localhost")
  491. HttpAddr = server.Key("http_addr").MustString(DEFAULT_HTTP_ADDR)
  492. HttpPort = server.Key("http_port").MustString("3000")
  493. RouterLogging = server.Key("router_logging").MustBool(false)
  494. EnableGzip = server.Key("enable_gzip").MustBool(false)
  495. EnforceDomain = server.Key("enforce_domain").MustBool(false)
  496. StaticRootPath = makeAbsolute(server.Key("static_root_path").String(), HomePath)
  497. if err := validateStaticRootPath(); err != nil {
  498. return err
  499. }
  500. // read data proxy settings
  501. dataproxy := iniFile.Section("dataproxy")
  502. DataProxyLogging = dataproxy.Key("logging").MustBool(false)
  503. DataProxyTimeout = dataproxy.Key("timeout").MustInt(30)
  504. cfg.SendUserHeader = dataproxy.Key("send_user_header").MustBool(false)
  505. // read security settings
  506. security := iniFile.Section("security")
  507. SecretKey = security.Key("secret_key").String()
  508. DisableGravatar = security.Key("disable_gravatar").MustBool(true)
  509. cfg.DisableBruteForceLoginProtection = security.Key("disable_brute_force_login_protection").MustBool(false)
  510. DisableBruteForceLoginProtection = cfg.DisableBruteForceLoginProtection
  511. CookieSecure = security.Key("cookie_secure").MustBool(false)
  512. cfg.CookieSecure = CookieSecure
  513. samesiteString := security.Key("cookie_samesite").MustString("lax")
  514. validSameSiteValues := map[string]http.SameSite{
  515. "lax": http.SameSiteLaxMode,
  516. "strict": http.SameSiteStrictMode,
  517. "none": http.SameSiteDefaultMode,
  518. }
  519. if samesite, ok := validSameSiteValues[samesiteString]; ok {
  520. CookieSameSite = samesite
  521. cfg.CookieSameSite = CookieSameSite
  522. } else {
  523. CookieSameSite = http.SameSiteLaxMode
  524. cfg.CookieSameSite = CookieSameSite
  525. }
  526. // read snapshots settings
  527. snapshots := iniFile.Section("snapshots")
  528. ExternalSnapshotUrl = snapshots.Key("external_snapshot_url").String()
  529. ExternalSnapshotName = snapshots.Key("external_snapshot_name").String()
  530. ExternalEnabled = snapshots.Key("external_enabled").MustBool(true)
  531. SnapShotRemoveExpired = snapshots.Key("snapshot_remove_expired").MustBool(true)
  532. // read dashboard settings
  533. dashboards := iniFile.Section("dashboards")
  534. DashboardVersionsToKeep = dashboards.Key("versions_to_keep").MustInt(20)
  535. // read data source proxy white list
  536. DataProxyWhiteList = make(map[string]bool)
  537. for _, hostAndIp := range util.SplitString(security.Key("data_source_proxy_whitelist").String()) {
  538. DataProxyWhiteList[hostAndIp] = true
  539. }
  540. // admin
  541. AdminUser = security.Key("admin_user").String()
  542. AdminPassword = security.Key("admin_password").String()
  543. // users
  544. users := iniFile.Section("users")
  545. AllowUserSignUp = users.Key("allow_sign_up").MustBool(true)
  546. AllowUserOrgCreate = users.Key("allow_org_create").MustBool(true)
  547. AutoAssignOrg = users.Key("auto_assign_org").MustBool(true)
  548. AutoAssignOrgId = users.Key("auto_assign_org_id").MustInt(1)
  549. AutoAssignOrgRole = users.Key("auto_assign_org_role").In("Editor", []string{"Editor", "Admin", "Viewer"})
  550. VerifyEmailEnabled = users.Key("verify_email_enabled").MustBool(false)
  551. LoginHint = users.Key("login_hint").String()
  552. PasswordHint = users.Key("password_hint").String()
  553. DefaultTheme = users.Key("default_theme").String()
  554. ExternalUserMngLinkUrl = users.Key("external_manage_link_url").String()
  555. ExternalUserMngLinkName = users.Key("external_manage_link_name").String()
  556. ExternalUserMngInfo = users.Key("external_manage_info").String()
  557. ViewersCanEdit = users.Key("viewers_can_edit").MustBool(false)
  558. cfg.EditorsCanAdmin = users.Key("editors_can_admin").MustBool(false)
  559. // auth
  560. auth := iniFile.Section("auth")
  561. LoginCookieName = auth.Key("login_cookie_name").MustString("grafana_session")
  562. cfg.LoginCookieName = LoginCookieName
  563. cfg.LoginMaxInactiveLifetimeDays = auth.Key("login_maximum_inactive_lifetime_days").MustInt(7)
  564. LoginMaxLifetimeDays = auth.Key("login_maximum_lifetime_days").MustInt(30)
  565. cfg.LoginMaxLifetimeDays = LoginMaxLifetimeDays
  566. cfg.TokenRotationIntervalMinutes = auth.Key("token_rotation_interval_minutes").MustInt(10)
  567. if cfg.TokenRotationIntervalMinutes < 2 {
  568. cfg.TokenRotationIntervalMinutes = 2
  569. }
  570. DisableLoginForm = auth.Key("disable_login_form").MustBool(false)
  571. DisableSignoutMenu = auth.Key("disable_signout_menu").MustBool(false)
  572. OAuthAutoLogin = auth.Key("oauth_auto_login").MustBool(false)
  573. SignoutRedirectUrl = auth.Key("signout_redirect_url").String()
  574. // anonymous access
  575. AnonymousEnabled = iniFile.Section("auth.anonymous").Key("enabled").MustBool(false)
  576. AnonymousOrgName = iniFile.Section("auth.anonymous").Key("org_name").String()
  577. AnonymousOrgRole = iniFile.Section("auth.anonymous").Key("org_role").String()
  578. // auth proxy
  579. authProxy := iniFile.Section("auth.proxy")
  580. AuthProxyEnabled = authProxy.Key("enabled").MustBool(false)
  581. AuthProxyHeaderName = authProxy.Key("header_name").String()
  582. AuthProxyHeaderProperty = authProxy.Key("header_property").String()
  583. AuthProxyAutoSignUp = authProxy.Key("auto_sign_up").MustBool(true)
  584. AuthProxyLdapSyncTtl = authProxy.Key("ldap_sync_ttl").MustInt()
  585. AuthProxyWhitelist = authProxy.Key("whitelist").String()
  586. AuthProxyHeaders = make(map[string]string)
  587. for _, propertyAndHeader := range util.SplitString(authProxy.Key("headers").String()) {
  588. split := strings.SplitN(propertyAndHeader, ":", 2)
  589. if len(split) == 2 {
  590. AuthProxyHeaders[split[0]] = split[1]
  591. }
  592. }
  593. // basic auth
  594. authBasic := iniFile.Section("auth.basic")
  595. BasicAuthEnabled = authBasic.Key("enabled").MustBool(true)
  596. // global plugin settings
  597. PluginAppsSkipVerifyTLS = iniFile.Section("plugins").Key("app_tls_skip_verify_insecure").MustBool(false)
  598. // Rendering
  599. renderSec := iniFile.Section("rendering")
  600. cfg.RendererUrl = renderSec.Key("server_url").String()
  601. cfg.RendererCallbackUrl = renderSec.Key("callback_url").String()
  602. if cfg.RendererCallbackUrl == "" {
  603. cfg.RendererCallbackUrl = AppUrl
  604. } else {
  605. if cfg.RendererCallbackUrl[len(cfg.RendererCallbackUrl)-1] != '/' {
  606. cfg.RendererCallbackUrl += "/"
  607. }
  608. _, err := url.Parse(cfg.RendererCallbackUrl)
  609. if err != nil {
  610. log.Fatal(4, "Invalid callback_url(%s): %s", cfg.RendererCallbackUrl, err)
  611. }
  612. }
  613. cfg.ImagesDir = filepath.Join(cfg.DataPath, "png")
  614. cfg.PhantomDir = filepath.Join(HomePath, "tools/phantomjs")
  615. cfg.TempDataLifetime = iniFile.Section("paths").Key("temp_data_lifetime").MustDuration(time.Second * 3600 * 24)
  616. cfg.MetricsEndpointEnabled = iniFile.Section("metrics").Key("enabled").MustBool(true)
  617. cfg.MetricsEndpointBasicAuthUsername = iniFile.Section("metrics").Key("basic_auth_username").String()
  618. cfg.MetricsEndpointBasicAuthPassword = iniFile.Section("metrics").Key("basic_auth_password").String()
  619. analytics := iniFile.Section("analytics")
  620. ReportingEnabled = analytics.Key("reporting_enabled").MustBool(true)
  621. CheckForUpdates = analytics.Key("check_for_updates").MustBool(true)
  622. GoogleAnalyticsId = analytics.Key("google_analytics_ua_id").String()
  623. GoogleTagManagerId = analytics.Key("google_tag_manager_id").String()
  624. ldapSec := iniFile.Section("auth.ldap")
  625. LdapEnabled = ldapSec.Key("enabled").MustBool(false)
  626. LdapConfigFile = ldapSec.Key("config_file").String()
  627. LdapAllowSignup = ldapSec.Key("allow_sign_up").MustBool(true)
  628. alerting := iniFile.Section("alerting")
  629. AlertingEnabled = alerting.Key("enabled").MustBool(true)
  630. ExecuteAlerts = alerting.Key("execute_alerts").MustBool(true)
  631. AlertingRenderLimit = alerting.Key("concurrent_render_limit").MustInt(5)
  632. AlertingErrorOrTimeout = alerting.Key("error_or_timeout").MustString("alerting")
  633. AlertingNoDataOrNullValues = alerting.Key("nodata_or_nullvalues").MustString("no_data")
  634. explore := iniFile.Section("explore")
  635. ExploreEnabled = explore.Key("enabled").MustBool(true)
  636. panels := iniFile.Section("panels")
  637. cfg.EnableAlphaPanels = panels.Key("enable_alpha").MustBool(false)
  638. cfg.DisableSanitizeHtml = panels.Key("disable_sanitize_html").MustBool(false)
  639. cfg.readSessionConfig()
  640. cfg.readSmtpSettings()
  641. cfg.readQuotaSettings()
  642. if VerifyEmailEnabled && !cfg.Smtp.Enabled {
  643. log.Warn("require_email_validation is enabled but smtp is disabled")
  644. }
  645. // check old key name
  646. GrafanaComUrl = iniFile.Section("grafana_net").Key("url").MustString("")
  647. if GrafanaComUrl == "" {
  648. GrafanaComUrl = iniFile.Section("grafana_com").Key("url").MustString("https://grafana.com")
  649. }
  650. imageUploadingSection := iniFile.Section("external_image_storage")
  651. ImageUploadProvider = imageUploadingSection.Key("provider").MustString("")
  652. enterprise := iniFile.Section("enterprise")
  653. cfg.EnterpriseLicensePath = enterprise.Key("license_path").MustString(filepath.Join(cfg.DataPath, "license.jwt"))
  654. cacheServer := iniFile.Section("remote_cache")
  655. cfg.RemoteCacheOptions = &RemoteCacheOptions{
  656. Name: cacheServer.Key("type").MustString("database"),
  657. ConnStr: cacheServer.Key("connstr").MustString(""),
  658. }
  659. return nil
  660. }
  661. type RemoteCacheOptions struct {
  662. Name string
  663. ConnStr string
  664. }
  665. func (cfg *Cfg) readSessionConfig() {
  666. sec := cfg.Raw.Section("session")
  667. SessionOptions = session.Options{}
  668. SessionOptions.Provider = sec.Key("provider").In("memory", []string{"memory", "file", "redis", "mysql", "postgres", "memcache"})
  669. SessionOptions.ProviderConfig = strings.Trim(sec.Key("provider_config").String(), "\" ")
  670. SessionOptions.CookieName = sec.Key("cookie_name").MustString("grafana_sess")
  671. SessionOptions.CookiePath = AppSubUrl
  672. SessionOptions.Secure = sec.Key("cookie_secure").MustBool()
  673. SessionOptions.Gclifetime = cfg.Raw.Section("session").Key("gc_interval_time").MustInt64(86400)
  674. SessionOptions.Maxlifetime = cfg.Raw.Section("session").Key("session_life_time").MustInt64(86400)
  675. SessionOptions.IDLength = 16
  676. if SessionOptions.Provider == "file" {
  677. SessionOptions.ProviderConfig = makeAbsolute(SessionOptions.ProviderConfig, cfg.DataPath)
  678. os.MkdirAll(path.Dir(SessionOptions.ProviderConfig), os.ModePerm)
  679. }
  680. if SessionOptions.CookiePath == "" {
  681. SessionOptions.CookiePath = "/"
  682. }
  683. SessionConnMaxLifetime = cfg.Raw.Section("session").Key("conn_max_lifetime").MustInt64(14400)
  684. }
  685. func (cfg *Cfg) initLogging(file *ini.File) {
  686. // split on comma
  687. logModes := strings.Split(file.Section("log").Key("mode").MustString("console"), ",")
  688. // also try space
  689. if len(logModes) == 1 {
  690. logModes = strings.Split(file.Section("log").Key("mode").MustString("console"), " ")
  691. }
  692. cfg.LogsPath = makeAbsolute(file.Section("paths").Key("logs").String(), HomePath)
  693. log.ReadLoggingConfig(logModes, cfg.LogsPath, file)
  694. }
  695. func (cfg *Cfg) LogConfigSources() {
  696. var text bytes.Buffer
  697. for _, file := range configFiles {
  698. logger.Info("Config loaded from", "file", file)
  699. }
  700. if len(appliedCommandLineProperties) > 0 {
  701. for _, prop := range appliedCommandLineProperties {
  702. logger.Info("Config overridden from command line", "arg", prop)
  703. }
  704. }
  705. if len(appliedEnvOverrides) > 0 {
  706. text.WriteString("\tEnvironment variables used:\n")
  707. for _, prop := range appliedEnvOverrides {
  708. logger.Info("Config overridden from Environment variable", "var", prop)
  709. }
  710. }
  711. logger.Info("Path Home", "path", HomePath)
  712. logger.Info("Path Data", "path", cfg.DataPath)
  713. logger.Info("Path Logs", "path", cfg.LogsPath)
  714. logger.Info("Path Plugins", "path", PluginsPath)
  715. logger.Info("Path Provisioning", "path", cfg.ProvisioningPath)
  716. logger.Info("App mode " + Env)
  717. }