setting.go 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862
  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. // User
  200. EditorsCanOwn bool
  201. // DistributedCache
  202. RemoteCacheOptions *RemoteCacheOptions
  203. }
  204. type CommandLineArgs struct {
  205. Config string
  206. HomePath string
  207. Args []string
  208. }
  209. func init() {
  210. IsWindows = runtime.GOOS == "windows"
  211. logger = log.New("settings")
  212. }
  213. func parseAppUrlAndSubUrl(section *ini.Section) (string, string) {
  214. appUrl := section.Key("root_url").MustString("http://localhost:3000/")
  215. if appUrl[len(appUrl)-1] != '/' {
  216. appUrl += "/"
  217. }
  218. // Check if has app suburl.
  219. url, err := url.Parse(appUrl)
  220. if err != nil {
  221. log.Fatal(4, "Invalid root_url(%s): %s", appUrl, err)
  222. }
  223. appSubUrl := strings.TrimSuffix(url.Path, "/")
  224. return appUrl, appSubUrl
  225. }
  226. func ToAbsUrl(relativeUrl string) string {
  227. return AppUrl + relativeUrl
  228. }
  229. func shouldRedactKey(s string) bool {
  230. uppercased := strings.ToUpper(s)
  231. return strings.Contains(uppercased, "PASSWORD") || strings.Contains(uppercased, "SECRET") || strings.Contains(uppercased, "PROVIDER_CONFIG")
  232. }
  233. func shouldRedactURLKey(s string) bool {
  234. uppercased := strings.ToUpper(s)
  235. return strings.Contains(uppercased, "DATABASE_URL")
  236. }
  237. func applyEnvVariableOverrides(file *ini.File) error {
  238. appliedEnvOverrides = make([]string, 0)
  239. for _, section := range file.Sections() {
  240. for _, key := range section.Keys() {
  241. sectionName := strings.ToUpper(strings.Replace(section.Name(), ".", "_", -1))
  242. keyName := strings.ToUpper(strings.Replace(key.Name(), ".", "_", -1))
  243. envKey := fmt.Sprintf("GF_%s_%s", sectionName, keyName)
  244. envValue := os.Getenv(envKey)
  245. if len(envValue) > 0 {
  246. key.SetValue(envValue)
  247. if shouldRedactKey(envKey) {
  248. envValue = "*********"
  249. }
  250. if shouldRedactURLKey(envKey) {
  251. u, err := url.Parse(envValue)
  252. if err != nil {
  253. return fmt.Errorf("could not parse environment variable. key: %s, value: %s. error: %v", envKey, envValue, err)
  254. }
  255. ui := u.User
  256. if ui != nil {
  257. _, exists := ui.Password()
  258. if exists {
  259. u.User = url.UserPassword(ui.Username(), "-redacted-")
  260. envValue = u.String()
  261. }
  262. }
  263. }
  264. appliedEnvOverrides = append(appliedEnvOverrides, fmt.Sprintf("%s=%s", envKey, envValue))
  265. }
  266. }
  267. }
  268. return nil
  269. }
  270. func applyCommandLineDefaultProperties(props map[string]string, file *ini.File) {
  271. appliedCommandLineProperties = make([]string, 0)
  272. for _, section := range file.Sections() {
  273. for _, key := range section.Keys() {
  274. keyString := fmt.Sprintf("default.%s.%s", section.Name(), key.Name())
  275. value, exists := props[keyString]
  276. if exists {
  277. key.SetValue(value)
  278. if shouldRedactKey(keyString) {
  279. value = "*********"
  280. }
  281. appliedCommandLineProperties = append(appliedCommandLineProperties, fmt.Sprintf("%s=%s", keyString, value))
  282. }
  283. }
  284. }
  285. }
  286. func applyCommandLineProperties(props map[string]string, file *ini.File) {
  287. for _, section := range file.Sections() {
  288. sectionName := section.Name() + "."
  289. if section.Name() == ini.DEFAULT_SECTION {
  290. sectionName = ""
  291. }
  292. for _, key := range section.Keys() {
  293. keyString := sectionName + key.Name()
  294. value, exists := props[keyString]
  295. if exists {
  296. appliedCommandLineProperties = append(appliedCommandLineProperties, fmt.Sprintf("%s=%s", keyString, value))
  297. key.SetValue(value)
  298. }
  299. }
  300. }
  301. }
  302. func getCommandLineProperties(args []string) map[string]string {
  303. props := make(map[string]string)
  304. for _, arg := range args {
  305. if !strings.HasPrefix(arg, "cfg:") {
  306. continue
  307. }
  308. trimmed := strings.TrimPrefix(arg, "cfg:")
  309. parts := strings.Split(trimmed, "=")
  310. if len(parts) != 2 {
  311. log.Fatal(3, "Invalid command line argument. argument: %v", arg)
  312. return nil
  313. }
  314. props[parts[0]] = parts[1]
  315. }
  316. return props
  317. }
  318. func makeAbsolute(path string, root string) string {
  319. if filepath.IsAbs(path) {
  320. return path
  321. }
  322. return filepath.Join(root, path)
  323. }
  324. func evalEnvVarExpression(value string) string {
  325. regex := regexp.MustCompile(`\${(\w+)}`)
  326. return regex.ReplaceAllStringFunc(value, func(envVar string) string {
  327. envVar = strings.TrimPrefix(envVar, "${")
  328. envVar = strings.TrimSuffix(envVar, "}")
  329. envValue := os.Getenv(envVar)
  330. // if env variable is hostname and it is empty use os.Hostname as default
  331. if envVar == "HOSTNAME" && envValue == "" {
  332. envValue, _ = os.Hostname()
  333. }
  334. return envValue
  335. })
  336. }
  337. func evalConfigValues(file *ini.File) {
  338. for _, section := range file.Sections() {
  339. for _, key := range section.Keys() {
  340. key.SetValue(evalEnvVarExpression(key.Value()))
  341. }
  342. }
  343. }
  344. func loadSpecifedConfigFile(configFile string, masterFile *ini.File) error {
  345. if configFile == "" {
  346. configFile = filepath.Join(HomePath, CustomInitPath)
  347. // return without error if custom file does not exist
  348. if !pathExists(configFile) {
  349. return nil
  350. }
  351. }
  352. userConfig, err := ini.Load(configFile)
  353. if err != nil {
  354. return fmt.Errorf("Failed to parse %v, %v", configFile, err)
  355. }
  356. userConfig.BlockMode = false
  357. for _, section := range userConfig.Sections() {
  358. for _, key := range section.Keys() {
  359. if key.Value() == "" {
  360. continue
  361. }
  362. defaultSec, err := masterFile.GetSection(section.Name())
  363. if err != nil {
  364. defaultSec, _ = masterFile.NewSection(section.Name())
  365. }
  366. defaultKey, err := defaultSec.GetKey(key.Name())
  367. if err != nil {
  368. defaultKey, _ = defaultSec.NewKey(key.Name(), key.Value())
  369. }
  370. defaultKey.SetValue(key.Value())
  371. }
  372. }
  373. configFiles = append(configFiles, configFile)
  374. return nil
  375. }
  376. func (cfg *Cfg) loadConfiguration(args *CommandLineArgs) (*ini.File, error) {
  377. var err error
  378. // load config defaults
  379. defaultConfigFile := path.Join(HomePath, "conf/defaults.ini")
  380. configFiles = append(configFiles, defaultConfigFile)
  381. // check if config file exists
  382. if _, err := os.Stat(defaultConfigFile); os.IsNotExist(err) {
  383. fmt.Println("Grafana-server Init Failed: Could not find config defaults, make sure homepath command line parameter is set or working directory is homepath")
  384. os.Exit(1)
  385. }
  386. // load defaults
  387. parsedFile, err := ini.Load(defaultConfigFile)
  388. if err != nil {
  389. fmt.Println(fmt.Sprintf("Failed to parse defaults.ini, %v", err))
  390. os.Exit(1)
  391. return nil, err
  392. }
  393. parsedFile.BlockMode = false
  394. // command line props
  395. commandLineProps := getCommandLineProperties(args.Args)
  396. // load default overrides
  397. applyCommandLineDefaultProperties(commandLineProps, parsedFile)
  398. // load specified config file
  399. err = loadSpecifedConfigFile(args.Config, parsedFile)
  400. if err != nil {
  401. cfg.initLogging(parsedFile)
  402. log.Fatal(3, err.Error())
  403. }
  404. // apply environment overrides
  405. err = applyEnvVariableOverrides(parsedFile)
  406. if err != nil {
  407. return nil, err
  408. }
  409. // apply command line overrides
  410. applyCommandLineProperties(commandLineProps, parsedFile)
  411. // evaluate config values containing environment variables
  412. evalConfigValues(parsedFile)
  413. // update data path and logging config
  414. cfg.DataPath = makeAbsolute(parsedFile.Section("paths").Key("data").String(), HomePath)
  415. cfg.initLogging(parsedFile)
  416. return parsedFile, err
  417. }
  418. func pathExists(path string) bool {
  419. _, err := os.Stat(path)
  420. if err == nil {
  421. return true
  422. }
  423. if os.IsNotExist(err) {
  424. return false
  425. }
  426. return false
  427. }
  428. func setHomePath(args *CommandLineArgs) {
  429. if args.HomePath != "" {
  430. HomePath = args.HomePath
  431. return
  432. }
  433. HomePath, _ = filepath.Abs(".")
  434. // check if homepath is correct
  435. if pathExists(filepath.Join(HomePath, "conf/defaults.ini")) {
  436. return
  437. }
  438. // try down one path
  439. if pathExists(filepath.Join(HomePath, "../conf/defaults.ini")) {
  440. HomePath = filepath.Join(HomePath, "../")
  441. }
  442. }
  443. var skipStaticRootValidation = false
  444. func validateStaticRootPath() error {
  445. if skipStaticRootValidation {
  446. return nil
  447. }
  448. if _, err := os.Stat(path.Join(StaticRootPath, "build")); err != nil {
  449. logger.Error("Failed to detect generated javascript files in public/build")
  450. }
  451. return nil
  452. }
  453. func NewCfg() *Cfg {
  454. return &Cfg{
  455. Raw: ini.Empty(),
  456. }
  457. }
  458. func (cfg *Cfg) Load(args *CommandLineArgs) error {
  459. setHomePath(args)
  460. iniFile, err := cfg.loadConfiguration(args)
  461. if err != nil {
  462. return err
  463. }
  464. cfg.Raw = iniFile
  465. // Temporary keep global, to make refactor in steps
  466. Raw = cfg.Raw
  467. ApplicationName = APP_NAME
  468. if IsEnterprise {
  469. ApplicationName = APP_NAME_ENTERPRISE
  470. }
  471. Env = iniFile.Section("").Key("app_mode").MustString("development")
  472. InstanceName = iniFile.Section("").Key("instance_name").MustString("unknown_instance_name")
  473. PluginsPath = makeAbsolute(iniFile.Section("paths").Key("plugins").String(), HomePath)
  474. cfg.ProvisioningPath = makeAbsolute(iniFile.Section("paths").Key("provisioning").String(), HomePath)
  475. server := iniFile.Section("server")
  476. AppUrl, AppSubUrl = parseAppUrlAndSubUrl(server)
  477. cfg.AppUrl = AppUrl
  478. cfg.AppSubUrl = AppSubUrl
  479. Protocol = HTTP
  480. if server.Key("protocol").MustString("http") == "https" {
  481. Protocol = HTTPS
  482. CertFile = server.Key("cert_file").String()
  483. KeyFile = server.Key("cert_key").String()
  484. }
  485. if server.Key("protocol").MustString("http") == "socket" {
  486. Protocol = SOCKET
  487. SocketPath = server.Key("socket").String()
  488. }
  489. Domain = server.Key("domain").MustString("localhost")
  490. HttpAddr = server.Key("http_addr").MustString(DEFAULT_HTTP_ADDR)
  491. HttpPort = server.Key("http_port").MustString("3000")
  492. RouterLogging = server.Key("router_logging").MustBool(false)
  493. EnableGzip = server.Key("enable_gzip").MustBool(false)
  494. EnforceDomain = server.Key("enforce_domain").MustBool(false)
  495. StaticRootPath = makeAbsolute(server.Key("static_root_path").String(), HomePath)
  496. if err := validateStaticRootPath(); err != nil {
  497. return err
  498. }
  499. // read data proxy settings
  500. dataproxy := iniFile.Section("dataproxy")
  501. DataProxyLogging = dataproxy.Key("logging").MustBool(false)
  502. DataProxyTimeout = dataproxy.Key("timeout").MustInt(30)
  503. // read security settings
  504. security := iniFile.Section("security")
  505. SecretKey = security.Key("secret_key").String()
  506. DisableGravatar = security.Key("disable_gravatar").MustBool(true)
  507. cfg.DisableBruteForceLoginProtection = security.Key("disable_brute_force_login_protection").MustBool(false)
  508. DisableBruteForceLoginProtection = cfg.DisableBruteForceLoginProtection
  509. CookieSecure = security.Key("cookie_secure").MustBool(false)
  510. cfg.CookieSecure = CookieSecure
  511. samesiteString := security.Key("cookie_samesite").MustString("lax")
  512. validSameSiteValues := map[string]http.SameSite{
  513. "lax": http.SameSiteLaxMode,
  514. "strict": http.SameSiteStrictMode,
  515. "none": http.SameSiteDefaultMode,
  516. }
  517. if samesite, ok := validSameSiteValues[samesiteString]; ok {
  518. CookieSameSite = samesite
  519. cfg.CookieSameSite = CookieSameSite
  520. } else {
  521. CookieSameSite = http.SameSiteLaxMode
  522. cfg.CookieSameSite = CookieSameSite
  523. }
  524. // read snapshots settings
  525. snapshots := iniFile.Section("snapshots")
  526. ExternalSnapshotUrl = snapshots.Key("external_snapshot_url").String()
  527. ExternalSnapshotName = snapshots.Key("external_snapshot_name").String()
  528. ExternalEnabled = snapshots.Key("external_enabled").MustBool(true)
  529. SnapShotRemoveExpired = snapshots.Key("snapshot_remove_expired").MustBool(true)
  530. // read dashboard settings
  531. dashboards := iniFile.Section("dashboards")
  532. DashboardVersionsToKeep = dashboards.Key("versions_to_keep").MustInt(20)
  533. // read data source proxy white list
  534. DataProxyWhiteList = make(map[string]bool)
  535. for _, hostAndIp := range util.SplitString(security.Key("data_source_proxy_whitelist").String()) {
  536. DataProxyWhiteList[hostAndIp] = true
  537. }
  538. // admin
  539. AdminUser = security.Key("admin_user").String()
  540. AdminPassword = security.Key("admin_password").String()
  541. // users
  542. users := iniFile.Section("users")
  543. AllowUserSignUp = users.Key("allow_sign_up").MustBool(true)
  544. AllowUserOrgCreate = users.Key("allow_org_create").MustBool(true)
  545. AutoAssignOrg = users.Key("auto_assign_org").MustBool(true)
  546. AutoAssignOrgId = users.Key("auto_assign_org_id").MustInt(1)
  547. AutoAssignOrgRole = users.Key("auto_assign_org_role").In("Editor", []string{"Editor", "Admin", "Viewer"})
  548. VerifyEmailEnabled = users.Key("verify_email_enabled").MustBool(false)
  549. LoginHint = users.Key("login_hint").String()
  550. PasswordHint = users.Key("password_hint").String()
  551. DefaultTheme = users.Key("default_theme").String()
  552. ExternalUserMngLinkUrl = users.Key("external_manage_link_url").String()
  553. ExternalUserMngLinkName = users.Key("external_manage_link_name").String()
  554. ExternalUserMngInfo = users.Key("external_manage_info").String()
  555. ViewersCanEdit = users.Key("viewers_can_edit").MustBool(false)
  556. cfg.EditorsCanOwn = users.Key("editors_can_own").MustBool(false)
  557. // auth
  558. auth := iniFile.Section("auth")
  559. LoginCookieName = auth.Key("login_cookie_name").MustString("grafana_session")
  560. cfg.LoginCookieName = LoginCookieName
  561. cfg.LoginMaxInactiveLifetimeDays = auth.Key("login_maximum_inactive_lifetime_days").MustInt(7)
  562. LoginMaxLifetimeDays = auth.Key("login_maximum_lifetime_days").MustInt(30)
  563. cfg.LoginMaxLifetimeDays = LoginMaxLifetimeDays
  564. cfg.TokenRotationIntervalMinutes = auth.Key("token_rotation_interval_minutes").MustInt(10)
  565. if cfg.TokenRotationIntervalMinutes < 2 {
  566. cfg.TokenRotationIntervalMinutes = 2
  567. }
  568. DisableLoginForm = auth.Key("disable_login_form").MustBool(false)
  569. DisableSignoutMenu = auth.Key("disable_signout_menu").MustBool(false)
  570. OAuthAutoLogin = auth.Key("oauth_auto_login").MustBool(false)
  571. SignoutRedirectUrl = auth.Key("signout_redirect_url").String()
  572. // anonymous access
  573. AnonymousEnabled = iniFile.Section("auth.anonymous").Key("enabled").MustBool(false)
  574. AnonymousOrgName = iniFile.Section("auth.anonymous").Key("org_name").String()
  575. AnonymousOrgRole = iniFile.Section("auth.anonymous").Key("org_role").String()
  576. // auth proxy
  577. authProxy := iniFile.Section("auth.proxy")
  578. AuthProxyEnabled = authProxy.Key("enabled").MustBool(false)
  579. AuthProxyHeaderName = authProxy.Key("header_name").String()
  580. AuthProxyHeaderProperty = authProxy.Key("header_property").String()
  581. AuthProxyAutoSignUp = authProxy.Key("auto_sign_up").MustBool(true)
  582. AuthProxyLdapSyncTtl = authProxy.Key("ldap_sync_ttl").MustInt()
  583. AuthProxyWhitelist = authProxy.Key("whitelist").String()
  584. AuthProxyHeaders = make(map[string]string)
  585. for _, propertyAndHeader := range util.SplitString(authProxy.Key("headers").String()) {
  586. split := strings.SplitN(propertyAndHeader, ":", 2)
  587. if len(split) == 2 {
  588. AuthProxyHeaders[split[0]] = split[1]
  589. }
  590. }
  591. // basic auth
  592. authBasic := iniFile.Section("auth.basic")
  593. BasicAuthEnabled = authBasic.Key("enabled").MustBool(true)
  594. // global plugin settings
  595. PluginAppsSkipVerifyTLS = iniFile.Section("plugins").Key("app_tls_skip_verify_insecure").MustBool(false)
  596. // Rendering
  597. renderSec := iniFile.Section("rendering")
  598. cfg.RendererUrl = renderSec.Key("server_url").String()
  599. cfg.RendererCallbackUrl = renderSec.Key("callback_url").String()
  600. if cfg.RendererCallbackUrl == "" {
  601. cfg.RendererCallbackUrl = AppUrl
  602. } else {
  603. if cfg.RendererCallbackUrl[len(cfg.RendererCallbackUrl)-1] != '/' {
  604. cfg.RendererCallbackUrl += "/"
  605. }
  606. _, err := url.Parse(cfg.RendererCallbackUrl)
  607. if err != nil {
  608. log.Fatal(4, "Invalid callback_url(%s): %s", cfg.RendererCallbackUrl, err)
  609. }
  610. }
  611. cfg.ImagesDir = filepath.Join(cfg.DataPath, "png")
  612. cfg.PhantomDir = filepath.Join(HomePath, "tools/phantomjs")
  613. cfg.TempDataLifetime = iniFile.Section("paths").Key("temp_data_lifetime").MustDuration(time.Second * 3600 * 24)
  614. cfg.MetricsEndpointEnabled = iniFile.Section("metrics").Key("enabled").MustBool(true)
  615. cfg.MetricsEndpointBasicAuthUsername = iniFile.Section("metrics").Key("basic_auth_username").String()
  616. cfg.MetricsEndpointBasicAuthPassword = iniFile.Section("metrics").Key("basic_auth_password").String()
  617. analytics := iniFile.Section("analytics")
  618. ReportingEnabled = analytics.Key("reporting_enabled").MustBool(true)
  619. CheckForUpdates = analytics.Key("check_for_updates").MustBool(true)
  620. GoogleAnalyticsId = analytics.Key("google_analytics_ua_id").String()
  621. GoogleTagManagerId = analytics.Key("google_tag_manager_id").String()
  622. ldapSec := iniFile.Section("auth.ldap")
  623. LdapEnabled = ldapSec.Key("enabled").MustBool(false)
  624. LdapConfigFile = ldapSec.Key("config_file").String()
  625. LdapAllowSignup = ldapSec.Key("allow_sign_up").MustBool(true)
  626. alerting := iniFile.Section("alerting")
  627. AlertingEnabled = alerting.Key("enabled").MustBool(true)
  628. ExecuteAlerts = alerting.Key("execute_alerts").MustBool(true)
  629. AlertingRenderLimit = alerting.Key("concurrent_render_limit").MustInt(5)
  630. AlertingErrorOrTimeout = alerting.Key("error_or_timeout").MustString("alerting")
  631. AlertingNoDataOrNullValues = alerting.Key("nodata_or_nullvalues").MustString("no_data")
  632. explore := iniFile.Section("explore")
  633. ExploreEnabled = explore.Key("enabled").MustBool(true)
  634. panels := iniFile.Section("panels")
  635. cfg.EnableAlphaPanels = panels.Key("enable_alpha").MustBool(false)
  636. cfg.DisableSanitizeHtml = panels.Key("disable_sanitize_html").MustBool(false)
  637. cfg.readSessionConfig()
  638. cfg.readSmtpSettings()
  639. cfg.readQuotaSettings()
  640. if VerifyEmailEnabled && !cfg.Smtp.Enabled {
  641. log.Warn("require_email_validation is enabled but smtp is disabled")
  642. }
  643. // check old key name
  644. GrafanaComUrl = iniFile.Section("grafana_net").Key("url").MustString("")
  645. if GrafanaComUrl == "" {
  646. GrafanaComUrl = iniFile.Section("grafana_com").Key("url").MustString("https://grafana.com")
  647. }
  648. imageUploadingSection := iniFile.Section("external_image_storage")
  649. ImageUploadProvider = imageUploadingSection.Key("provider").MustString("")
  650. enterprise := iniFile.Section("enterprise")
  651. cfg.EnterpriseLicensePath = enterprise.Key("license_path").MustString(filepath.Join(cfg.DataPath, "license.jwt"))
  652. cacheServer := iniFile.Section("remote_cache")
  653. cfg.RemoteCacheOptions = &RemoteCacheOptions{
  654. Name: cacheServer.Key("type").MustString("database"),
  655. ConnStr: cacheServer.Key("connstr").MustString(""),
  656. }
  657. return nil
  658. }
  659. type RemoteCacheOptions struct {
  660. Name string
  661. ConnStr string
  662. }
  663. func (cfg *Cfg) readSessionConfig() {
  664. sec := cfg.Raw.Section("session")
  665. SessionOptions = session.Options{}
  666. SessionOptions.Provider = sec.Key("provider").In("memory", []string{"memory", "file", "redis", "mysql", "postgres", "memcache"})
  667. SessionOptions.ProviderConfig = strings.Trim(sec.Key("provider_config").String(), "\" ")
  668. SessionOptions.CookieName = sec.Key("cookie_name").MustString("grafana_sess")
  669. SessionOptions.CookiePath = AppSubUrl
  670. SessionOptions.Secure = sec.Key("cookie_secure").MustBool()
  671. SessionOptions.Gclifetime = cfg.Raw.Section("session").Key("gc_interval_time").MustInt64(86400)
  672. SessionOptions.Maxlifetime = cfg.Raw.Section("session").Key("session_life_time").MustInt64(86400)
  673. SessionOptions.IDLength = 16
  674. if SessionOptions.Provider == "file" {
  675. SessionOptions.ProviderConfig = makeAbsolute(SessionOptions.ProviderConfig, cfg.DataPath)
  676. os.MkdirAll(path.Dir(SessionOptions.ProviderConfig), os.ModePerm)
  677. }
  678. if SessionOptions.CookiePath == "" {
  679. SessionOptions.CookiePath = "/"
  680. }
  681. SessionConnMaxLifetime = cfg.Raw.Section("session").Key("conn_max_lifetime").MustInt64(14400)
  682. }
  683. func (cfg *Cfg) initLogging(file *ini.File) {
  684. // split on comma
  685. logModes := strings.Split(file.Section("log").Key("mode").MustString("console"), ",")
  686. // also try space
  687. if len(logModes) == 1 {
  688. logModes = strings.Split(file.Section("log").Key("mode").MustString("console"), " ")
  689. }
  690. cfg.LogsPath = makeAbsolute(file.Section("paths").Key("logs").String(), HomePath)
  691. log.ReadLoggingConfig(logModes, cfg.LogsPath, file)
  692. }
  693. func (cfg *Cfg) LogConfigSources() {
  694. var text bytes.Buffer
  695. for _, file := range configFiles {
  696. logger.Info("Config loaded from", "file", file)
  697. }
  698. if len(appliedCommandLineProperties) > 0 {
  699. for _, prop := range appliedCommandLineProperties {
  700. logger.Info("Config overridden from command line", "arg", prop)
  701. }
  702. }
  703. if len(appliedEnvOverrides) > 0 {
  704. text.WriteString("\tEnvironment variables used:\n")
  705. for _, prop := range appliedEnvOverrides {
  706. logger.Info("Config overridden from Environment variable", "var", prop)
  707. }
  708. }
  709. logger.Info("Path Home", "path", HomePath)
  710. logger.Info("Path Data", "path", cfg.DataPath)
  711. logger.Info("Path Logs", "path", cfg.LogsPath)
  712. logger.Info("Path Plugins", "path", PluginsPath)
  713. logger.Info("Path Provisioning", "path", cfg.ProvisioningPath)
  714. logger.Info("App mode " + Env)
  715. }