Skip to content

Commit 851b6ef

Browse files
authored
Improve Plugin docs (#514)
* Improve Plugin docs * Some more improvements
1 parent d118cad commit 851b6ef

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

docs/quix-cloud/managed-services/plugin.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Non-managed services can also define these properties in YAML, making any deploy
1616

1717
![Sidebar example](images/plugin-sidebar.png){height=50%}
1818

19-
* Provide basic authentication integration with Quix Cloud so publicly exposed services don’t require a separate login
19+
* Provide basic authentication integration with Quix Cloud so publicly exposed services don’t require a separate login (optional)
2020

2121
## YAML configuration
2222

@@ -27,15 +27,16 @@ plugin:
2727
embeddedView: true # Enables embedded UI (frontend renders iframe)
2828
sidebarItem: # Optional environment sidebar shortcut
2929
show: true # Whether to display a shortcut in the sidebar
30-
label: "Configuration" # Text for the menu item
31-
icon: "tune" # Material icon name
30+
label: "Configuration" # Text for the menu item
31+
icon: "tune" # Material icon name (see notes below)
3232
order: 1 # Ordering (lower = higher)
3333
```
3434
3535
Notes
3636
37-
* plugin.embeddedView: boolean. true → FE renders embedded UI.
38-
* plugin.sidebarItem: optional object configuring the Environment’s left sidebar item.
37+
* `plugin.embeddedView`: boolean. true → FE renders embedded UI.
38+
* `plugin.sidebarItem`: optional object configuring the Environment’s left sidebar item.
39+
* `plugin.sidebarItem.icon`: must be a [Google Material icon](https://fonts.google.com/icons). Use the **internal icon code**, typically written in **lowercase** (e.g. `tune`, `settings`, `play_arrow`).
3940

4041
## Embedded view URL
4142

@@ -46,10 +47,15 @@ Population rules:
4647
* Managed service → Derived from Managed Services conventions.
4748
* Non-managed service → Requires `publicAccess` to be enabled; resolves from the deployment’s public URL.
4849

49-
## Authentication and authorization
50+
## Authentication and authorization (optional)
5051

51-
The embedded view inherits authentication and authorization from the Quix platform: no separate login is required, and the same user/environment permissions apply.
52-
When an embedded view loads, the Plugin system injects the Quix user token into the iframe. The UI uses this token to call the backend securely.
52+
> **Note**
53+
> Authentication is **not required**. If your frontend app doesn’t need it, you can ignore this section.
54+
> The details below are only useful if you want your embedded app to reuse Quix’s authentication and authorization system, so it follows the same user and environment permissions.
55+
56+
When used, the embedded view inherits authentication and authorization from the Quix platform: no separate login is required, and the same user/environment permissions apply.
57+
58+
When an embedded view loads, the Plugin system injects the Quix user token into the iframe. The UI can then use this token to call the backend securely.
5359

5460
### How the token is injected in the embedded view
5561

@@ -112,7 +118,7 @@ window.addEventListener('message', messageHandler);
112118

113119
### How to handle the token in the backend
114120

115-
Install the Quix Portal helper package from the public feed:
121+
If you want to validate and authorize requests against Quix, you can install the Quix Portal helper package from the public feed:
116122

117123
```bash
118124
pip install -i https://pkgs.dev.azure.com/quix-analytics/53f7fe95-59fe-4307-b479-2473b96de6d1/_packaging/public/pypi/simple/ quixportal

0 commit comments

Comments
 (0)