From 66aa4c8dfd0e4d978abde3ae6af6af15bbd0c47d Mon Sep 17 00:00:00 2001 From: Anna Urbiztondo Date: Wed, 13 Aug 2025 09:15:44 +0200 Subject: [PATCH] Final touches --- .../plugin-management/customize-nav-bar.md | 8 ++--- .../plugin-frontend-sandbox.md | 36 +++++++++---------- 2 files changed, 22 insertions(+), 22 deletions(-) diff --git a/docs/sources/administration/plugin-management/customize-nav-bar.md b/docs/sources/administration/plugin-management/customize-nav-bar.md index 0ca94f0fafc..77dc20a900f 100644 --- a/docs/sources/administration/plugin-management/customize-nav-bar.md +++ b/docs/sources/administration/plugin-management/customize-nav-bar.md @@ -73,12 +73,12 @@ org-example-app = explore 50 /a/org-example-app/logs = alerting 75 ``` -## Understanding page paths +## Find page paths -To move individual pages, you need to know their paths. Page paths in app plugins follow this format: -`/a/PLUGIN_ID/PAGE_PATH` +To move individual pages you need to know their paths. To identify a plugin page path: -You can identify a plugin page path by visiting the page in the browser and observing the URL in the address bar. +- Visit the page in the browser and check the URL in the address bar. +- Page paths in app plugins follow the format `/a/PLUGIN_ID/PAGE_PATH` ## Troubleshooting diff --git a/docs/sources/administration/plugin-management/plugin-frontend-sandbox.md b/docs/sources/administration/plugin-management/plugin-frontend-sandbox.md index 837a09750c6..19c5c6f72b3 100644 --- a/docs/sources/administration/plugin-management/plugin-frontend-sandbox.md +++ b/docs/sources/administration/plugin-management/plugin-frontend-sandbox.md @@ -34,7 +34,24 @@ The Plugin Frontend Sandbox is a security feature that isolates plugin frontend Plugins running inside the Frontend Sandbox should continue to work normally without any noticeable changes in their intended functionality. -## Enable Frontend Sandbox +## When to use the Plugin Frontend Sandbox + +We strongly recommend enabling the Frontend Sandbox for plugins that allow users to write custom JavaScript code for data visualization or manipulation, since they can potentially execute arbitrary JavaScript code in your Grafana instance. The sandbox provides an additional layer of security by restricting what this code can access and modify. + +These are examples of plugins where the sandbox is particularly useful: + +- Panel plugins that allow users to write custom JavaScript code +- Plugins from untrusted sources + +## Compatibility and requirements + +The following applies: + +- The Frontend Sandbox is available in public preview in Grafana >=11.5. It's compatible with all types of plugins including app plugins, panel plugins, and data source plugins. +- Angular-based plugins are not supported. +- Plugins developed and signed by Grafana Labs are excluded and cannot be sandboxed. + +## Enable the Frontend Sandbox The Frontend Sandbox feature is currently behind the `pluginsFrontendSandbox` feature flag. To enable it, you need to: @@ -48,23 +65,6 @@ For Grafana Cloud users, you can simply use the toggle switch in the plugin cata Enabling the Frontend Sandbox might impact the performance of certain plugins. Only disable the sandbox if you fully trust the plugin and understand the security implications. {{< /admonition >}} -## Compatibility - -The following applies: - -- The Frontend Sandbox is available in public preview in Grafana >=11.5. It's compatible with all types of plugins including app plugins, panel plugins, and data source plugins. -- Angular-based plugins are not supported. -- Plugins developed and signed by Grafana Labs are excluded and cannot be sandboxed. - -## When to use the Plugin Frontend Sandbox - -We strongly recommend enabling the Frontend Sandbox for plugins that allow users to write custom JavaScript code for data visualization or manipulation, since they can potentially execute arbitrary JavaScript code in your Grafana instance. The sandbox provides an additional layer of security by restricting what this code can access and modify. - -These are examples of plugins where the sandbox is particularly useful: - -- Panel plugins that allow users to write custom JavaScript code -- Plugins from untrusted sources - ## Troubleshooting If a plugin isn't functioning correctly with the Frontend Sandbox enabled: