Commit 78996516 by Diana Payton Committed by GitHub

Docs: Update configuration.md (#25707)

* Update configuration.md

* moved configuration.md to administration folder

* updated links

* Added quota section

* Update upgrading.md

* Update configuration.md

* Update configuration.md

* Update configuration.md

* Updating links

* Update configuration.md

* Update configuration.md

* Update configuration.md

Reworked the security options

* Update configuration.md

* Update configuration.md

* Update provisioning.md

* Update provisioning.md

* Update configuration.md

* Update configuration.md

* Update docs/sources/administration/configuration.md

Co-authored-by: Marcus Efraimsson <marcus.efraimsson@gmail.com>

Co-authored-by: Marcus Efraimsson <marcus.efraimsson@gmail.com>
parent 4463b18f
...@@ -53,7 +53,7 @@ aliases = ["/docs/grafana/v1.1", "/docs/grafana/latest/guides/reference/admin", ...@@ -53,7 +53,7 @@ aliases = ["/docs/grafana/v1.1", "/docs/grafana/latest/guides/reference/admin",
<h4>Getting started</h4> <h4>Getting started</h4>
<p>Learn the basics of using Grafana.</p> <p>Learn the basics of using Grafana.</p>
</a> </a>
<a href="{{< relref "installation/configuration.md" >}}" class="nav-cards__item nav-cards__item--guide"> <a href="{{< relref "administration/configuration.md" >}}" class="nav-cards__item nav-cards__item--guide">
<h4>Configure Grafana</h4> <h4>Configure Grafana</h4>
<p>Review the configuration and setup options.</p> <p>Review the configuration and setup options.</p>
</a> </a>
......
...@@ -130,7 +130,7 @@ grafana-cli --homepath "c:\Program Files\grafana" admin reset-admin-password myn ...@@ -130,7 +130,7 @@ grafana-cli --homepath "c:\Program Files\grafana" admin reset-admin-password myn
### Override config file ### Override config file
`--config value` overrides the default location where Grafana expects the configuration file. Refer to [Configuration]({{< relref "../installation/configuration.md" >}}) for more information about configuring Grafana and default configuration file locations. `--config value` overrides the default location where Grafana expects the configuration file. Refer to [Configuration]({{< relref "../administration/configuration.md" >}}) for more information about configuring Grafana and default configuration file locations.
**Example:** **Example:**
```bash ```bash
......
...@@ -14,7 +14,7 @@ Grafana supports automatic rendering of panels and dashboards as PNG images. Thi ...@@ -14,7 +14,7 @@ Grafana supports automatic rendering of panels and dashboards as PNG images. Thi
While an image is being rendered, the PNG image is temporarily written to the file system. When the image is rendered, the PNG image is temporarily written to the `png` folder in the Grafana `data` folder. While an image is being rendered, the PNG image is temporarily written to the file system. When the image is rendered, the PNG image is temporarily written to the `png` folder in the Grafana `data` folder.
A background job runs every 10 minutes and removes temporary images. You can configure how long an image should be stored before being removed by configuring the [temp-data-lifetime]({{< relref "../installation/configuration/#temp-data-lifetime" >}}) setting. A background job runs every 10 minutes and removes temporary images. You can configure how long an image should be stored before being removed by configuring the [temp-data-lifetime]({{< relref "../administration/configuration/#temp-data-lifetime" >}}) setting.
You can also render a PNG by clicking the dropdown arrow next to a panel title, then clicking **Share > Direct link rendered image**. You can also render a PNG by clicking the dropdown arrow next to a panel title, then clicking **Share > Direct link rendered image**.
...@@ -26,7 +26,7 @@ Rendering images can require a lot of memory, mainly because Grafana creates bro ...@@ -26,7 +26,7 @@ Rendering images can require a lot of memory, mainly because Grafana creates bro
## Alerting and render limits ## Alerting and render limits
Alert notifications can include images, but rendering many images at the same time can overload the server where the renderer is running. For instructions of how to configure this, see [concurrent_render_limit]({{< relref "../installation/configuration/#concurrent_render_limit" >}}). Alert notifications can include images, but rendering many images at the same time can overload the server where the renderer is running. For instructions of how to configure this, see [concurrent_render_limit]({{< relref "../administration/configuration/#concurrent_render_limit" >}}).
## Install Grafana Image Renderer plugin ## Install Grafana Image Renderer plugin
......
...@@ -12,7 +12,7 @@ weight = 8 ...@@ -12,7 +12,7 @@ weight = 8
Grafana collects some metrics about itself internally. Grafana supports pushing metrics to Graphite or exposing them to be scraped by Prometheus. Grafana collects some metrics about itself internally. Grafana supports pushing metrics to Graphite or exposing them to be scraped by Prometheus.
For more information about configuration options related to Grafana metrics, refer to [metrics]({{< relref "../installation/configuration/#metrics" >}}) and [metrics.graphite]({{< relref "../installation/configuration/#metrics-graphite" >}}) in [Configuration]({{< relref "../installation/configuration.md" >}}). For more information about configuration options related to Grafana metrics, refer to [metrics]({{< relref "../administration/configuration/#metrics" >}}) and [metrics.graphite]({{< relref "../administration/configuration/#metrics-graphite" >}}) in [Configuration]({{< relref "../administration/configuration.md" >}}).
## Available metrics ## Available metrics
......
...@@ -15,7 +15,7 @@ In previous versions of Grafana, you could only use the API for provisioning dat ...@@ -15,7 +15,7 @@ In previous versions of Grafana, you could only use the API for provisioning dat
## Config File ## Config File
Check out the [configuration]({{< relref "../installation/configuration" >}}) page for more information on what you can configure in `grafana.ini` Check out the [configuration]({{< relref "configuration.md" >}}) page for more information on what you can configure in `grafana.ini`
### Config File Locations ### Config File Locations
...@@ -61,17 +61,17 @@ Currently we do not provide any scripts/manifests for configuring Grafana. Rathe ...@@ -61,17 +61,17 @@ Currently we do not provide any scripts/manifests for configuring Grafana. Rathe
| Saltstack | [https://github.com/salt-formulas/salt-formula-grafana](https://github.com/salt-formulas/salt-formula-grafana) | | Saltstack | [https://github.com/salt-formulas/salt-formula-grafana](https://github.com/salt-formulas/salt-formula-grafana) |
| Jsonnet | [https://github.com/grafana/grafonnet-lib/](https://github.com/grafana/grafonnet-lib/) | | Jsonnet | [https://github.com/grafana/grafonnet-lib/](https://github.com/grafana/grafonnet-lib/) |
## Datasources ## Data sources
> This feature is available from v5.0 > This feature is available from v5.0
You can manage data sources in Grafana by adding one or more YAML config files in the [`provisioning/datasources`]({{< relref "../installation/configuration/#provisioning" >}}) directory. Each config file can contain a list of `datasources` that will be added or updated during start up. If the data source already exists, then Grafana updates it to match the configuration file. The config file can also contain a list of data sources that should be deleted. That list is called `deleteDatasources`. Grafana deletes data sources listed in `deleteDatasources` before inserting or updating those in the `datasource` list. It's possible to manage data sources in Grafana by adding one or more yaml config files in the [`provisioning/datasources`](/administration/configuration/#provisioning) directory. Each config file can contain a list of `datasources` that will be added or updated during start up. If the data source already exists, then Grafana updates it to match the configuration file. The config file can also contain a list of data sources that should be deleted. That list is called `deleteDatasources`. Grafana will delete data sources listed in `deleteDatasources` before inserting/updating those in the `datasource` list.
### Running Multiple Grafana Instances ### Running Multiple Grafana Instances
If you are running multiple instances of Grafana you might run into problems if they have different versions of the `datasource.yaml` configuration file. The best way to solve this problem is to add a version number to each datasource in the configuration and increase it when you update the config. Grafana will only update datasources with the same or lower version number than specified in the config. That way, old configs cannot overwrite newer configs if they restart at the same time. If you are running multiple instances of Grafana you might run into problems if they have different versions of the `datasource.yaml` configuration file. The best way to solve this problem is to add a version number to each datasource in the configuration and increase it when you update the config. Grafana will only update datasources with the same or lower version number than specified in the config. That way, old configs cannot overwrite newer configs if they restart at the same time.
### Example Datasource Config File ### Example data source Config File
```yaml ```yaml
# config file version # config file version
...@@ -177,7 +177,7 @@ Since not all datasources have the same configuration settings we only have the ...@@ -177,7 +177,7 @@ Since not all datasources have the same configuration settings we only have the
`{"authType":"keys","defaultRegion":"us-west-2","timeField":"@timestamp"}` `{"authType":"keys","defaultRegion":"us-west-2","timeField":"@timestamp"}`
Secure json data is a map of settings that will be encrypted with [secret key]({{< relref "../installation/configuration/#secret-key" >}}) from the Grafana config. The purpose of this is only to hide content from the users of the application. This should be used for storing TLS Cert and password that Grafana will append to the request on the server side. All of these settings are optional. Secure json data is a map of settings that will be encrypted with [secret key]({{< relref "configuration.md#secret-key" >}}) from the Grafana config. The purpose of this is only to hide content from the users of the application. This should be used for storing TLS Cert and password that Grafana will append to the request on the server side. All of these settings are optional.
| Name | Type | Datasource | Description | | Name | Type | Datasource | Description |
| ----------------- | ------ | ---------- | --------------------------------------- | | ----------------- | ------ | ---------- | --------------------------------------- |
...@@ -191,7 +191,7 @@ Secure json data is a map of settings that will be encrypted with [secret key]({ ...@@ -191,7 +191,7 @@ Secure json data is a map of settings that will be encrypted with [secret key]({
#### Custom HTTP headers for datasources #### Custom HTTP headers for datasources
Datasources managed by Grafanas provisioning can be configured to add HTTP headers to all requests Data sources managed by Grafanas provisioning can be configured to add HTTP headers to all requests
going to that datasource. The header name is configured in the `jsonData` field and the header value should be going to that datasource. The header name is configured in the `jsonData` field and the header value should be
configured in `secureJsonData`. configured in `secureJsonData`.
...@@ -212,7 +212,7 @@ datasources: ...@@ -212,7 +212,7 @@ datasources:
> This feature is available from v7.1 > This feature is available from v7.1
You can manage plugins in Grafana by adding one or more YAML config files in the [`provisioning/plugins`]({{< relref "../installation/configuration/#provisioning" >}}) directory. Each config file can contain a list of `apps` that will be updated during start up. Grafana updates each app to match the configuration file. You can manage plugins in Grafana by adding one or more YAML config files in the [`provisioning/plugins`]({{< relref "configuration.md#provisioning" >}}) directory. Each config file can contain a list of `apps` that will be updated during start up. Grafana updates each app to match the configuration file.
### Example plugin configuration file ### Example plugin configuration file
...@@ -240,7 +240,7 @@ apps: ...@@ -240,7 +240,7 @@ apps:
## Dashboards ## Dashboards
You can manage dashboards in Grafana by adding one or more YAML config files in the [`provisioning/dashboards`]({{< relref "../installation/configuration.md" >}}) directory. Each config file can contain a list of `dashboards providers` that load dashboards into Grafana from the local filesystem. You can manage dashboards in Grafana by adding one or more YAML config files in the [`provisioning/dashboards`]({{< relref "configuration.md" >}}) directory. Each config file can contain a list of `dashboards providers` that load dashboards into Grafana from the local filesystem.
The dashboard provider config file looks somewhat like this: The dashboard provider config file looks somewhat like this:
...@@ -304,7 +304,7 @@ By default Grafana will delete dashboards in the database if the file is removed ...@@ -304,7 +304,7 @@ By default Grafana will delete dashboards in the database if the file is removed
## Alert Notification Channels ## Alert Notification Channels
Alert Notification Channels can be provisioned by adding one or more yaml config files in the [`provisioning/notifiers`](/installation/configuration/#provisioning) directory. Alert Notification Channels can be provisioned by adding one or more yaml config files in the [`provisioning/notifiers`](/administration/configuration/#provisioning) directory.
Each config file can contain the following top-level fields: Each config file can contain the following top-level fields:
......
...@@ -41,7 +41,7 @@ This section describes the fields you fill out to create an alert. ...@@ -41,7 +41,7 @@ This section describes the fields you fill out to create an alert.
- **Evaluate every -** Specify how often the scheduler should evaluate the alert rule. This is referred to as the _evaluation interval_. - **Evaluate every -** Specify how often the scheduler should evaluate the alert rule. This is referred to as the _evaluation interval_.
- **For -** Specify how long the query needs to violate the configured thresholds before the alert notification triggers. - **For -** Specify how long the query needs to violate the configured thresholds before the alert notification triggers.
You can set a minimum evaluation interval in the `alerting.min_interval_seconds` config field, to set a minimum time between evaluations. Refer to [Configuration]({{< relref "../installation/configuration.md" >}}#min-interval-seconds) for more information. You can set a minimum evaluation interval in the `alerting.min_interval_seconds` config field, to set a minimum time between evaluations. Refer to [Configuration]({{< relref "../administration/configuration.md" >}}#min-interval-seconds) for more information.
> **Caution:** Do not use `For` with the `If no data or all values are null` setting set to `No Data`. The triggering of `No Data` will trigger instantly and not take `For` into consideration. This may also result in that an OK notification not being sent if alert transitions from `No Data -> Pending -> OK`. > **Caution:** Do not use `For` with the `If no data or all values are null` setting set to `No Data`. The triggering of `No Data` will trigger instantly and not take `For` into consideration. This may also result in that an OK notification not being sent if alert transitions from `No Data -> Pending -> OK`.
......
...@@ -76,7 +76,7 @@ VictorOps | `victorops` | yes, external only | no ...@@ -76,7 +76,7 @@ VictorOps | `victorops` | yes, external only | no
### Email ### Email
To enable email notifications you have to setup [SMTP settings]({{< relref "../installation/configuration/#smtp" >}}) To enable email notifications you have to setup [SMTP settings]({{< relref "../administration/configuration/#smtp" >}})
in the Grafana config. Email notifications will upload an image of the alert graph to an in the Grafana config. Email notifications will upload an image of the alert graph to an
external image destination if available or fallback to attaching the image to the email. external image destination if available or fallback to attaching the image to the email.
Be aware that if you use the `local` image storage email servers and clients might not be Be aware that if you use the `local` image storage email servers and clients might not be
...@@ -213,11 +213,11 @@ Alertmanager handles alerts sent by client applications such as Prometheus serve ...@@ -213,11 +213,11 @@ Alertmanager handles alerts sent by client applications such as Prometheus serve
Grafana can render the panel associated with the alert rule as a PNG image and include that in the notification. Read more about the requirements and how to configure Grafana can render the panel associated with the alert rule as a PNG image and include that in the notification. Read more about the requirements and how to configure
[image rendering]({{< relref "../administration/image_rendering/" >}}). [image rendering]({{< relref "../administration/image_rendering/" >}}).
You must configure an [external image storage provider]({{< relref "../installation/configuration/#external-image-storage" >}}) in order to receive images in alert notifications. If your notification channel requires that the image be publicly accessible (e.g. Slack, PagerDuty), configure a provider which uploads the image to a remote image store like Amazon S3, Webdav, Google Cloud Storage, or Azure Blob Storage. Otherwise, the local provider can be used to serve the image directly from Grafana. You must configure an [external image storage provider]({{< relref "../administration/configuration/#external-image-storage" >}}) in order to receive images in alert notifications. If your notification channel requires that the image be publicly accessible (e.g. Slack, PagerDuty), configure a provider which uploads the image to a remote image store like Amazon S3, Webdav, Google Cloud Storage, or Azure Blob Storage. Otherwise, the local provider can be used to serve the image directly from Grafana.
Notification services which need public image access are marked as 'external only'. Notification services which need public image access are marked as 'external only'.
## Configure the link back to Grafana from alert notifications ## Configure the link back to Grafana from alert notifications
All alert notifications contain a link back to the triggered alert in the Grafana instance. All alert notifications contain a link back to the triggered alert in the Grafana instance.
This URL is based on the [domain]({{< relref "../installation/configuration/#domain" >}}) setting in Grafana. This URL is based on the [domain]({{< relref "../administration/configuration/#domain" >}}) setting in Grafana.
...@@ -94,7 +94,7 @@ To enable the Azure AD OAuth2 you must register your application with Azure AD. ...@@ -94,7 +94,7 @@ To enable the Azure AD OAuth2 you must register your application with Azure AD.
## Enable Azure AD OAuth in Grafana ## Enable Azure AD OAuth in Grafana
1. Add the following to the [Grafana configuration file]({{< relref "../installation/configuration.md#config-file-locations" >}}): 1. Add the following to the [Grafana configuration file]({{< relref "../administration/configuration.md#config-file-locations" >}}):
```ini ```ini
[auth.azuread] [auth.azuread]
...@@ -110,7 +110,7 @@ allowed_domains = ...@@ -110,7 +110,7 @@ allowed_domains =
allowed_groups = allowed_groups =
``` ```
> Note: Ensure that the [root_url]({{< relref "../installation/configuration/#root-url" >}}) in Grafana is set in your Azure Application Reply URLs (App -> Settings -> Reply URLs) > Note: Ensure that the [root_url]({{< relref "../administration/configuration/#root-url" >}}) in Grafana is set in your Azure Application Reply URLs (App -> Settings -> Reply URLs)
### Configure allowed groups and domains ### Configure allowed groups and domains
......
...@@ -31,7 +31,7 @@ First, you need to create a Google OAuth Client: ...@@ -31,7 +31,7 @@ First, you need to create a Google OAuth Client:
## Enable Google OAuth in Grafana ## Enable Google OAuth in Grafana
Specify the Client ID and Secret in the [Grafana configuration file]({{< relref "../installation/configuration.md#config-file-locations" >}}). For example: Specify the Client ID and Secret in the [Grafana configuration file]({{< relref "../administration/configuration.md#config-file-locations" >}}). For example:
```bash ```bash
[auth.google] [auth.google]
......
...@@ -26,7 +26,7 @@ This means that you should be able to configure LDAP integration using any compl ...@@ -26,7 +26,7 @@ This means that you should be able to configure LDAP integration using any compl
## Enable LDAP ## Enable LDAP
In order to use LDAP integration you'll first need to enable LDAP in the [main config file]({{< relref "../installation/configuration.md" >}}) as well as specify the path to the LDAP In order to use LDAP integration you'll first need to enable LDAP in the [main config file]({{< relref "../administration/configuration.md" >}}) as well as specify the path to the LDAP
specific configuration file (default: `/etc/grafana/ldap.toml`). specific configuration file (default: `/etc/grafana/ldap.toml`).
```bash ```bash
...@@ -355,7 +355,7 @@ Please inspect your Active Directory configuration and documentation to find the ...@@ -355,7 +355,7 @@ Please inspect your Active Directory configuration and documentation to find the
## Troubleshooting ## Troubleshooting
To troubleshoot and get more log info enable LDAP debug logging in the [main config file]({{< relref "../installation/configuration.md" >}}). To troubleshoot and get more log info enable LDAP debug logging in the [main config file]({{< relref "../administration/configuration.md" >}}).
```bash ```bash
[log] [log]
......
...@@ -38,7 +38,7 @@ Before you can sign a user in, you need to create an Okta application from the O ...@@ -38,7 +38,7 @@ Before you can sign a user in, you need to create an Okta application from the O
## Enable Okta OAuth in Grafana ## Enable Okta OAuth in Grafana
1. Add the following to the [Grafana configuration file]({{< relref "../installation/configuration.md#config-file-locations" >}}): 1. Add the following to the [Grafana configuration file]({{< relref "../administration/configuration.md#config-file-locations" >}}):
```ini ```ini
[auth.okta] [auth.okta]
......
...@@ -11,7 +11,7 @@ For more information on the types of plugins you can build, refer to the [Plugin ...@@ -11,7 +11,7 @@ For more information on the types of plugins you can build, refer to the [Plugin
The easiest way to start developing Grafana plugins is to use the [Grafana Toolkit](https://www.npmjs.com/package/@grafana/toolkit). The easiest way to start developing Grafana plugins is to use the [Grafana Toolkit](https://www.npmjs.com/package/@grafana/toolkit).
Open the terminal, and run the following command in your [plugin directory]({{< relref "../../installation/configuration.md#plugins" >}}): Open the terminal, and run the following command in your [plugin directory]({{< relref "../../administration/configuration.md#plugins" >}}):
```bash ```bash
npx @grafana/toolkit plugin:create my-grafana-plugin npx @grafana/toolkit plugin:create my-grafana-plugin
......
...@@ -87,7 +87,7 @@ export { WorldmapCtrl as PanelCtrl }; ...@@ -87,7 +87,7 @@ export { WorldmapCtrl as PanelCtrl };
There are three ways that you can start developing a Grafana plugin. There are three ways that you can start developing a Grafana plugin.
1. Set up a Grafana development environment. [(described here)](https://github.com/grafana/grafana/blob/master/contribute/developer-guide.md) and place your plugin in the `data/plugins` folder. 1. Set up a Grafana development environment. [(described here)](https://github.com/grafana/grafana/blob/master/contribute/developer-guide.md) and place your plugin in the `data/plugins` folder.
2. Install Grafana and place your plugin in the plugins directory which is set in your [config file](/installation/configuration). By default this is `/var/lib/grafana/plugins` on Linux systems. 2. Install Grafana and place your plugin in the plugins directory which is set in your [config file](/administration/configuration). By default this is `/var/lib/grafana/plugins` on Linux systems.
3. Place your plugin directory anywhere you like and specify it grafana.ini. 3. Place your plugin directory anywhere you like and specify it grafana.ini.
We encourage people to set up the full Grafana environment so that you can get inspiration from the rest of the Grafana code base. We encourage people to set up the full Grafana environment so that you can get inspiration from the rest of the Grafana code base.
......
...@@ -89,9 +89,9 @@ This setting can also be set with an environment variable, which is useful if yo ...@@ -89,9 +89,9 @@ This setting can also be set with an environment variable, which is useful if yo
### Root URL ### Root URL
Update the [`root_url`](../installation/configuration/#root-url) in your configuration. It should be the URL that users type in their browsers to access the frontend, not the node hostname(s). Update the [`root_url`](../administration/configuration/#root-url) in your configuration. It should be the URL that users type in their browsers to access the frontend, not the node hostname(s).
This is important, because as part of the validation checks at startup, Grafana compares the license URL to the [`root_url`](../installation/configuration/#root-url) in your configuration. This is important, because as part of the validation checks at startup, Grafana compares the license URL to the [`root_url`](../administration/configuration/#root-url) in your configuration.
In your configuration file: In your configuration file:
......
...@@ -12,7 +12,7 @@ weight = 300 ...@@ -12,7 +12,7 @@ weight = 300
# Grafana Enterprise configuration # Grafana Enterprise configuration
This page describes Grafana Enterprise-specific configuration options that you can specify in a `.ini` configuration file or using environment variables. Refer to [Configuration]({{< relref "../installation/configuration.md" >}}) for more information about available configuration options. This page describes Grafana Enterprise-specific configuration options that you can specify in a `.ini` configuration file or using environment variables. Refer to [Configuration]({{< relref "../administration/configuration.md" >}}) for more information about available configuration options.
## [white_labeling] ## [white_labeling]
......
...@@ -16,7 +16,7 @@ If your license has expired most of Grafana keeps working as normal. Some enterp ...@@ -16,7 +16,7 @@ If your license has expired most of Grafana keeps working as normal. Some enterp
## Update your license ## Update your license
1. Locate your current `license.jwt` file. In a standard installation it is stored inside Grafana's data directory, which on a typical Linux installation is in `/var/lib/grafana/data`. This location might be overridden in the ini file [Configuration](https://grafana.com/docs/grafana/latest/installation/configuration/). 1. Locate your current `license.jwt` file. In a standard installation it is stored inside Grafana's data directory, which on a typical Linux installation is in `/var/lib/grafana/data`. This location might be overridden in the ini file [Configuration](https://grafana.com/docs/grafana/latest/administration/configuration/).
```ini ```ini
[enterprise] [enterprise]
license_path = /path/to/your/license.jwt license_path = /path/to/your/license.jwt
......
...@@ -21,7 +21,7 @@ Any changes you make to a dashboard used in a report are reflected the next time ...@@ -21,7 +21,7 @@ Any changes you make to a dashboard used in a report are reflected the next time
## Requirements ## Requirements
* SMTP must be configured for reports to be sent. Refer to [SMTP]({{< relref "../installation/configuration.md#smtp" >}}) in [Configuration]({{< relref "../installation/configuration.md" >}}) for more information. * SMTP must be configured for reports to be sent. Refer to [SMTP]({{< relref "../administration/configuration.md#smtp" >}}) in [Configuration]({{< relref "../administration/configuration.md" >}}) for more information.
* The Image Renderer plugin must be installed or the remote rendering service must be set up. Refer to [Image rendering]({{< relref "../administration/image_rendering.md" >}}) for more information. * The Image Renderer plugin must be installed or the remote rendering service must be set up. Refer to [Image rendering]({{< relref "../administration/image_rendering.md" >}}) for more information.
## Create or update a report ## Create or update a report
...@@ -109,7 +109,7 @@ When generating reports, each panel renders separately before being collected in ...@@ -109,7 +109,7 @@ When generating reports, each panel renders separately before being collected in
To modify the panels' clarity you can set a scale factor for the rendered images. A higher scale factor is more legible but will increase the file size of the generated PDF. To modify the panels' clarity you can set a scale factor for the rendered images. A higher scale factor is more legible but will increase the file size of the generated PDF.
These options are available in the [configuration]({{< relref "../installation/configuration.md">}}) file. These options are available in the [configuration]({{< relref "../administration/configuration.md">}}) file.
```ini ```ini
[reporting] [reporting]
...@@ -132,7 +132,7 @@ If the time zone is set differently between your Grafana server and its remote i ...@@ -132,7 +132,7 @@ If the time zone is set differently between your Grafana server and its remote i
## Troubleshoot reporting ## Troubleshoot reporting
To troubleshoot and get more log information, enable debug logging in the configuration file. Refer to [Configuration]({{< relref "../installation/configuration.md#filters" >}}) for more information. To troubleshoot and get more log information, enable debug logging in the configuration file. Refer to [Configuration]({{< relref "../administration/configuration.md#filters" >}}) for more information.
```bash ```bash
[log] [log]
......
...@@ -39,7 +39,7 @@ In terms of initiation: ...@@ -39,7 +39,7 @@ In terms of initiation:
## Set up SAML authentication ## Set up SAML authentication
The table below describes all SAML configuration options. Continue reading below for details on specific options. Like any other Grafana configuration, you can apply these options as [environment variables]({{< relref "../installation/configuration.md#configure-with-environment-variables" >}}). The table below describes all SAML configuration options. Continue reading below for details on specific options. Like any other Grafana configuration, you can apply these options as [environment variables]({{< relref "../administration/configuration.md#configure-with-environment-variables" >}}).
| Setting | Required | Description | Default | | Setting | Required | Description | Default |
| ----------------------------------------------------------- | -------- | -------------------------------------------------------------------------------------------------- | ------------- | | ----------------------------------------------------------- | -------- | -------------------------------------------------------------------------------------------------- | ------------- |
...@@ -65,7 +65,7 @@ The table below describes all SAML configuration options. Continue reading below ...@@ -65,7 +65,7 @@ The table below describes all SAML configuration options. Continue reading below
To use the SAML integration, in the `auth.saml` section of in the Grafana custom configuration file, set `enabled` to `true`. To use the SAML integration, in the `auth.saml` section of in the Grafana custom configuration file, set `enabled` to `true`.
Refer to [Configuration]({{< relref "../installation/configuration.md" >}}) for more information about configuring Grafana. Refer to [Configuration]({{< relref "../administration/configuration.md" >}}) for more information about configuring Grafana.
### Certificate and private key ### Certificate and private key
...@@ -239,7 +239,7 @@ To configure SAML integration with Okta, create integration inside the Okta orga ...@@ -239,7 +239,7 @@ To configure SAML integration with Okta, create integration inside the Okta orga
### Edit SAML options in the Grafana config file ### Edit SAML options in the Grafana config file
Once the application is created, configure Grafana to use it for SAML authentication. Refer to [Configuration]({{< relref "../installation/configuration.md" >}}) to get more information about how to configure Grafana. Once the application is created, configure Grafana to use it for SAML authentication. Refer to [Configuration]({{< relref "../administration/configuration.md" >}}) to get more information about how to configure Grafana.
1. In the `[auth.saml]` section in the Grafana configuration file, set [`enabled`]({{< relref "./enterprise-configuration.md#enabled" >}}) to `true`. 1. In the `[auth.saml]` section in the Grafana configuration file, set [`enabled`]({{< relref "./enterprise-configuration.md#enabled" >}}) to `true`.
1. Configure the [certificate and private key]({{< relref "#certificate-and-private-key" >}}). 1. Configure the [certificate and private key]({{< relref "#certificate-and-private-key" >}}).
...@@ -271,7 +271,7 @@ assertion_attribute_groups = Group ...@@ -271,7 +271,7 @@ assertion_attribute_groups = Group
## Troubleshoot SAML authentication ## Troubleshoot SAML authentication
To troubleshoot and get more log information, enable SAML debug logging in the configuration file. Refer to [Configuration]({{< relref "../installation/configuration.md#filters" >}}) for more information. To troubleshoot and get more log information, enable SAML debug logging in the configuration file. Refer to [Configuration]({{< relref "../administration/configuration.md#filters" >}}) for more information.
```bash ```bash
[log] [log]
......
...@@ -28,7 +28,7 @@ When more users are active on a dashboard than can fit in the presence indicator ...@@ -28,7 +28,7 @@ When more users are active on a dashboard than can fit in the presence indicator
{{< docs-imagebox img="/img/docs/enterprise/presence_indicators.png" max-width="400px" class="docs-image--no-shadow" >}} {{< docs-imagebox img="/img/docs/enterprise/presence_indicators.png" max-width="400px" class="docs-image--no-shadow" >}}
You can choose your own definition of "recent" by setting it in the [configuration]({{< relref "../installation/configuration.md">}}) file. You can choose your own definition of "recent" by setting it in the [configuration]({{< relref "../administration/configuration.md">}}) file.
```ini ```ini
[analytics.views] [analytics.views]
......
...@@ -34,7 +34,7 @@ You can change the following elements: ...@@ -34,7 +34,7 @@ You can change the following elements:
{{< docs-imagebox img="/img/docs/v66/whitelabeling_1.png" max-width="800px" caption="White labeling example" >}} {{< docs-imagebox img="/img/docs/v66/whitelabeling_1.png" max-width="800px" caption="White labeling example" >}}
The configuration file in Grafana Enterprise contains the following options. Each option is defined in the file. For more information about configuring Grafana, refer to [Configuration]({{< relref "../installation/configuration.md">}}). The configuration file in Grafana Enterprise contains the following options. Each option is defined in the file. For more information about configuring Grafana, refer to [Configuration]({{< relref "../administration/configuration.md">}}).
```ini ```ini
# Enterprise only # Enterprise only
......
...@@ -54,7 +54,7 @@ All users might want to learn about: ...@@ -54,7 +54,7 @@ All users might want to learn about:
Administrators might want to learn about: Administrators might want to learn about:
* [Grafana configuration]({{< relref "../installation/configuration.md" >}}) * [Grafana configuration]({{< relref "../administration/configuration.md" >}})
* [Authentication]({{< relref "../auth/overview.md" >}}) * [Authentication]({{< relref "../auth/overview.md" >}})
* [User permissions and roles]({{< relref "../permissions/overview.md" >}}) * [User permissions and roles]({{< relref "../permissions/overview.md" >}})
* [Provisioning]({{< relref "../administration/provisioning.md" >}}) * [Provisioning]({{< relref "../administration/provisioning.md" >}})
......
...@@ -51,7 +51,7 @@ Templating allows you to drill down into your data, say, from all data to North ...@@ -51,7 +51,7 @@ Templating allows you to drill down into your data, say, from all data to North
## Configure Grafana ## Configure Grafana
If you're a Grafana administrator, then you'll want to thoroughly familiarize yourself with [Grafana configuration options]({{< relref "../installation/configuration.md" >}}) and the [Grafana CLI]({{< relref "../administration/cli.md" >}}). If you're a Grafana administrator, then you'll want to thoroughly familiarize yourself with [Grafana configuration options]({{< relref "../administration/configuration.md" >}}) and the [Grafana CLI]({{< relref "../administration/cli.md" >}}).
Configuration covers both config files and environment variables. You can set up default ports, logging levels, email IP addresses, security, and more. Configuration covers both config files and environment variables. You can set up default ports, logging levels, email IP addresses, security, and more.
......
...@@ -143,8 +143,8 @@ Read more about the short-lived token solution and how to configure it [here](/a ...@@ -143,8 +143,8 @@ Read more about the short-lived token solution and how to configure it [here](/a
Besides these changes we have also made security improvements regarding Cross-Site Request Forgery (CSRF) and Cross-site Scripting (XSS) vulnerabilities: Besides these changes we have also made security improvements regarding Cross-Site Request Forgery (CSRF) and Cross-site Scripting (XSS) vulnerabilities:
* Cookies are per default using the [SameSite](/installation/configuration/#cookie-samesite) attribute to protect against CSRF attacks * Cookies are per default using the [SameSite](/administration/configuration/#cookie-samesite) attribute to protect against CSRF attacks
* Script tags in text panels are per default [disabled](/installation/configuration/#disable-sanitize-html) to protect against XSS attacks * Script tags in text panels are per default [disabled](/administration/configuration/#disable-sanitize-html) to protect against XSS attacks
> If you're using [Auth Proxy Authentication](/auth/auth-proxy/) you still need to have user sessions set up and configured > If you're using [Auth Proxy Authentication](/auth/auth-proxy/) you still need to have user sessions set up and configured
but our goal is to remove this requirement in the near future. but our goal is to remove this requirement in the near future.
......
...@@ -32,7 +32,7 @@ This feature also adds a new Team permission that can be assigned to any user wi ...@@ -32,7 +32,7 @@ This feature also adds a new Team permission that can be assigned to any user wi
We believe that this is more in line with the Grafana philosophy, as it will allow teams to be more self-organizing. This option will be made permanent if it gets positive feedback from the community so let us know what you think in the [issue on GitHub](https://github.com/grafana/grafana/issues/15590). We believe that this is more in line with the Grafana philosophy, as it will allow teams to be more self-organizing. This option will be made permanent if it gets positive feedback from the community so let us know what you think in the [issue on GitHub](https://github.com/grafana/grafana/issues/15590).
To turn this feature on add the following [config option](/installation/configuration/#editors-can-admin) to your Grafana ini file in the `users` section and then restart the Grafana server: To turn this feature on add the following [config option](/administration/configuration/#editors-can-admin) to your Grafana ini file in the `users` section and then restart the Grafana server:
```ini ```ini
[users] [users]
......
...@@ -80,7 +80,7 @@ to use the full panel height in case there is no panel title. ...@@ -80,7 +80,7 @@ to use the full panel height in case there is no panel title.
This release contains a lot of small features and fixes: This release contains a lot of small features and fixes:
- Explore - Adds user time zone support, reconnect for failing data sources and a fix that prevents killing Prometheus instances when Histogram metrics are loaded. - Explore - Adds user time zone support, reconnect for failing data sources and a fix that prevents killing Prometheus instances when Histogram metrics are loaded.
- Alerting - Adds support for configuring timeout durations and retries, see [configuration](/installation/configuration/#evaluation-timeout-seconds) for more information. - Alerting - Adds support for configuring timeout durations and retries, see [configuration](/administration/configuration/#evaluation-timeout-seconds) for more information.
- Azure Monitor - Adds support for multiple subscriptions per data source. - Azure Monitor - Adds support for multiple subscriptions per data source.
- Elasticsearch - A small bug fix to properly display percentiles metrics in table panel. - Elasticsearch - A small bug fix to properly display percentiles metrics in table panel.
- InfluxDB - Support for POST HTTP verb. - InfluxDB - Support for POST HTTP verb.
......
...@@ -90,7 +90,7 @@ Grafana 6.4 continues the work started in 6.3 of creating a data model and query ...@@ -90,7 +90,7 @@ Grafana 6.4 continues the work started in 6.3 of creating a data model and query
The first new feature all these changes have enabled is the ability to share query results between panels. So for example if you have an expensive query you can visualize the same results in a graph, table and singlestat panel. To reuse another panel’s query result select the data source named `-- Dashboard --` and then select the panel. The first new feature all these changes have enabled is the ability to share query results between panels. So for example if you have an expensive query you can visualize the same results in a graph, table and singlestat panel. To reuse another panel’s query result select the data source named `-- Dashboard --` and then select the panel.
To make the sharing of query results even more powerful we are introducing a transformation step as well that allows you to select specific parts of the query result and transform it. This new transformation feature is in [alpha](https://grafana.com/docs/installation/configuration/#enable-alpha) state and has to be enabled in the config file. To make the sharing of query results even more powerful we are introducing a transformation step as well that allows you to select specific parts of the query result and transform it. This new transformation feature is in [alpha](https://grafana.com/docs/administration/configuration/#enable-alpha) state and has to be enabled in the config file.
DataFrame, our primary data model, has now a [columnar](https://en.wikipedia.org/wiki/Column-oriented_DBMS) layout. This DataFrame, our primary data model, has now a [columnar](https://en.wikipedia.org/wiki/Column-oriented_DBMS) layout. This
will support easier frontend processing. The DataSource query interface has been updated to better support streaming. will support easier frontend processing. The DataSource query interface has been updated to better support streaming.
......
...@@ -103,7 +103,7 @@ The time picker has gotten a major design update. Key changes: ...@@ -103,7 +103,7 @@ The time picker has gotten a major design update. Key changes:
## Cookie management modifications ## Cookie management modifications
In order to align with a [change in Chrome 80](https://www.chromestatus.com/feature/5088147346030592), a breaking change has been introduced to Grafana's [`cookie_samesite` setting]({{< relref "../installation/configuration.md#cookie-samesite" >}}). Grafana now properly renders cookies with the `SameSite=None` attribute when this setting is `none`. The previous behavior of `none` was to omit the `SameSite` attribute from cookies. Grafana will use the previous behavior when `cookie_samesite` is set to `disabled`. In order to align with a [change in Chrome 80](https://www.chromestatus.com/feature/5088147346030592), a breaking change has been introduced to Grafana's [`cookie_samesite` setting]({{< relref "../administration/configuration.md#cookie-samesite" >}}). Grafana now properly renders cookies with the `SameSite=None` attribute when this setting is `none`. The previous behavior of `none` was to omit the `SameSite` attribute from cookies. Grafana will use the previous behavior when `cookie_samesite` is set to `disabled`.
Read more about this in the [upgrade notes]({{< relref "../installation/upgrading/#important-changes-regarding-samesite-cookie-attribute" >}}). Read more about this in the [upgrade notes]({{< relref "../installation/upgrading/#important-changes-regarding-samesite-cookie-attribute" >}}).
......
...@@ -47,7 +47,7 @@ Grafana v6.7 comes with a new OAuth integration for Microsoft Azure Active Direc ...@@ -47,7 +47,7 @@ Grafana v6.7 comes with a new OAuth integration for Microsoft Azure Active Direc
Allowing a low dashboard refresh interval can cause severe load on data sources and Grafana. Grafana v6.7 allows you to restrict the dashboard refresh interval so it cannot be set lower than a given interval. This provides a way for administrators to control dashboard refresh behavior on a global level. Allowing a low dashboard refresh interval can cause severe load on data sources and Grafana. Grafana v6.7 allows you to restrict the dashboard refresh interval so it cannot be set lower than a given interval. This provides a way for administrators to control dashboard refresh behavior on a global level.
Refer to min_refresh_interval in [Configuration]({{< relref "../installation/configuration#min-refresh-interval" >}}) for more information and how to enable this feature. Refer to min_refresh_interval in [Configuration]({{< relref "../administration/configuration#min-refresh-interval" >}}) for more information and how to enable this feature.
### Stackdriver project selector ### Stackdriver project selector
......
...@@ -229,7 +229,7 @@ Content-Type: application/json ...@@ -229,7 +229,7 @@ Content-Type: application/json
} }
``` ```
Note that `OrgId` is an optional parameter that can be used to assign a new user to a different organization when [auto_assign_org](https://grafana.com/docs/grafana/latest/installation/configuration/#auto-assign-org) is set to `true`. Note that `OrgId` is an optional parameter that can be used to assign a new user to a different organization when [auto_assign_org](https://grafana.com/docs/grafana/latest/administration/configuration/#auto-assign-org) is set to `true`.
**Example Response**: **Example Response**:
......
...@@ -18,7 +18,7 @@ To prevent this type of exploitation from happening, we recommend that you apply ...@@ -18,7 +18,7 @@ To prevent this type of exploitation from happening, we recommend that you apply
## Limit IP addresses/hostnames for data source URL ## Limit IP addresses/hostnames for data source URL
You can configure Grafana to only allow certain IP addresses or hostnames to be used as data source URLs and proxied through the Grafana data source proxy. Refer to [data_source_proxy_whitelist]({{< relref "configuration/#data-source-proxy-whitelist" >}}) for usage instructions. You can configure Grafana to only allow certain IP addresses or hostnames to be used as data source URLs and proxied through the Grafana data source proxy. Refer to [data_source_proxy_whitelist]({{< relref "../administration/configuration/#data-source-proxy-whitelist" >}}) for usage instructions.
## Firewall rules ## Firewall rules
......
...@@ -146,7 +146,7 @@ If you're using systemd and have a large amount of annotations consider temporar ...@@ -146,7 +146,7 @@ If you're using systemd and have a large amount of annotations consider temporar
## Upgrading to v6.0 ## Upgrading to v6.0
If you have text panels with script tags they will no longer work due to a new setting that per default disallow unsanitized HTML. If you have text panels with script tags they will no longer work due to a new setting that per default disallow unsanitized HTML.
Read more [here]({{< relref "configuration/#disable-sanitize-html" >}}) about this new setting. Read more [here]({{< relref "../administration/configuration/#disable-sanitize-html" >}}) about this new setting.
### Authentication and security ### Authentication and security
...@@ -191,7 +191,7 @@ configuration. ...@@ -191,7 +191,7 @@ configuration.
### Embedding Grafana ### Embedding Grafana
If you're embedding Grafana in a `<frame>`, `<iframe>`, `<embed>` or `<object>` on a different website it will no longer work due to a new setting If you're embedding Grafana in a `<frame>`, `<iframe>`, `<embed>` or `<object>` on a different website it will no longer work due to a new setting
that per default instructs the browser to not allow Grafana to be embedded. Read more [here]({{< relref "configuration/#allow-embedding" >}}) about that per default instructs the browser to not allow Grafana to be embedded. Read more [here]({{< relref "../administration/configuration/#allow-embedding" >}}) about
this new setting. this new setting.
### Session storage is no longer used ### Session storage is no longer used
...@@ -237,7 +237,7 @@ The Generic OAuth setting `send_client_credentials_via_post`, used for supportin ...@@ -237,7 +237,7 @@ The Generic OAuth setting `send_client_credentials_via_post`, used for supportin
Chrome 80 treats cookies as `SameSite=Lax` by default if no `SameSite` attribute is specified, see https://www.chromestatus.com/feature/5088147346030592. Chrome 80 treats cookies as `SameSite=Lax` by default if no `SameSite` attribute is specified, see https://www.chromestatus.com/feature/5088147346030592.
Due to this change in Chrome, the `[security]` setting `cookie_samesite` configured to `none` now renders cookies with `SameSite=None` attribute compared to before where no `SameSite` attribute was added to cookies. To get the old behavior, use value `disabled` instead of `none`, see [cookie_samesite in Configuration]({{< relref "configuration/#cookie-samesite" >}}) for more information. Due to this change in Chrome, the `[security]` setting `cookie_samesite` configured to `none` now renders cookies with `SameSite=None` attribute compared to before where no `SameSite` attribute was added to cookies. To get the old behavior, use value `disabled` instead of `none`, see [cookie_samesite in Configuration]({{< relref "../administration/configuration/#cookie-samesite" >}}) for more information.
**Note:** There is currently a bug affecting Mac OSX and iOS that causes `SameSite=None` cookies to be treated as `SameSite=Strict` and therefore not sent with cross-site requests, see https://bugs.webkit.org/show_bug.cgi?id=198181 for details. Until this is fixed, `SameSite=None` might not work properly on Safari. **Note:** There is currently a bug affecting Mac OSX and iOS that causes `SameSite=None` cookies to be treated as `SameSite=Strict` and therefore not sent with cross-site requests, see https://bugs.webkit.org/show_bug.cgi?id=198181 for details. Until this is fixed, `SameSite=None` might not work properly on Safari.
...@@ -252,12 +252,12 @@ PhantomJS was deprecated in [Grafana v6.4]({{< relref "../guides/whats-new-in-v6 ...@@ -252,12 +252,12 @@ PhantomJS was deprecated in [Grafana v6.4]({{< relref "../guides/whats-new-in-v6
### Dashboard minimum refresh interval enforced ### Dashboard minimum refresh interval enforced
A global minimum dashboard refresh interval is now enforced and defaults to 5 seconds. Read more [here]({{< relref "configuration/#min-refresh-interval" >}}) about this setting. A global minimum dashboard refresh interval is now enforced and defaults to 5 seconds. Read more [here]({{< relref "../administration/configuration/#min-refresh-interval" >}}) about this setting.
### Backend plugins ### Backend plugins
Grafana now requires backend plugins to be signed. If a backend plugin is not signed Grafana will not load/start it. This is an additional security measure to make sure backend plugin binaries and files haven't been tampered with. All Grafana Labs authored backend plugins, including Enterprise plugins, are now signed. It's possible to allow unsigned plugins using a configuration setting, but is something we strongly advise against doing. Read more [here]({{< relref "configuration/#allow-loading-unsigned-plugins" >}}) about this setting. Grafana now requires backend plugins to be signed. If a backend plugin is not signed Grafana will not load/start it. This is an additional security measure to make sure backend plugin binaries and files haven't been tampered with. All Grafana Labs authored backend plugins, including Enterprise plugins, are now signed. It's possible to allow unsigned plugins using a configuration setting, but is something we strongly advise against doing. Read more [here]({{< relref "../administration/#allow-loading-unsigned-plugins" >}}) about this setting.
### Cookie path ### Cookie path
Starting from Grafana v7.0.0, the cookie path does not include the trailing slash if Grafana is served from a subpath in order to align with [RFC 6265](https://tools.ietf.org/html/rfc6265#section-5.1.4). However, stale session cookies (set before the upgrade) can result in unsuccessful logins because they can not be deleted during the standard login phase due to the changed cookie path. Therefore users experiencing login problems are advised to manually delete old session cookies, or administrators can fix this for all users by changing the [`login_cookie_name`]({{< relref "configuration/#login-cookie-name" >}}), so the old cookie would get ignored. Starting from Grafana v7.0.0, the cookie path does not include the trailing slash if Grafana is served from a subpath in order to align with [RFC 6265](https://tools.ietf.org/html/rfc6265#section-5.1.4). However, stale session cookies (set before the upgrade) can result in unsuccessful logins because they can not be deleted during the standard login phase due to the changed cookie path. Therefore users experiencing login problems are advised to manually delete old session cookies, or administrators can fix this for all users by changing the [`login_cookie_name`]({{< relref "../administration/#login-cookie-name" >}}), so the old cookie would get ignored.
...@@ -32,7 +32,7 @@ ...@@ -32,7 +32,7 @@
link: /administration/ link: /administration/
children: children:
- name: Configuration - name: Configuration
link: /installation/configuration/ link: /administration/configuration/
- name: Configure Docker image - name: Configure Docker image
link: /installation/configure-docker/ link: /installation/configure-docker/
- name: Security - name: Security
......
...@@ -28,7 +28,7 @@ Can do everything scoped to the organization. For example: ...@@ -28,7 +28,7 @@ Can do everything scoped to the organization. For example:
- Can create and modify dashboards and alert rules. This can be disabled on specific folders and dashboards. - Can create and modify dashboards and alert rules. This can be disabled on specific folders and dashboards.
- **Cannot** create or edit data sources nor invite new users. - **Cannot** create or edit data sources nor invite new users.
This role can be tweaked via Grafana server setting [editors_can_admin]({{< relref "../installation/configuration.md#editors_can_admin" >}}). If you set this to true users This role can be tweaked via Grafana server setting [editors_can_admin]({{< relref "../administration/configuration.md#editors_can_admin" >}}). If you set this to true users
with **Editor** can also administrate dashboards, folders and teams they create. Useful for enabling self organizing teams. with **Editor** can also administrate dashboards, folders and teams they create. Useful for enabling self organizing teams.
## Viewer Role ## Viewer Role
...@@ -36,6 +36,6 @@ with **Editor** can also administrate dashboards, folders and teams they create. ...@@ -36,6 +36,6 @@ with **Editor** can also administrate dashboards, folders and teams they create.
- View any dashboard. This can be disabled on specific folders and dashboards. - View any dashboard. This can be disabled on specific folders and dashboards.
- **Cannot** create or edit dashboards nor data sources. - **Cannot** create or edit dashboards nor data sources.
This role can be tweaked via Grafana server setting [viewers_can_edit]({{< relref "../installation/configuration.md#viewers-can-edit" >}}). If you set this to true users This role can be tweaked via Grafana server setting [viewers_can_edit]({{< relref "../administration/configuration.md#viewers-can-edit" >}}). If you set this to true users
with **Viewer** can also make transient dashboard edits, meaning they can modify panels and queries but not save the changes (nor create new dashboards). with **Viewer** can also make transient dashboard edits, meaning they can modify panels and queries but not save the changes (nor create new dashboards).
Useful for public Grafana installations where you want anonymous users to be able to edit panels and queries but not save or create new dashboards. Useful for public Grafana installations where you want anonymous users to be able to edit panels and queries but not save or create new dashboards.
...@@ -74,7 +74,7 @@ EROR[06-01|16:45:59] Failed to load plugin error=plugin <plugin id> is unsigne ...@@ -74,7 +74,7 @@ EROR[06-01|16:45:59] Failed to load plugin error=plugin <plugin id> is unsigne
## Allow unsigned plugins ## Allow unsigned plugins
While you can allow unsigned plugins using a configuration setting, we strongly advise you not to. For more information on how to allow unsigned backend plugin, refer to [Configuration]({{< relref "../installation/configuration.md#allow-loading-unsigned-plugins" >}}). Allowing unsigned plugins will not skip verifying the authenticity of a plugin if plugin has a _MANIFEST.txt_ file. While you can allow unsigned plugins using a configuration setting, we strongly advise you not to. For more information on how to allow unsigned backend plugin, refer to [Configuration]({{< relref "../administration/configuration.md#allow-loading-unsigned-plugins" >}}). Allowing unsigned plugins will not skip verifying the authenticity of a plugin if plugin has a _MANIFEST.txt_ file.
If you run an unsigned backend plugin, then Grafana writes a warning message to the server log: If you run an unsigned backend plugin, then Grafana writes a warning message to the server log:
......
...@@ -33,7 +33,7 @@ https://play.grafana.org/d/000000012/grafana-play-home?orgId=1&from=156871968017 ...@@ -33,7 +33,7 @@ https://play.grafana.org/d/000000012/grafana-play-home?orgId=1&from=156871968017
You can embed a panel using an iframe on another web site. This tab will show you the html that you need to use. You can embed a panel using an iframe on another web site. This tab will show you the html that you need to use.
> **Note:** This sharing requires [allow_embedding]({{< relref "../installation/configuration.md#allow-embedding" >}}) enabled and anonymous access, or proper configuration of the [cookie_samesite]({{< relref "../installation/configuration.md#cookie-samesite" >}}) setting. > **Note:** This sharing requires [allow_embedding]({{< relref "../administration/configuration.md#allow-embedding" >}}) enabled and anonymous access, or proper configuration of the [cookie_samesite]({{< relref "../administration/configuration.md#cookie-samesite" >}}) setting.
Example: Example:
......
...@@ -33,7 +33,7 @@ https://play.grafana.org/d/000000012/grafana-play-home?orgId=1&from=156871968017 ...@@ -33,7 +33,7 @@ https://play.grafana.org/d/000000012/grafana-play-home?orgId=1&from=156871968017
You can embed a panel using an iframe on another web site. This tab will show you the html that you need to use. You can embed a panel using an iframe on another web site. This tab will show you the html that you need to use.
> **Note:** This sharing requires [allow_embedding]({{< relref "../installation/configuration.md#allow-embedding" >}}) enabled and anonymous access, or proper configuration of the [cookie_samesite]({{< relref "../installation/configuration.md#cookie-samesite" >}}) setting. > **Note:** This sharing requires [allow_embedding]({{< relref "../administration/configuration.md#allow-embedding" >}}) enabled and anonymous access, or proper configuration of the [cookie_samesite]({{< relref "../administration/configuration.md#cookie-samesite" >}}) setting.
Example: Example:
......
...@@ -20,7 +20,7 @@ MySQL or Postgres. ...@@ -20,7 +20,7 @@ MySQL or Postgres.
## Configure multiple servers to use the same database ## Configure multiple servers to use the same database
First, you need to setup MySQL or Postgres on another server and configure Grafana to use that database. First, you need to setup MySQL or Postgres on another server and configure Grafana to use that database.
You can find the configuration for doing that in the [[database]]({{< relref "../installation/configuration.md" >}}#database) section in the grafana config. You can find the configuration for doing that in the [[database]]({{< relref "../administration/configuration.md" >}}#database) section in the grafana config.
Grafana will now persist all long term data in the database. How to configure the database for high availability is out of scope for this guide. We recommend finding an expert on for the database you're using. Grafana will now persist all long term data in the database. How to configure the database for high availability is out of scope for this guide. We recommend finding an expert on for the database you're using.
## Alerting ## Alerting
...@@ -30,7 +30,7 @@ Currently alerting supports a limited form of high availability. Since v4.2.0, a ...@@ -30,7 +30,7 @@ Currently alerting supports a limited form of high availability. Since v4.2.0, a
## User sessions ## User sessions
> After Grafana 6.2 you don't need to configure session storage since the database will be used by default. > After Grafana 6.2 you don't need to configure session storage since the database will be used by default.
> If you want to offload the login session data from the database you can configure [remote_cache]({{< relref "../installation/configuration.md" >}}#remote-cache) > If you want to offload the login session data from the database you can configure [remote_cache]({{< relref "../administration/configuration.md" >}}#remote-cache)
The second thing to consider is how to deal with user sessions and how to configure your load balancer in front of Grafana. The second thing to consider is how to deal with user sessions and how to configure your load balancer in front of Grafana.
Grafana supports two ways of storing session data: locally on disk or in a database/cache-server. Grafana supports two ways of storing session data: locally on disk or in a database/cache-server.
...@@ -43,7 +43,7 @@ stored on disk rather than on a shared database. This is the default behavior fo ...@@ -43,7 +43,7 @@ stored on disk rather than on a shared database. This is the default behavior fo
### Stateless sessions ### Stateless sessions
You can also choose to store session data in a Redis/Memcache/Postgres/MySQL which means that the load balancer can send a user to any Grafana server without having to log in on each server. This requires a little bit more work from the operator but enables you to remove/add grafana servers without impacting the user experience. You can also choose to store session data in a Redis/Memcache/Postgres/MySQL which means that the load balancer can send a user to any Grafana server without having to log in on each server. This requires a little bit more work from the operator but enables you to remove/add grafana servers without impacting the user experience.
If you use MySQL/Postgres for session storage, you first need a table to store the session data in. More details about that in [[sessions]]({{< relref "../installation/configuration.md" >}}#session) If you use MySQL/Postgres for session storage, you first need a table to store the session data in. More details about that in [[sessions]]({{< relref "../administration/configuration.md" >}}#session)
For Grafana itself it doesn't really matter if you store the session data on disk or database/redis/memcache. But we recommend using a database/redis/memcache since it makes it easier to manage the grafana servers. For Grafana itself it doesn't really matter if you store the session data on disk or database/redis/memcache. But we recommend using a database/redis/memcache since it makes it easier to manage the grafana servers.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment