mirror of
https://github.com/grafana/grafana.git
synced 2025-02-25 18:55:37 -06:00
[feat] docs; update admonition syntax (#68842)
* [feat] docs; update admonition syntax - Standardizes according to style conventions: https://grafana.com/docs/writers-toolkit/style-guide/style-conventions/#admonitions - Prepares docs for better, uniform admonition style. * Remove false positives and irregularities * false positive removal * Update docs/sources/datasources/mysql/_index.md * Update docs/sources/developers/angular_deprecation/angular-plugins.md * fix link errors * Prettify some nested blockquotes * remoe unnecessary admonition
This commit is contained in:
@@ -61,14 +61,18 @@ If `auto_sign_up` is enabled, then the `sub` claim is used as the "external Auth
|
||||
If you want to embed Grafana in an iframe while maintaning user identity and role checks,
|
||||
you can use JWT authentication to authenticate the iframe.
|
||||
|
||||
> **Note**: For Grafana Cloud, or scenarios where verifying viewer identity is not required,
|
||||
> embed [public dashboards]({{< relref "../../../../dashboards/dashboard-public" >}}).
|
||||
{{% admonition type="note" %}}
|
||||
For Grafana Cloud, or scenarios where verifying viewer identity is not required,
|
||||
embed [public dashboards]({{< relref "../../../../dashboards/dashboard-public" >}}).
|
||||
{{% /admonition %}}
|
||||
|
||||
In this scenario, you will need to configure Grafana to accept a JWT
|
||||
provided in the HTTP header and a reverse proxy should rewrite requests to the
|
||||
Grafana instance to include the JWT in the request's headers.
|
||||
|
||||
> **Note**: For embedding to work, you must enable `allow_embedding` in the [security section]({{< relref "../../../configure-grafana#allow_embedding" >}}). This setting is not available in Grafana Cloud.
|
||||
{{% admonition type="note" %}}
|
||||
For embedding to work, you must enable `allow_embedding` in the [security section]({{< relref "../../../configure-grafana#allow_embedding" >}}). This setting is not available in Grafana Cloud.
|
||||
{{% /admonition %}}
|
||||
|
||||
In a scenario where it is not possible to rewrite the request headers you
|
||||
can use URL login instead.
|
||||
@@ -91,8 +95,10 @@ skip_org_role_sync = true
|
||||
|
||||
**Note**: You need to have enabled JWT before setting this setting see section Enabled JWT
|
||||
|
||||
> **Warning**: this can lead to JWTs being exposed in logs and possible session hijacking if the server is not
|
||||
> using HTTP over TLS.
|
||||
{{% admonition type="warning" %}}
|
||||
this can lead to JWTs being exposed in logs and possible session hijacking if the server is not
|
||||
using HTTP over TLS.
|
||||
{{% /admonition %}}
|
||||
|
||||
```ini
|
||||
# [auth.jwt]
|
||||
|
||||
Reference in New Issue
Block a user