Skip to content
Snippets Groups Projects
grafana.ini.j2 64.6 KiB
Newer Older
  • Learn to ignore specific revisions
  • Florian Pritz's avatar
    Florian Pritz committed
    ##################### Grafana Configuration Example #####################
    #
    # Everything has defaults so you only need to uncomment things you want to
    # change
    
    # possible values : production, development
    
    ;app_mode = production
    
    Florian Pritz's avatar
    Florian Pritz committed
    
    # instance name, defaults to HOSTNAME environment variable value or hostname if HOSTNAME var is empty
    
    ;instance_name = ${HOSTNAME}
    
    Florian Pritz's avatar
    Florian Pritz committed
    
    
    # force migration will run migrations that might cause dataloss
    
    # Deprecated, use clean_upgrade option in [unified_alerting.upgrade] instead.
    
    ;force_migration = false
    
    
    Florian Pritz's avatar
    Florian Pritz committed
    #################################### Paths ####################################
    [paths]
    # Path to where grafana can store temp files, sessions, and the sqlite3 db (if that is used)
    ;data = /var/lib/grafana
    
    
    # Temporary files in `data` directory older than given duration will be removed
    ;temp_data_lifetime = 24h
    
    
    Florian Pritz's avatar
    Florian Pritz committed
    # Directory where grafana can store logs
    ;logs = /var/log/grafana
    
    Florian Pritz's avatar
    Florian Pritz committed
    # Directory where grafana will automatically scan and look for plugins
    ;plugins = /var/lib/grafana/plugins
    
    
    # folder that contains provisioning config files that grafana will apply on startup and while running.
    
    provisioning = /etc/grafana/provisioning
    
    Florian Pritz's avatar
    Florian Pritz committed
    #################################### Server ####################################
    [server]
    
    # Protocol (http, https, h2, socket)
    
    Florian Pritz's avatar
    Florian Pritz committed
    ;protocol = http
    
    
    # This is the minimum TLS version allowed. By default, this value is empty. Accepted values are: TLS1.2, TLS1.3. If nothing is set TLS1.2 would be taken
    ;min_tls_version = ""
    
    
    Florian Pritz's avatar
    Florian Pritz committed
    # The ip address to bind to, empty will bind to all interfaces
    
    http_addr = 127.0.0.1
    
    Florian Pritz's avatar
    Florian Pritz committed
    
    # The http port  to use
    ;http_port = 3000
    
    # The public facing domain name used to access grafana from a browser
    domain = {{grafana_domain}}
    
    # Redirect to correct domain if host header does not match domain
    # Prevents DNS rebinding attacks
    ;enforce_domain = false
    
    # The full public facing url you use in browser, used for redirects and emails
    # If you use reverse proxy and sub path specify full url (with sub path)
    root_url = https://{{grafana_domain}}
    
    
    # Serve Grafana from subpath specified in `root_url` setting. By default it is set to `false` for compatibility reasons.
    ;serve_from_sub_path = false
    
    
    Florian Pritz's avatar
    Florian Pritz committed
    # Log web requests
    ;router_logging = false
    
    # the path relative working path
    ;static_root_path = public
    
    # enable gzip
    
    Florian Pritz's avatar
    Florian Pritz committed
    
    # https certs & key file
    ;cert_file =
    ;cert_key =
    
    
    # Unix socket gid
    # Changing the gid of a file without privileges requires that the target group is in the group of the process and that the process is the file owner
    # It is recommended to set the gid as http server user gid
    # Not set when the value is -1
    ;socket_gid =
    
    # Unix socket mode
    ;socket_mode =
    
    
    Florian Pritz's avatar
    Florian Pritz committed
    # Unix socket path
    ;socket =
    
    
    # CDN Url
    ;cdn_url =
    
    # Sets the maximum time using a duration format (5s/5m/5ms) before timing out read of an incoming request and closing idle connections.
    # `0` means there is no timeout for reading the request.
    ;read_timeout = 0
    
    
    # This setting enables you to specify additional headers that the server adds to HTTP(S) responses.
    [server.custom_response_headers]
    #exampleHeader1 = exampleValue1
    #exampleHeader2 = exampleValue2
    
    
    #################################### GRPC Server #########################
    ;[grpc_server]
    ;network = "tcp"
    ;address = "127.0.0.1:10000"
    ;use_tls = false
    ;cert_file =
    ;key_file =
    
    
    Florian Pritz's avatar
    Florian Pritz committed
    #################################### Database ####################################
    [database]
    # You can configure the database connection by specifying type, host, name, user and password
    
    # as separate properties or as on string using the url properties.
    
    Florian Pritz's avatar
    Florian Pritz committed
    
    # Either "mysql", "postgres" or "sqlite3", it's your choice
    ;type = sqlite3
    ;host = 127.0.0.1:3306
    ;name = grafana
    ;user = root
    
    # If the password contains # or ; you have to wrap it with triple quotes. Ex """#password;"""
    
    Florian Pritz's avatar
    Florian Pritz committed
    ;password =
    
    # Use either URL or the previous fields to configure the database
    # Example: mysql://user:secret@host:port/database
    ;url =
    
    
    # For "postgres", use either "disable", "require" or "verify-full"
    # For "mysql", use either "true", "false", or "skip-verify".
    
    Florian Pritz's avatar
    Florian Pritz committed
    ;ssl_mode = disable
    
    
    # Database drivers may support different transaction isolation levels.
    # Currently, only "mysql" driver supports isolation levels.
    # If the value is empty - driver's default isolation level is applied.
    # For "mysql" use "READ-UNCOMMITTED", "READ-COMMITTED", "REPEATABLE-READ" or "SERIALIZABLE".
    ;isolation_level =
    
    
    ;ca_cert_path =
    ;client_key_path =
    ;client_cert_path =
    ;server_cert_name =
    
    
    Florian Pritz's avatar
    Florian Pritz committed
    # For "sqlite3" only, path relative to data_path setting
    
    {% if grafana_anonymous_access %}
    path = ":memory"
    {% else %}
    
    Florian Pritz's avatar
    Florian Pritz committed
    ;path = grafana.db
    
    Florian Pritz's avatar
    Florian Pritz committed
    
    
    # Max idle conn setting default is 2
    ;max_idle_conn = 2
    
    
    Florian Pritz's avatar
    Florian Pritz committed
    # Max conn setting default is 0 (mean not set)
    ;max_open_conn =
    
    
    # Connection Max Lifetime default is 14400 (means 14400 seconds or 4 hours)
    ;conn_max_lifetime = 14400
    
    # Set to true to log the sql calls and execution times.
    
    ;log_queries =
    
    Florian Pritz's avatar
    Florian Pritz committed
    
    
    # For "sqlite3" only. cache mode setting used for connecting to the database. (private, shared)
    ;cache_mode = private
    
    
    # For "sqlite3" only. Enable/disable Write-Ahead Logging, https://sqlite.org/wal.html. Default is false.
    ;wal = false
    
    
    # For "mysql" only if migrationLocking feature toggle is set. How many seconds to wait before failing to lock the database for the migrations, default is 0.
    
    ;locking_attempt_timeout_sec = 0
    
    
    # For "sqlite" only. How many times to retry query in case of database is locked failures. Default is 0 (disabled).
    ;query_retries = 0
    
    # For "sqlite" only. How many times to retry transaction in case of database is locked failures. Default is 5.
    ;transaction_retries = 5
    
    
    # Set to true to add metrics and tracing for database queries.
    
    ;instrument_queries = false
    
    
    Jelle van der Waa's avatar
    Jelle van der Waa committed
    ################################### Data sources #########################
    [datasources]
    # Upper limit of data sources that Grafana will return. This limit is a temporary configuration and it will be deprecated when pagination will be introduced on the list data sources API.
    ;datasource_limit = 5000
    
    
    #################################### Cache server #############################
    [remote_cache]
    # Either "redis", "memcached" or "database" default is "database"
    ;type = database
    
    Florian Pritz's avatar
    Florian Pritz committed
    
    
    # cache connectionstring options
    # database: will use Grafana primary database.
    # redis: config like redis server e.g. `addr=127.0.0.1:6379,pool_size=100,db=0,ssl=false`. Only addr is required. ssl may be 'true', 'false', or 'insecure'.
    # memcache: 127.0.0.1:11211
    ;connstr =
    
    Florian Pritz's avatar
    Florian Pritz committed
    
    
    # prefix prepended to all the keys in the remote cache
    ; prefix =
    
    # This enables encryption of values stored in the remote cache
    ;encryption =
    
    
    Florian Pritz's avatar
    Florian Pritz committed
    #################################### Data proxy ###########################
    [dataproxy]
    
    # This enables data proxy logging, default is false
    ;logging = false
    
    
    Jelle van der Waa's avatar
    Jelle van der Waa committed
    # How long the data proxy waits to read the headers of the response before timing out, default is 30 seconds.
    # This setting also applies to core backend HTTP data sources where query requests use an HTTP client with timeout set.
    
    Jelle van der Waa's avatar
    Jelle van der Waa committed
    # How long the data proxy waits to establish a TCP connection before timing out, default is 10 seconds.
    ;dialTimeout = 10
    
    # How many seconds the data proxy waits before sending a keepalive probe request.
    ;keep_alive_seconds = 30
    
    # How many seconds the data proxy waits for a successful TLS Handshake before timing out.
    ;tls_handshake_timeout_seconds = 10
    
    # How many seconds the data proxy will wait for a server's first response headers after
    # fully writing the request headers if the request has an "Expect: 100-continue"
    # header. A value of 0 will result in the body being sent immediately, without
    # waiting for the server to approve.
    ;expect_continue_timeout_seconds = 1
    
    
    # Optionally limits the total number of connections per host, including connections in the dialing,
    # active, and idle states. On limit violation, dials will block.
    # A value of zero (0) means no limit.
    ;max_conns_per_host = 0
    
    
    Jelle van der Waa's avatar
    Jelle van der Waa committed
    # The maximum number of idle connections that Grafana will keep alive.
    ;max_idle_connections = 100
    
    # How many seconds the data proxy keeps an idle connection open before timing out.
    ;idle_conn_timeout_seconds = 90
    
    
    # If enabled and user is not anonymous, data proxy will add X-Grafana-User header with username into the request, default is false.
    ;send_user_header = false
    
    
    # Limit the amount of bytes that will be read/accepted from responses of outgoing HTTP requests.
    ;response_limit = 0
    
    # Limits the number of rows that Grafana will process from SQL data sources.
    ;row_limit = 1000000
    
    
    # Sets a custom value for the `User-Agent` header for outgoing data proxy requests. If empty, the default value is `Grafana/<BuildVersion>` (for example `Grafana/9.0.0`).
    ;user_agent =
    
    
    Florian Pritz's avatar
    Florian Pritz committed
    #################################### Analytics ####################################
    [analytics]
    # Server reporting, sends usage counters to stats.grafana.org every 24 hours.
    # No ip addresses are being tracked, only simple counters to track
    # running instances, dashboard and error counts. It is very helpful to us.
    # Change this option to false to disable reporting.
    
    reporting_enabled = false
    
    Florian Pritz's avatar
    Florian Pritz committed
    
    
    Jelle van der Waa's avatar
    Jelle van der Waa committed
    # The name of the distributor of the Grafana instance. Ex hosted-grafana, grafana-labs
    ;reporting_distributor = grafana-labs
    
    
    # Set to false to disable all checks to https://grafana.com
    # for new versions of grafana. The check is used
    # in some UI views to notify that a grafana update exists.
    
    Florian Pritz's avatar
    Florian Pritz committed
    # This option does not cause any auto updates, nor send any information
    
    # only a GET request to https://raw.githubusercontent.com/grafana/grafana/main/latest.json to get the latest version.
    
    check_for_updates = false
    
    Florian Pritz's avatar
    Florian Pritz committed
    
    
    # Set to false to disable all checks to https://grafana.com
    # for new versions of plugins. The check is used
    # in some UI views to notify that a plugin update exists.
    # This option does not cause any auto updates, nor send any information
    # only a GET request to https://grafana.com to get the latest versions.
    ;check_for_plugin_updates = true
    
    
    Florian Pritz's avatar
    Florian Pritz committed
    # Google Analytics universal tracking code, only enabled if you specify an id here
    ;google_analytics_ua_id =
    
    
    # Google Analytics 4 tracking code, only enabled if you specify an id here
    ;google_analytics_4_id =
    
    
    # When Google Analytics 4 Enhanced event measurement is enabled, we will try to avoid sending duplicate events and let Google Analytics 4 detect navigation changes, etc.
    ;google_analytics_4_send_manual_page_views = false
    
    
    # Google Tag Manager ID, only enabled if you specify an id here
    ;google_tag_manager_id =
    
    
    # Rudderstack write key, enabled only if rudderstack_data_plane_url is also set
    ;rudderstack_write_key =
    
    # Rudderstack data plane url, enabled only if rudderstack_write_key is also set
    ;rudderstack_data_plane_url =
    
    # Rudderstack SDK url, optional, only valid if rudderstack_write_key and rudderstack_data_plane_url is also set
    ;rudderstack_sdk_url =
    
    # Rudderstack Config url, optional, used by Rudderstack SDK to fetch source config
    ;rudderstack_config_url =
    
    
    # Rudderstack Integrations URL, optional. Only valid if you pass the SDK version 1.1 or higher
    ;rudderstack_integrations_url =
    
    
    # Intercom secret, optional, used to hash user_id before passing to Intercom via Rudderstack
    ;intercom_secret =
    
    
    # Controls if the UI contains any links to user feedback forms
    ;feedback_links_enabled = true
    
    
    Florian Pritz's avatar
    Florian Pritz committed
    #################################### Security ####################################
    [security]
    
    # disable creation of admin user on first start of grafana
    
    disable_initial_admin_creation = true
    
    Florian Pritz's avatar
    Florian Pritz committed
    # default admin user, created on startup
    
    Florian Pritz's avatar
    Florian Pritz committed
    
    # default admin password, can be changed before first start of grafana,  or in profile settings
    ;admin_password = admin
    
    
    # default admin email, created on startup
    ;admin_email = admin@localhost
    
    
    Florian Pritz's avatar
    Florian Pritz committed
    # used for signing
    
    secret_key = {{ vault_grafana_secret_key }}
    
    Florian Pritz's avatar
    Florian Pritz committed
    
    
    # current key provider used for envelope encryption, default to static value specified by secret_key
    
    ;encryption_provider = secretKey.v1
    
    
    # list of configured key providers, space separated (Enterprise only): e.g., awskms.v1 azurekv.v1
    ;available_encryption_providers =
    
    
    Florian Pritz's avatar
    Florian Pritz committed
    # disable gravatar profile images
    ;disable_gravatar = false
    
    # data source proxy whitelist (ip_or_domain:port separated by spaces)
    ;data_source_proxy_whitelist =
    
    
    # disable protection against brute force login attempts
    ;disable_brute_force_login_protection = false
    
    
    # set to true if you host Grafana behind HTTPS. default is false.
    
    cookie_secure = true
    
    # set cookie SameSite attribute. defaults to `lax`. can be set to "lax", "strict", "none" and "disabled"
    
    cookie_samesite = strict
    
    # set to true if you want to allow browsers to render Grafana in a <frame>, <iframe>, <embed> or <object>. default is false.
    ;allow_embedding = false
    
    # Set to true if you want to enable http strict transport security (HSTS) response header.
    # HSTS tells browsers that the site should only be accessed using HTTPS.
    
    ;strict_transport_security = false
    
    
    # Sets how long a browser should cache HSTS. Only applied if strict_transport_security is enabled.
    
    ;strict_transport_security_max_age_seconds = 86400
    
    
    # Set to true if to enable HSTS preloading option. Only applied if strict_transport_security is enabled.
    ;strict_transport_security_preload = false
    
    # Set to true if to enable the HSTS includeSubDomains option. Only applied if strict_transport_security is enabled.
    ;strict_transport_security_subdomains = false
    
    # Set to true to enable the X-Content-Type-Options response header.
    # The X-Content-Type-Options response HTTP header is a marker used by the server to indicate that the MIME types advertised
    
    # in the Content-Type headers should not be changed and be followed.
    ;x_content_type_options = true
    
    
    # Set to true to enable the X-XSS-Protection header, which tells browsers to stop pages from loading
    
    # when they detect reflected cross-site scripting (XSS) attacks.
    ;x_xss_protection = true
    
    Jelle van der Waa's avatar
    Jelle van der Waa committed
    # Enable adding the Content-Security-Policy header to your requests.
    # CSP allows to control resources the user agent is allowed to load and helps prevent XSS attacks.
    ;content_security_policy = false
    
    # Set Content Security Policy template used when adding the Content-Security-Policy header to your requests.
    # $NONCE in the template includes a random nonce.
    # $ROOT_PATH is server.root_url without the protocol.
    ;content_security_policy_template = """script-src 'self' 'unsafe-eval' 'unsafe-inline' 'strict-dynamic' $NONCE;object-src 'none';font-src 'self';style-src 'self' 'unsafe-inline' blob:;img-src * data:;base-uri 'self';connect-src 'self' grafana.com ws://$ROOT_PATH wss://$ROOT_PATH;manifest-src 'self';media-src 'none';form-action 'self';"""
    
    
    # Enable adding the Content-Security-Policy-Report-Only header to your requests.
    # Allows you to monitor the effects of a policy without enforcing it.
    ;content_security_policy_report_only = false
    
    # Set Content Security Policy Report Only template used when adding the Content-Security-Policy-Report-Only header to your requests.
    # $NONCE in the template includes a random nonce.
    # $ROOT_PATH is server.root_url without the protocol.
    ;content_security_policy_report_only_template = """script-src 'self' 'unsafe-eval' 'unsafe-inline' 'strict-dynamic' $NONCE;object-src 'none';font-src 'self';style-src 'self' 'unsafe-inline' blob:;img-src * data:;base-uri 'self';connect-src 'self' grafana.com ws://$ROOT_PATH wss://$ROOT_PATH;manifest-src 'self';media-src 'none';form-action 'self';"""
    
    # Controls if old angular plugins are supported or not. This will be disabled by default in future release
    
    ;angular_support_enabled = true
    
    
    # List of additional allowed URLs to pass by the CSRF check, separated by spaces. Suggested when authentication comes from an IdP.
    ;csrf_trusted_origins = example.com
    
    # List of allowed headers to be set by the user, separated by spaces. Suggested to use for if authentication lives behind reverse proxies.
    ;csrf_additional_headers =
    
    
    # The CSRF check will be executed even if the request has no login cookie.
    ;csrf_always_check = false
    
    
    # Comma-separated list of plugins ids that won't be loaded inside the frontend sandbox
    ;disable_frontend_sandbox_for_plugins =
    
    
    [security.encryption]
    # Defines the time-to-live (TTL) for decrypted data encryption keys stored in memory (cache).
    # Please note that small values may cause performance issues due to a high frequency decryption operations.
    ;data_keys_cache_ttl = 15m
    
    # Defines the frequency of data encryption keys cache cleanup interval.
    # On every interval, decrypted data encryption keys that reached the TTL are removed from the cache.
    ;data_keys_cache_cleanup_interval = 1m
    
    
    #################################### Snapshots ###########################
    
    Florian Pritz's avatar
    Florian Pritz committed
    [snapshots]
    
    # set to false to remove snapshot functionality
    ;enabled = true
    
    
    Florian Pritz's avatar
    Florian Pritz committed
    # snapshot sharing options
    ;external_enabled = true
    
    ;external_snapshot_url = https://snapshots.raintank.io
    ;external_snapshot_name = Publish to snapshots.raintank.io
    
    Florian Pritz's avatar
    Florian Pritz committed
    
    
    Jelle van der Waa's avatar
    Jelle van der Waa committed
    # Set to true to enable this Grafana instance act as an external snapshot server and allow unauthenticated requests for
    
    # creating and deleting snapshots.
    ;public_mode = false
    
    
    Florian Pritz's avatar
    Florian Pritz committed
    # remove expired snapshot
    ;snapshot_remove_expired = true
    
    
    #################################### Dashboards History ##################
    [dashboards]
    # Number dashboard versions to keep (per dashboard). Default: 20, Minimum: 1
    ;versions_to_keep = 20
    
    Florian Pritz's avatar
    Florian Pritz committed
    
    
    Jelle van der Waa's avatar
    Jelle van der Waa committed
    # Minimum dashboard refresh interval. When set, this will restrict users to set the refresh interval of a dashboard lower than given interval. Per default this is 5 seconds.
    
    # The interval string is a possibly signed sequence of decimal numbers, followed by a unit suffix (ms, s, m, h, d), e.g. 30s or 1m.
    
    Jelle van der Waa's avatar
    Jelle van der Waa committed
    ;min_refresh_interval = 5s
    
    # Path to the default home dashboard. If this value is empty, then Grafana uses StaticRootPath + "dashboards/home.json"
    
    default_home_dashboard_path = /var/lib/grafana/public-dashboards/archive.json
    
    {% else %}
    ;default_home_dashboard_path =
    
    #################################### Users ###############################
    
    Florian Pritz's avatar
    Florian Pritz committed
    [users]
    # disable user signup / registration
    allow_sign_up = false
    
    # Allow non admin users to create organizations
    ;allow_org_create = true
    
    # Set to true to automatically assign new users to the default organization (id 1)
    ;auto_assign_org = true
    
    
    # Set this value to automatically add new users to the provided organization (if auto_assign_org above is set to true)
    ;auto_assign_org_id = 1
    
    
    # Default role new users will be automatically assigned
    
    Florian Pritz's avatar
    Florian Pritz committed
    ;auto_assign_org_role = Viewer
    
    
    # Require email validation before sign up completes
    ;verify_email_enabled = false
    
    
    Florian Pritz's avatar
    Florian Pritz committed
    # Background text for the user field on the login page
    ;login_hint = email or username
    
    ;password_hint = password
    
    Florian Pritz's avatar
    Florian Pritz committed
    
    # Default UI theme ("dark" or "light")
    ;default_theme = dark
    
    
    # Default UI language (supported IETF language tag, such as en-US)
    ;default_language = en-US
    
    Jelle van der Waa's avatar
    Jelle van der Waa committed
    # Path to a custom home page. Users are only redirected to this if the default home dashboard is used. It should match a frontend route and contain a leading slash.
    
    # External user management, these options affect the organization users view
    ;external_manage_link_url =
    ;external_manage_link_name =
    ;external_manage_info =
    
    # Viewers can edit/inspect dashboard settings in the browser. But not save the dashboard.
    ;viewers_can_edit = false
    
    
    # Editors can administrate dashboard, folders and teams they create
    ;editors_can_admin = false
    
    
    Jelle van der Waa's avatar
    Jelle van der Waa committed
    # The duration in time a user invitation remains valid before expiring. This setting should be expressed as a duration. Examples: 6h (hours), 2d (days), 1w (week). Default is 24h (24 hours). The minimum supported duration is 15m (15 minutes).
    ;user_invite_max_lifetime_duration = 24h
    
    # Enter a comma-separated list of users login to hide them in the Grafana UI. These users are shown to Grafana admins and themselves.
    ; hidden_users =
    
    
    [secretscan]
    # Enable secretscan feature
    ;enabled = false
    
    # Interval to check for token leaks
    ;interval = 5m
    
    # base URL of the grafana token leak check service
    ;base_url = https://secret-scanning.grafana.net
    
    # URL to send outgoing webhooks to in case of detection
    ;oncall_url =
    
    # Whether to revoke the token if a leak is detected or just send a notification
    ;revoke = true
    
    
    [service_accounts]
    # Service account maximum expiration date in days.
    # When set, Grafana will not allow the creation of tokens with expiry greater than this setting.
    ; token_expiration_day_limit =
    
    
    Florian Pritz's avatar
    Florian Pritz committed
    [auth]
    
    # Login cookie name
    ;login_cookie_name = grafana_session
    
    
    # Disable usage of Grafana build-in login solution.
    ;disable_login = false
    
    
    Jelle van der Waa's avatar
    Jelle van der Waa committed
    # The maximum lifetime (duration) an authenticated user can be inactive before being required to login at next visit. Default is 7 days (7d). This setting should be expressed as a duration, e.g. 5m (minutes), 6h (hours), 10d (days), 2w (weeks), 1M (month). The lifetime resets at each successful token rotation.
    ;login_maximum_inactive_lifetime_duration =
    
    Jelle van der Waa's avatar
    Jelle van der Waa committed
    # The maximum lifetime (duration) an authenticated user can be logged in since login time before being required to login. Default is 30 days (30d). This setting should be expressed as a duration, e.g. 5m (minutes), 6h (hours), 10d (days), 2w (weeks), 1M (month).
    ;login_maximum_lifetime_duration =
    
    
    # How often should auth tokens be rotated for authenticated users when being active. The default is each 10 minutes.
    ;token_rotation_interval_minutes = 10
    
    
    Florian Pritz's avatar
    Florian Pritz committed
    # Set to true to disable (hide) the login form, useful if you use OAuth, defaults to false
    
    disable_login_form = true
    
    Florian Pritz's avatar
    Florian Pritz committed
    
    
    Jelle van der Waa's avatar
    Jelle van der Waa committed
    # Set to true to disable the sign out link in the side menu. Useful if you use auth.proxy or auth.jwt, defaults to false
    
    Florian Pritz's avatar
    Florian Pritz committed
    ;disable_signout_menu = false
    
    
    # URL to redirect the user to after sign out
    
    signout_redirect_url = https://accounts.archlinux.org/realms/archlinux/protocol/openid-connect/logout?redirect_uri=https://{{ grafana_domain }}
    
    # Set to true to attempt login with OAuth automatically, skipping the login screen.
    # This setting is ignored if multiple OAuth providers are configured.
    
    # Deprecated, use auto_login option for specific provider instead.
    ;oauth_auto_login = false
    
    Jelle van der Waa's avatar
    Jelle van der Waa committed
    # OAuth state max age cookie duration in seconds. Defaults to 600 seconds.
    ;oauth_state_cookie_max_age = 600
    
    
    # Skip forced assignment of OrgID 1 or 'auto_assign_org_id' for social logins
    
    # Deprecated, use skip_org_role_sync option for specific provider instead.
    
    ;oauth_skip_org_role_update_sync = false
    
    
    # limit of api_key seconds to live before expiration
    ;api_key_max_seconds_to_live = -1
    
    
    Jelle van der Waa's avatar
    Jelle van der Waa committed
    # Set to true to enable SigV4 authentication option for HTTP-based datasources.
    ;sigv4_auth_enabled = false
    
    
    # Set to true to enable verbose logging of SigV4 request signing
    ;sigv4_verbose_logging = false
    
    
    # Set to true to enable Azure authentication option for HTTP-based datasources.
    ;azure_auth_enabled = false
    
    
    # Set to skip the organization role from JWT login and use system's role assignment instead.
    ; skip_org_role_sync = false
    
    
    # Use email lookup in addition to the unique ID provided by the IdP
    ;oauth_allow_insecure_email_lookup = false
    
    
    # Set to true to include id of identity as a response header
    ;id_response_header_enabled = false
    
    # Prefix used for the id response header, X-Grafana-Identity-Id
    ;id_response_header_prefix = X-Grafana
    
    # List of identity namespaces to add id response headers for, separated by space.
    # Available namespaces are user, api-key and service-account.
    # The header value will encode the namespace ("user:<id>", "api-key:<id>", "service-account:<id>")
    ;id_response_header_namespaces = user api-key service-account
    
    
    #################################### Anonymous Auth ######################
    
    Florian Pritz's avatar
    Florian Pritz committed
    [auth.anonymous]
    # enable anonymous access
    
    enabled = {{ 'true' if grafana_anonymous_access else 'false' }}
    
    Florian Pritz's avatar
    Florian Pritz committed
    
    # specify organization name that should be used for unauthenticated users
    ;org_name = Main Org.
    
    # specify role for unauthenticated users
    
    Florian Pritz's avatar
    Florian Pritz committed
    
    
    Jelle van der Waa's avatar
    Jelle van der Waa committed
    # mask the Grafana version number for unauthenticated users
    
    #################################### GitHub Auth ##########################
    
    Florian Pritz's avatar
    Florian Pritz committed
    [auth.github]
    
    ;name = GitHub
    ;icon = github
    
    Florian Pritz's avatar
    Florian Pritz committed
    ;enabled = false
    ;allow_sign_up = true
    
    Florian Pritz's avatar
    Florian Pritz committed
    ;client_id = some_id
    ;client_secret = some_secret
    ;scopes = user:email,read:org
    ;auth_url = https://github.com/login/oauth/authorize
    ;token_url = https://github.com/login/oauth/access_token
    ;api_url = https://api.github.com/user
    
    ;signout_redirect_url =
    
    ;allowed_domains =
    
    Florian Pritz's avatar
    Florian Pritz committed
    ;team_ids =
    ;allowed_organizations =
    
    ;role_attribute_path =
    ;role_attribute_strict = false
    ;allow_assign_grafana_admin = false
    
    ;skip_org_role_sync = false
    
    Florian Pritz's avatar
    Florian Pritz committed
    
    
    #################################### GitLab Auth #########################
    [auth.gitlab]
    
    ;name = GitLab
    ;icon = gitlab
    
    ;enabled = false
    ;allow_sign_up = true
    
    ;client_id = some_id
    ;client_secret = some_secret
    
    ;scopes = openid email profile
    
    ;auth_url = https://gitlab.com/oauth/authorize
    ;token_url = https://gitlab.com/oauth/token
    ;api_url = https://gitlab.com/api/v4
    
    ;signout_redirect_url =
    
    ;allowed_domains =
    ;allowed_groups =
    
    ;role_attribute_path =
    ;role_attribute_strict = false
    ;allow_assign_grafana_admin = false
    
    ;skip_org_role_sync = false
    
    ;tls_skip_verify_insecure = false
    ;tls_client_cert =
    ;tls_client_key =
    ;tls_client_ca =
    ;use_pkce = true
    
    Florian Pritz's avatar
    Florian Pritz committed
    #################################### Google Auth ##########################
    [auth.google]
    
    ;name = Google
    ;icon = google
    
    Florian Pritz's avatar
    Florian Pritz committed
    ;enabled = false
    ;allow_sign_up = true
    
    Florian Pritz's avatar
    Florian Pritz committed
    ;client_id = some_client_id
    ;client_secret = some_client_secret
    
    ;scopes = openid email profile
    ;auth_url = https://accounts.google.com/o/oauth2/v2/auth
    ;token_url = https://oauth2.googleapis.com/token
    ;api_url = https://openidconnect.googleapis.com/v1/userinfo
    
    ;signout_redirect_url =
    
    Florian Pritz's avatar
    Florian Pritz committed
    ;allowed_domains =
    
    ;hosted_domain =
    
    ;allowed_groups =
    ;role_attribute_path =
    ;role_attribute_strict = false
    ;allow_assign_grafana_admin = false
    
    ;skip_org_role_sync = false
    
    
    #################################### Grafana.com Auth ####################
    [auth.grafana_com]
    
    ;name = Grafana.com
    ;icon = grafana
    
    ;enabled = false
    ;allow_sign_up = true
    
    ;client_id = some_id
    ;client_secret = some_secret
    ;scopes = user:email
    ;allowed_organizations =
    
    ;skip_org_role_sync = false
    
    
    #################################### Azure AD OAuth #######################
    [auth.azuread]
    
    ;name = Microsoft
    ;icon = microsoft
    
    ;enabled = false
    ;allow_sign_up = true
    
    ;client_id = some_client_id
    ;client_secret = some_client_secret
    ;scopes = openid email profile
    ;auth_url = https://login.microsoftonline.com/<tenant-id>/oauth2/v2.0/authorize
    ;token_url = https://login.microsoftonline.com/<tenant-id>/oauth2/v2.0/token
    
    ;signout_redirect_url =
    
    ;allowed_domains =
    ;allowed_groups =
    
    ;allowed_organizations =
    
    ;role_attribute_strict = false
    
    ;allow_assign_grafana_admin = false
    
    # prevent synchronizing users organization roles
    ;skip_org_role_sync = false
    
    Florian Pritz's avatar
    Florian Pritz committed
    
    
    Jelle van der Waa's avatar
    Jelle van der Waa committed
    #################################### Okta OAuth #######################
    [auth.okta]
    ;name = Okta
    ;enabled = false
    ;allow_sign_up = true
    
    Jelle van der Waa's avatar
    Jelle van der Waa committed
    ;client_id = some_id
    ;client_secret = some_secret
    ;scopes = openid profile email groups
    ;auth_url = https://<tenant-id>.okta.com/oauth2/v1/authorize
    ;token_url = https://<tenant-id>.okta.com/oauth2/v1/token
    ;api_url = https://<tenant-id>.okta.com/oauth2/v1/userinfo
    
    ;signout_redirect_url =
    
    Jelle van der Waa's avatar
    Jelle van der Waa committed
    ;allowed_domains =
    ;allowed_groups =
    ;role_attribute_path =
    ;role_attribute_strict = false
    
    ;allow_assign_grafana_admin = false
    
    ;skip_org_role_sync = false
    
    {% if not grafana_anonymous_access %}
    
    Florian Pritz's avatar
    Florian Pritz committed
    #################################### Generic OAuth ##########################
    [auth.generic_oauth]
    
    enabled = true
    name = OAuth
    allow_sign_up = true
    
    client_id = openid_grafana
    client_secret = {{ vault_monitoring_grafana_client_secret }}
    scopes = openid profile email
    
    Jelle van der Waa's avatar
    Jelle van der Waa committed
    ;empty_scopes = false
    
    email_attribute_name = email:primary
    email_attribute_path = email
    
    Jelle van der Waa's avatar
    Jelle van der Waa committed
    ;login_attribute_path =
    ;name_attribute_path =
    ;id_token_attribute_name =
    
    auth_url = https://accounts.archlinux.org/realms/archlinux/protocol/openid-connect/auth
    token_url = https://accounts.archlinux.org/realms/archlinux/protocol/openid-connect/token
    api_url = https://accounts.archlinux.org/realms/archlinux/protocol/openid-connect/userinfo
    
    ;signout_redirect_url =
    
    ;teams_url =
    
    ;allowed_domains =
    
    Florian Pritz's avatar
    Florian Pritz committed
    ;team_ids =
    ;allowed_organizations =
    
    role_attribute_path: contains(roles[*], 'DevOps') && 'Admin'
    role_attribute_strict = true
    
    ;groups_attribute_path =
    ;team_ids_attribute_path =
    
    ;tls_skip_verify_insecure = false
    ;tls_client_cert =
    ;tls_client_key =
    ;tls_client_ca =
    
    ;allow_assign_grafana_admin = false
    
    Florian Pritz's avatar
    Florian Pritz committed
    
    
    #################################### Basic Auth ##########################
    [auth.basic]
    ;enabled = true
    
    Florian Pritz's avatar
    Florian Pritz committed
    
    #################################### Auth Proxy ##########################
    [auth.proxy]
    ;enabled = false
    ;header_name = X-WEBAUTH-USER
    ;header_property = username
    ;auto_sign_up = true
    
    ;sync_ttl = 60
    
    Florian Pritz's avatar
    Florian Pritz committed
    ;whitelist = 192.168.1.1, 192.168.2.1
    
    ;headers = Email:X-User-Email, Name:X-User-Name
    
    # Non-ASCII strings in header values are encoded using quoted-printable encoding
    ;headers_encoded = false
    
    # Read the auth proxy docs for details on what the setting below enables
    ;enable_login_token = false
    
    Florian Pritz's avatar
    Florian Pritz committed
    
    
    Jelle van der Waa's avatar
    Jelle van der Waa committed
    #################################### Auth JWT ##########################
    [auth.jwt]
    ;enabled = true
    ;header_name = X-JWT-Assertion
    ;email_claim = sub
    ;username_claim = sub
    ;jwk_set_url = https://foo.bar/.well-known/jwks.json
    ;jwk_set_file = /path/to/jwks.json
    ;cache_ttl = 60m
    
    ;expect_claims = {"aud": ["foo", "bar"]}
    
    Jelle van der Waa's avatar
    Jelle van der Waa committed
    ;key_file = /path/to/key/file
    
    # Use in conjunction with key_file in case the JWT token's header specifies a key ID in "kid" field
    ;key_id = some-key-id
    
    ;role_attribute_path =
    ;role_attribute_strict = false
    
    ;auto_sign_up = false
    
    ;allow_assign_grafana_admin = false
    
    Florian Pritz's avatar
    Florian Pritz committed
    #################################### Auth LDAP ##########################
    [auth.ldap]
    ;enabled = false
    ;config_file = /etc/grafana/ldap.toml
    ;allow_sign_up = true
    
    # prevent synchronizing ldap users organization roles
    ;skip_org_role_sync = false
    
    Florian Pritz's avatar
    Florian Pritz committed
    
    
    Jelle van der Waa's avatar
    Jelle van der Waa committed
    # LDAP background sync (Enterprise only)
    
    # At 1 am every day
    
    ;sync_cron = "0 1 * * *"
    
    ;active_sync_enabled = true
    
    
    Jelle van der Waa's avatar
    Jelle van der Waa committed
    #################################### AWS ###########################
    [aws]
    # Enter a comma-separated list of allowed AWS authentication providers.
    # Options are: default (AWS SDK Default), keys (Access && secret key), credentials (Credentials field), ec2_iam_role (EC2 IAM Role)
    ; allowed_auth_providers = default,keys,credentials
    
    # Allow AWS users to assume a role using temporary security credentials.
    # If true, assume role will be enabled for all AWS authentication providers that are specified in aws_auth_providers
    ; assume_role_enabled = true
    
    
    # Specify max no of pages to be returned by the ListMetricPages API
    ; list_metrics_page_limit = 500
    
    # Experimental, for use in Grafana Cloud only. Please do not set.
    
    Jelle van der Waa's avatar
    Jelle van der Waa committed
    #################################### Azure ###############################
    [azure]
    # Azure cloud environment where Grafana is hosted
    # Possible values are AzureCloud, AzureChinaCloud, AzureUSGovernment and AzureGermanCloud
    # Default value is AzureCloud (i.e. public cloud)
    ;cloud = AzureCloud
    
    # Specifies whether Grafana hosted in Azure service with Managed Identity configured (e.g. Azure Virtual Machines instance)
    # If enabled, the managed identity can be used for authentication of Grafana in Azure services
    # Disabled by default, needs to be explicitly enabled
    ;managed_identity_enabled = false
    
    # Client ID to use for user-assigned managed identity
    # Should be set for user-assigned identity and should be empty for system-assigned identity
    ;managed_identity_client_id =
    
    
    # Specifies whether Azure AD Workload Identity authentication should be enabled in datasources that support it
    # For more documentation on Azure AD Workload Identity, review this documentation:
    # https://azure.github.io/azure-workload-identity/docs/
    # Disabled by default, needs to be explicitly enabled
    ;workload_identity_enabled = false
    
    # Tenant ID of the Azure AD Workload Identity
    # Allows to override default tenant ID of the Azure AD identity associated with the Kubernetes service account
    ;workload_identity_tenant_id =
    
    # Client ID of the Azure AD Workload Identity
    # Allows to override default client ID of the Azure AD identity associated with the Kubernetes service account
    ;workload_identity_client_id =
    
    # Custom path to token file for the Azure AD Workload Identity
    # Allows to set a custom path to the projected service account token file
    ;workload_identity_token_file =
    
    
    # Specifies whether user identity authentication (on behalf of currently signed-in user) should be enabled in datasources
    # that support it (requires AAD authentication)
    # Disabled by default, needs to be explicitly enabled
    ;user_identity_enabled = false
    
    # Override token URL for Azure Active Directory
    # By default is the same as token URL configured for AAD authentication settings
    ;user_identity_token_url =
    
    # Override ADD application ID which would be used to exchange users token to an access token for the datasource
    # By default is the same as used in AAD authentication or can be set to another application (for OBO flow)
    ;user_identity_client_id =
    
    # Override the AAD application client secret
    # By default is the same as used in AAD authentication or can be set to another application (for OBO flow)
    ;user_identity_client_secret =
    
    
    #################################### Role-based Access Control ###########
    [rbac]
    ;permission_cache = true
    
    
    # Reset basic roles permissions on boot
    # Warning left to true, basic roles permissions will be reset on every boot
    #reset_basic_roles = false
    
    
    # Validate permissions' action and scope on role creation and update
    ; permission_validation_enabled = true
    
    
    Florian Pritz's avatar
    Florian Pritz committed
    #################################### SMTP / Emailing ##########################
    [smtp]
    ;enabled = false
    ;host = localhost:25
    ;user =
    
    # If the password contains # or ; you have to wrap it with triple quotes. Ex """#password;"""
    
    Florian Pritz's avatar
    Florian Pritz committed
    ;password =
    ;cert_file =
    ;key_file =
    ;skip_verify = false
    ;from_address = admin@grafana.localhost
    ;from_name = Grafana
    
    # EHLO identity in SMTP dialog (defaults to instance_name)
    ;ehlo_identity = dashboard.example.com
    
    Jelle van der Waa's avatar
    Jelle van der Waa committed
    # SMTP startTLS policy (defaults to 'OpportunisticStartTLS')
    ;startTLS_policy = NoStartTLS
    
    Florian Pritz's avatar
    Florian Pritz committed
    
    [emails]
    ;welcome_email_on_sign_up = false
    
    ;templates_pattern = emails/*.html, emails/*.txt
    ;content_types = text/html
    
    Florian Pritz's avatar
    Florian Pritz committed
    
    #################################### Logging ##########################
    [log]
    # Either "console", "file", "syslog". Default is console and  file
    # Use space to separate multiple modes, e.g. "console file"
    mode = syslog
    
    
    # Either "debug", "info", "warn", "error", "critical", default is "info"
    
    Florian Pritz's avatar
    Florian Pritz committed
    ;level = info
    
    # optional settings to set different levels for specific loggers. Ex filters = sqlstore:debug
    ;filters =
    
    
    # Set the default error message shown to users. This message is displayed instead of sensitive backend errors which should be obfuscated. Default is the same as the sample value.
    ;user_facing_default_error = "please inspect Grafana server log for details"
    
    
    Florian Pritz's avatar
    Florian Pritz committed
    # For "console" mode only
    [log.console]
    ;level =
    
    # log line format, valid options are text, console and json
    ;format = console
    
    # For "file" mode only
    [log.file]
    ;level =
    
    # log line format, valid options are text, console and json
    ;format = text
    
    # This enables automated log rotate(switch of following options), default is true
    ;log_rotate = true
    
    # Max line number of single file, default is 1000000
    ;max_lines = 1000000
    
    # Max size shift of single file, default is 28 means 1 << 28, 256MB
    ;max_size_shift = 28
    
    # Segment log daily, default is true
    ;daily_rotate = true
    
    # Expired days of log file(delete after max days), default is 7
    ;max_days = 7
    
    [log.syslog]
    ;level =
    
    # log line format, valid options are text, console and json
    ;format = text
    
    # Syslog network type and address. This can be udp, tcp, or unix. If left blank, the default unix endpoints will be used.
    ;network =
    ;address =
    
    # Syslog facility. user, daemon and local0 through local7 are valid.
    ;facility =
    
    # Syslog tag. By default, the process' argv[0] is used.
    ;tag =
    
    
    Jelle van der Waa's avatar
    Jelle van der Waa committed
    [log.frontend]
    
    # Should Faro javascript agent be initialized
    
    Jelle van der Waa's avatar
    Jelle van der Waa committed
    ;enabled = false
    
    
    # Custom HTTP endpoint to send events to. Default will log the events to stdout.
    ;custom_endpoint = /log-grafana-javascript-agent
    
    Jelle van der Waa's avatar
    Jelle van der Waa committed
    
    # Requests per second limit enforced an extended period, for Grafana backend log ingestion endpoint (/log).
    ;log_endpoint_requests_per_second_limit = 3
    
    # Max requests accepted per short interval of time for Grafana backend log ingestion endpoint (/log).
    ;log_endpoint_burst_limit = 15
    
    
    # Should error instrumentation be enabled, only affects Grafana Javascript Agent
    ;instrumentations_errors_enabled = true
    
    # Should console instrumentation be enabled, only affects Grafana Javascript Agent
    ;instrumentations_console_enabled = false
    
    # Should webvitals instrumentation be enabled, only affects Grafana Javascript Agent
    ;instrumentations_webvitals_enabled = false
    
    # Api Key, only applies to Grafana Javascript Agent provider
    ;api_key = testApiKey
    
    
    #################################### Usage Quotas ########################
    [quota]
    ; enabled = false
    
    #### set quotas to -1 to make unlimited. ####
    # limit number of users per Org.
    ; org_user = 10
    
    # limit number of dashboards per Org.
    ; org_dashboard = 100