Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
cebb5dc2bb | ||
|
|
3318ddc8c3 | ||
|
|
e656731729 | ||
|
|
2257fe2a08 | ||
|
|
673589f6c8 | ||
|
|
c642f9a8d3 | ||
|
|
83968be07e | ||
|
|
019bd11017 | ||
|
|
c16e00f94c | ||
|
|
bffa3e723c | ||
|
|
0774b02878 | ||
|
|
47c349bcd4 | ||
|
|
874432becf | ||
|
|
958cc68cba | ||
|
|
abaf845e94 | ||
|
|
ea9075bde5 | ||
|
|
4ebaea29fd | ||
|
|
165201632d | ||
|
|
bc59355eab |
No files matched your search
|
After Width: | Height: | Size: 100 KiB |
@@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"label": "Advanced",
|
"label": "Advanced",
|
||||||
"collapsed": true,
|
"collapsed": true,
|
||||||
"position": 4,
|
"position": 5,
|
||||||
"link": {
|
"link": {
|
||||||
"type": "generated-index",
|
"type": "generated-index",
|
||||||
"title": "Advanced Concepts or features"
|
"title": "Advanced Concepts or features"
|
||||||
|
|||||||
@@ -57,50 +57,8 @@ Homarr becomes the instance administrator.
|
|||||||
Use `pnpm docker:dev:up` instead when you only need Redis in the background. Running the migration also seeds the
|
Use `pnpm docker:dev:up` instead when you only need Redis in the background. Running the migration also seeds the
|
||||||
default data; use `pnpm db:seed` to seed it explicitly later.
|
default data; use `pnpm db:seed` to seed it explicitly later.
|
||||||
|
|
||||||
### Run PocketBase and documentation
|
Workshop contributors can set up PocketBase and Docusaurus with the dedicated
|
||||||
|
[Workshop development guide](../../workshop/development).
|
||||||
Start PocketBase in another terminal:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
cp apps/workshop/.env.example apps/workshop/.env
|
|
||||||
docker compose --env-file apps/workshop/.env -f apps/workshop/docker-compose.yml up --build workshop
|
|
||||||
```
|
|
||||||
|
|
||||||
Then start Docusaurus in a third terminal:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
WORKSHOP_API_URL=http://127.0.0.1:8090 pnpm dev:docs
|
|
||||||
```
|
|
||||||
|
|
||||||
PocketBase runs on port 8090 and Docusaurus on port 3003. Stopping the services preserves the PocketBase volume.
|
|
||||||
|
|
||||||
Open `http://127.0.0.1:8090/_/` and create the first PocketBase superuser. The Workshop UI is available at
|
|
||||||
`http://127.0.0.1:3003/workshop`.
|
|
||||||
|
|
||||||
Point Homarr at the local services with:
|
|
||||||
|
|
||||||
```dotenv
|
|
||||||
HOMARR_WEBSITE_URL=http://127.0.0.1:3003
|
|
||||||
WORKSHOP_API_URL=http://127.0.0.1:8090
|
|
||||||
WORKSHOP_WEB_URL=http://127.0.0.1:3003/workshop
|
|
||||||
```
|
|
||||||
|
|
||||||
Restart `pnpm dev` after changing `.env`. GitHub OAuth is optional locally. See
|
|
||||||
[`apps/workshop/README.md`](https://github.com/homarr-labs/homarr/blob/HEAD/apps/workshop/README.md) for OAuth,
|
|
||||||
Workshop moderator promotion, logs, tests, backup, restore, stopping, and intentional volume reset.
|
|
||||||
|
|
||||||
### URL testing
|
|
||||||
|
|
||||||
Docusaurus reads `HOMARR_WEBSITE_URL` and `WORKSHOP_API_URL` when it starts or builds. Homarr also reads
|
|
||||||
`WORKSHOP_WEB_URL` when its server starts, so these values do not rely on `NEXT_PUBLIC_*` build variables. Test a
|
|
||||||
separate API origin before release:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
HOMARR_WEBSITE_URL=http://127.0.0.1:3003 \
|
|
||||||
WORKSHOP_API_URL=http://127.0.0.1:8090 \
|
|
||||||
WORKSHOP_WEB_URL=http://127.0.0.1:3003/workshop \
|
|
||||||
pnpm dev:docs
|
|
||||||
```
|
|
||||||
|
|
||||||
### Useful commands
|
### Useful commands
|
||||||
|
|
||||||
@@ -112,7 +70,6 @@ pnpm dev:docs
|
|||||||
- `pnpm dev:cli -- rebuild <name>` — rebuild an image from its recorded checkout or pull request.
|
- `pnpm dev:cli -- rebuild <name>` — rebuild an image from its recorded checkout or pull request.
|
||||||
- `pnpm dev:cli:install` — optionally install the developer CLI as a `homarr` binary.
|
- `pnpm dev:cli:install` — optionally install the developer CLI as a `homarr` binary.
|
||||||
- `pnpm dev:docs` — Docusaurus only on port 3003.
|
- `pnpm dev:docs` — Docusaurus only on port 3003.
|
||||||
- `pnpm docker:workshop` — local PocketBase through Docker Compose.
|
|
||||||
- `pnpm docker:dev:up` — Redis development service in the background.
|
- `pnpm docker:dev:up` — Redis development service in the background.
|
||||||
- `pnpm cli` — Homarr operations CLI.
|
- `pnpm cli` — Homarr operations CLI.
|
||||||
- `pnpm db:migration:sqlite:run` — create or update a SQLite database.
|
- `pnpm db:migration:sqlite:run` — create or update a SQLite database.
|
||||||
@@ -122,7 +79,6 @@ pnpm dev:docs
|
|||||||
- `pnpm lint` / `pnpm lint:fix` — check or apply oxlint.
|
- `pnpm lint` / `pnpm lint:fix` — check or apply oxlint.
|
||||||
- `pnpm typecheck` — typecheck all workspaces.
|
- `pnpm typecheck` — typecheck all workspaces.
|
||||||
- `pnpm test` — unit and contract suites.
|
- `pnpm test` — unit and contract suites.
|
||||||
- `pnpm test:workshop` — disposable Workshop integration suite.
|
|
||||||
- `pnpm build` — production monorepo build.
|
- `pnpm build` — production monorepo build.
|
||||||
- `docker build -t homarr .` — build a production Docker image.
|
- `docker build -t homarr .` — build a production Docker image.
|
||||||
- `docker run -p 7575:7575 -e SECRET_ENCRYPTION_KEY='your_64_character_hex_string' homarr:<name>` — run it.
|
- `docker run -p 7575:7575 -e SECRET_ENCRYPTION_KEY='your_64_character_hex_string' homarr:<name>` — run it.
|
||||||
@@ -37,6 +37,9 @@ Using the `PUID` and `PGID` will require you to set the correct permissions on t
|
|||||||
| `WORKSHOP_API_URL` | PocketBase API used by Homarr and standalone documentation. | HTTP(S) URL | `HOMARR_WEBSITE_URL` |
|
| `WORKSHOP_API_URL` | PocketBase API used by Homarr and standalone documentation. | HTTP(S) URL | `HOMARR_WEBSITE_URL` |
|
||||||
| `WORKSHOP_WEB_URL` | Public Workshop page opened from Homarr. | HTTP(S) URL | `HOMARR_WEBSITE_URL/workshop` |
|
| `WORKSHOP_WEB_URL` | Public Workshop page opened from Homarr. | HTTP(S) URL | `HOMARR_WEBSITE_URL/workshop` |
|
||||||
|
|
||||||
|
Workshop service operators can find its server-only configuration in the
|
||||||
|
[Workshop operator guide](../../workshop/operator#environment-variables).
|
||||||
|
|
||||||
## Authentication
|
## Authentication
|
||||||
|
|
||||||
See [Single Sign-On](/docs/advanced/single-sign-on) for more informations.
|
See [Single Sign-On](/docs/advanced/single-sign-on) for more informations.
|
||||||
@@ -109,12 +112,9 @@ External redis is currently not supported with Proxmox Community Scripts
|
|||||||
The advanced deployments environment variables should only be used if you know what you are doing.
|
The advanced deployments environment variables should only be used if you know what you are doing.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
| Environment Variable | Description |
|
| Environment Variable | Description |
|
||||||
| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| ------------------------ | --------------------------------------------------- |
|
||||||
| `DB_MIGRATIONS_DISABLED` | Disable db migrations. For example for helm charts. |
|
| `DB_MIGRATIONS_DISABLED` | Disable db migrations. For example for helm charts. |
|
||||||
| `WORKSHOP_PUBLIC_ORIGIN` | Origin used in PocketBase-generated links and email. It must be set explicitly in production and must match the externally reachable Workshop origin. |
|
|
||||||
| `PB_ALLOWED_ORIGINS` | Browser origins accepted by PocketBase. Use `*` for the central public community so arbitrary self-hosted Homarr instances can use the API and OAuth; private staging may use a comma-separated origin allowlist. |
|
|
||||||
|
|
||||||
All public URL variables reject non-HTTP protocols, embedded credentials, query strings, and fragments, and normalize
|
All public URL variables reject non-HTTP protocols, embedded credentials, query strings, and fragments, and normalize
|
||||||
trailing slashes when Homarr or Docusaurus starts. The Docusaurus-only `WORKSHOP_URL` name is accepted as a deprecated alias for
|
trailing slashes when Homarr or Docusaurus starts.
|
||||||
`WORKSHOP_API_URL` for one release. `WORKSHOP_API_URL` takes precedence.
|
|
||||||
@@ -6,32 +6,14 @@ tags:
|
|||||||
|
|
||||||
Homarr has the following keyboard shortcuts:
|
Homarr has the following keyboard shortcuts:
|
||||||
|
|
||||||
| Shortcut | Description |
|
| Shortcut | Description |
|
||||||
| ----------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
|
| ----------------------------------------------- | ------------------------------------------ |
|
||||||
| `MOD` + `K` | Opens the search bar |
|
| `MOD` + `K` | Opens the search bar |
|
||||||
| `MOD` + `J` | Toggles Dark Mode |
|
| `MOD` + `J` | Toggles Dark Mode |
|
||||||
| `MOD` + `E` | Toggles Edit Mode |
|
| `MOD` + `E` | Toggles Edit Mode |
|
||||||
| Hold `Shift` for 500 ms over a supported widget | Opens its temporary advanced view |
|
| Hold `Shift` for 500 ms over a supported widget | Opens its temporary advanced view |
|
||||||
| `Shift` + `Enter` on a supported widget | Opens its advanced view until it is closed |
|
| `Shift` + `Enter` on a supported widget | Opens its advanced view until it is closed |
|
||||||
| `Esc` | Stops keyboard tile editing, cancels an active pointer or touch move/resize, or closes an open advanced view or board menu |
|
| `Esc` | Closes an open advanced view or board menu |
|
||||||
|
|
||||||
## Board editing
|
|
||||||
|
|
||||||
`MOD` + `E` enters edit mode. Homarr keeps the current board visible while the editor prepares; movement and resizing become available when it is ready.
|
|
||||||
|
|
||||||
When a tile is focused in edit mode:
|
|
||||||
|
|
||||||
| Shortcut | Description |
|
|
||||||
| -------------------- | --------------------------------------------------------------------------- |
|
|
||||||
| `Enter` or `Space` | Starts or stops keyboard editing |
|
|
||||||
| Arrow keys | Moves the focused tile within its current canvas, rail, or Container |
|
|
||||||
| `Shift` + Arrow keys | Resizes from the tile's lower-right corner: Left/Up shrink; Right/Down grow |
|
|
||||||
| `Esc` | Stops keyboard editing without undoing its changes |
|
|
||||||
|
|
||||||
Keyboard moves and resizes apply immediately. To move an item between a canvas, rail, or Container, drag it there or use **Move / resize item** for precise numeric placement.
|
|
||||||
Commands at a grid boundary or at the tile's minimum size are ignored and announced instead of moving or shrinking the tile.
|
|
||||||
|
|
||||||
On touch screens, press and hold a tile before moving it; a quick tap does not start a drag. Resize handles accept direct touch input. During a pointer or touch move or resize, `Esc` cancels the interaction and restores the layout from before it started.
|
|
||||||
|
|
||||||
:::tip
|
:::tip
|
||||||
|
|
||||||
|
|||||||
|
Before Width: | Height: | Size: 38 KiB After Width: | Height: | Size: 39 KiB |
@@ -85,8 +85,8 @@ To do this, enter the board settings:
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
Scroll to the **Custom CSS** section on the board settings page. It is part of the unified settings form; enter your CSS
|
Scroll down a bit and click on custom CSS.
|
||||||
there and save the board settings to apply it to that board.
|
Here you can enter your CSS code, which will be applied on the respective board page.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"label": "Community",
|
"label": "Community",
|
||||||
"position": 5,
|
"position": 6,
|
||||||
"collapsed": true,
|
"collapsed": true,
|
||||||
"link": {
|
"link": {
|
||||||
"type": "generated-index"
|
"type": "generated-index"
|
||||||
|
|||||||
@@ -10,16 +10,10 @@ import imageStartFromScratchStepServerSettings from "./img/onboarding-from-scrat
|
|||||||
import imageStartFromScratchStepAdminUser from "./img/onboarding-from-scratch-step-admin-user.png";
|
import imageStartFromScratchStepAdminUser from "./img/onboarding-from-scratch-step-admin-user.png";
|
||||||
import imageStartFromScratchStepExternalAdminGroup from "./img/onboarding-from-scratch-step-external-admin-group.png";
|
import imageStartFromScratchStepExternalAdminGroup from "./img/onboarding-from-scratch-step-external-admin-group.png";
|
||||||
import imageStartFromScratchStepFinish from "./img/onboarding-from-scratch-step-finish.png";
|
import imageStartFromScratchStepFinish from "./img/onboarding-from-scratch-step-finish.png";
|
||||||
|
import manageBoardHeaderEditMode from "./img/manage-board-header-edit-mode.png";
|
||||||
|
import manageBoardHeaderAddItem from "./img/manage-board-header-add-item-menu.png";
|
||||||
|
import manageBoardHeaderChooseItem from "./img/manage-board-header-choose-item.png";
|
||||||
import manageBoardNoApp from "./img/manage-board-no-app.png";
|
import manageBoardNoApp from "./img/manage-board-no-app.png";
|
||||||
import currentKeyboardTileEditing from "../management/boards/img/keyboard-tile-editing.png";
|
|
||||||
import boardDesktopCurrent from "./img/onboarding-board-desktop-current.png";
|
|
||||||
import boardEditModeCurrent from "./img/onboarding-board-edit-mode-current.png";
|
|
||||||
import addContentMenuCurrent from "./img/onboarding-add-content-menu-current.png";
|
|
||||||
import chooseItemCurrent from "./img/onboarding-choose-item-current.png";
|
|
||||||
import editItemCurrent from "./img/onboarding-edit-item-current.png";
|
|
||||||
import boardsHomeMobileMenu from "./img/onboarding-boards-home-mobile-menu.png";
|
|
||||||
import moveResizeMenuCurrent from "./img/onboarding-move-resize-menu-current.png";
|
|
||||||
import currentBoardMobileView from "./img/onboarding-board-mobile-current.png";
|
|
||||||
import manageExportOldHomarr from "./img/old-homarr-export-data.png";
|
import manageExportOldHomarr from "./img/old-homarr-export-data.png";
|
||||||
import manageImportOldHomarrDropzone from "./img/old-homarr-import-dropzone.png";
|
import manageImportOldHomarrDropzone from "./img/old-homarr-import-dropzone.png";
|
||||||
import manageImportOldHomarrChooseData from "./img/old-homarr-import-choose-imported-data.png";
|
import manageImportOldHomarrChooseData from "./img/old-homarr-import-choose-imported-data.png";
|
||||||
@@ -35,12 +29,12 @@ Congratulations on installing Homarr. Now it's time to get yourself familiar wit
|
|||||||
|
|
||||||
## Onboarding
|
## Onboarding
|
||||||
|
|
||||||
The onboarding will show the first time you start Homarr.
|
The onboard will show the first time you start Homarr.
|
||||||
This process will help you with your first steps and adding some initial data, such as the administrator account.
|
This process will help you with your first steps and adding some initial data, such as the administrator account.
|
||||||
|
|
||||||
:::note
|
:::note
|
||||||
|
|
||||||
If you see this screen repeatedly after you restart the Homarr container, your Docker mounting paths may be missing,
|
If you see this screen repeatitly after you restarted the Homarr container, your Docker mounting paths may be missing,
|
||||||
incorrect or read-only. Read [our installation instructions](/docs/getting-started/installation/docker) again to fix this issue.
|
incorrect or read-only. Read [our installation instructions](/docs/getting-started/installation/docker) again to fix this issue.
|
||||||
|
|
||||||
:::
|
:::
|
||||||
@@ -74,7 +68,7 @@ The name of the group must match exactly the name of the group in the provider.
|
|||||||
/>
|
/>
|
||||||
|
|
||||||
Next, you can configure some basic settings for Homarr. We recommend to leave all settings at default for most users.
|
Next, you can configure some basic settings for Homarr. We recommend to leave all settings at default for most users.
|
||||||
Here you can also disable analytics. Please note that our analytics are completely anonymous and fully compliant with GDPR and PECR.
|
Here you can also disable analytics. Please note that our analytics are completly anonymous and is fully compliant with GDPR and PECR.
|
||||||
|
|
||||||
<img
|
<img
|
||||||
src={imageStartFromScratchStepServerSettings}
|
src={imageStartFromScratchStepServerSettings}
|
||||||
@@ -132,12 +126,11 @@ It is important that you first migrate correctly using [the list of breaking cha
|
|||||||
1. Navigate to your old Homarr, open your management pages, open the tools submenu and open `Migrate to 1.0`.
|
1. Navigate to your old Homarr, open your management pages, open the tools submenu and open `Migrate to 1.0`.
|
||||||
2. Check the contents that you want to export. We recommend you to export all data.
|
2. Check the contents that you want to export. We recommend you to export all data.
|
||||||
3. Click on the export data button
|
3. Click on the export data button
|
||||||
4. Save the downloaded ZIP file on your device. If you selected "integrations" or "users", you also get an encryption / decryption key.
|
4. Save the ZIP file, that is being downloaded, on your device. If you selected "integrations" or "users", you also get an encryption / decryption key.
|
||||||
Copy it and keep it safe; you need it later in the import flow.
|
Copy it and do not loose it!
|
||||||
5. Go to your new Homarr 1.0 or later instance and start the onboarding. Choose `Import from Homarr before 1.0`.
|
5. Go to your new >1.0.0 Homarr instance and start the onboarding. Choose `Import from Homarr before 1.0`
|
||||||
6. Drag and drop your previously downloaded ZIP archive into the file upload: <br/><img src={manageImportOldHomarrDropzone} style={{ maxWidth: 500 }} />
|
6. Drag and drop your previously downloaded ZIP archive into the file upload: <br/><img src={manageImportOldHomarrDropzone} style={{ maxWidth: 500 }} />
|
||||||
7. Next, choose the data that you want to import and how to import it. Old Homarr screen sizes are imported as responsive layouts on the same board: the narrowest becomes **Mobile**, the widest becomes **Base**, and layouts between them become custom layouts. Homarr normalizes duplicate breakpoints automatically, so you can review the imported board in Board Settings and adjust the layouts there.<br/><img src={manageImportOldHomarrChooseData} style={{ maxWidth: 500 }} />
|
7. Next, choose the data that you want to import and how to import it. Since screen sizes were removed in 1.0, we create a new board for every screen size by default. We recommend you to only keep the best layout and adjust it later in 1.0.0 - but you can also import all of them and pick later.<br/><img src={manageImportOldHomarrChooseData} style={{ maxWidth: 500 }} />
|
||||||
For example, legacy `sm`, `md`, and `lg` layouts at `0px`, `800px`, and `1400px` become Mobile, a custom layout, and Base. The imported board keeps each layout's positions, names, and column counts where possible so you can review the result before saving. If a board has one saved layout, Homarr keeps it as Base and generates Mobile from it; a board without saved layouts receives Mobile at `0px` with 3 columns and Base at `768px` with 10 columns.
|
|
||||||
8. If you previously exported integrations or users, you will be asked to decrypt the data safely using your obtained encryption token. Paste into the modal and confirm your action.<br/><img src={manageImportDecryptionToken} style={{ maxWidth: 500 }} />
|
8. If you previously exported integrations or users, you will be asked to decrypt the data safely using your obtained encryption token. Paste into the modal and confirm your action.<br/><img src={manageImportDecryptionToken} style={{ maxWidth: 500 }} />
|
||||||
9. Next, you can [follow the same setup as when starting from scratch](#starting-from-scratch). After you completed the onboarding, all of your data will be migrated and available.
|
9. Next, you can [follow the same setup as when starting from scratch](#starting-from-scratch). After you completed the onboarding, all of your data will be migrated and available.
|
||||||
|
|
||||||
@@ -154,25 +147,9 @@ Public boards are also accessible for users, that are not logged in ([see access
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
Congratulations - you've just created your first board. You can see the boards you have access to on this page:
|
Congratulations - you've just created your first board. You can see boards, that you have access to, on this page:
|
||||||
|
|
||||||
<figure>
|

|
||||||
<img
|
|
||||||
src={boardsHomeMobileMenu}
|
|
||||||
alt="Boards management page showing a Home badge and separate desktop and mobile home-board menu entries"
|
|
||||||
style={{ maxWidth: "100%" }}
|
|
||||||
/>
|
|
||||||
<figcaption>The Boards page selects the board opened from Home separately for desktop and mobile.</figcaption>
|
|
||||||
</figure>
|
|
||||||
|
|
||||||
The board marked **Home** is the board opened from the desktop Home route. **Set as your mobile board** selects which board
|
|
||||||
opens on phones. This is separate from the **Mobile** layout: the home-board setting chooses a board, while **Mobile** and
|
|
||||||
**Base** are responsive layouts inside that board. A phone can therefore open a different home board and still use that
|
|
||||||
board's Mobile layout.
|
|
||||||
|
|
||||||
New boards start with **Mobile** and **Base** responsive layouts automatically, so you can edit the board for phones and
|
|
||||||
desktops without creating extra layouts first. Mobile starts at `0px` with 3 columns and Base at `768px` with 10 columns.
|
|
||||||
Each layout keeps its own tile positions and sizes.
|
|
||||||
|
|
||||||
## Add your first app to Homarr
|
## Add your first app to Homarr
|
||||||
|
|
||||||
@@ -196,63 +173,37 @@ After you created the app, you'll see in on the apps page:
|
|||||||
Let's add your freshly created app, from the previous step, to the board.
|
Let's add your freshly created app, from the previous step, to the board.
|
||||||
To do this, edit your previously created board by clicking on the big `Open board` button:
|
To do this, edit your previously created board by clicking on the big `Open board` button:
|
||||||
|
|
||||||
<figure>
|

|
||||||
<img src={boardDesktopCurrent} alt="Current Homarr board opened from the Boards page" style={{ maxWidth: "100%" }} />
|
|
||||||
<figcaption>Open a board to view its dashboard, then enter edit mode to arrange its content.</figcaption>
|
|
||||||
</figure>
|
|
||||||
|
|
||||||
Here you have the following options in the header:
|
Here you have the following options in the header:
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
- **Search**: Here you can search for data. You can search for integrations, boards, actions, sites and much more. Some actions may be context dependent (eg. will only show when certain widgets are on your page)
|
- **Search**: Here you can search for data. You can search for integrations, boards, actions, sites and much more. Some actions may be context dependent (eg. will only show when certain widgets are on your page)
|
||||||
- **Edit board**: Clicking this button will toggle edit mode. In this mode you can edit the contents of your board.
|
- **Edit mode**: Clicking this button will toggle the edit mode. In this mode you can edit the contents of your board.
|
||||||
- **Settings**: Clicking this button will redirect you to a settings page where you can adjust the board settings (page title, colors, ...).
|
- **Settings**: Clicking this button will redirect you to a settings page where you can adjust the board settings (page title, colors, ...).
|
||||||
- **Board switcher**: Use this button to open another board that you can access.
|
|
||||||
- **Profile**: This avatar will be visible on every page. Clicking it will show a menu with actions.
|
- **Profile**: This avatar will be visible on every page. Clicking it will show a menu with actions.
|
||||||
|
|
||||||
When entering the edit mode, you'll get some additional buttons to work with:
|
When entering the edit mode, you'll get some additional buttons to work with:
|
||||||
|
|
||||||
<figure>
|
<img src={manageBoardHeaderEditMode} alt={"Screenshot of buttons in the edit mode"} width={200} />
|
||||||
<img
|
|
||||||
src={boardEditModeCurrent}
|
|
||||||
alt="Current Homarr board editor with tile controls visible"
|
|
||||||
style={{ maxWidth: "100%" }}
|
|
||||||
/>
|
|
||||||
<figcaption>The current editor keeps the board visible while its editing controls are available.</figcaption>
|
|
||||||
</figure>
|
|
||||||
|
|
||||||
- **Add board content**: Click this button to create a new item, app, integration, or Container.
|
- **Add item**: Click this button to add new elements to your page.
|
||||||
- **Save board**: Click this button to save your changes and leave edit mode. If you leave with unsaved changes, Homarr asks whether to discard them.
|
- **Exit edit mode**: Click this button to save your changes and exit edit mode.
|
||||||
|
|
||||||
Outside edit mode, right-click a widget for its live status, refresh, settings, quick options, and supported actions.
|
Outside edit mode, right-click a widget for its live status, refresh, settings, quick options, and supported actions.
|
||||||
Hold `Shift` while hovering a widget that supports advanced view to expand it in place while the rest of the board
|
Hold `Shift` while hovering a widget that supports advanced view to expand it in place while the rest of the board
|
||||||
stays visible but dimmed. Release `Shift` to close it. You can also focus that widget and press `Shift` + `Enter` to
|
stays visible but dimmed. Release `Shift` to close it. You can also focus that widget and press `Shift` + `Enter` to
|
||||||
keep its advanced view open until you close it. Widgets without a distinct advanced experience adapt in place.
|
keep its advanced view open until you close it. Widgets without a distinct advanced experience adapt in place.
|
||||||
|
|
||||||
To continue, click **New item** in the add-content menu. New content is placed at the first available position on the main
|
To continue, click the option "New Item":
|
||||||
canvas; it is not inserted at a clicked empty cell or directly into a rail or Container:
|
|
||||||
|
|
||||||
<figure>
|
<img src={manageBoardHeaderAddItem} alt={"Screenshot of the add item menu"} width={200} />
|
||||||
<img
|
|
||||||
src={addContentMenuCurrent}
|
|
||||||
alt="Current add board content menu with item, app, integration, and Container actions"
|
|
||||||
style={{ maxWidth: "100%" }}
|
|
||||||
/>
|
|
||||||
<figcaption>The add-content menu provides the four supported ways to place new content on the board.</figcaption>
|
|
||||||
</figure>
|
|
||||||
|
|
||||||
Next, you can choose what item you'd like to add.
|
Next, you can choose what item you'd like to add.
|
||||||
We will discuss the other options in the following sections - for now choose "App" to continue.
|
We will discuss the other options in the following sections - for now choose "App" to continue.
|
||||||
|
|
||||||
<figure>
|
<img src={manageBoardHeaderChooseItem} alt={"Screenshot of choosing the app item in the modal"} width={300} />
|
||||||
<img
|
|
||||||
src={chooseItemCurrent}
|
|
||||||
alt="Current item picker showing the App card and other item types"
|
|
||||||
style={{ maxWidth: "100%" }}
|
|
||||||
/>
|
|
||||||
<figcaption>Choose the App item from the current picker to add an app tile.</figcaption>
|
|
||||||
</figure>
|
|
||||||
|
|
||||||
As soon as you chose the app, the modal will close and you'll get the following item on your board:
|
As soon as you chose the app, the modal will close and you'll get the following item on your board:
|
||||||
|
|
||||||
@@ -261,52 +212,30 @@ As soon as you chose the app, the modal will close and you'll get the following
|
|||||||
This is expected, because you haven't told Homarr what app it should show in this item.
|
This is expected, because you haven't told Homarr what app it should show in this item.
|
||||||
To configure this, click on the small 3 dots at the top of the item in the edit mode and choose "Edit item" in the menu.
|
To configure this, click on the small 3 dots at the top of the item in the edit mode and choose "Edit item" in the menu.
|
||||||
|
|
||||||
<figure>
|

|
||||||
<img
|
|
||||||
src={moveResizeMenuCurrent}
|
|
||||||
alt="Current board tile menu showing Edit item and Move or resize item"
|
|
||||||
style={{ maxWidth: "450px" }}
|
|
||||||
/>
|
|
||||||
<figcaption>The tile menu contains the item editor and the separate move-and-resize tools.</figcaption>
|
|
||||||
</figure>
|
|
||||||
|
|
||||||
In the modal you can edit the app that you want to display:
|
In the modal you can edit the app that you want to display:
|
||||||
|
|
||||||
<figure>
|

|
||||||
<img src={editItemCurrent} alt="Current Edit item modal for an App tile" style={{ maxWidth: "620px" }} />
|
|
||||||
<figcaption>Use the Edit item modal to choose the app and configure how its tile is displayed.</figcaption>
|
|
||||||
</figure>
|
|
||||||
|
|
||||||
As soon as you save your changes, the tile on the board will refresh and display your app.
|
As soon as you save your changes, the tile on the board will refresh and display your app.
|
||||||
Resize from any visible edge or corner handle. For a Container, activate its top-left grip before using its resize handles.
|
Use the resize handle at the bottom right to resize the tile.
|
||||||
Press and hold a handle, move the pointer, and release it when the tile has the size you want.
|
Press and hold the handle, move the pointer, and release it when the tile has the size you want.
|
||||||
|
|
||||||
To move a tile in edit mode, press and hold its inert content area, move it to the desired position, and release it.
|

|
||||||
|
|
||||||
|
To move a tile in edit mode, press and hold its content, move it to the desired position, and release it.
|
||||||
Widget content is disabled while editing so its controls do not intercept the drag; use the tile's settings button for edit actions.
|
Widget content is disabled while editing so its controls do not intercept the drag; use the tile's settings button for edit actions.
|
||||||
The tile snaps to the grid. A single compatible collision may swap the two items when both resulting placements fit;
|
The tile snaps to the grid. Equally-sized tiles swap when one is dropped into the other's slot, while other neighboring tiles move out of the way automatically.
|
||||||
otherwise the collision chain reflows neighboring tiles automatically.
|
|
||||||
|

|
||||||
|
|
||||||
Every `1 × 1` tile has a logical content size of `200 × 200` pixels.
|
Every `1 × 1` tile has a logical content size of `200 × 200` pixels.
|
||||||
Larger tiles use multiples of that fixed unit, with a consistent gap between cells.
|
Larger tiles use multiples of that fixed unit, with a consistent gap between cells.
|
||||||
Homarr scales the complete board uniformly, like zooming a page.
|
Homarr scales the complete board uniformly, like zooming a page.
|
||||||
The complete canvas always fits the available width without horizontal board scrolling. Below 100%, Homarr preserves the
|
It stops shrinking at 75% and lets you scroll horizontally instead of making text and controls too small.
|
||||||
widget's readable typography and control density instead of shrinking each widget independently.
|
|
||||||
It does not squeeze or reflow the content of individual widgets, so a widget keeps the same design and proportions across screen sizes.
|
It does not squeeze or reflow the content of individual widgets, so a widget keeps the same design and proportions across screen sizes.
|
||||||
|
|
||||||
On a narrow screen, Homarr uses the **Mobile layout** for the selected board and stacks the board content vertically while
|
|
||||||
preserving each widget's fixed logical proportions:
|
|
||||||
|
|
||||||
<figure>
|
|
||||||
<img
|
|
||||||
src={currentBoardMobileView}
|
|
||||||
alt="Homarr's Mobile layout in a 390-pixel-wide viewport, with tiles scaled to fit and stacked vertically"
|
|
||||||
style={{ maxWidth: "390px" }}
|
|
||||||
/>
|
|
||||||
<figcaption>
|
|
||||||
At phone width, the selected board uses its Mobile layout and fits the complete canvas to the viewport.
|
|
||||||
</figcaption>
|
|
||||||
</figure>
|
|
||||||
|
|
||||||
:::note
|
:::note
|
||||||
|
|
||||||
Viewing a board initially uses the lightweight, non-interactive layout.
|
Viewing a board initially uses the lightweight, non-interactive layout.
|
||||||
@@ -322,17 +251,16 @@ This helps you to explore the capabilities of Homarr before you build your board
|
|||||||
|
|
||||||
:::
|
:::
|
||||||
|
|
||||||
Keyboard users can focus a tile, press Enter or Space, then use arrow keys to move and Shift plus arrow keys to resize
|
Keyboard users can focus a tile, press Enter or Space, then use arrow keys to move and Shift plus arrow keys to resize.
|
||||||
within its current canvas, rail, or Container. Press Escape to stop keyboard editing. Touch dragging starts after a short
|
Press Escape to stop.
|
||||||
hold of about `200 ms`; resize handles accept direct touch input. During a pointer or touch move or resize, press Escape
|
For precise numeric controls or touch input, choose **Move / resize item** from the tile's edit menu.
|
||||||
to cancel and restore the previous layout. For cross-grid moves or precise numeric controls, choose **Move / resize item**
|
The dialog can also move the tile to another section or fixed sidebar:
|
||||||
from the tile's edit menu.
|
|
||||||
Keyboard commands at a grid boundary or minimum tile size are ignored and announced; they do not move or shrink the tile.
|
|
||||||
|
|
||||||
<img src={currentKeyboardTileEditing} alt="A board tile focused for keyboard editing" style={{ maxWidth: "100%" }} />
|

|
||||||
|
|
||||||
Open **Move / resize item** from the tile menu to move the tile to another section or rail and enter precise numeric
|
Be sure to save your changes by exiting edit mode!
|
||||||
coordinates and dimensions. After making changes, click **Save board** to persist them and leave edit mode.
|
|
||||||
|

|
||||||
|
|
||||||
## Adding your first integration
|
## Adding your first integration
|
||||||
|
|
||||||
@@ -367,14 +295,7 @@ Let's add your integration, that you have configured in the section above, as a
|
|||||||
First, navigate back to your board that you want to add it to.
|
First, navigate back to your board that you want to add it to.
|
||||||
Next, enter edit mode again and add another item to your board:
|
Next, enter edit mode again and add another item to your board:
|
||||||
|
|
||||||
<figure>
|

|
||||||
<img
|
|
||||||
src={addContentMenuCurrent}
|
|
||||||
alt="Current add board content menu with item, app, integration, and Container actions"
|
|
||||||
style={{ maxWidth: "100%" }}
|
|
||||||
/>
|
|
||||||
<figcaption>Use the same add-content menu to place an integration widget on the board.</figcaption>
|
|
||||||
</figure>
|
|
||||||
|
|
||||||
Instead of choosing an app, let's choose `System Health Monitoring` this time.
|
Instead of choosing an app, let's choose `System Health Monitoring` this time.
|
||||||
Click on "Add to board":
|
Click on "Add to board":
|
||||||
@@ -401,7 +322,9 @@ Editing a widget will trigger a data update and data will soon appear:
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
As with every change, click **Save board** to persist your board changes and leave edit mode.
|
As with every change, don't forget to save your changes using the exit edit mode button:
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
## Organizing items with Containers
|
## Organizing items with Containers
|
||||||
|
|
||||||
@@ -414,7 +337,7 @@ Each Container can configure:
|
|||||||
- Show or hide **Open all in new tabs**.
|
- Show or hide **Open all in new tabs**.
|
||||||
- Change its border color and custom CSS classes.
|
- Change its border color and custom CSS classes.
|
||||||
|
|
||||||
Open the add-content menu and choose **New container**.
|
Open the add-content menu and choose **New Container**.
|
||||||
In edit mode, move and resize it like any other item, then drag items into or out of it.
|
In edit mode, move and resize it like any other item, then drag items into or out of it.
|
||||||
Nested content stays within the Container's bounds.
|
Nested content stays within the Container's bounds.
|
||||||
While resizing, the solid outline follows the pointer continuously and the dashed grid preview shows the size that will be saved on release.
|
While resizing, the solid outline follows the pointer continuously and the dashed grid preview shows the size that will be saved on release.
|
||||||
|
|||||||
|
Before Width: | Height: | Size: 561 KiB |
|
Before Width: | Height: | Size: 101 KiB After Width: | Height: | Size: 6.2 KiB |
|
Before Width: | Height: | Size: 9.5 KiB After Width: | Height: | Size: 3.2 KiB |
|
Before Width: | Height: | Size: 9.2 KiB After Width: | Height: | Size: 20 KiB |
|
Before Width: | Height: | Size: 97 KiB |
|
Before Width: | Height: | Size: 132 KiB |
|
Before Width: | Height: | Size: 115 KiB |
|
Before Width: | Height: | Size: 60 KiB |
|
Before Width: | Height: | Size: 34 KiB |
|
Before Width: | Height: | Size: 177 KiB |
|
Before Width: | Height: | Size: 68 KiB |
|
Before Width: | Height: | Size: 33 KiB |
@@ -93,10 +93,6 @@ an optional `error` on a failed integration; media-request responses expose a `f
|
|||||||
requests endpoint returns its items in `requests`. When every selected integration fails, the query returns an error instead
|
requests endpoint returns its items in `requests`. When every selected integration fails, the query returns an error instead
|
||||||
of a partial response.
|
of a partial response.
|
||||||
|
|
||||||
Other widgets use the same settlement pattern with endpoint-specific shapes: a failed integration may appear as a named
|
|
||||||
fallback row, in a failure array, or be omitted while healthy results remain. Widget pages should identify the shape they
|
|
||||||
render rather than assuming every query exposes an `error` field.
|
|
||||||
|
|
||||||
### Saving dashboard layouts
|
### Saving dashboard layouts
|
||||||
|
|
||||||
The dashboard editor saves item positions and sections as one board update.
|
The dashboard editor saves item positions and sections as one board update.
|
||||||
|
|||||||
@@ -1,362 +1,85 @@
|
|||||||
---
|
---
|
||||||
|
description: Configure and use Homarr Assistant.
|
||||||
tags:
|
tags:
|
||||||
- Assistant
|
- Assistant
|
||||||
- AI
|
- AI
|
||||||
- Administration
|
- Administration
|
||||||
- Security
|
|
||||||
---
|
---
|
||||||
|
|
||||||
import assistantConfigImage from "./img/assistant-config.png";
|
|
||||||
import assistantWidgetImage from "./img/assistant-widget.png";
|
|
||||||
|
|
||||||
# Assistant
|
# Assistant
|
||||||
|
|
||||||
Administrators can configure the instance-wide AI assistant from **Management → Assistant**.
|
Homarr Assistant can answer questions about your Homarr instance and use Homarr tools on your behalf. It follows the
|
||||||
It is available to signed-in users from the user menu, with `Shift + A`, and from the
|
permissions of the signed-in user and asks for approval before it changes anything.
|
||||||
`Cmd/Ctrl + K` command menu. **Ask Homarr Assistant** is always available as a local result in the default
|
|
||||||
search. Selecting it with an existing query sends that query in the background; selecting it without a
|
|
||||||
query turns the command-menu search field into a prompt composer. Press
|
|
||||||
`Enter` to send the prompt in the background without opening the conversation. The search field receives
|
|
||||||
focus whenever the command menu opens, including when it is opened by an assistant tool. Sending from the
|
|
||||||
command menu preserves any draft in the expanded conversation. The local result is temporarily disabled while
|
|
||||||
the assistant is responding or waiting for an approval.
|
|
||||||
|
|
||||||
Availability follows the setup state. Signed-out users do not get an assistant action in the user menu or from
|

|
||||||
`Shift + A`; the always-visible command-menu result is disabled and says **Sign in**. If the provider connection or
|
|
||||||
model is configured but **Enable Assistant** is off, the user-menu and `Shift + A` entry points do not open the
|
|
||||||
assistant, while `Cmd/Ctrl + K` keeps its result visible but disabled with an explanation that an administrator must
|
|
||||||
configure and enable it. Saving a working connection, model, and enabled state makes all three entry points
|
|
||||||
available again.
|
|
||||||
|
|
||||||
While a response is running, a compact activity bar appears at the bottom of the page and the user-menu
|
## Open the assistant
|
||||||
avatar shows a thinking indicator. The activity bar can be opened to follow the response. Completed
|
|
||||||
responses add an unread count to the user menu until they are opened or dismissed. The expanded
|
|
||||||
conversation has a minimize action that returns it to the activity bar without interrupting a response.
|
|
||||||
Its adjacent close action hides the panel without leaving an activity bar behind. Both window actions use
|
|
||||||
subtle buttons with an icon, tooltip, and accessible label.
|
|
||||||
The transcript follows streamed output while it is already at the bottom, including fast responses. Scrolling
|
|
||||||
up releases that follow state until **Scroll to latest** is selected or the user returns to the bottom.
|
|
||||||
|
|
||||||
`Shift + A` opens the compact conversation panel directly. The shortcut is ignored while typing in text
|
- Select **Assistant** in the user menu.
|
||||||
fields, selectors, and editable content.
|
- Press `Shift + A` from anywhere in Homarr.
|
||||||
|
- Type a question in `Cmd/Ctrl + K`, then select **Ask Homarr Assistant**.
|
||||||
|
- Add the **Assistant** widget to a board for a permanent conversation view.
|
||||||
|
|
||||||
The **Assistant** board widget embeds the same persisted conversation and full interaction surface directly
|
You can minimize a conversation while it works. The activity bar shows its progress and the user menu shows unread
|
||||||
on a dashboard. By default it follows the current conversation. Widget settings can instead pin a specific
|
responses.
|
||||||
conversation; the conversation picker stays hidden until **Pinned conversation** is selected.
|
|
||||||
If the pinned conversation was deleted or cannot be opened, the widget shows an **Open conversation** recovery action
|
|
||||||
and retry state instead of silently losing the widget content or falling back to another thread. **Open conversation**
|
|
||||||
retries the same pinned thread after a failed switch.
|
|
||||||
|
|
||||||
<img
|
## What it can do
|
||||||
src={assistantWidgetImage}
|
|
||||||
alt="Assistant widget embedded on a dashboard with its conversation header, automatic approvals control, model selector, and composer"
|
|
||||||
style={{ maxWidth: "100%" }}
|
|
||||||
/>
|
|
||||||
|
|
||||||
The current preview capture shows the board-embedded surface, including its conversation header, automatic-approval
|
- Find and update boards, apps, integrations, widgets, and dashboard settings.
|
||||||
control, model and thinking controls, and composer. These controls operate on the same persisted thread as the
|
- Check downloads, media, Docker containers, service health, and other connected integrations.
|
||||||
floating assistant while keeping this surface's draft and focus independent.
|
- Create formatted notes and Custom Widgets.
|
||||||
|
- Search the web when OpenRouter web search is enabled.
|
||||||
|
- Show tool activity, reasoning summaries, usage, time, and cost when the provider reports them.
|
||||||
|
|
||||||
The Shift+A panel is non-modal: opening it focuses its composer, but it does not capture focus from the board.
|
Use `@` to add an app, board, integration, widget, or tool as context. Use `/` for common prompts. You can also paste or
|
||||||
Users can continue typing in an Assistant widget or interacting with other dashboard controls while the panel
|
attach images and text files when the selected model supports them.
|
||||||
is open. Every visible assistant surface keeps its own draft, attachment list, selection, and focus while sharing
|
|
||||||
the same persisted conversation. Switching conversations restores the draft that belongs to that surface and
|
|
||||||
conversation instead of copying text into another widget or the floating panel.
|
|
||||||
|
|
||||||
When the assistant is unavailable, its command-menu result remains visible but disabled and explains that
|
## Configure the assistant
|
||||||
an administrator must configure and enable it.
|
|
||||||
|
|
||||||
The assistant uses the assistant-ui runtime for **AI SDK v7**. Homarr tracks the newest mutually compatible
|
Open **Management → Assistant**.
|
||||||
package set permitted by its supply-chain release-age policy. Persisted message rows can still report the upstream
|
|
||||||
codec name `ai-sdk/v6`; assistant-ui's current v7 adapter deliberately retains that identifier for its compatible
|
|
||||||
UI-message wire format. It does not mean the application is running AI SDK v6.
|
|
||||||
|
|
||||||
## Configure a model provider
|

|
||||||
|
|
||||||
Homarr includes presets for OpenRouter, OpenAI, Anthropic Claude, Google Gemini, xAI, Groq, Mistral AI,
|
1. Select a provider.
|
||||||
DeepSeek, Together AI, Ollama, and LM Studio. Provider icons make the presets easy to identify. A custom
|
2. Check the API base URL and add an API key if required.
|
||||||
preset connects any other service that implements the OpenAI Chat Completions API.
|
3. Select **Save provider connection**.
|
||||||
|
4. Refresh the model list and choose a model.
|
||||||
|
5. Enable the assistant, then select **Save assistant**.
|
||||||
|
|
||||||
The provider list also shows **Homarr — Coming soon** as a disabled option.
|
Homarr includes presets for OpenRouter, OpenAI, Claude, Gemini, xAI, Groq, Mistral, DeepSeek, Together AI, Ollama, and
|
||||||
|
LM Studio. Use **Custom endpoint** for another OpenAI-compatible Chat Completions service.
|
||||||
|
|
||||||
The management page presents setup as three compact sections: provider and endpoint, credentials, then
|
The [Homarr provider](../workshop/homarr-provider) does not require an administrator API key. Each user signs in to the
|
||||||
model and availability. A status summary at the top shows whether the connection is ready, whether a key
|
Community Workshop and receives a separate daily allowance. A shared Workshop daily quota also applies, so requests
|
||||||
is protected, and which model is selected. Redundant active-state badges are omitted when the setup is ready.
|
can be rejected after that shared quota is exhausted.
|
||||||
|
|
||||||
<img
|
:::info Local model servers
|
||||||
src={assistantConfigImage}
|
|
||||||
alt="Assistant configuration page showing provider, credentials, model, and availability sections"
|
|
||||||
style={{ maxWidth: "100%" }}
|
|
||||||
/>
|
|
||||||
|
|
||||||
The screenshot shows the configuration surface with no provider key entered; the assistant remains disabled until a
|
Inside a container, `localhost` means the Homarr container. Use the model server's container name, local DNS name, or
|
||||||
working provider, model, and enabled state are saved.
|
host gateway address instead.
|
||||||
|
|
||||||
1. Choose a provider preset or **Custom endpoint**, then confirm the API base URL. It usually ends in `/v1`.
|
|
||||||
2. Add an API key if the service requires bearer authentication. Additional authentication or routing
|
|
||||||
headers are available in the collapsed advanced section.
|
|
||||||
3. Save the provider connection.
|
|
||||||
4. Refresh the model list and select a discovered model. Homarr displays the friendly model name but
|
|
||||||
stores and sends the provider's exact model ID. Context-window sizes use compact labels such as `1M`.
|
|
||||||
5. Enable the assistant and save the configuration.
|
|
||||||
|
|
||||||
Changing the provider or base URL immediately resets the unsaved credential/header draft, selected model, and
|
|
||||||
enabled state, and puts the model section into a **save connection first** state. Saving that destination change also
|
|
||||||
clears stored credentials for the previous destination. Changing the discovery path resets the selected model and
|
|
||||||
enabled state; save the new path before relying on its discovery results. For an unsaved provider or base-URL change,
|
|
||||||
the model controls, **Refresh models**, web-search switch, enable switch, and **Save assistant** remain unavailable.
|
|
||||||
After the connection is saved, refresh the model list and select a model; if discovery is blank or returns no models,
|
|
||||||
the manual model-ID field is the supported fallback. Only then enable the assistant and save the configuration.
|
|
||||||
|
|
||||||
The model discovery path defaults to `/models` and is appended to the API base URL. Leave the custom path blank when
|
|
||||||
the service does not expose a usable discovery endpoint. A manual model ID can still be used when discovery is
|
|
||||||
unavailable or returns no models.
|
|
||||||
|
|
||||||
API keys and additional header values are encrypted in the Homarr database. They are decrypted only on
|
|
||||||
the server for discovery and model requests, and they are never returned to the browser. Changing the
|
|
||||||
provider or base URL, then saving the connection, clears existing credentials. This prevents credentials for one
|
|
||||||
service from being sent to another endpoint. Additional headers are write-only; saving them replaces the complete
|
|
||||||
stored header set. Use the
|
|
||||||
explicit clear/remove flow when you want to remove previously saved headers.
|
|
||||||
|
|
||||||
When a key is already stored, the page shows its protected state instead of an ambiguous empty password
|
|
||||||
field. Removing the API key requires explicit confirmation. Save that removal before entering and saving a
|
|
||||||
different key.
|
|
||||||
|
|
||||||
:::info Container networking
|
|
||||||
|
|
||||||
For a containerized Homarr installation, `localhost` refers to the Homarr container. Use a resolvable
|
|
||||||
container name, internal DNS name, or host gateway address to reach Ollama, LM Studio, or another local
|
|
||||||
model server.
|
|
||||||
|
|
||||||
:::
|
:::
|
||||||
|
|
||||||
The configured endpoint must support streaming Chat Completions and structured tool calls for the full
|
## Approvals and data
|
||||||
assistant experience. Model discovery alone does not guarantee tool support, except when OpenRouter
|
|
||||||
explicitly advertises the model's `tools` capability.
|
|
||||||
|
|
||||||
OpenRouter web search is an opt-in option in the model section. It registers OpenRouter's model-callable
|
Read-only tools can run automatically. Changes show an approval card with the exact action before Homarr runs it.
|
||||||
[`openrouter:web_search` server tool](https://openrouter.ai/docs/guides/features/server-tools/web-search)
|
Normal Homarr permissions still apply.
|
||||||
alongside Homarr's tools, so OpenRouter performs each search without
|
|
||||||
exposing the stored credential to the browser. The model decides when live research is needed and can use the
|
|
||||||
grounded results and source links in responses or dashboard notes. Homarr limits each assistant request to
|
|
||||||
three searches with five results per search. OpenRouter charges web-search usage separately from model tokens.
|
|
||||||
Completed responses show a compact web-search activity card when OpenRouter reports search usage. OpenRouter
|
|
||||||
does not expose these server-side searches as ordinary client-executed tool calls, so Homarr shows the reported
|
|
||||||
search count and the safe title and URL from each returned `url_citation` annotation instead. Citation excerpts
|
|
||||||
stay in the provider response and are not persisted in the activity card.
|
|
||||||
|
|
||||||
The option is also available for custom endpoints that forward OpenRouter's server-tools request format. This
|
API keys and custom headers are encrypted in the Homarr database and are never returned to the browser. Prompts,
|
||||||
supports OpenRouter proxies, including the future Homarr Router provider. Leave it disabled for ordinary
|
attachments, tool definitions, and tool results are sent to the configured model provider. Check that provider's data
|
||||||
OpenAI-compatible endpoints because the `openrouter:*` tool type is not part of the standard OpenAI API.
|
policy before enabling the assistant.
|
||||||
|
|
||||||
The Claude preset uses Anthropic's OpenAI SDK compatibility layer. Anthropic describes that layer as
|
Conversations are stored per user. Users can edit or retry messages, copy responses, export a conversation as Markdown,
|
||||||
suited to testing and comparison rather than as its full native API; unsupported OpenAI fields may be
|
and delete conversations.
|
||||||
ignored. Streaming responses and tool calls are supported, which are the capabilities Homarr Assistant
|
|
||||||
uses. Choose OpenRouter or another provider when you prefer a provider-neutral production endpoint.
|
|
||||||
|
|
||||||
## Conversations and tools
|
## If setup does not work
|
||||||
|
|
||||||
Conversations and messages are stored per user in the Homarr database. The assistant stays out of the
|
- **No models found:** check the base URL, model discovery path, and API key. You can enter a model ID manually.
|
||||||
page layout until it is opened. Users can start, revisit, and delete conversations from the
|
- **The assistant is unavailable:** enable it and save the configuration.
|
||||||
conversation menu in the floating panel.
|
- **A model stops during a tool call:** use a model that supports streaming and structured tool calls.
|
||||||
|
- **A local endpoint cannot be reached:** check container networking and the endpoint's listen address.
|
||||||
|
|
||||||
Messages support copy, edit-and-resend, response regeneration and branch navigation, Markdown export,
|
Homarr exposes its MCP-enabled procedures to external clients through the [MCP server](./mcp). MCP omits
|
||||||
and helpful/not-helpful feedback. The conversation menu also provides a compact export action beside delete for
|
`customWidget_*` tools for non-admin API keys, while the built-in assistant adds browser actions and optional
|
||||||
each conversation. Its debugging-oriented Markdown includes every stored user, assistant, reasoning, tool, error,
|
OpenRouter web search. Custom Widget authors can find the full workflow in
|
||||||
branch-parent, and server-metadata record while redacting secret-looking fields and embedded attachment data.
|
[Agent authoring](./custom-widgets/agent-authoring).
|
||||||
The per-response export uses the same tool-aware format instead of assistant-ui's text-only copy representation.
|
|
||||||
Selecting text in a message exposes a quote action that carries the selected passage into the next prompt.
|
|
||||||
Files returned by a compatible model can be downloaded directly from the message.
|
|
||||||
Assistant responses render GitHub-flavored Markdown, including headings, links, lists, task lists, tables,
|
|
||||||
quotes, inline code, and fenced code blocks. Line breaks are preserved, and Homarr repairs common streamed
|
|
||||||
responses where a provider returns escaped line breaks or places a bold-label list on one line.
|
|
||||||
Completed fenced code blocks use language-aware syntax highlighting; a streaming block stays plain until its
|
|
||||||
content is stable. Safe same-origin links are prefetched and use client-side navigation, so opening a returned
|
|
||||||
preview, editor, board, or other Homarr item does not unload the assistant. External links keep their normal
|
|
||||||
external-browser behavior.
|
|
||||||
Fenced `mermaid` blocks render as diagrams in the current color scheme using Mermaid's strict security mode;
|
|
||||||
invalid diagrams fall back to their source instead of breaking the response.
|
|
||||||
When Homarr's icon search returns an image URL, visual result tables render that actual icon in a compact
|
|
||||||
image column instead of substituting an emoji. Assistant-provided Markdown images accept safe relative,
|
|
||||||
HTTP, and HTTPS sources and load without forwarding the Homarr page as the referrer. Image message parts
|
|
||||||
render through assistant-ui's image primitive in a bounded responsive preview with an accessible loading state,
|
|
||||||
a filename caption when available, and an in-place retry when the source fails.
|
|
||||||
Images up to 1 MB and text, Markdown, CSV, HTML, XML, or JSON documents up to 350 KB can be attached by
|
|
||||||
using the paperclip, dropping files onto the composer, or pasting an image with `Cmd/Ctrl + V`. Attachment
|
|
||||||
previews stay local to the composer where they were added and show upload state, file type, and a removable image
|
|
||||||
thumbnail or document tile. A request can contain up to five attachments.
|
|
||||||
Image understanding depends on the selected model; document text is extracted locally by Homarr and sent
|
|
||||||
as part of the prompt.
|
|
||||||
|
|
||||||
Type `@` in the composer to add permission-checked context. The nested menu contains apps, integrations,
|
|
||||||
boards, widgets, and tools available to the current user. Homarr validates every referenced ID again on
|
|
||||||
the server before adding it to the model context. Selected references appear as compact, typed pills in the
|
|
||||||
composer and sent message, while preserving assistant-ui's underlying directive syntax for the model. When the
|
|
||||||
assistant cites one of those references in its own response, Homarr renders the same typed pill and uses the
|
|
||||||
stored app or integration icon when one is available. Type `/`
|
|
||||||
for common prompt shortcuts. Both menus support keyboard navigation and keep the active result visible while
|
|
||||||
moving through long lists. The selector below the composer combines searchable, provider-grouped models with
|
|
||||||
their description, context size and image-input capability, plus the thinking-level control. Model selection is
|
|
||||||
saved to the current conversation when selected. For a persisted thread, changing the model updates that thread's
|
|
||||||
preference without changing the administrator's configured default; switching threads restores each thread's saved
|
|
||||||
model, while a new thread starts from the configured default until the user changes it. Thinking mode can be left on
|
|
||||||
**Auto**, disabled, or set
|
|
||||||
from minimal through high; explicit levels are sent using the AI SDK's provider-neutral reasoning setting and
|
|
||||||
still depend on support from the chosen model and endpoint. Reasoning text is shown live when the provider streams
|
|
||||||
it through assistant-ui's grouped-parts and chain-of-thought primitives. The compact **Thinking** trace groups
|
|
||||||
adjacent reasoning with ordinary tool calls, shows each tool's status, duration and safe human-readable target,
|
|
||||||
and expands raw input, output and result previews only on request. Approval and question tools remain full-width
|
|
||||||
outside the trace. The disclosure renders Markdown, can be opened or closed without interrupting the response,
|
|
||||||
and keeps the user's collapsed state when another message starts. A compact dot matrix distinguishes an initial
|
|
||||||
thinking pass from response streaming and settles into waiting, success, or error states in the minimized activity
|
|
||||||
bar. The state always keeps its text label, and the animation is disabled when the operating system requests
|
|
||||||
reduced motion.
|
|
||||||
|
|
||||||
A circular context ring beside the model selector gives a quick glance at cumulative conversation usage without
|
|
||||||
expanding the composer toolbar. Its accessible label includes cumulative tokens and cost when available, while
|
|
||||||
its popover keeps the latest complete context reading as a new response starts and lists every request
|
|
||||||
turn with its model, provider, input, output, cached-input and reasoning tokens, context use, duration, speed,
|
|
||||||
agent steps, routing details, and cost when reported. Before usage is available, the control remains a compact
|
|
||||||
ring instead of showing a redundant missing-data label. Closing and reopening the popover reads persisted
|
|
||||||
conversation metadata instead of resetting the display to zero. A larger ring inside the popover breaks the latest
|
|
||||||
reported context into used, remaining and total capacity plus input, cached-input, output and reasoning tokens.
|
|
||||||
|
|
||||||
Each assistant response places a small provider logo in the same stable action toolbar as copy, export,
|
|
||||||
feedback, and regenerate. Hovering the logo shows the provider, exact model, timing, throughput, and cost without
|
|
||||||
adding another metadata row to the transcript. Branch navigation occupies its own adjacent group, so switching
|
|
||||||
between response versions never pushes the response actions off-screen.
|
|
||||||
|
|
||||||
OpenRouter responses request inline usage and routing metadata. Opening detailed turn data also loads the
|
|
||||||
server-side generation record for its model steps and briefly polls while OpenRouter finishes processing it.
|
|
||||||
The details separate Homarr's end-to-end timing from OpenRouter's provider latency, generation time, and provider
|
|
||||||
throughput, and can include normalized and native token counts, moderation latency, cache discount, fallback count,
|
|
||||||
service tier, data region, BYOK status, routed provider, generation identifier, exact cost, and upstream inference
|
|
||||||
cost. Provider credentials remain server-side; the browser can request only generation identifiers already stored
|
|
||||||
on a conversation owned by the signed-in user and signed by the Homarr server for that user and conversation.
|
|
||||||
Successful generation lookups are cached briefly so polling and multi-step requests do not repeatedly query
|
|
||||||
OpenRouter for the same record.
|
|
||||||
When a provider omits cost but model discovery includes prompt and completion pricing, Homarr labels the
|
|
||||||
calculated value as estimated. Missing provider data is shown as not reported rather than inferred.
|
|
||||||
|
|
||||||
The assistant can use the same internal tool definitions as the [Homarr MCP server](./mcp).
|
|
||||||
Each tool call runs as the signed-in user, so normal Homarr permission checks still apply. Read-only
|
|
||||||
procedures can run during the agent loop. Mutating procedures require native approval unless automatic approvals are
|
|
||||||
enabled for the conversation. Neutral choices and questions still wait for the user. The approval appears as a large
|
|
||||||
**Approve and run** or **Deny** action;
|
|
||||||
the assistant does not require a second typed confirmation first. Tool cards expose their status, timing,
|
|
||||||
validated input, result, and error state without flooding the conversation with raw JSON by default.
|
|
||||||
Common collection and widget results are summarized inline as compact responsive cards, while the full
|
|
||||||
structured result remains available in the tool card details. Icon searches show the returned image variants,
|
|
||||||
file formats, and repositories instead of the size of the complete icon catalog. Their trace uses a readable
|
|
||||||
activity such as **Looking for “homarr” icons** instead of exposing the internal MCP procedure name.
|
|
||||||
|
|
||||||
Large tool-driven requests can use up to 32 agent steps and a larger response budget within one request, so
|
|
||||||
multi-item dashboard changes normally finish without requiring a follow-up “Continue” message. OpenRouter calls
|
|
||||||
Homarr tools sequentially to prevent routed models from interleaving or truncating parallel JSON arguments, while
|
|
||||||
every mutation still follows its native approval policy, including conversation-scoped automatic approvals. A safely
|
|
||||||
recoverable truncated icon-search object is repaired
|
|
||||||
before validation; incomplete search strings and all mutation inputs are never guessed.
|
|
||||||
Homarr also normalizes internal tool results to the model's JSON-compatible message format before continuing an
|
|
||||||
agent loop. Rich server values such as dates cannot invalidate the next model step, and an interrupted tool call
|
|
||||||
without a result is omitted when the conversation resumes instead of making the entire prompt fail.
|
|
||||||
|
|
||||||
The assistant can create a formatted dashboard note by adding a **Notebook** widget. Ask it for a note with
|
|
||||||
headings, lists, tasks, links, emphasis, tables, or images; it generates compatible rich-text content, shows
|
|
||||||
the native widget configuration form and standard mutation approval, then places the widget in the next
|
|
||||||
available dashboard position. The generated content is retained even though the Notebook content field is
|
|
||||||
normally hidden from widget settings.
|
|
||||||
|
|
||||||
Automatic placement checks every responsive layout and treats both widgets and complete container footprints
|
|
||||||
as occupied. New assistant-created items use the first free position in the main canvas instead of overlapping
|
|
||||||
existing content or being placed in a gutter.
|
|
||||||
|
|
||||||
Every assistant-created dashboard widget now passes through Homarr's native widget editor before it is added.
|
|
||||||
The form fills widget defaults, validates widget-specific options, and only offers compatible integrations that
|
|
||||||
the current user can use. Required integrations cannot be left empty, single-integration widgets cannot receive
|
|
||||||
multiple integrations, and the reviewed values are passed unchanged into the final approval-gated mutation.
|
|
||||||
|
|
||||||
Custom-widget tools let an administrator list, inspect, create, and update definitions. The custom-widget
|
|
||||||
form's **Design with AI** action sends a focused request into the current conversation, where the assistant
|
|
||||||
can propose the matching mutation and use the same approval controls. Existing stored secret values are
|
|
||||||
reported only as configured/not configured and are preserved on update unless replacements are explicitly
|
|
||||||
provided. For Custom Widget requests, Homarr lazily adds the complete installed skill, all bundled schema,
|
|
||||||
runtime and security references, and the current JSON Schema to the trusted authoring context. This avoids an
|
|
||||||
extra provider round trip for the large `customWidget_getSkill` and `customWidget_schema` results. If the model
|
|
||||||
discovers the Custom Widget workflow mid-response, Homarr promotes the same resources before its next step and
|
|
||||||
removes the now-redundant resource calls from provider history. Multiline JSX uses `templateLines` to avoid fragile
|
|
||||||
streamed JSON escaping. Custom Widget authoring tools are mandatory: the assistant validates the complete candidate,
|
|
||||||
creates a preview from that exact version, executes every returned preview query, checks the actual HTTP status and
|
|
||||||
response shape, and repeats the entire validation and preview sequence after any material JSX, request, source, option,
|
|
||||||
or binding change. It only reports a widget as validated, working, created, or placed when the corresponding tool result
|
|
||||||
proves that checkpoint. Large widgets are saved from the exact final tested preview session, so the approved create step
|
|
||||||
does not stream the complete JSX a second time. When the request already names a board, that board is carried into the
|
|
||||||
create result and placement continues without asking the user to select it again. Preview and saved-definition results
|
|
||||||
include safe Homarr paths that open in the assistant without a page reload. When placement is still a choice, the
|
|
||||||
assistant uses the structured question UI instead of ending with a prose question.
|
|
||||||
|
|
||||||
The authoring phase limits broad component-document retrieval and then moves into validation with the smallest useful
|
|
||||||
reference set. Supplied samples and successful preview responses are treated as binding contracts: the assistant is
|
|
||||||
instructed to render the requested fields, guard optional nested data, preserve every returned item, expose freshness
|
|
||||||
when timestamps are available, and provide a refresh path for recoverable empty or error states.
|
|
||||||
|
|
||||||
The shield control in the conversation header can enable automatic approvals for the current conversation; they are
|
|
||||||
off by default.
|
|
||||||
While enabled, Homarr accepts every affirmative approval step as it arrives: protected mutations are approved,
|
|
||||||
presented app details and board changes are used, and structured questions with an explicitly categorized
|
|
||||||
**Confirm** answer choose that answer. Neutral choices such as selecting a board still wait for input because
|
|
||||||
they do not have a safe affirmative default. Automatic approvals turn off when you switch conversations, and
|
|
||||||
the shared approval tracker prevents the same call from being handled twice when both a board widget and the
|
|
||||||
floating assistant are visible.
|
|
||||||
|
|
||||||
When the assistant genuinely needs missing information or a choice, it can pause with a structured
|
|
||||||
question. Each proposed answer is visibly categorized as **Confirm**, **Decline**, or **Option**, so the effect
|
|
||||||
of automatic approval is unambiguous. **Other** is shown only when the tool allows it (`allowOther` is not `false`);
|
|
||||||
selecting it opens a freeform response and is always a manual alternative, not an automatic approval choice. While a
|
|
||||||
question is unanswered, its controls stay in a dedicated area immediately
|
|
||||||
above the composer instead of requiring the user to find the tool call in the transcript. The question temporarily
|
|
||||||
uses the available conversation body, with its own scrolling when necessary, rather than squeezing a long option
|
|
||||||
list into a short dock beside part of the transcript. The answered choice then remains in the conversation history.
|
|
||||||
Submitting the answer resumes the same agent run automatically. The minimized activity bar shows the
|
|
||||||
question or approval that needs attention and opens directly back to the request. While an answer, app
|
|
||||||
form, or mutation approval is pending, the composer preserves its draft but does not replace the pending
|
|
||||||
tool call with a new message. If the provider stops before an interactive tool supplies complete arguments,
|
|
||||||
Homarr replaces the loading state with an explicit error and confirms that no change was made.
|
|
||||||
|
|
||||||
App creation uses Homarr's native app form inside the conversation. The form reuses the local icon picker,
|
|
||||||
including automatic matching and searches through the `icon.findIcons` procedure, before the final
|
|
||||||
`app.create` approval is requested. App fields are filled only after the complete tool input has arrived, so
|
|
||||||
streaming partial arguments cannot replace the proposed values with empty fields. The model is instructed not
|
|
||||||
to invent external icon CDN URLs.
|
|
||||||
|
|
||||||
Board appearance changes use a similar review flow. The assistant first reads the board's current settings,
|
|
||||||
including its complete custom stylesheet, and then opens an editable form with Custom CSS, Appearance,
|
|
||||||
Background, and General tabs. The form highlights how many fields were proposed, preserves settings the
|
|
||||||
assistant did not change, and returns only values that differ from the current board. If nothing differs, the review
|
|
||||||
cancels without creating a mutation or approval. Custom CSS can be
|
|
||||||
copied or restored before continuing, and Homarr warns when it contains an imported stylesheet or remote
|
|
||||||
resource URL. Continuing from the form opens the normal mutation approval before anything is saved.
|
|
||||||
|
|
||||||
The board-settings tool covers General, Background, Appearance, Custom CSS, and app-status settings. It does not edit
|
|
||||||
responsive layouts, board access control, or Danger zone actions; those remain outside this review scope.
|
|
||||||
|
|
||||||
Ask for changes such as “make the cards denser on my Home board,” “add a mobile CSS rule without removing
|
|
||||||
my existing styles,” or “change the board colors and disable app status checks.” The current user must have
|
|
||||||
modify permission on the selected board. The empty conversation includes an **Improve a dashboard** starter,
|
|
||||||
and `/style` prepares the same guided workflow from the composer.
|
|
||||||
|
|
||||||
Homarr also exposes a small set of browser-only actions to the assistant. These actions can navigate to
|
|
||||||
safe internal routes, refresh the current view, and open Homarr interfaces such as the command menu and media request search.
|
|
||||||
They never receive provider credentials and cannot navigate to arbitrary external URLs.
|
|
||||||
|
|
||||||
After an approved mutation completes, Homarr automatically refetches active page and dashboard data so
|
|
||||||
board items, settings, custom CSS, apps, and other visible results update without a full browser reload.
|
|
||||||
The refresh action in the conversation header performs the same safe refetch manually. It keeps the
|
|
||||||
conversation open while refreshing both client queries and server-rendered route data.
|
|
||||||
|
|
||||||
:::warning
|
|
||||||
|
|
||||||
Assistant prompts and selected tool results are sent to the configured model endpoint. Review that
|
|
||||||
service's privacy and retention terms before enabling this feature for an instance.
|
|
||||||
|
|
||||||
:::
|
|
||||||
@@ -22,6 +22,8 @@ Navigate to `Management` → `Tools` → `Backup`. You must have **admin** permi
|
|||||||
|
|
||||||
## Exporting a Backup
|
## Exporting a Backup
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
Click the **Export** button in the export card. You'll be prompted to type `I understand` to confirm. Once confirmed, a ZIP file downloads containing:
|
Click the **Export** button in the export card. You'll be prompted to type `I understand` to confirm. Once confirmed, a ZIP file downloads containing:
|
||||||
|
|
||||||
| File | Description |
|
| File | Description |
|
||||||
@@ -33,6 +35,8 @@ The backup contains the complete database. It includes Custom Widgets and all ot
|
|||||||
|
|
||||||
## Restoring a Backup
|
## Restoring a Backup
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
### 1. Upload
|
### 1. Upload
|
||||||
|
|
||||||
Drag and drop or select a `.zip` backup file. The import card validates that the file contains a valid `db.sqlite` and metadata.
|
Drag and drop or select a `.zip` backup file. The import card validates that the file contains a valid `db.sqlite` and metadata.
|
||||||
|
|||||||
|
Before Width: | Height: | Size: 101 KiB |
|
Before Width: | Height: | Size: 102 KiB |
|
Before Width: | Height: | Size: 95 KiB |
|
Before Width: | Height: | Size: 101 KiB |
|
Before Width: | Height: | Size: 160 KiB |
|
Before Width: | Height: | Size: 256 KiB After Width: | Height: | Size: 36 KiB |
@@ -11,18 +11,15 @@ tags:
|
|||||||
|
|
||||||
import iconColorImage from "./img/icon-color.png";
|
import iconColorImage from "./img/icon-color.png";
|
||||||
import itemRadiusImage from "./img/item-radius.png";
|
import itemRadiusImage from "./img/item-radius.png";
|
||||||
import layoutSettingsImage from "./img/layout-settings.png";
|
import layoutLargeImage from "./img/layout-large.png";
|
||||||
import layoutSettingsCustomRailsImage from "./img/layout-settings-custom-rails.png";
|
import layoutMediumImage from "./img/layout-medium.png";
|
||||||
import boardViewModeImage from "./img/board-view-mode.png";
|
import layoutSmallImage from "./img/layout-small.png";
|
||||||
import boardEditModeImage from "./img/board-edit-mode.png";
|
|
||||||
import addBoardContentMenuImage from "./img/add-board-content-menu.png";
|
|
||||||
import keyboardTileEditingImage from "./img/keyboard-tile-editing.png";
|
|
||||||
|
|
||||||
Each dashboard is called a "board".
|
Each dashboard is called a "board".
|
||||||
You can create as many boards as you want.
|
You can create as many boards as you want.
|
||||||
Boards can be restricted to user groups.
|
Boards can be restricted to user groups.
|
||||||
A user may also have a "home board" which they will see at the root path (e.g. my-homarr.com or my-homarr.com/boards).
|
A user may also have a "home board" which they will see at the root path (e.g. my-homarr.com or my-homarr.com/board).
|
||||||
Other boards can be viewed by direct links (e.g. my-homarr.com/boards/smart-home) or via the management pages.
|
Other boards can be viewed by direct links (e.g. my-homarr.com/board/smart-home) or via the management pages.
|
||||||
|
|
||||||
Names of boards must be unique because this will be used in the URL to load the desired board.
|
Names of boards must be unique because this will be used in the URL to load the desired board.
|
||||||
|
|
||||||
@@ -95,23 +92,9 @@ Homarr will fall back to the Homarr logo if nothing is set.
|
|||||||
|
|
||||||
In this section you can configure the different responsive layouts. Homarr selects the layout with the highest breakpoint that is not wider than the current screen, then scales its complete fixed-size canvas uniformly.
|
In this section you can configure the different responsive layouts. Homarr selects the layout with the highest breakpoint that is not wider than the current screen, then scales its complete fixed-size canvas uniformly.
|
||||||
|
|
||||||
<img
|

|
||||||
src={layoutSettingsImage}
|
|
||||||
alt="Board settings showing protected Mobile and Base responsive layouts with rail controls"
|
|
||||||
style={{ maxWidth: "100%" }}
|
|
||||||
/>
|
|
||||||
|
|
||||||
The layout cards show the representative geometry used for planning. This current example also shows a custom layout
|
Every board has two protected layouts:
|
||||||
with both fixed rails enabled; the rails reserve columns and the remaining canvas reflows automatically.
|
|
||||||
|
|
||||||
<img
|
|
||||||
src={layoutSettingsCustomRailsImage}
|
|
||||||
alt="Board layout settings with a custom layout and both fixed rails enabled"
|
|
||||||
style={{ maxWidth: "100%" }}
|
|
||||||
/>
|
|
||||||
|
|
||||||
Every board has two protected layouts. Creating a board adds **Mobile** at `0px` with three columns and **Base** at
|
|
||||||
`768px` with the column count you choose. Both layouts can be edited, but neither can be removed.
|
|
||||||
|
|
||||||
Every `1 × 1` tile has a `200 × 200` logical-pixel content area.
|
Every `1 × 1` tile has a `200 × 200` logical-pixel content area.
|
||||||
The `24` logical-pixel gap between tiles is separate from that size.
|
The `24` logical-pixel gap between tiles is separate from that size.
|
||||||
@@ -124,17 +107,9 @@ The complete canvas always fits the available width and never adds horizontal bo
|
|||||||
- **Mobile** starts at `0px` and uses three columns on new boards.
|
- **Mobile** starts at `0px` and uses three columns on new boards.
|
||||||
- **Base** is the widest layout and starts at `768px` on new boards.
|
- **Base** is the widest layout and starts at `768px` on new boards.
|
||||||
|
|
||||||
Mobile and Base can be renamed and their column counts and rails can be changed. You can add removable custom layouts
|
Mobile and Base can be renamed and their column counts and rails can be changed, but they cannot be removed. You can add removable custom layouts between their breakpoints.
|
||||||
between their breakpoints.
|
|
||||||
|
|
||||||
Each layout stores independent positions and sizes. Moving or resizing a widget while editing Mobile does not move it in
|
Each layout stores independent positions and sizes. Moving or resizing a widget while editing Mobile does not move it in Base or any custom layout. New custom layouts are generated from Base and scaled to their selected column count.
|
||||||
Base or any custom layout. New custom layouts start from Base's current column count and rail widths; Homarr chooses a
|
|
||||||
free breakpoint between Mobile and Base, and you can then change the breakpoint, columns, and rails.
|
|
||||||
|
|
||||||
Older or incomplete boards are repaired automatically. A board with no layouts receives Mobile at `0px` with three
|
|
||||||
columns and Base at `768px` with ten columns. A board with one layout keeps it as Base and receives a generated Mobile
|
|
||||||
layout. With multiple layouts, the narrowest becomes Mobile, the widest becomes Base, and intermediate layouts remain
|
|
||||||
custom. Duplicate or out-of-order breakpoints are normalized without discarding saved positions.
|
|
||||||
|
|
||||||
Use **Reset from Base** on Mobile or a custom layout to replace all of its positions and sizes with a newly generated version of Base. The layout's name, breakpoint, and column count are kept.
|
Use **Reset from Base** on Mobile or a custom layout to replace all of its positions and sizes with a newly generated version of Base. The layout's name, breakpoint, and column count are kept.
|
||||||
|
|
||||||
@@ -160,7 +135,6 @@ The preview shows how much space remains for the main canvas.
|
|||||||
|
|
||||||
Rail columns are reserved from the layout's total column count.
|
Rail columns are reserved from the layout's total column count.
|
||||||
For example, a 12-column layout with a two-column left rail leaves ten columns for the canvas.
|
For example, a 12-column layout with a two-column left rail leaves ten columns for the canvas.
|
||||||
The combined rail widths cannot consume the final main-canvas column.
|
|
||||||
Enabling or widening a rail reflows canvas items into the remaining columns.
|
Enabling or widening a rail reflows canvas items into the remaining columns.
|
||||||
Disabling a rail moves its contents back into the next available canvas positions.
|
Disabling a rail moves its contents back into the next available canvas positions.
|
||||||
|
|
||||||
@@ -169,73 +143,39 @@ Apps, widgets, and Containers inside them still use the same fixed `200 × 200`
|
|||||||
|
|
||||||
#### Breakpoint
|
#### Breakpoint
|
||||||
|
|
||||||
The minimum screen width where the layout is used; a layout is eligible at its breakpoint and above. Mobile is fixed at
|
The minimum screen width where the layout is used. Mobile is fixed at `0px`. Custom breakpoints must be unique and sit between Mobile and Base. Base must remain the highest breakpoint.
|
||||||
`0px`. Custom breakpoints must be unique and sit between Mobile and Base. Base must remain the highest breakpoint.
|
|
||||||
When the initial viewport is not available, Homarr uses its remembered viewport information, client hints, or User-Agent
|
|
||||||
fallback to select a layout.
|
|
||||||
|
|
||||||
#### View and edit modes
|
#### View and edit modes
|
||||||
|
|
||||||
View mode renders a static board without executing the drag-and-drop editor.
|
View mode renders a static board without executing the drag-and-drop editor.
|
||||||
After the board is interactive, Homarr prepares the editor in the background for users who can modify it.
|
After the board is interactive, Homarr prepares the editor in the background for users who can modify it.
|
||||||
Entering edit mode keeps the static board visible until that preparation finishes, then enables collision-aware movement and resizing.
|
Entering edit mode keeps the static board visible until that preparation finishes, then enables collision-aware movement and resizing without changing the board geometry.
|
||||||
Collapsed Containers are expanded while editing so their contents and controls are reachable.
|
Widget content is inert in edit mode, so dragging anywhere on the content moves the tile instead of activating the widget; its settings button remains visible in the compact header above the tile.
|
||||||
|
Dropping a tile into another tile's exact slot swaps their positions when both resulting placements fit without overlapping other content.
|
||||||
<img
|
For other collisions, or when a tile grows into occupied space, nearby tiles are compacted out of the way.
|
||||||
src={boardViewModeImage}
|
|
||||||
alt="A Homarr board in view mode with the dashboard canvas and static widgets visible"
|
|
||||||
style={{ maxWidth: "100%" }}
|
|
||||||
/>
|
|
||||||
|
|
||||||
Widget content is inert in edit mode, so dragging from the inert widget area moves the tile instead of activating the widget;
|
|
||||||
settings and other controls remain usable in the compact header above the tile.
|
|
||||||
A single compatible collision can swap two items when both resulting placements fit, including different-sized or lateral moves.
|
|
||||||
For other collisions, or when a tile grows into occupied space, nearby tiles are compacted out of the way and collision chains reflow.
|
|
||||||
The visible corner controls provide a 44-pixel resize target, and edge controls appear on hover for horizontal or vertical resizing.
|
The visible corner controls provide a 44-pixel resize target, and edge controls appear on hover for horizontal or vertical resizing.
|
||||||
Resize handles stop at the tile's minimum allowed size while the pointer is still moving.
|
Resize handles stop at the tile's minimum allowed size while the pointer is still moving.
|
||||||
Use the pencil button in the board header to enter edit mode; click it again to save. If you leave the page with unsaved
|
Exit edit mode to save the resulting positions.
|
||||||
changes, Homarr asks whether to discard them. If the editor cannot load, the board remains in view mode.
|
|
||||||
|
|
||||||
<img
|
Pointer users can drag anywhere on a widget tile. Containers use the grab button at their top-left corner.
|
||||||
src={boardEditModeImage}
|
Resize tiles from any edge or corner handle.
|
||||||
alt="Board in edit mode with the board header controls and editable dashboard tiles visible"
|
On a touch screen, press and hold the tile before moving it; resize handles support direct touch input.
|
||||||
style={{ maxWidth: "100%" }}
|
|
||||||
/>
|
|
||||||
|
|
||||||
While edit mode is active, **Add board content** creates a new item, app, integration, or Container on the main canvas.
|
|
||||||
New content uses the first available position; clicking an empty cell does not place it there, and items cannot be added
|
|
||||||
directly into a rail or Container from this menu.
|
|
||||||
|
|
||||||
<img
|
|
||||||
src={addBoardContentMenuImage}
|
|
||||||
alt="Board edit mode add-content menu showing New item, Add an app, New integration, and New container"
|
|
||||||
style={{ maxWidth: "100%" }}
|
|
||||||
/>
|
|
||||||
|
|
||||||
Pointer users can drag from the inert widget area; interactive controls are excluded. Containers use the grab button at their top-left corner.
|
|
||||||
Widgets can be resized from any edge or corner handle. Activate a Container's chrome with its top-left grip before using
|
|
||||||
its resize handles.
|
|
||||||
On a touch screen, press and hold a tile for about `200 ms` before moving it; a quick tap does not start a drag. Resize
|
|
||||||
handles support direct touch input.
|
|
||||||
Keyboard users can focus a tile, press Enter or Space to start editing, use the arrow keys to move it, and use Shift plus the arrow keys to resize it.
|
Keyboard users can focus a tile, press Enter or Space to start editing, use the arrow keys to move it, and use Shift plus the arrow keys to resize it.
|
||||||
Press Enter, Space, or Escape to stop keyboard editing.
|
Press Enter, Space, or Escape to stop keyboard editing.
|
||||||
Keyboard moves and resizes apply immediately within the current canvas, rail, or Container; they cannot move an item
|
Keyboard moves and resizes apply immediately; Escape stops keyboard editing without undoing those changes.
|
||||||
between grids. Use pointer drag or **Move / resize item** for that.
|
|
||||||
Escape stops keyboard editing without undoing those changes.
|
|
||||||
During a pointer or touch interaction, Escape cancels the move or resize and restores the layout from before that interaction.
|
During a pointer or touch interaction, Escape cancels the move or resize and restores the layout from before that interaction.
|
||||||
Invalid, outside, or otherwise forbidden drops are cancelled in the same way.
|
|
||||||
The **Move / resize item** action in the edit menu remains available for precise numeric input.
|
The **Move / resize item** action in the edit menu remains available for precise numeric input.
|
||||||
|
|
||||||
<img src={keyboardTileEditingImage} alt="A focused board tile in keyboard editing mode" style={{ maxWidth: "100%" }} />
|
|
||||||
|
|
||||||
#### Preview
|
#### Preview
|
||||||
|
|
||||||
Layout Settings shows a lightweight structural preview for every layout, including saved spans, Containers, widget labels, and app icons.
|
Layout Settings shows a lightweight structural preview for every layout, including saved spans, Containers, widget labels, and app icons. The canvas width represents the screen range where that layout is active.
|
||||||
It uses a representative viewport width to project the saved geometry; it does not execute widget queries or represent every
|
|
||||||
pixel of the screen range where the layout is active.
|
|
||||||
|
|
||||||
Choose **Edit layout** to open the real board editor at that representative width on desktop. Save returns to Layout Settings. Cancel discards the local changes. On phones and tablets, the normal board editor continues to use the layout selected by the device width.
|
Choose **Edit layout** to open the real board editor at that representative width on desktop. Save returns to Layout Settings. Cancel discards the local changes. On phones and tablets, the normal board editor continues to use the layout selected by the device width.
|
||||||
|
|
||||||
|
<img src={layoutSmallImage} height={256} />
|
||||||
|
<img src={layoutMediumImage} height={256} />
|
||||||
|
<img src={layoutLargeImage} height={256} />
|
||||||
|
|
||||||
### Containers and rails
|
### Containers and rails
|
||||||
|
|
||||||
Containers can hold apps, widgets, and nested Containers.
|
Containers can hold apps, widgets, and nested Containers.
|
||||||
@@ -307,10 +247,9 @@ Change the radius of your items and Containers.
|
|||||||
This is the field where you can enter custom CSS.
|
This is the field where you can enter custom CSS.
|
||||||
The styling will only be applied on the respective board page.
|
The styling will only be applied on the respective board page.
|
||||||
|
|
||||||
When Homarr Assistant is enabled, users with modify permission can also ask it to edit the board's General, Background,
|
When Homarr Assistant is enabled, users with modify permission can also ask it to edit the board's Custom
|
||||||
Appearance, Custom CSS, and app-status settings. The assistant reads the current stylesheet first and presents an
|
CSS and other visual or behavior settings. The assistant reads the current stylesheet first and presents an
|
||||||
editable review form before requesting approval to save the change. It does not edit responsive layouts, access control,
|
editable review form before requesting approval to save the change.
|
||||||
or Danger zone actions.
|
|
||||||
|
|
||||||
[See this guide on how to work with custom CSS](/docs/advanced/styling/).
|
[See this guide on how to work with custom CSS](/docs/advanced/styling/).
|
||||||
|
|
||||||
@@ -327,12 +266,12 @@ Widgets expose their routine controls without requiring edit mode:
|
|||||||
- Hold `Shift` while hovering a widget that supports advanced view to expand it in place while the other widgets
|
- Hold `Shift` while hovering a widget that supports advanced view to expand it in place while the other widgets
|
||||||
remain visible but dimmed. Release `Shift` to close it. Focus that widget and press `Shift` + `Enter` to keep the view
|
remain visible but dimmed. Release `Shift` to close it. Focus that widget and press `Shift` + `Enter` to keep the view
|
||||||
open until you close it. On touch devices, open it from the widget menu. Other widgets adapt in place instead.
|
open until you close it. On touch devices, open it from the widget menu. Other widgets adapt in place instead.
|
||||||
- When signed in, outside edit mode, and with **Enable right click on widgets** enabled, right-click a widget to inspect
|
- Right-click a widget to inspect its live query status, refresh its data, change quick options, open settings, or run
|
||||||
its live query status, refresh its data, change quick options, open settings, or run supported actions. App tiles do
|
supported actions. Available controls follow your board and integration permissions.
|
||||||
not use this widget menu, and available controls follow your board and integration permissions.
|
- If you can modify the board, right-click or touch and hold an empty grid cell to add an item there. Focus a board
|
||||||
|
section and press `Shift` + `F10` for the keyboard equivalent.
|
||||||
|
|
||||||
The widget context menu follows the **Enable right click on widgets** preference in your user settings. On touch devices,
|
Widget and empty-space context menus follow the **Enable right click on widgets** preference in your user settings.
|
||||||
use the widget menu where your browser exposes it.
|
|
||||||
|
|
||||||
### Access control
|
### Access control
|
||||||
|
|
||||||
@@ -391,8 +330,7 @@ Duplicating a board will not copy the users and groups that have access to the b
|
|||||||
nor the integrations the user does not have access to.
|
nor the integrations the user does not have access to.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
Duplicating a board will create a new board with the same settings, all responsive layouts, and independent positions as the original board.
|
Duplicating a board will create a new board with the same settings and layout as the original board.
|
||||||
Duplicating a board that contains Custom Widgets also requires an administrator.
|
|
||||||
You can duplicate a board by clicking on the three dots in the list of boards and selecting "Duplicate board".
|
You can duplicate a board by clicking on the three dots in the list of boards and selecting "Duplicate board".
|
||||||
|
|
||||||

|

|
||||||
@@ -450,13 +388,5 @@ For the global home board you can only select boards that are public.
|
|||||||
|
|
||||||
### Mobile home board
|
### Mobile home board
|
||||||
|
|
||||||
The mobile home board controls which board opens for devices that Homarr detects as mobile from the User-Agent header.
|
Same as the home board, you can also set a mobile home board.
|
||||||
This is separate from a board's **Mobile layout**, which controls the layout selected inside that board.
|
It will be used for devices that are detected as mobile devices. (Using User-Agent header)
|
||||||
You can set a mobile home board for yourself in your user preferences, for a user or group through management, or for the
|
|
||||||
whole server with **Global mobile board** under `Management` > `Settings` > `Boards`.
|
|
||||||
|
|
||||||
For signed-in users, Homarr checks the user's mobile home board, then the user's desktop home board, then the mobile and
|
|
||||||
desktop defaults for the lowest-position matching group, followed by the mobile and desktop defaults for the `Everyone`
|
|
||||||
group, and finally the server-wide mobile and desktop defaults. Anonymous visitors use the server-wide mobile default and
|
|
||||||
then the server-wide desktop default. Server-wide fallback boards must be public. See the
|
|
||||||
[global board defaults](/docs/management/settings#boards) for the complete precedence and the required public-board rule.
|
|
||||||
@@ -67,23 +67,17 @@ These interfaces do not return an archive URL or archive hash.
|
|||||||
|
|
||||||
1. Load `customWidget_getSkill`, then get the prompt and live schema.
|
1. Load `customWidget_getSkill`, then get the prompt and live schema.
|
||||||
2. Call `customWidget_getComponentCatalog`, followed by `customWidget_getComponent` for only the relevant installed
|
2. Call `customWidget_getComponentCatalog`, followed by `customWidget_getComponent` for only the relevant installed
|
||||||
components and `customWidget_getExample` when one catalog example matches the interaction pattern. Fetch at most
|
components and `customWidget_getExample` when one catalog example matches the interaction pattern. If shared props
|
||||||
eight component documents before the first validation (or four after a complete example already matches). If shared
|
are needed, collect their catalog names and call `customWidget_getSharedProps` once for that set.
|
||||||
props are needed, collect their catalog names and call `customWidget_getSharedProps` once for that set.
|
|
||||||
3. Read the external API documentation.
|
3. Read the external API documentation.
|
||||||
4. Build one definition, using `templateLines` for multiline JSX tool input.
|
4. Build one definition, using `templateLines` for multiline JSX tool input.
|
||||||
5. Validate the definition without saving it and repair every reported issue.
|
5. Validate the definition without saving it and repair every reported issue.
|
||||||
6. Create a preview session.
|
6. Create a preview session.
|
||||||
7. Run `customWidget_previewQuery` for every query returned by the preview and inspect its actual status and data shape. Use
|
7. Run `customWidget_previewQuery` for every query returned by the preview and inspect its actual status and data shape.
|
||||||
`{}` for load queries; manual queries require exactly the returned primitive `parameterNames`.
|
|
||||||
8. Test relevant actions in simulation mode.
|
8. Test relevant actions in simulation mode.
|
||||||
9. Open the returned preview path with browser tools.
|
9. Open the returned preview path with browser tools.
|
||||||
10. Inspect the redacted journal and revise the local candidate until validation, data, and rendering all work. Keep the
|
10. Inspect the redacted journal and revise the local candidate until validation, data, and rendering all work.
|
||||||
exact tested preview candidate locally. Any definition, template, or source change requires a new validation and preview;
|
11. Create the widget, including any source URLs and credentials the user already supplied.
|
||||||
earlier query evidence belongs to the previous preview revision.
|
|
||||||
11. Create the widget from that final tested preview with `customWidget_createFromPreview`. The preview session already carries
|
|
||||||
the source URLs and encrypted credentials supplied during preview; the create call accepts only its session ID plus an
|
|
||||||
optional target board and persists that tested preview.
|
|
||||||
12. Open its returned management path, and use a structured question when the user must choose whether to place it on a board.
|
12. Open its returned management path, and use a structured question when the user must choose whether to place it on a board.
|
||||||
13. Otherwise, ask the user to configure the saved definition with the ten-minute Homarr source-setup URL.
|
13. Otherwise, ask the user to configure the saved definition with the ten-minute Homarr source-setup URL.
|
||||||
14. Create a final preview with the saved definition ID so Homarr loads its stored credentials, then test it again.
|
14. Create a final preview with the saved definition ID so Homarr loads its stored credentials, then test it again.
|
||||||
@@ -131,20 +125,33 @@ To exercise the real Homarr Assistant lifecycle instead of accepting a returned
|
|||||||
OPENROUTER_API_KEY=... pnpm --filter @homarr/custom-widgets test:assistant-ai
|
OPENROUTER_API_KEY=... pnpm --filter @homarr/custom-widgets test:assistant-ai
|
||||||
```
|
```
|
||||||
|
|
||||||
|
The same suites can target the Homarr provider with a Workshop PocketBase token instead of an OpenRouter key:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
AI_PROVIDER_BASE_URL=https://homarr.dev/api/ai/v1 \
|
||||||
|
AI_PROVIDER_API_KEY=<workshop-token> \
|
||||||
|
AI_PROVIDER_MODEL=homarr/model \
|
||||||
|
pnpm --filter @homarr/custom-widgets test:assistant-ai
|
||||||
|
```
|
||||||
|
|
||||||
|
`AI_PROVIDER_JUDGE_MODEL` can select a separate judge when the configured endpoint offers one. The Homarr provider
|
||||||
|
offers exactly one model, so generation and review both use `homarr/model`.
|
||||||
|
|
||||||
The assistant test exposes the same lazy skill, live schema, component catalog, targeted component references,
|
The assistant test exposes the same lazy skill, live schema, component catalog, targeted component references,
|
||||||
validation, preview-query, and create-from-preview tools as the product. It refuses to save a definition that was not
|
validation, preview-query, and create-from-preview tools as the product. It refuses to save a definition that was not
|
||||||
validated exactly or whose preview queries were not all tested. Multi-request fixtures return a different payload for
|
validated exactly or whose preview queries were not all tested. Multi-request fixtures return a different payload for
|
||||||
each documented path and require manual-query parameters. Use `--case=pokedex`, `--case=coinmarketcap-keyless`,
|
each documented path and require manual-query parameters. Use `--case=pokedex`, `--case=coinmarketcap-keyless`,
|
||||||
`--case=bored-activity`, or `--case=agify-name` for a focused run.
|
`--case=bored-activity`, or `--case=agify-name` for a focused run.
|
||||||
|
|
||||||
Both suites default generation and harsh review to OpenRouter's `~deepseek/deepseek-v4-flash-latest` route. They save
|
Both suites use the configured provider models for generation and harsh review. They save tool traces, validated
|
||||||
tool traces, validated manifests, raw reviews, and detailed category scores under
|
manifests, raw reviews, and detailed category scores under
|
||||||
`packages/custom-widgets/.ai-evaluations/`. These live tests are maintainer-invoked rather than CI-required because
|
`packages/custom-widgets/.ai-evaluations/`. These live tests are maintainer-invoked rather than CI-required because
|
||||||
they consume a configured provider account and exercise a nondeterministic model. The repository's ordinary tests
|
they consume a configured provider account and exercise a nondeterministic model. The repository's ordinary tests
|
||||||
cover the lifecycle enforcement, fixture routing, score calculation, and failure behavior without network access.
|
cover the lifecycle enforcement, fixture routing, score calculation, and failure behavior without network access.
|
||||||
|
|
||||||
Each scenario stops as soon as it passes and has a hard limit of ten generation attempts. Override the models or
|
Each scenario stops as soon as it passes and has a hard limit of ten generation attempts. Override the endpoint,
|
||||||
per-scenario limit with `OPENROUTER_GENERATOR_MODEL`, `OPENROUTER_JUDGE_MODEL`, and
|
models, or per-scenario limit with `AI_PROVIDER_BASE_URL`, `AI_PROVIDER_API_KEY`, `AI_PROVIDER_MODEL`,
|
||||||
|
`AI_PROVIDER_JUDGE_MODEL`, and
|
||||||
`CUSTOM_WIDGET_AI_MAX_LOOPS`. Generated artifacts are local and ignored by Git; promote a reviewed, validated result
|
`CUSTOM_WIDGET_AI_MAX_LOOPS`. Generated artifacts are local and ignored by Git; promote a reviewed, validated result
|
||||||
into the bundled-widget source deliberately.
|
into the bundled-widget source deliberately.
|
||||||
|
|
||||||
|
|||||||
@@ -1,37 +1,8 @@
|
|||||||
# Create a Custom Widget
|
# Create a Custom Widget
|
||||||
|
|
||||||
import { CanonicalCustomWidgetExample } from "@site/src/components/custom-widget-code";
|
import { CanonicalCustomWidgetExample } from "@site/src/components/custom-widget-code";
|
||||||
import workbenchImage from "./img/workbench.png";
|
|
||||||
import workbenchMobileImage from "./img/workbench-mobile.png";
|
|
||||||
import workbenchValidationImage from "./img/workbench-validation.png";
|
|
||||||
|
|
||||||
The workbench exposes **General**, **API sources**, **Requests**, **Options**, **JSX**, and **Preview** sections. Advanced JSON is
|
The workbench is visual-first: configure the default API connection, add request cards, add option rows, then write JSX. Additional sources and raw manifest JSON remain under Advanced. Code and preview sit side by side on desktop and use tabs on mobile.
|
||||||
available in the manifest and request/option editors. Code and preview sit side by side on desktop; on smaller screens the
|
|
||||||
**Configure**/**Preview** switch shows one pane at a time and the section navigation scrolls horizontally. Preview sizes display
|
|
||||||
as **S/M/L** (Compact/Standard/Wide), and fixtures are **Live**, **Loading**, **Empty**, or **Error**.
|
|
||||||
For multiline JSX, prefer `templateLines` in agent or MCP input and keep the final tested preview as the source of truth before saving.
|
|
||||||
|
|
||||||
<img
|
|
||||||
src={workbenchImage}
|
|
||||||
alt="Custom Widget workbench with configuration sections and a live preview"
|
|
||||||
style={{ maxWidth: "100%" }}
|
|
||||||
/>
|
|
||||||
|
|
||||||
<img
|
|
||||||
src={workbenchMobileImage}
|
|
||||||
alt="Mobile Custom Widget workbench with Configure and Preview switch and horizontally scrollable section navigation"
|
|
||||||
style={{ maxWidth: "100%" }}
|
|
||||||
/>
|
|
||||||
|
|
||||||
The workbench keeps the configuration and preview together so you can inspect validation diagnostics, the redacted request
|
|
||||||
journal, fixture data, and preview size before saving. Invalid fields stay marked in the form while the preview explains why it
|
|
||||||
needs attention.
|
|
||||||
|
|
||||||
<img
|
|
||||||
src={workbenchValidationImage}
|
|
||||||
alt="Custom Widget workbench showing a Base URL validation error with Test, preview, and Create actions disabled"
|
|
||||||
style={{ maxWidth: "100%" }}
|
|
||||||
/>
|
|
||||||
|
|
||||||
## Manual workflow
|
## Manual workflow
|
||||||
|
|
||||||
@@ -50,9 +21,7 @@ needs attention.
|
|||||||
|
|
||||||
<CanonicalCustomWidgetExample id="widget-options" label="Widget options" example="options" height="360px" />
|
<CanonicalCustomWidgetExample id="widget-options" label="Widget options" example="options" height="360px" />
|
||||||
|
|
||||||
Every option has a default. Supported controls include text, textarea, number, switch, select, multi-select, slider, date, time, color, icon, URL, duration, time zone, and JSON. Dynamic choices use `choicesFrom: { request, itemsPath?, valuePath, labelPath }`; the request must be a load query without invocation parameters, and you cannot provide both static `choices` and `choicesFrom`.
|
Every option has a default. Supported controls include text, textarea, number, switch, select, multi-select, slider, date, time, color, icon, URL, duration, time zone, and JSON. Dynamic choices use `choicesFrom` with a query ID and value/label paths.
|
||||||
|
|
||||||
Preview actions are simulated by default and recorded in the journal without contacting the service. Enable **Run actions against the configured API** only when you intend a real mutation; live actions still require configured confirmation.
|
|
||||||
|
|
||||||
## ChatGPT or Claude
|
## ChatGPT or Claude
|
||||||
|
|
||||||
@@ -62,8 +31,7 @@ The model must return one fenced `json` block containing the complete widget, in
|
|||||||
field. Copy that single block and select **Paste**. Homarr fills the visual builders and the JSX editor
|
field. Copy that single block and select **Paste**. Homarr fills the visual builders and the JSX editor
|
||||||
without any placeholder replacement or second paste.
|
without any placeholder replacement or second paste.
|
||||||
|
|
||||||
Homarr shows all actionable schema or JSX errors inline. Enter credentials separately. The copied prompt does not include the
|
Homarr shows all actionable schema or JSX errors inline. Enter credentials separately. The prompt deliberately
|
||||||
latest preview response; use **Preview** > **Data** to inspect it and mention important response fields in your request. The prompt deliberately
|
|
||||||
recommends a focused Mantine component set, visual hierarchy, responsive layout, theme compatibility, and loading,
|
recommends a focused Mantine component set, visual hierarchy, responsive layout, theme compatibility, and loading,
|
||||||
empty, failure, and success states.
|
empty, failure, and success states.
|
||||||
|
|
||||||
|
|||||||
@@ -7,21 +7,7 @@ Templates are JSX expressions interpreted inside a widget-local safety and rende
|
|||||||
- `options.name` — saved widget configuration
|
- `options.name` — saved widget configuration
|
||||||
- `inputs.name` — temporary values from declarative `bind`
|
- `inputs.name` — temporary values from declarative `bind`
|
||||||
|
|
||||||
The v2 manifest requires a `default` source and supports up to eight sources, 64 requests, and 64 options. Source IDs are
|
|
||||||
case-insensitively unique. Each request allows up to 32 static headers and 32 invalidation targets; a widget can contain
|
|
||||||
up to 24 secrets, each up to 8,192 characters, and templates are limited to 50,000 characters. Validation reports the
|
|
||||||
exact field when a limit is exceeded.
|
|
||||||
|
|
||||||
Authoring input accepts either `template` or `templateLines`, not both. `templateLines` accepts 1–2,000 lines, each up to
|
|
||||||
10,000 characters; after joining lines with newlines, the complete template must still fit the 50,000-character limit.
|
|
||||||
|
|
||||||
The safe interpreter also bounds JSX evaluation: AST depth 64, 25,000 operations, 4,000 collection items, 10,000 rendered
|
|
||||||
nodes, and 200,000 characters in one string or rendered value. API responses are bounded separately before they reach the
|
|
||||||
template.
|
|
||||||
|
|
||||||
Use normal Mantine layouts, typography, feedback, dates, and charts. Official compound names such as `Card.Section`, `Tabs.List`, and `Radio.Group` are supported. Ordinary safe props pass through; a dangerous capability produces an explicit error.
|
Use normal Mantine layouts, typography, feedback, dates, and charts. Official compound names such as `Card.Section`, `Tabs.List`, and `Radio.Group` are supported. Ordinary safe props pass through; a dangerous capability produces an explicit error.
|
||||||
Unsafe URLs, callback props, and unapproved style properties are stripped. Response data is deep-sanitized and budgeted
|
|
||||||
before it reaches `data`, so treat it as untrusted input even when the source is private.
|
|
||||||
|
|
||||||
## Temporary inputs
|
## Temporary inputs
|
||||||
|
|
||||||
@@ -29,7 +15,7 @@ before it reaches `data`, so treat it as untrusted input even when the source is
|
|||||||
<Stack>
|
<Stack>
|
||||||
<TextInput bind="search" defaultValue="" label="Search" />
|
<TextInput bind="search" defaultValue="" label="Search" />
|
||||||
<SubFetch requestId="search" params={{ query: inputs.search }}>
|
<SubFetch requestId="search" params={{ query: inputs.search }}>
|
||||||
{(results, meta) => (
|
{(results) => (
|
||||||
<Stack>
|
<Stack>
|
||||||
{(results ?? []).map((item) => (
|
{(results ?? []).map((item) => (
|
||||||
<Text key={item.id}>{item.name}</Text>
|
<Text key={item.id}>{item.name}</Text>
|
||||||
@@ -46,23 +32,14 @@ Bound values live only in React memory while the widget is mounted. They are not
|
|||||||
|
|
||||||
Use expressions, conditionals, optional chaining, arrays, objects, template strings, safe standard helpers, and expression callbacks for `map`, `filter`, `sort`, and trusted runtime slots. Callback blocks, authored `const`, IIFEs, authored recursion, arbitrary functions, imports, hooks, refs, raw events, browser requests, `eval`, and bigint are blocked.
|
Use expressions, conditionals, optional chaining, arrays, objects, template strings, safe standard helpers, and expression callbacks for `map`, `filter`, `sort`, and trusted runtime slots. Callback blocks, authored `const`, IIFEs, authored recursion, arbitrary functions, imports, hooks, refs, raw events, browser requests, `eval`, and bigint are blocked.
|
||||||
|
|
||||||
Bounded regex literals are supported for string matching, splitting, search, and replacement. Regex literals are limited to
|
Bounded regex literals are supported for string matching, splitting, search, and replacement. Patterns with lookbehind, backreferences, nested quantifiers, excessive length, or unsupported flags are rejected.
|
||||||
128 characters and flags `gimsu`; lookarounds, backreferences, repeated alternatives/groups, unsupported flags, and more
|
|
||||||
than one variable quantifier are rejected.
|
|
||||||
|
|
||||||
## Runtime components
|
## Runtime components
|
||||||
|
|
||||||
- `SubFetch` runs a named query. Automatic queries run when the widget loads; set `trigger="manual"` to defer one and pass
|
- `SubFetch` runs a manual query with its `params`. Set `triggerContent` to a card or image to make that content the accessible click and keyboard trigger instead of showing the default load button.
|
||||||
primitive `params` for its invocation references. With `triggerContent`, any content node (commonly a card or image) becomes
|
- `ActionButton` and `ToggleSwitch` run actions.
|
||||||
the accessible click and keyboard trigger instead of showing the default load button.
|
- `RefreshButton` renders a compact, accessible icon control that refreshes load queries for authenticated viewers. It
|
||||||
- `SubFetch` with `trigger="manual"` keeps its result local to that instance; it does not populate the shared
|
is disabled for anonymous public-board viewers because refreshing invalidates shared server cache state.
|
||||||
`data.requestId` or `status.requestId` roots. The child callback receives `(result, meta)`, while loading, errors, and
|
|
||||||
retry are handled by `SubFetch`. Provide both `triggerContent` and `triggerAriaLabel` when custom content launches it.
|
|
||||||
- `ActionButton` and `ToggleSwitch` run actions only when the widget is mounted outside edit mode. A toggle needs both
|
|
||||||
enabled and disabled request parameters and rolls back its visual state if the action fails.
|
|
||||||
- `RefreshButton` renders a compact, accessible icon control that invalidates the client's load-query cache so active load
|
|
||||||
queries can refetch; it does not execute a request itself. It is disabled when the widget has no active item or preview
|
|
||||||
session, or while the board is in edit mode.
|
|
||||||
- `Icon`/`TablerIcon` resolves installed safe icons.
|
- `Icon`/`TablerIcon` resolves installed safe icons.
|
||||||
|
|
||||||
Always include responsive loading, empty, error, and success states. Runtime failures remain inside the widget tile.
|
Always include responsive loading, empty, error, and success states. Runtime failures remain inside the widget tile.
|
||||||
|
Before Width: | Height: | Size: 58 KiB |
|
Before Width: | Height: | Size: 78 KiB |
|
Before Width: | Height: | Size: 90 KiB |
@@ -42,14 +42,9 @@ interface HomarrCustomWidgetV2 {
|
|||||||
|
|
||||||
### Design with AI
|
### Design with AI
|
||||||
|
|
||||||
The **Design with AI** action is available while creating or editing a custom widget. Describe what the widget should show and,
|
The **Design with AI** action is available while creating or editing a custom widget. Describe what the widget should show and, when [Homarr Assistant](../assistant) is enabled, send the request directly from the form. The assistant receives the widget schema, current non-secret configuration, and latest test response, then proposes the matching create or update tool for your approval.
|
||||||
when [Homarr Assistant](../assistant) is enabled, send the request directly from the form. The generated prompt includes the
|
|
||||||
widget schema and current non-secret configuration, but not the latest preview response. It proposes the matching create or
|
|
||||||
update tool for your approval.
|
|
||||||
|
|
||||||
Use the preview's **Data** tab to inspect the endpoint's real response shape and mention important fields in your request; the
|
Run **Test** first when possible so the prompt includes the endpoint's real response shape. Saved secrets are never added to the prompt. **Copy to clipboard** remains available when the Assistant is disabled or when you prefer another AI service.
|
||||||
copied prompt does not automatically include the latest preview response. Saved secrets are never added to the prompt. **Copy to
|
|
||||||
clipboard** remains available when the Assistant is disabled or when you prefer another AI service.
|
|
||||||
|
|
||||||
<CustomWidgetCodeExample
|
<CustomWidgetCodeExample
|
||||||
id="complete-widget-manifest"
|
id="complete-widget-manifest"
|
||||||
@@ -67,9 +62,9 @@ preview, publish, install, configure, or write secrets, including through HTTP a
|
|||||||
only lists Custom Widget MCP tools, prompts, and resources when its owner is an administrator.
|
only lists Custom Widget MCP tools, prompts, and resources when its owner is an administrator.
|
||||||
|
|
||||||
Adding or configuring a Custom Widget placement requires both administrator access and permission to modify that
|
Adding or configuring a Custom Widget placement requires both administrator access and permission to modify that
|
||||||
board. Duplicating a board that contains Custom Widgets also requires an administrator. A non-administrator with
|
board. A non-administrator with board-modify access can move, resize, change presentation settings, or remove an
|
||||||
board-modify access can move, resize, change presentation settings, or remove an existing placement, but cannot add one,
|
existing placement, but cannot add one, change its definition, refresh interval, or Custom Widget options. Duplicating
|
||||||
change its definition, refresh interval, or Custom Widget options.
|
a board that contains Custom Widgets also requires an administrator.
|
||||||
|
|
||||||
Once an administrator has placed a widget, ordinary board permissions apply to rendering and requests. Authorized
|
Once an administrator has placed a widget, ordinary board permissions apply to rendering and requests. Authorized
|
||||||
non-administrators can use it on private boards, and queries can render for anonymous viewers on public boards.
|
non-administrators can use it on private boards, and queries can render for anonymous viewers on public boards.
|
||||||
@@ -104,8 +99,10 @@ logs, or exports.
|
|||||||
For administrators adding widgets while editing a board, the Custom Widgets section includes **Import from
|
For administrators adding widgets while editing a board, the Custom Widgets section includes **Import from
|
||||||
Workshop**. Non-administrators do not see the Custom Widget picker or Workshop actions. Selecting **Install widget**
|
Workshop**. Non-administrators do not see the Custom Widget picker or Workshop actions. Selecting **Install widget**
|
||||||
opens a two-step modal flow: first review the Workshop entry and its complete source in the read-only editor, then
|
opens a two-step modal flow: first review the Workshop entry and its complete source in the read-only editor, then
|
||||||
confirm API sources and credentials. After import, the new definition appears in the picker. Its tile waits for the board
|
confirm API sources and credentials. The steps keep the same dimensions and the previous step remains available when
|
||||||
to be saved before server requests run.
|
you go back. After import, the new definition appears in the picker. Its tile
|
||||||
|
waits for the board to be saved before server requests run and loads automatically after a successful save; no page
|
||||||
|
reload is required.
|
||||||
|
|
||||||
## Import and Workshop
|
## Import and Workshop
|
||||||
|
|
||||||
@@ -134,7 +131,6 @@ replace the v1 backup.
|
|||||||
|
|
||||||
## Bundled examples
|
## Bundled examples
|
||||||
|
|
||||||
Homarr seeds five disabled examples without credentials and never overwrites an edited seed. They use the same public
|
Homarr seeds five disabled examples without credentials and never overwrites an edited seed. They use the same public contract. The Tautulli example is the highest-scoring widget preserved from Homarr's AI authoring evaluation:
|
||||||
contract. Tautulli Activity is one of the bundled examples preserved from Homarr's AI authoring evaluation:
|
|
||||||
|
|
||||||
<BundledCustomWidgetGallery />
|
<BundledCustomWidgetGallery />
|
||||||
@@ -1,11 +1,6 @@
|
|||||||
# Configure requests and security
|
# Configure requests and security
|
||||||
|
|
||||||
Most widgets use a single source named `default`; the manifest must contain it. Extra keyed sources are available for widgets
|
Most widgets use a single source named `default`. Extra keyed sources are available under Advanced for widgets that combine APIs. Authentication is `none`, `bearer`, `basic`, an API-key header, or an API-key query parameter. Credentials belong to the widget but remain outside its manifest.
|
||||||
that combine APIs. Source IDs are case-insensitively unique. Base URLs must use HTTP(S), contain no embedded credentials,
|
|
||||||
query string, or fragment, and sources can be `public`, `private`, or `loopback`. Authentication is `none`, `bearer`,
|
|
||||||
`basic`, an API-key header, or an API-key query parameter. Credentials belong to the widget but remain outside its manifest.
|
|
||||||
Source origins are fixed by the definition and source-setup flow; widget options and invocation parameters cannot redirect a
|
|
||||||
request to a different origin.
|
|
||||||
|
|
||||||
## Named requests
|
## Named requests
|
||||||
|
|
||||||
@@ -40,28 +35,19 @@ Bind values directly where they are used:
|
|||||||
|
|
||||||
`{option:name}` and `$option` read saved widget options. `{param:name}` and `$param` read invocation-time `params`. Load queries cannot use invocation parameters. Homarr infers the exact parameter names and primitive values from these references, rejecting missing or extra invocation params at the request boundary.
|
`{option:name}` and `$option` read saved widget options. `{param:name}` and `$param` read invocation-time `params`. Load queries cannot use invocation parameters. Homarr infers the exact parameter names and primitive values from these references, rejecting missing or extra invocation params at the request boundary.
|
||||||
|
|
||||||
Path placeholders and query values must resolve to text, numbers, or booleans. `$option` and `$param` references may appear
|
Paths and query-string values must resolve to text, numbers, or booleans. JSON bodies can also use structured `json` and `multiSelect` option values, for example `{ "entity_ids": { "$option": "entities" } }`.
|
||||||
recursively in JSON bodies; invocation parameters remain primitive, and load queries cannot use `$param`. JSON bodies can
|
|
||||||
also use structured `json` and `multiSelect` option values, for example `{ "entity_ids": { "$option": "entities" } }`.
|
|
||||||
|
|
||||||
## Protection
|
## Protection
|
||||||
|
|
||||||
Every request uses Homarr's existing server executor: same-origin source enforcement, network scope, DNS and redirect validation, SSRF protection, board permissions, rate and request limits, body and response limits, timeouts, and encrypted credential injection. Static headers cannot override credentials, cookies, routing, proxy, forwarding, or hop-by-hop headers.
|
Every request uses Homarr's existing server executor: same-origin source enforcement, network scope, DNS and redirect validation, SSRF protection, board permissions, rate and request limits, body and response limits, timeouts, and encrypted credential injection. Static headers cannot override credentials, cookies, routing, proxy, forwarding, or hop-by-hop headers.
|
||||||
|
|
||||||
The executor caps request bodies at 10 KiB and response bodies at 1 MiB. Parsed JSON is limited to depth 32 and 50,000 nodes;
|
|
||||||
each network hop has a ten-second timeout, queries follow at most three same-origin redirects, actions do not follow redirects,
|
|
||||||
and the total request deadline is 45 seconds.
|
|
||||||
|
|
||||||
The limiter allows four concurrent requests per user/item and eight per definition. Per minute, a user/item can make up to 60
|
|
||||||
queries, 10 actions, or 3 DELETE actions; a definition can receive up to 240, 40, or 12 of those request categories.
|
|
||||||
|
|
||||||
Queries default to view permission and actions to modify. DELETE always requires full permission and confirmation. Actions are never cached, retried, or run on load.
|
Queries default to view permission and actions to modify. DELETE always requires full permission and confirmation. Actions are never cached, retried, or run on load.
|
||||||
|
|
||||||
Management and runtime are intentionally separate. A Homarr administrator with board-modify permission places and
|
Management and runtime are intentionally separate. A Homarr administrator with board-modify permission places and
|
||||||
configures the widget. After placement, query and action authorization follows the request's board permission. Public
|
configures the widget. After placement, query and action authorization follows the request's board permission. Public
|
||||||
boards may execute queries for anonymous viewers, but mutations stay authenticated. This includes shared-cache
|
boards may execute queries for anonymous viewers, but mutations stay authenticated. This includes shared-cache
|
||||||
invalidation: `RefreshButton` is disabled only without an active item or preview session, or in edit mode, while ordinary
|
invalidation: `RefreshButton` is disabled for anonymous viewers, while ordinary scheduled query rendering remains
|
||||||
scheduled query rendering remains available to anonymous viewers.
|
available.
|
||||||
|
|
||||||
Responses use bounded, versioned shared-Redis cache keys. Action invalidation advances the shared version so every
|
Responses use bounded, versioned shared-Redis cache keys. Action invalidation advances the shared version so every
|
||||||
Homarr replica stops serving the previous response without scanning or deleting a key prefix.
|
Homarr replica stops serving the previous response without scanning or deleting a key prefix.
|
||||||
@@ -41,8 +41,7 @@ The workbench marks the invalid field while you type. An invalid URL does not re
|
|||||||
|
|
||||||
An invalid definition disables widget preview and Save/Create. The Data, Options, Actions, and Diagnostics tabs remain available so you can correct it.
|
An invalid definition disables widget preview and Save/Create. The Data, Options, Actions, and Diagnostics tabs remain available so you can correct it.
|
||||||
|
|
||||||
The Diagnostics tab shows current schema and JSX errors, accessibility checks, and (after a preview) the redacted request
|
The Diagnostics tab shows the current schema errors.
|
||||||
journal. It does not expose credentials or raw secret values.
|
|
||||||
|
|
||||||
## Workshop unavailable
|
## Workshop unavailable
|
||||||
|
|
||||||
|
|||||||
|
Before Width: | Height: | Size: 164 KiB |
|
Before Width: | Height: | Size: 55 KiB |
@@ -23,9 +23,9 @@ approval before running mutating procedures.
|
|||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
The MCP endpoint lives under the **API** page at `Management` → `Tools` → `API` → **AI / MCP** tab.
|
The MCP endpoint lives under the **API** page at `Management` → `Tools` → `API` → **MCP** tab.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
### 1. Create an API Key
|
### 1. Create an API Key
|
||||||
|
|
||||||
|
|||||||
@@ -1,169 +0,0 @@
|
|||||||
---
|
|
||||||
tags:
|
|
||||||
- Workshop
|
|
||||||
- Custom Widgets
|
|
||||||
- Custom CSS
|
|
||||||
---
|
|
||||||
|
|
||||||
# Community Workshop
|
|
||||||
|
|
||||||
:::warning Experimental feature
|
|
||||||
|
|
||||||
This feature is experimental and will probably change. If you encounter bugs, need more capabilities, or find something confusing, tell us in the [official discussion thread](https://github.com/homarr-labs/homarr/discussions/categories/custom-widgets). Your feedback directly shapes what comes next. Happy hacking!
|
|
||||||
|
|
||||||
:::
|
|
||||||
|
|
||||||
The [Community Workshop](pathname:///workshop) is where Homarr users share and discover
|
|
||||||
**custom CSS themes** and **custom widgets**. You can browse submissions, upvote the ones
|
|
||||||
you like, report abuse, and install entries directly into your own Homarr instance.
|
|
||||||
|
|
||||||
The central `homarr.dev` Workshop is a public community. Browsing it on the website is public. Browsing, installing,
|
|
||||||
publishing, or importing Workshop content **inside a Homarr instance is restricted to Homarr administrators**.
|
|
||||||
|
|
||||||
:::warning
|
|
||||||
|
|
||||||
The Workshop contains community-made content. Moderation is not a security boundary, and PocketBase does not interpret
|
|
||||||
or validate submission content. Always review widget capabilities, network origins, actions, and CSS before installing.
|
|
||||||
Homarr's installation-time validator is definitive and can reject content that the public service accepted earlier.
|
|
||||||
Back up your instance before installing untrusted content.
|
|
||||||
|
|
||||||
:::
|
|
||||||
|
|
||||||
## Browsing and voting
|
|
||||||
|
|
||||||
- Filter by **Widgets** or **CSS**, show or hide outdated entries, and sort by popularity, creation date, recent updates, or discussion activity.
|
|
||||||
- Sign in with **GitHub** to upvote/downvote, submit your own creations, or report a submission.
|
|
||||||
- Each submission shows its title, description, linked GitHub author, revision, optional screenshots, comments, and full content. Widget pages also summarize API sources, actions, options, network access, and required credentials before installation.
|
|
||||||
- A new submission receives one real upvote owned by its author. Votes remain unique per user and submission.
|
|
||||||
- Open report counts are public on submission cards so visitors can make an informed installation decision. The submission author and Workshop moderators can read each report category and explanation; reporter identities remain moderator-only.
|
|
||||||
- Signed-in moderators see a **Moderation** button in the Workshop header. The moderation queue is sorted by open report count and lets moderators inspect every report, dismiss it, or delete the submission. Reports do not automatically remove a submission.
|
|
||||||
- The manual **Outdated** badge warns visitors that a submission may need an update.
|
|
||||||
|
|
||||||
## Comments
|
|
||||||
|
|
||||||
Comments are publicly readable and appear in chronological conversation bubbles with the author's avatar and GitHub profile. Signed-in users can post; authors can edit or delete their own comments, and Workshop moderators can delete any comment. Failed posts keep the text you typed. When SMTP and `WORKSHOP_PUBLIC_ORIGIN` are configured, the submission author receives one email for a comment from another user. Self-comments, edits, and deletions do not send mail.
|
|
||||||
|
|
||||||
## Submitting
|
|
||||||
|
|
||||||
1. Sign in with GitHub.
|
|
||||||
2. Click **Share yours** and choose the type:
|
|
||||||
- **Custom widget** — paste the JSON exported from **Manage → Custom Widgets → Export**.
|
|
||||||
It must match the `homarr-custom-widget-v2` schema (validated before submission).
|
|
||||||
- **Custom CSS** — paste your stylesheet (max 16384 characters).
|
|
||||||
3. Review the widget JSON or CSS in the syntax-aware editor, then add a title, description, optional screenshots, and changelog.
|
|
||||||
4. Submit the entry.
|
|
||||||
|
|
||||||
Custom widget JSON is normalized to readable multi-line formatting when it is published, and the Workshop detail page
|
|
||||||
also formats older compact submissions before displaying them.
|
|
||||||
|
|
||||||
Community members can report submissions as outdated or no longer working, malicious, spam, copyright-infringing,
|
|
||||||
inappropriate, or another concern. An outdated report does not automatically mark or remove the submission.
|
|
||||||
|
|
||||||
Submissions are published immediately. Reported entries are reviewed and may be removed.
|
|
||||||
Authors can edit a submission later to publish a new revision. The edit form can keep or remove existing screenshots and add new PNG, JPG, or WebP images without changing the Workshop URL.
|
|
||||||
|
|
||||||
When SMTP and `WORKSHOP_PUBLIC_ORIGIN` are configured, every current Workshop moderator receives an email when a report is submitted. If a moderator deletes the reported submission, its author receives a separate removal email. Author self-deletion does not send a moderation email.
|
|
||||||
|
|
||||||
:::info Separate roles
|
|
||||||
|
|
||||||
A Workshop moderator is a user with PocketBase's internal `isAdmin` field. This role moderates the central community
|
|
||||||
and is unrelated to a Homarr instance administrator.
|
|
||||||
|
|
||||||
:::
|
|
||||||
|
|
||||||
## Submission guidelines
|
|
||||||
|
|
||||||
Submissions must be useful to Homarr users and safe to install. Do not submit content that is
|
|
||||||
malicious, deceptive, illegal, hateful, sexually explicit, gore, gambling-focused, spam, or content
|
|
||||||
that primarily promotes unrelated products or services.
|
|
||||||
|
|
||||||
## Installing into Homarr
|
|
||||||
|
|
||||||
You can install workshop entries without leaving Homarr:
|
|
||||||
|
|
||||||
- **Custom widgets (Homarr administrators only)** — go to **Manage → Custom Widgets**, or use **Import from Workshop** in the
|
|
||||||
board widget picker. Choose **Install widget**, review the complete source and capabilities, then confirm API sources and any local secrets in the second modal step.
|
|
||||||
- **Custom CSS from Workshop (Homarr administrators only)** — open a board's **Settings → Custom CSS**, click **Import from Workshop**, choose a theme, review its full CSS in the second same-size modal step, and click **Import CSS** once. The board setting is still saved separately.
|
|
||||||
|
|
||||||
Alternatively, open a submission in the Workshop and use **Download widget JSON** or **Copy CSS**. The submission page shows the matching manual installation steps before the source code.
|
|
||||||
|
|
||||||
Custom Widget imports detect required bearer, basic, header, or query credentials. You can enter them during import or explicitly defer them; secret values are never stored in Workshop content. Missing credentials remain visible on the local Custom Widget afterward.
|
|
||||||
|
|
||||||
## Workshop deployment
|
|
||||||
|
|
||||||
Workshop is powered by [PocketBase](https://pocketbase.io). The production image compiles the current Docusaurus site and serves it together with the API from one origin. The deployment lives in `apps/workshop/` with a Dockerfile, Compose configuration, version-controlled migrations, hooks, a smoke test, and ACT-local workflow instructions.
|
|
||||||
|
|
||||||
Submission links include Open Graph and X/Twitter metadata for the submission title, description, and type. The first uploaded screenshot is used as the social preview image; submissions without screenshots use the Homarr logo.
|
|
||||||
|
|
||||||
Run `pnpm docker:workshop` for PocketBase on port 8090, then run
|
|
||||||
`WORKSHOP_API_URL=http://127.0.0.1:8090 pnpm dev:docs` for Docusaurus on port 3003. `pnpm docker:docs` builds the
|
|
||||||
combined production layout. Normal start and stop commands retain data; `down --volumes` is an intentional,
|
|
||||||
irreversible development reset.
|
|
||||||
|
|
||||||
GitHub needs only the central callback `https://<workshop-host>/api/oauth2-redirect`. Keep PocketBase origins unrestricted
|
|
||||||
unless every self-hosted Homarr caller is explicitly listed. Configure both `GITHUB_CLIENT_ID` and
|
|
||||||
`GITHUB_CLIENT_SECRET`; supplying only one is a startup error. Set `WORKSHOP_PUBLIC_ORIGIN` in production so generated
|
|
||||||
links and email use the public host. Workshop stores only the OAuth provider username in `users.name`, and
|
|
||||||
users cannot rename it. Map **OAuth2 username** to `name`; leave OAuth2 id, full name, and avatar mappings
|
|
||||||
empty. Profile and avatar URLs are derived from `https://github.com/<username>` and
|
|
||||||
`https://github.com/<username>.png`, so PocketBase does not store duplicate profile metadata or avatar files. Configure
|
|
||||||
SMTP for comment, report, and removal notices.
|
|
||||||
|
|
||||||
The public URL contract is:
|
|
||||||
|
|
||||||
| Variable | Purpose | Default |
|
|
||||||
| ------------------------ | ------------------------------------------------- | ----------------------------- |
|
|
||||||
| `HOMARR_WEBSITE_URL` | Documentation/site base used by Homarr links | `https://homarr.dev` |
|
|
||||||
| `WORKSHOP_API_URL` | PocketBase API used by Homarr and standalone docs | `HOMARR_WEBSITE_URL` |
|
|
||||||
| `WORKSHOP_WEB_URL` | Public Workshop page linked from Homarr | `HOMARR_WEBSITE_URL/workshop` |
|
|
||||||
| `WORKSHOP_PUBLIC_ORIGIN` | PocketBase-generated links and email | Required in production |
|
|
||||||
| `PB_ALLOWED_ORIGINS` | PocketBase browser origins | `*` for the central community |
|
|
||||||
|
|
||||||
The deprecated docs-only `WORKSHOP_URL` alias remains for one release; `WORKSHOP_API_URL` takes precedence. The
|
|
||||||
combined Workshop image writes these public URLs into its browser runtime configuration whenever the container starts;
|
|
||||||
the Docker build arguments remain fallbacks. Restart the container after changing these values, without rebuilding it.
|
|
||||||
|
|
||||||
### Staging and demo deployment
|
|
||||||
|
|
||||||
Use `apps/workshop/docker-compose.staging.yml` with the published `ghcr.io/homarr-labs/workshop:v2` image for a v2
|
|
||||||
preview. Copy `apps/workshop/.env.staging.example` to `.env.staging`; its default public contract is:
|
|
||||||
|
|
||||||
```dotenv
|
|
||||||
HOMARR_WEBSITE_URL=https://v2.preview.homarr.dev
|
|
||||||
WORKSHOP_API_URL=https://v2.preview.homarr.dev
|
|
||||||
WORKSHOP_WEB_URL=https://v2.preview.homarr.dev/workshop
|
|
||||||
WORKSHOP_PUBLIC_ORIGIN=https://v2.preview.homarr.dev
|
|
||||||
PB_ALLOWED_ORIGINS=*
|
|
||||||
```
|
|
||||||
|
|
||||||
Start or update it from the repository root:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
docker compose --env-file apps/workshop/.env.staging \
|
|
||||||
-f apps/workshop/docker-compose.staging.yml pull
|
|
||||||
docker compose --env-file apps/workshop/.env.staging \
|
|
||||||
-f apps/workshop/docker-compose.staging.yml up --detach
|
|
||||||
curl --fail http://127.0.0.1:8090/api/health
|
|
||||||
```
|
|
||||||
|
|
||||||
The service binds to `127.0.0.1:8090`. Terminate TLS at a reverse proxy and forward the **entire hostname**, including
|
|
||||||
`/api`, `/_/`, and `/workshop-runtime-config.js`; forwarding only `/workshop` breaks PocketBase and runtime URL loading.
|
|
||||||
This combined image serves both the documentation site and PocketBase, so use a dedicated Workshop hostname if the
|
|
||||||
chosen hostname already serves Homarr itself. In that case, replace the hostname in all four URL values and keep
|
|
||||||
`/workshop` only on `WORKSHOP_WEB_URL`.
|
|
||||||
|
|
||||||
The Compose volume preserves PocketBase data across pulls and container recreation. The mutable `v2` tag is suitable
|
|
||||||
for previews; use the `sha-<commit>` tag for promotion. For the public central Workshop, `PB_ALLOWED_ORIGINS=*` allows
|
|
||||||
self-hosted Homarr origins to use the API and OAuth. A private demo may use a comma-separated origin allowlist instead.
|
|
||||||
GitHub OAuth requires both credentials and the callback
|
|
||||||
`https://v2.preview.homarr.dev/api/oauth2-redirect`. Restart after changing environment values, then verify the health
|
|
||||||
endpoint, `/workshop`, a public listing request, GitHub sign-in, and an installation from the Homarr preview.
|
|
||||||
|
|
||||||
Back up application and PocketBase data before deployment. Publish the combined image by immutable digest, test the
|
|
||||||
exact digest in staging, rehearse application rollback and PocketBase restore, then promote that same digest.
|
|
||||||
|
|
||||||
## Client architecture
|
|
||||||
|
|
||||||
Workshop access is centralized in `@homarr/workshop/backend`. It exports the typed `WorkshopBackend`, its typed PocketBase instance, stable TanStack Query option factories, and the `useWorkshop…` query and mutation hooks used by Homarr. The documentation site uses the same backend rather than maintaining a second API contract.
|
|
||||||
|
|
||||||
Listing fields derived by the `workshop_listings` view—such as submission type, score, and counts—are normalized by the shared client. Healthy deployments keep filtering, sorting, and pagination in PocketBase. If a persistent development volume still has an older view that rejects those fields, the client retries without them and applies the same operations locally; it can also fall back to the base submissions collection. Production deployments should nevertheless apply the current migration so the view exposes the complete metadata.
|
|
||||||
@@ -28,8 +28,7 @@ import piHoleApp from "./img/pi-hole-ping-icon.png";
|
|||||||
|
|
||||||
### Interactions
|
### Interactions
|
||||||
|
|
||||||
App tiles stay compact and open their configured destination directly. They do not use the shared widget context menu;
|
App tiles stay compact and open their configured destination directly. Right-click a tile to inspect its status or change its settings when the board and your preferences allow it.
|
||||||
configure the app and its status check from the tile's edit actions.
|
|
||||||
|
|
||||||
### Adding the widget
|
### Adding the widget
|
||||||
|
|
||||||
|
|||||||
@@ -14,9 +14,7 @@ import { archiveTeamWarriorWidget } from ".";
|
|||||||
|
|
||||||
<WidgetHeader widget={archiveTeamWarriorWidget} categories={["Archiving", "Monitoring"]} />
|
<WidgetHeader widget={archiveTeamWarriorWidget} categories={["Archiving", "Monitoring"]} />
|
||||||
|
|
||||||
Use this widget to see what your ArchiveTeam Warrior is preserving without leaving Homarr. The compact view prioritizes the
|
Use this widget to see what your ArchiveTeam Warrior is preserving without leaving Homarr. The compact view keeps the current project, runner state, job counts, bandwidth, and broadcast message visible. Advanced view adds the complete active-job list and exact update time.
|
||||||
selected project and Warrior status; shorter tiles can hide secondary counts, bandwidth, or the broadcast message. Advanced
|
|
||||||
view adds the runner status, exact update time, and a scrollable list of reported work items.
|
|
||||||
|
|
||||||
### Supported integration
|
### Supported integration
|
||||||
|
|
||||||
|
|||||||
@@ -8,7 +8,6 @@ import { AddingWidget } from "@site/src/components/widgets/adding";
|
|||||||
import { WidgetConfig } from "@site/src/components/widgets/configuration";
|
import { WidgetConfig } from "@site/src/components/widgets/configuration";
|
||||||
import { WidgetHeader } from "@site/src/components/widgets/header";
|
import { WidgetHeader } from "@site/src/components/widgets/header";
|
||||||
import { assistantWidget } from ".";
|
import { assistantWidget } from ".";
|
||||||
import assistantWidgetImage from "../../management/img/assistant-widget.png";
|
|
||||||
|
|
||||||
<WidgetHeader widget={assistantWidget} categories={["Productivity"]} />
|
<WidgetHeader widget={assistantWidget} categories={["Productivity"]} />
|
||||||
|
|
||||||
@@ -17,18 +16,7 @@ board. Messages, conversations, tool calls, approvals, files, mentions, model co
|
|||||||
usage details, and response actions remain synchronized with the app-wide assistant.
|
usage details, and response actions remain synchronized with the app-wide assistant.
|
||||||
|
|
||||||
The assistant must be enabled by an administrator in **Management → Assistant**. Signed-out users and users
|
The assistant must be enabled by an administrator in **Management → Assistant**. Signed-out users and users
|
||||||
on an instance without an enabled model see an unavailable state instead of a broken composer. Signed-out users see
|
on an instance without an enabled model see an unavailable state instead of a broken composer.
|
||||||
**Sign in**; a configured provider without a saved model or with **Enable Assistant** off remains unavailable until
|
|
||||||
the administrator saves a working connection, selects a model, and enables the assistant.
|
|
||||||
|
|
||||||
<img
|
|
||||||
src={assistantWidgetImage}
|
|
||||||
alt="Assistant widget embedded on a dashboard with its conversation header, automatic approvals control, model selector, and composer"
|
|
||||||
style={{ maxWidth: "100%" }}
|
|
||||||
/>
|
|
||||||
|
|
||||||
The current preview capture labels the board-embedded surface: its header exposes conversation history, refresh,
|
|
||||||
automatic approvals, and new-conversation controls, while the footer exposes the model, thinking mode, and composer.
|
|
||||||
|
|
||||||
### Adding the widget
|
### Adding the widget
|
||||||
|
|
||||||
@@ -48,9 +36,7 @@ in that layout to keep the complete conversation inline.
|
|||||||
the command menu. This is the default and keeps every assistant entry point synchronized.
|
the command menu. This is the default and keeps every assistant entry point synchronized.
|
||||||
|
|
||||||
**Pinned conversation** reveals a searchable conversation selector. A pinned widget never changes the
|
**Pinned conversation** reveals a searchable conversation selector. A pinned widget never changes the
|
||||||
active conversation silently: select **Open conversation** inside the widget before continuing that thread. If the pinned
|
active conversation silently: select **Open conversation** inside the widget before continuing that thread.
|
||||||
thread was deleted or cannot be opened, the widget keeps the pinned selection, shows the same recovery action and a
|
|
||||||
retry state, and retries that thread when **Open conversation** is selected again.
|
|
||||||
|
|
||||||
### Conversation features
|
### Conversation features
|
||||||
|
|
||||||
@@ -64,16 +50,10 @@ retry state, and retries that thread when **Open conversation** is selected agai
|
|||||||
- Edit user messages and copy, regenerate, branch, quote, export, or rate responses.
|
- Edit user messages and copy, regenerate, branch, quote, export, or rate responses.
|
||||||
- Inspect syntax-highlighted Markdown, sources, generated files, tool results, streaming chain-of-thought,
|
- Inspect syntax-highlighted Markdown, sources, generated files, tool results, streaming chain-of-thought,
|
||||||
cumulative conversation usage, per-turn token and context use, timing, speed, provider routing, and cost.
|
cumulative conversation usage, per-turn token and context use, timing, speed, provider routing, and cost.
|
||||||
- Change the model and reasoning effort for the active conversation. A model choice is saved per persisted thread,
|
- Change the model and reasoning effort for the active conversation.
|
||||||
does not change the administrator's default, and is restored when that thread is selected again; a new thread
|
|
||||||
starts from the configured default.
|
|
||||||
- Refresh the current board from the conversation header. Approved mutations also refresh visible board data automatically.
|
- Refresh the current board from the conversation header. Approved mutations also refresh visible board data automatically.
|
||||||
|
|
||||||
The expanded assistant and board widget use the same persisted thread runtime. A response continues in the
|
The expanded assistant and board widget use the same persisted thread runtime. A response continues in the
|
||||||
background when the widget leaves the viewport or the expanded panel is minimized. Each visible surface keeps an
|
background when the widget leaves the viewport or the expanded panel is minimized. Each visible surface keeps an
|
||||||
independent draft, attachments, selection, and focus, so typing in a board widget cannot move or overwrite the
|
independent draft, attachments, selection, and focus, so typing in a board widget cannot move or overwrite the
|
||||||
floating panel composer.
|
floating panel composer.
|
||||||
|
|
||||||
Automatic approvals are off by default, reset when switching conversations, and never select a neutral choice. A
|
|
||||||
structured question shows **Other** only when the tool allows it (`allowOther` is not `false`); selecting **Other**
|
|
||||||
opens a manual freeform response even when automatic approvals are enabled.
|
|
||||||
@@ -34,7 +34,7 @@ This widget displays your Beszel alert configurations separated by status (trigg
|
|||||||
]}
|
]}
|
||||||
/>
|
/>
|
||||||
|
|
||||||
<WidgetInteractionGuide advancedView={false} />
|
<WidgetInteractionGuide />
|
||||||
|
|
||||||
### Adding the widget
|
### Adding the widget
|
||||||
|
|
||||||
|
|||||||
@@ -8,7 +8,6 @@ import { WidgetHeader } from "@site/src/components/widgets/header";
|
|||||||
import { AddingWidget } from "@site/src/components/widgets/adding";
|
import { AddingWidget } from "@site/src/components/widgets/adding";
|
||||||
import { WidgetConfig } from "@site/src/components/widgets/configuration";
|
import { WidgetConfig } from "@site/src/components/widgets/configuration";
|
||||||
import { WidgetIntegrations } from "@site/src/components/widgets/integrations";
|
import { WidgetIntegrations } from "@site/src/components/widgets/integrations";
|
||||||
import { WidgetInteractionGuide } from "@site/src/components/widgets/interactions";
|
|
||||||
import { beszelSystemGridWidget } from ".";
|
import { beszelSystemGridWidget } from ".";
|
||||||
import { beszelIntegration } from "@site/docs/integrations/beszel";
|
import { beszelIntegration } from "@site/docs/integrations/beszel";
|
||||||
|
|
||||||
@@ -35,8 +34,6 @@ Select a system card to open the complete statistics view, including system, fil
|
|||||||
]}
|
]}
|
||||||
/>
|
/>
|
||||||
|
|
||||||
<WidgetInteractionGuide advancedView={false} />
|
|
||||||
|
|
||||||
### Adding the widget
|
### Adding the widget
|
||||||
|
|
||||||
<AddingWidget />
|
<AddingWidget />
|
||||||
|
|||||||
@@ -17,7 +17,7 @@ import beszelSystemStats from "./img/beszel-system-stats.png";
|
|||||||
|
|
||||||
<WidgetHeader widget={beszelSystemStatsWidget} categories={["System Monitoring", "Charts"]} />
|
<WidgetHeader widget={beszelSystemStatsWidget} categories={["System Monitoring", "Charts"]} />
|
||||||
|
|
||||||
This widget displays time-series charts for a selected Beszel system, including CPU, memory, disk, network, and Docker container metrics. The Disk Usage chart combines the root disk and every extra filesystem reported by Beszel. Use the widget controls to switch between the realtime Live view and historical periods ranging from 1 hour to 30 days. Live view keeps a one-minute window and pauses while the browser tab is hidden. If the live stream drops, the widget now shows the connection failure state immediately and can switch back to historical data.
|
This widget displays time-series charts for a selected Beszel system, including CPU, memory, disk, network, and Docker container metrics. The Disk Usage chart combines the root disk and every extra filesystem reported by Beszel. Hover over or focus the widget controls to switch between the realtime Live view and historical periods ranging from 1 hour to 30 days. Live view keeps a one-minute window and pauses while the browser tab is hidden. If the live stream drops, the widget now shows the connection failure state immediately and can switch back to historical data.
|
||||||
|
|
||||||
### Screenshots
|
### Screenshots
|
||||||
|
|
||||||
|
|||||||
@@ -8,7 +8,6 @@ import { WidgetHeader } from "@site/src/components/widgets/header";
|
|||||||
import { AddingWidget } from "@site/src/components/widgets/adding";
|
import { AddingWidget } from "@site/src/components/widgets/adding";
|
||||||
import { WidgetConfig } from "@site/src/components/widgets/configuration";
|
import { WidgetConfig } from "@site/src/components/widgets/configuration";
|
||||||
import { WidgetIntegrations } from "@site/src/components/widgets/integrations";
|
import { WidgetIntegrations } from "@site/src/components/widgets/integrations";
|
||||||
import { WidgetInteractionGuide } from "@site/src/components/widgets/interactions";
|
|
||||||
import { beszelSystemTableWidget } from ".";
|
import { beszelSystemTableWidget } from ".";
|
||||||
import { beszelIntegration } from "@site/docs/integrations/beszel";
|
import { beszelIntegration } from "@site/docs/integrations/beszel";
|
||||||
|
|
||||||
@@ -36,8 +35,6 @@ Select a system row to open the complete statistics view.
|
|||||||
]}
|
]}
|
||||||
/>
|
/>
|
||||||
|
|
||||||
<WidgetInteractionGuide advancedView={false} />
|
|
||||||
|
|
||||||
### Adding the widget
|
### Adding the widget
|
||||||
|
|
||||||
<AddingWidget />
|
<AddingWidget />
|
||||||
|
|||||||
|
Before Width: | Height: | Size: 45 KiB |
|
Before Width: | Height: | Size: 17 KiB |
@@ -31,12 +31,16 @@ the same data is requested through Homarr's MCP or Assistant tools.
|
|||||||
|
|
||||||
### Screenshots
|
### Screenshots
|
||||||
|
|
||||||
import currentView from "./img/current-view.png";
|
import popover from "./img/popover.png";
|
||||||
import advancedView from "./img/advanced-view.png";
|
import withIntegrations from "./img/with-integrations.png";
|
||||||
|
import withoutIntegrations from "./img/without-integrations.png";
|
||||||
|
|
||||||
<div className="flex flex-col gap-1">
|
<div className="flex gap-1">
|
||||||
<img src={currentView} alt="Calendar month view with marked events" width={513} height={303} />
|
<img src={withIntegrations} alt="calendar with-integrations big-size" width={256 + 4} height={256 + 4} />
|
||||||
<img src={advancedView} alt="Calendar advanced view with grouped events" width={800} height={484} />
|
<div className="flex flex-col gap-1">
|
||||||
|
<img src={popover} alt="calendar popover-details the-mandalorian" width={128 * 3} height={128} />
|
||||||
|
<img src={withoutIntegrations} alt="calendar without-integrations small-size" width={256} height={128} />
|
||||||
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
### Supported Integrations
|
### Supported Integrations
|
||||||
|
|||||||
@@ -32,8 +32,7 @@ Credentials remain on the server.
|
|||||||
|
|
||||||
:::note
|
:::note
|
||||||
Custom API widgets must first be created in **Management → Custom Widgets** before they appear in the widget picker.
|
Custom API widgets must first be created in **Management → Custom Widgets** before they appear in the widget picker.
|
||||||
Action buttons require the request's minimum board permission, which is `modify` by default. Anonymous viewers cannot run
|
Action buttons can only be executed by administrators.
|
||||||
mutations. DELETE additionally requires full permission and confirmation.
|
|
||||||
:::
|
:::
|
||||||
|
|
||||||
### Permissions and actions
|
### Permissions and actions
|
||||||
|
|||||||
@@ -20,9 +20,7 @@ import { technitiumDnsIntegration } from "@site/docs/integrations/technitium-dns
|
|||||||
|
|
||||||
<WidgetHeader widget={dnsHoleControlsWidget} categories={["DNS Hole"]} />
|
<WidgetHeader widget={dnsHoleControlsWidget} categories={["DNS Hole"]} />
|
||||||
|
|
||||||
This widget lets permitted users enable, disable, or temporarily pause one or more DNS services. It shares the summary query
|
This widget lets permitted users enable, disable, or temporarily pause one or more DNS services. It shares the summary query and cache with DNS Hole Summary. Every selected source stays available in the normal scrollable view, while cards and controls adapt to the widget's width and height.
|
||||||
and cache with DNS Hole Summary. Cards and controls adapt to the widget's width and height. Sources that fail to load are
|
|
||||||
omitted from the returned summaries; bulk actions keep successful results visible and report the number of failures.
|
|
||||||
|
|
||||||
### Screenshots
|
### Screenshots
|
||||||
|
|
||||||
|
|||||||
|
Before Width: | Height: | Size: 31 KiB After Width: | Height: | Size: 39 KiB |
@@ -8,7 +8,6 @@ import { WidgetHeader } from "@site/src/components/widgets/header";
|
|||||||
import { AddingWidget } from "@site/src/components/widgets/adding";
|
import { AddingWidget } from "@site/src/components/widgets/adding";
|
||||||
import { WidgetConfig } from "@site/src/components/widgets/configuration";
|
import { WidgetConfig } from "@site/src/components/widgets/configuration";
|
||||||
import { WidgetIntegrations } from "@site/src/components/widgets/integrations";
|
import { WidgetIntegrations } from "@site/src/components/widgets/integrations";
|
||||||
import { WidgetInteractionGuide } from "@site/src/components/widgets/interactions";
|
|
||||||
import { IconAd } from "@tabler/icons-react";
|
import { IconAd } from "@tabler/icons-react";
|
||||||
import Tabs from "@theme/Tabs";
|
import Tabs from "@theme/Tabs";
|
||||||
import TabItem from "@theme/TabItem";
|
import TabItem from "@theme/TabItem";
|
||||||
@@ -50,8 +49,6 @@ Each container row has an action menu, accessible via the three-dot icon or by r
|
|||||||
- **Remove** - permanently remove the container after a second confirmation click
|
- **Remove** - permanently remove the container after a second confirmation click
|
||||||
- **Add to Homarr** - create a bookmark app from the container
|
- **Add to Homarr** - create a bookmark app from the container
|
||||||
|
|
||||||
<WidgetInteractionGuide advancedView={false} />
|
|
||||||
|
|
||||||
### Adding the widget
|
### Adding the widget
|
||||||
|
|
||||||
<AddingWidget />
|
<AddingWidget />
|
||||||
|
|||||||
|
Before Width: | Height: | Size: 116 KiB |
|
Before Width: | Height: | Size: 76 KiB |
@@ -21,79 +21,36 @@ import { downloadsWidget } from ".";
|
|||||||
|
|
||||||
<WidgetHeader widget={downloadsWidget} categories={["Torrent client", "Usenet client", "Downloads"]} />
|
<WidgetHeader widget={downloadsWidget} categories={["Torrent client", "Usenet client", "Downloads"]} />
|
||||||
|
|
||||||
This widget displays torrent, Usenet, and miscellaneous download jobs, along with their progress and other relevant information. It supports 7 download client integrations and provides a rich, responsive table interface.
|
This widget displays a list of torrents or usenet-articles that are currently being downloaded, along with their progress and other relevant information. It supports 7 download client integrations and provides a rich, responsive table interface.
|
||||||
|
|
||||||
### Screenshots
|
### Screenshots
|
||||||
|
|
||||||
import downloadsCard from "./img/screenshot.png";
|
import downloadsCard from "./img/screenshot.png";
|
||||||
import contextMenuImg from "./img/context-menu.png";
|
import contextMenuImg from "./img/context-menu.png";
|
||||||
import advancedViewImg from "./img/advanced-view.png";
|
|
||||||
import filterPanelImg from "./img/filter-panel.png";
|
|
||||||
|
|
||||||
<div>
|
<div>
|
||||||
<img src={downloadsCard} alt="Downloads widget showing torrent and usenet items" width={128 * 4} />
|
<img src={downloadsCard} alt="Downloads widget showing torrent and usenet items" width={128 * 4} />
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
#### Download-row context menu
|
#### Right-click context menu
|
||||||
|
|
||||||
<div>
|
<div>
|
||||||
<img src={contextMenuImg} alt="Downloads row context menu with pause, delete, and copy actions" width={128 * 4} />
|
<img src={contextMenuImg} alt="Downloads widget context menu with pause, delete, and copy actions" width={128 * 4} />
|
||||||
</div>
|
|
||||||
|
|
||||||
#### Advanced view
|
|
||||||
|
|
||||||
<div>
|
|
||||||
<img
|
|
||||||
src={advancedViewImg}
|
|
||||||
alt="Downloads widget in advanced view with stats, sortable columns, and expanded details"
|
|
||||||
width={128 * 6}
|
|
||||||
/>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
#### Advanced filter panel
|
|
||||||
|
|
||||||
<div>
|
|
||||||
<img src={filterPanelImg} alt="Downloads advanced view with the status filter panel open" width={128 * 6} />
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
### Features
|
### Features
|
||||||
|
|
||||||
- **Responsive compact table** — in compact mode, selected columns adapt to both widget width and height; narrow or short tiles hide speed/state columns, and the shortest tiles also hide the ETA column
|
- **Responsive table** — columns automatically adapt to widget width, hiding less important columns at smaller sizes
|
||||||
- **Sortable columns** — click any sortable column header to sort the current view; the configured default controls the initial column and direction
|
- **Sortable columns** — click any column header to sort ascending/descending
|
||||||
- **Column customization** — choose which columns to display, then hover a header to reveal its grab handle for reordering or drag its edge to resize it; layouts save automatically per widget
|
- **Column customization** — choose which columns to display, then hover a header to reveal its grab handle for reordering or drag its edge to resize it; layouts save automatically per widget
|
||||||
- **Download-row context menu** — copy a download name or ID from any row; pause, resume, and delete actions appear when you have Interact access to that integration
|
- **Right-click context menu** — pause, resume, delete downloads, or copy download names directly from the context menu
|
||||||
- **Row expansion** — click any row to see full details inline without opening a separate modal
|
- **Row expansion** — click any row to see full details inline without opening a separate modal
|
||||||
- **Hover tooltips** — hover a download name to see size, speeds, ETA, ratio, and category; open tooltips close when switching between compact and advanced mode
|
- **Hover tooltips** — hover a download name to see size, speeds, ETA, ratio, and category; open tooltips close when switching between compact and advanced mode
|
||||||
- **Global stats bar** — show queue progress, downloaded/total size, transfer speeds, global torrent ratio, and per-state counts in compact mode; advanced view always includes it
|
- **Global stats bar** — toggle a summary bar showing queue progress, total size, speeds, ratio, and per-state counts
|
||||||
- **Client filtering** — filter downloads by integration or status using the footer filter panel
|
- **Client filtering** — filter downloads by integration or status using the footer filter panel
|
||||||
- **Global controls** — pause/resume actionable queues from the footer bar, limited to selected integrations where you have Interact access
|
- **Global controls** — pause/resume all downloads across all clients from the footer bar
|
||||||
- **Status indicators** — color-coded badges show download state at a glance
|
- **Status indicators** — color-coded badges show download state at a glance
|
||||||
- **Speed overview** — total download and upload speeds for the selected clients are displayed in the footer
|
- **Speed overview** — total download and upload speeds displayed in the footer
|
||||||
|
|
||||||
:::note
|
|
||||||
|
|
||||||
Compact layouts use both dimensions: below 500px wide, speed columns are hidden; below 300px wide, the ETA and state
|
|
||||||
columns are hidden too. A tile shorter than 180px hides speed and state columns, and a tile shorter than 120px also
|
|
||||||
hides ETA. The footer is hidden below 96px in compact mode. Advanced view bypasses these compact size reductions,
|
|
||||||
keeps the selected column set, and always includes the stats bar and footer controls, with the filter panel available
|
|
||||||
from the footer.
|
|
||||||
|
|
||||||
The filter panel changes the visible rows. Its client/status filters also change the stats bar's progress, size, and
|
|
||||||
state counts, while transfer-speed totals summarize the selected clients and the global torrent ratio summarizes the
|
|
||||||
selected torrent clients. The configured category/label filter can optionally be applied to the global torrent ratio
|
|
||||||
through **Use category filter for global torrent ratio**; footer client/status filters do not change that ratio.
|
|
||||||
|
|
||||||
The per-item **Ratio** is sent bytes divided by the item's total size. **Global Ratio** is total uploaded bytes divided
|
|
||||||
by total downloaded bytes.
|
|
||||||
|
|
||||||
Mutation controls depend on the integration's Interact permission. Users without that permission can still view rows and
|
|
||||||
use the row menu's copy actions. `slskd` is list-only: its pause, resume, and delete operations are no-ops, so those
|
|
||||||
controls have no effect for that client even when Interact permission exposes them.
|
|
||||||
|
|
||||||
The screenshot above is a Downloads row menu, separate from the shared widget context menu. When board right-click menus
|
|
||||||
are enabled, the shared menu provides widget-level actions such as advanced view, widget options, refresh, and settings.
|
|
||||||
|
|
||||||
:::
|
|
||||||
|
|
||||||
### Supported Integrations
|
### Supported Integrations
|
||||||
|
|
||||||
@@ -125,20 +82,20 @@ are enabled, the shared menu provides widget-level actions such as advanced view
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
integration: slskdIntegration,
|
integration: slskdIntegration,
|
||||||
note: "Soulseek client (list-only; mutation controls are no-ops)",
|
note: "Soulseek client (read-only)",
|
||||||
},
|
},
|
||||||
]}
|
]}
|
||||||
/>
|
/>
|
||||||
|
|
||||||
### Interactions
|
### Interactions
|
||||||
|
|
||||||
- **Right-click** any download to copy its name or ID; pause, resume, and delete are available only with Interact access
|
- **Right-click** any download to open a context menu with pause/resume, delete, and copy actions
|
||||||
- **Click** any row to expand it and see full download details inline
|
- **Click** any row to expand it and see full download details inline
|
||||||
- **Hover** a download name for a quick stats tooltip
|
- **Hover** a download name for a quick stats tooltip
|
||||||
- **Stats toggle** — show or hide the global stats bar in compact mode; advanced view always shows the stats bar
|
- **Stats toggle** — show or hide the global stats bar from the footer
|
||||||
- **Pause / Resume** actionable queues using the footer controls
|
- **Pause / Resume** all downloads using the footer controls
|
||||||
- **Filter** rows by integration or status using the filter button in the footer
|
- **Filter** by integration or status using the filter button in the footer
|
||||||
- **Sort** by clicking sortable column headers; the default sort is configured per widget, while header changes apply to the current view
|
- **Sort** by clicking column headers (with persistent sort direction)
|
||||||
|
|
||||||
<WidgetInteractionGuide />
|
<WidgetInteractionGuide />
|
||||||
|
|
||||||
|
|||||||
@@ -30,20 +30,19 @@ export const downloadsWidget: WidgetDefinition = {
|
|||||||
{
|
{
|
||||||
name: "Columns to show",
|
name: "Columns to show",
|
||||||
description:
|
description:
|
||||||
"Select the columns you want to display in the widget. Compact layouts automatically hide/show selected columns based on widget width and height; advanced view keeps the selected columns visible.",
|
"Select the columns you want to display in the widget. Columns automatically hide/show based on widget width.",
|
||||||
values: `List of columns: ${columnsList.join(", ")}`,
|
values: `List of columns: ${columnsList.join(", ")}`,
|
||||||
defaultValue: ["name", "progress", "downSpeed", "time", "state"].join(", "),
|
defaultValue: ["name", "progress", "downSpeed", "time", "state"].join(", "),
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "Default sort column",
|
name: "Default sort column",
|
||||||
description:
|
description: "The column used for initial sorting when the widget loads.",
|
||||||
"The column used for initial sorting when the widget loads. Clicking a column header changes the current view only.",
|
|
||||||
defaultValue: "progress",
|
defaultValue: "progress",
|
||||||
values: `List of columns: ${sortColumns.join(", ")}`,
|
values: `List of columns: ${sortColumns.join(", ")}`,
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "Invert sorting",
|
name: "Invert sorting",
|
||||||
description: "This sets the initial sorting direction.",
|
description: "This will invert the default sorting order.",
|
||||||
values: { type: "boolean" },
|
values: { type: "boolean" },
|
||||||
defaultValue: "no",
|
defaultValue: "no",
|
||||||
},
|
},
|
||||||
@@ -67,7 +66,8 @@ export const downloadsWidget: WidgetDefinition = {
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "Hide completed torrent under this threshold (in kiB/s)",
|
name: "Hide completed torrent under this threshold (in kiB/s)",
|
||||||
description: "This will hide completed torrent entries whose upload speed is below the specified threshold.",
|
description:
|
||||||
|
"This will hide completed torrent entries that have a download speed below the specified threshold.",
|
||||||
values: "Any number above 0, 0 to disable",
|
values: "Any number above 0, 0 to disable",
|
||||||
defaultValue: "0",
|
defaultValue: "0",
|
||||||
},
|
},
|
||||||
@@ -85,16 +85,15 @@ export const downloadsWidget: WidgetDefinition = {
|
|||||||
defaultValue: "no",
|
defaultValue: "no",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "Use category filter for global torrent ratio",
|
name: "Use filter to calculate Ratio",
|
||||||
description:
|
description: "This will use the category filter when calculating the global torrent ratio.",
|
||||||
"When enabled, the configured category/label filter is applied to the global torrent ratio. Footer client/status filters do not change this ratio.",
|
|
||||||
values: { type: "boolean" },
|
values: { type: "boolean" },
|
||||||
defaultValue: "yes",
|
defaultValue: "yes",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "Limit items per integration",
|
name: "Limit items per integration",
|
||||||
description: "This will limit the number of items shown per integration, not globally.",
|
description: "This will limit the number of items shown per integration, not globally.",
|
||||||
values: "Any whole number from 1 upward",
|
values: "Any number above 1",
|
||||||
defaultValue: "50",
|
defaultValue: "50",
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
|
|||||||
@@ -33,7 +33,7 @@ import screen from "./img/screen.png";
|
|||||||
|
|
||||||
<WidgetInteractionGuide />
|
<WidgetInteractionGuide />
|
||||||
|
|
||||||
Use the pause or resume control to pause its slideshow; touch devices keep the control available. A paused slideshow keeps its resume control visible. The advanced view displays the complete photo without cropping, groups previous, pause or resume, and next together, and includes every loaded photo in its thumbnail strip.
|
Hover or focus the widget to pause its slideshow; touch devices keep the control available. A paused slideshow keeps its resume control visible. The advanced view displays the complete photo without cropping, groups previous, pause or resume, and next together, and includes every loaded photo in its thumbnail strip.
|
||||||
|
|
||||||
### Adding the widget
|
### Adding the widget
|
||||||
|
|
||||||
|
|||||||
|
Before Width: | Height: | Size: 48 KiB |
|
Before Width: | Height: | Size: 22 KiB After Width: | Height: | Size: 7.3 KiB |
@@ -31,12 +31,8 @@ Sessions without user metadata remain visible and are labeled as an unknown user
|
|||||||
### Screenshots
|
### Screenshots
|
||||||
|
|
||||||
import mediaTable from "./img/table.png";
|
import mediaTable from "./img/table.png";
|
||||||
import mediaAdvancedView from "./img/advanced-view.png";
|
|
||||||
|
|
||||||
<div className="flex flex-col gap-1">
|
<img src={mediaTable} alt="media-server-streams" width={128 * 3 * 1.5} height={128 * 1.5} />
|
||||||
<img src={mediaTable} alt="Media server compact streams table" width={303} height={198} />
|
|
||||||
<img src={mediaAdvancedView} alt="Media server advanced view with stream summary" width={800} height={484} />
|
|
||||||
</div>
|
|
||||||
|
|
||||||
### Supported Integrations
|
### Supported Integrations
|
||||||
|
|
||||||
|
|||||||
|
Before Width: | Height: | Size: 23 KiB |
@@ -15,20 +15,17 @@ import { weatherWidget } from ".";
|
|||||||
|
|
||||||
The Weather Widget uses your location to display the current, highest and lowest temperature.
|
The Weather Widget uses your location to display the current, highest and lowest temperature.
|
||||||
In the compact view, select a condition icon or forecast day to open details with a mouse, keyboard or touch.
|
In the compact view, select a condition icon or forecast day to open details with a mouse, keyboard or touch.
|
||||||
The compact forecast shows up to the configured number of days. The advanced view combines current conditions with the
|
The advanced view always combines current conditions with the full seven-day forecast, including humidity, wind,
|
||||||
available daily forecast, including humidity, wind, gusts, sunrise and sunset. Both views reuse the same cached Open
|
gusts, sunrise and sunset. Both views reuse the same cached Open Meteo response.
|
||||||
Meteo response.
|
|
||||||
|
|
||||||
### Screenshots
|
### Screenshots
|
||||||
|
|
||||||
import forecastWeather from "./img/forecast.png";
|
import forecastWeather from "./img/forecast.png";
|
||||||
import currentWeather from "./img/current.png";
|
import currentWeather from "./img/current.png";
|
||||||
import advancedWeather from "./img/advanced-view.png";
|
|
||||||
|
|
||||||
<div className="flex flex-col gap-1">
|
<div className="flex flex-col gap-1">
|
||||||
<img src={forecastWeather} alt="Weather compact forecast" width={238} height={112} />
|
<img src={forecastWeather} alt="weather forecast-5-days" width={128 * 4.5} />
|
||||||
<img src={currentWeather} alt="Weather compact current conditions" width={198} height={93} />
|
<img src={currentWeather} alt="weather current" width={128 * 3} />
|
||||||
<img src={advancedWeather} alt="Weather advanced view with seven-day forecast details" width={800} height={484} />
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<WidgetInteractionGuide />
|
<WidgetInteractionGuide />
|
||||||
|
|||||||
@@ -8,7 +8,6 @@ import { WidgetHeader } from "@site/src/components/widgets/header";
|
|||||||
import { AddingWidget } from "@site/src/components/widgets/adding";
|
import { AddingWidget } from "@site/src/components/widgets/adding";
|
||||||
import { WidgetConfig } from "@site/src/components/widgets/configuration";
|
import { WidgetConfig } from "@site/src/components/widgets/configuration";
|
||||||
import { WidgetIntegrations } from "@site/src/components/widgets/integrations";
|
import { WidgetIntegrations } from "@site/src/components/widgets/integrations";
|
||||||
import { WidgetInteractionGuide } from "@site/src/components/widgets/interactions";
|
|
||||||
import { wudWidget } from ".";
|
import { wudWidget } from ".";
|
||||||
import { wudIntegration } from "@site/docs/integrations/whats-up-docker";
|
import { wudIntegration } from "@site/docs/integrations/whats-up-docker";
|
||||||
|
|
||||||
@@ -27,8 +26,6 @@ This widget shows two stats from your WUD instance: the total number of monitore
|
|||||||
]}
|
]}
|
||||||
/>
|
/>
|
||||||
|
|
||||||
<WidgetInteractionGuide advancedView={false} />
|
|
||||||
|
|
||||||
### Adding the widget
|
### Adding the widget
|
||||||
|
|
||||||
<AddingWidget />
|
<AddingWidget />
|
||||||
|
|||||||
@@ -0,0 +1,9 @@
|
|||||||
|
{
|
||||||
|
"label": "Workshop",
|
||||||
|
"collapsed": true,
|
||||||
|
"position": 4,
|
||||||
|
"link": {
|
||||||
|
"type": "doc",
|
||||||
|
"id": "workshop/index"
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,62 @@
|
|||||||
|
---
|
||||||
|
title: Workshop development
|
||||||
|
sidebar_position: 4
|
||||||
|
tags:
|
||||||
|
- Workshop
|
||||||
|
- Developer
|
||||||
|
- Docusaurus
|
||||||
|
- PocketBase
|
||||||
|
---
|
||||||
|
|
||||||
|
# Workshop development
|
||||||
|
|
||||||
|
Install the repository dependencies and make sure Docker is available before starting the Workshop services. See the
|
||||||
|
[main development guide](../advanced/development/getting-started) for the repository prerequisites.
|
||||||
|
|
||||||
|
## Run PocketBase and documentation
|
||||||
|
|
||||||
|
Start PocketBase in one terminal:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
cp apps/workshop/.env.example apps/workshop/.env
|
||||||
|
docker compose --env-file apps/workshop/.env -f apps/workshop/docker-compose.yml up --build workshop
|
||||||
|
```
|
||||||
|
|
||||||
|
Then start Docusaurus in another terminal:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
WORKSHOP_API_URL=http://127.0.0.1:8090 pnpm dev:docs
|
||||||
|
```
|
||||||
|
|
||||||
|
PocketBase runs on port 8090 and Docusaurus on port 3003. Stopping the services preserves the PocketBase volume.
|
||||||
|
|
||||||
|
Open `http://127.0.0.1:8090/_/` and create the first PocketBase superuser. The Workshop UI is available at
|
||||||
|
`http://127.0.0.1:3003/workshop`.
|
||||||
|
|
||||||
|
Point Homarr at the local services with:
|
||||||
|
|
||||||
|
```dotenv
|
||||||
|
HOMARR_WEBSITE_URL=http://127.0.0.1:3003
|
||||||
|
WORKSHOP_API_URL=http://127.0.0.1:8090
|
||||||
|
WORKSHOP_WEB_URL=http://127.0.0.1:3003/workshop
|
||||||
|
```
|
||||||
|
|
||||||
|
Restart `pnpm dev:docs` after changing the Docusaurus URL variables. If Homarr is also running, restart its `pnpm dev`
|
||||||
|
process after changing the Workshop URLs. GitHub OAuth is optional locally. See
|
||||||
|
[`apps/workshop/README.md`](https://github.com/homarr-labs/homarr/blob/HEAD/apps/workshop/README.md) for OAuth,
|
||||||
|
Workshop moderator promotion, logs, tests, backup, restore, stopping, and intentional volume reset.
|
||||||
|
|
||||||
|
## URL testing
|
||||||
|
|
||||||
|
Docusaurus reads `HOMARR_WEBSITE_URL` and `WORKSHOP_API_URL` when it starts or builds. Homarr also reads
|
||||||
|
`WORKSHOP_WEB_URL` when its server starts, so these values do not rely on `NEXT_PUBLIC_*` build variables. Test a
|
||||||
|
separate API origin before release:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
HOMARR_WEBSITE_URL=http://127.0.0.1:3003 \
|
||||||
|
WORKSHOP_API_URL=http://127.0.0.1:8090 \
|
||||||
|
WORKSHOP_WEB_URL=http://127.0.0.1:3003/workshop \
|
||||||
|
pnpm dev:docs
|
||||||
|
```
|
||||||
|
|
||||||
|
The [Workshop operator guide](./operator) covers production environment variables, staging, and service validation.
|
||||||
@@ -0,0 +1,54 @@
|
|||||||
|
---
|
||||||
|
title: Homarr provider
|
||||||
|
sidebar_position: 2
|
||||||
|
tags:
|
||||||
|
- Assistant
|
||||||
|
- AI
|
||||||
|
- Privacy
|
||||||
|
- Community
|
||||||
|
---
|
||||||
|
|
||||||
|
import { OpenCollectiveLink } from "@site/src/components/assistant-provider/open-collective-link";
|
||||||
|
|
||||||
|
# Homarr provider
|
||||||
|
|
||||||
|
The Homarr provider gives Workshop users access to the **Homarr model** without an administrator API key. The Homarr
|
||||||
|
team selects a capable model based on quality, reliability, and cost, and can change the upstream model without
|
||||||
|
changing the user-facing provider. Each user signs in with GitHub and receives a separate daily allowance.
|
||||||
|
|
||||||
|
## Set it up
|
||||||
|
|
||||||
|
1. Open **Management → Assistant**.
|
||||||
|
2. Select **Homarr** as the provider.
|
||||||
|
3. Save the provider connection.
|
||||||
|
4. Select the available model, enable the assistant, and save.
|
||||||
|
5. Open the assistant and sign in to the Workshop when asked.
|
||||||
|
|
||||||
|
## Daily allowance
|
||||||
|
|
||||||
|
- Each user starts with **50 request units per UTC day**.
|
||||||
|
- Each model request uses one unit. Agent tool loops can make multiple model requests.
|
||||||
|
- Once Workshop forwards a request, it uses one unit even if the upstream later fails. This prevents failed requests
|
||||||
|
from bypassing the shared cost and abuse limits.
|
||||||
|
- The allowance resets at 00:00 UTC.
|
||||||
|
|
||||||
|
The battery beside the model selector shows the remaining allowance and reset time. The Workshop server enforces the
|
||||||
|
limit before it sends a request to OpenRouter.
|
||||||
|
|
||||||
|
## Data and cost
|
||||||
|
|
||||||
|
The Workshop keeps the OpenRouter API key on its server. It does not send that key to Homarr or the browser.
|
||||||
|
|
||||||
|
Prompts, attachments, tool definitions, and tool results are sent through OpenRouter to generate a response. The
|
||||||
|
Workshop proxy does not retain that content, responses, or per-request telemetry. It stores only the Workshop user,
|
||||||
|
UTC day, and counters required to enforce per-user and global daily allowances. Requests require OpenRouter routing
|
||||||
|
with zero data retention and data collection disabled. Homarr does not use this content to train language models.
|
||||||
|
|
||||||
|
We would rather become millionaires in a more ethical manner.
|
||||||
|
|
||||||
|
The Homarr community pays for these requests. Donations help cover the cost.
|
||||||
|
|
||||||
|
<OpenCollectiveLink />
|
||||||
|
|
||||||
|
Workshop operators can change the upstream model, per-user allowance, global allowance, and security limits in the
|
||||||
|
[Workshop operator guide](./operator#homarr-provider-proxy).
|
||||||
@@ -0,0 +1,53 @@
|
|||||||
|
---
|
||||||
|
title: Community Workshop
|
||||||
|
sidebar_label: Overview
|
||||||
|
tags:
|
||||||
|
- Workshop
|
||||||
|
- Custom Widgets
|
||||||
|
- Custom CSS
|
||||||
|
---
|
||||||
|
|
||||||
|
# Community Workshop
|
||||||
|
|
||||||
|
The [Community Workshop](pathname:///workshop) is where Homarr users share Custom Widgets and dashboard CSS.
|
||||||
|
|
||||||
|
:::warning Experimental
|
||||||
|
|
||||||
|
Workshop content is made by the community. Review it before installation and back up your Homarr instance.
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
|
## Find and install content
|
||||||
|
|
||||||
|
Browse the Workshop by type, date, popularity, or recent activity. Each submission includes its source, screenshots,
|
||||||
|
author, revision, comments, and reports.
|
||||||
|
|
||||||
|
Administrators can install content without leaving Homarr:
|
||||||
|
|
||||||
|
- **Custom Widgets:** open **Management → Custom Widgets**, then select **Import from Workshop**.
|
||||||
|
- **Custom CSS:** open a board's **Settings → Custom CSS**, then select **Import from Workshop**.
|
||||||
|
|
||||||
|
Homarr shows the complete source and required permissions before installation. Widget credentials are entered in your
|
||||||
|
Homarr instance and are never included in a Workshop submission.
|
||||||
|
|
||||||
|
## Share your work
|
||||||
|
|
||||||
|
1. Sign in to the Workshop with GitHub.
|
||||||
|
2. Select **Share yours**.
|
||||||
|
3. Choose **Custom Widget** or **Custom CSS**.
|
||||||
|
4. Add the source, a short description, screenshots, and a changelog.
|
||||||
|
5. Review and publish the submission.
|
||||||
|
|
||||||
|
Export Custom Widget JSON from **Management → Custom Widgets → Export**. You can edit a submission later without
|
||||||
|
changing its Workshop URL.
|
||||||
|
|
||||||
|
## Voting, comments, and reports
|
||||||
|
|
||||||
|
Signed-in users can vote, comment, and report submissions. Authors can edit their own comments and submissions.
|
||||||
|
Workshop moderators can review reports, remove comments, and delete unsafe content. Reports do not remove a submission
|
||||||
|
automatically.
|
||||||
|
|
||||||
|
A Workshop moderator manages the public community. This is separate from the administrator role on a Homarr instance.
|
||||||
|
|
||||||
|
Deployment and server configuration are in the [Workshop operator guide](./operator). Local setup is in
|
||||||
|
[Workshop development](./development).
|
||||||
@@ -0,0 +1,144 @@
|
|||||||
|
---
|
||||||
|
title: Workshop operator guide
|
||||||
|
sidebar_label: Operator guide
|
||||||
|
sidebar_position: 3
|
||||||
|
tags:
|
||||||
|
- Workshop
|
||||||
|
- Deployment
|
||||||
|
- Environment variables
|
||||||
|
- PocketBase
|
||||||
|
---
|
||||||
|
|
||||||
|
# Workshop operator guide
|
||||||
|
|
||||||
|
Workshop is powered by [PocketBase](https://pocketbase.io). The production image compiles the current Docusaurus site
|
||||||
|
and serves it together with the API from one origin. The deployment lives in `apps/workshop/` with a Dockerfile,
|
||||||
|
Compose configuration, version-controlled migrations, hooks, a smoke test, and ACT-local workflow instructions.
|
||||||
|
|
||||||
|
Submission links include Open Graph and X/Twitter metadata for the submission title, description, and type. The first
|
||||||
|
uploaded screenshot is used as the social preview image; submissions without screenshots use the Homarr logo.
|
||||||
|
|
||||||
|
Run `pnpm docker:workshop` for PocketBase on port 8090, then run
|
||||||
|
`WORKSHOP_API_URL=http://127.0.0.1:8090 pnpm dev:docs` for Docusaurus on port 3003. `pnpm docker:docs` builds the
|
||||||
|
combined production layout. Normal start and stop commands retain data; `down --volumes` is an intentional,
|
||||||
|
irreversible development reset. See [Workshop development](./development) for the complete local setup.
|
||||||
|
|
||||||
|
## Authentication and notifications
|
||||||
|
|
||||||
|
GitHub needs only the central callback `https://<workshop-host>/api/oauth2-redirect`. Keep PocketBase origins
|
||||||
|
unrestricted unless every self-hosted Homarr caller is explicitly listed. Configure both `GITHUB_CLIENT_ID` and
|
||||||
|
`GITHUB_CLIENT_SECRET`; supplying only one is a startup error. Set `WORKSHOP_PUBLIC_ORIGIN` in production so generated
|
||||||
|
links and email use the public host. Workshop stores only the OAuth provider username in `users.name`, and users cannot
|
||||||
|
rename it. Map **OAuth2 username** to `name`; leave OAuth2 id, full name, and avatar mappings empty. Profile and avatar
|
||||||
|
URLs are derived from `https://github.com/<username>` and `https://github.com/<username>.png`, so PocketBase does not
|
||||||
|
store duplicate profile metadata or avatar files. Configure SMTP for comment, report, and removal notices.
|
||||||
|
|
||||||
|
## Environment variables
|
||||||
|
|
||||||
|
The public URL contract and Workshop-only server configuration are:
|
||||||
|
|
||||||
|
| Variable | Purpose | Default |
|
||||||
|
| -------------------------------------- | ------------------------------------------------- | ------------------------------ |
|
||||||
|
| `HOMARR_WEBSITE_URL` | Documentation/site base used by Homarr links | `https://homarr.dev` |
|
||||||
|
| `WORKSHOP_API_URL` | PocketBase API used by Homarr and standalone docs | `HOMARR_WEBSITE_URL` |
|
||||||
|
| `WORKSHOP_WEB_URL` | Public Workshop page linked from Homarr | `HOMARR_WEBSITE_URL/workshop` |
|
||||||
|
| `WORKSHOP_PUBLIC_ORIGIN` | PocketBase-generated links and email | Required in production |
|
||||||
|
| `PB_ALLOWED_ORIGINS` | PocketBase browser origins | `*` for the central community |
|
||||||
|
| `OPENROUTER_API_KEY` | Server-only key for the Homarr provider proxy | Provider disabled when empty |
|
||||||
|
| `HOMARR_AI_DAILY_REQUEST_LIMIT` | Per-user daily provider allowance | `50` |
|
||||||
|
| `HOMARR_AI_GLOBAL_DAILY_REQUEST_LIMIT` | Shared daily ceiling across all users | `10000` |
|
||||||
|
| `HOMARR_AI_OPENROUTER_BASE_URL` | OpenRouter-compatible proxy upstream | `https://openrouter.ai/api/v1` |
|
||||||
|
| `HOMARR_AI_OPENROUTER_MODEL` | Server-selected upstream model | Selected by the Homarr team |
|
||||||
|
|
||||||
|
All public URL variables reject non-HTTP protocols, embedded credentials, query strings, and fragments, and normalize
|
||||||
|
trailing slashes when Homarr or Docusaurus starts. The deprecated docs-only `WORKSHOP_URL` alias remains for one
|
||||||
|
release; `WORKSHOP_API_URL` takes precedence. The combined Workshop image writes the public URLs into its browser
|
||||||
|
runtime configuration whenever the container starts; the Docker build arguments remain fallbacks. Restart the
|
||||||
|
container after changing these values, without rebuilding it.
|
||||||
|
|
||||||
|
### Homarr provider proxy
|
||||||
|
|
||||||
|
The [Homarr provider](./homarr-provider) proxy is part of the Workshop image. `OPENROUTER_API_KEY` enables the proxy,
|
||||||
|
`HOMARR_AI_OPENROUTER_BASE_URL` selects its OpenRouter-compatible upstream, `HOMARR_AI_OPENROUTER_MODEL` selects the
|
||||||
|
private upstream model behind the stable `homarr/model` alias, and the two allowance variables provide per-user and
|
||||||
|
shared request ceilings. Lowering either allowance takes effect for existing users. The upstream URL cannot contain
|
||||||
|
embedded credentials, a query, or a fragment and must use HTTPS. Tests can explicitly opt into an insecure local mock
|
||||||
|
with `HOMARR_AI_ALLOW_INSECURE_UPSTREAM=true`; do not use that setting with a real API key.
|
||||||
|
|
||||||
|
The proxy overwrites client routing and generation limits. It requires OpenRouter zero-data-retention routing, denies
|
||||||
|
data-collecting providers, limits responses to 32,768 completion tokens, and does not retain prompts, responses, or
|
||||||
|
per-request telemetry. It accepts only uploaded image data, conservatively bounds text to the advertised context, and
|
||||||
|
allows at most two concurrent requests per user and 100 across the service. Keep an OpenRouter account-level credit
|
||||||
|
limit as the final monetary backstop because request quotas are not dollar accounting.
|
||||||
|
|
||||||
|
Run `pnpm test:workshop` to test authentication, streaming, UTC reset, atomic per-user and global quota enforcement,
|
||||||
|
failed-request accounting, identity attribution, server-selected model routing, function tools, input and output
|
||||||
|
controls, privacy routing, spoofing resistance, absence of request logs, and migration rollback.
|
||||||
|
|
||||||
|
An operator can explicitly smoke-test a deployed Workshop against its real configured upstream with a dedicated,
|
||||||
|
low-quota test user:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
HOMARR_AI_LIVE_SMOKE=1 \
|
||||||
|
WORKSHOP_LIVE_TEST_URL=https://workshop.example.com \
|
||||||
|
WORKSHOP_LIVE_TEST_TOKEN=<temporary-pocketbase-user-token> \
|
||||||
|
pnpm test:workshop-live-provider
|
||||||
|
```
|
||||||
|
|
||||||
|
This optional check consumes one provider request. The test client needs neither the OpenRouter key nor the private
|
||||||
|
upstream model ID. Do not run it in CI or with a normal user's Workshop token.
|
||||||
|
|
||||||
|
The Custom Widget AI tests can use this proxy. Set `AI_PROVIDER_BASE_URL` to the `/api/ai/v1` endpoint and
|
||||||
|
`AI_PROVIDER_API_KEY` to a temporary Workshop user token. See
|
||||||
|
[Agent authoring](../management/custom-widgets/agent-authoring#evaluate-the-copied-prompt) for the command.
|
||||||
|
|
||||||
|
## Staging and demo deployment
|
||||||
|
|
||||||
|
Use `apps/workshop/docker-compose.staging.yml` with the published `ghcr.io/homarr-labs/workshop:v2` image for a v2
|
||||||
|
preview. Copy `apps/workshop/.env.staging.example` to `.env.staging`; its default public contract is:
|
||||||
|
|
||||||
|
```dotenv
|
||||||
|
HOMARR_WEBSITE_URL=https://v2.preview.homarr.dev
|
||||||
|
WORKSHOP_API_URL=https://v2.preview.homarr.dev
|
||||||
|
WORKSHOP_WEB_URL=https://v2.preview.homarr.dev/workshop
|
||||||
|
WORKSHOP_PUBLIC_ORIGIN=https://v2.preview.homarr.dev
|
||||||
|
PB_ALLOWED_ORIGINS=*
|
||||||
|
```
|
||||||
|
|
||||||
|
Start or update it from the repository root:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
docker compose --env-file apps/workshop/.env.staging \
|
||||||
|
-f apps/workshop/docker-compose.staging.yml pull
|
||||||
|
docker compose --env-file apps/workshop/.env.staging \
|
||||||
|
-f apps/workshop/docker-compose.staging.yml up --detach
|
||||||
|
curl --fail http://127.0.0.1:8090/api/health
|
||||||
|
```
|
||||||
|
|
||||||
|
The service binds to `127.0.0.1:8090`. Terminate TLS at a reverse proxy and forward the **entire hostname**, including
|
||||||
|
`/api`, `/_/`, and `/workshop-runtime-config.js`; forwarding only `/workshop` breaks PocketBase and runtime URL loading.
|
||||||
|
This combined image serves both the documentation site and PocketBase, so use a dedicated Workshop hostname if the
|
||||||
|
chosen hostname already serves Homarr itself. In that case, replace the hostname in all four URL values and keep
|
||||||
|
`/workshop` only on `WORKSHOP_WEB_URL`.
|
||||||
|
|
||||||
|
The Compose volume preserves PocketBase data across pulls and container recreation. The mutable `v2` tag is suitable
|
||||||
|
for previews; use the `sha-<commit>` tag for promotion. For the public central Workshop, `PB_ALLOWED_ORIGINS=*` allows
|
||||||
|
self-hosted Homarr origins to use the API and OAuth. A private demo may use a comma-separated origin allowlist instead.
|
||||||
|
GitHub OAuth requires both credentials and the callback `https://v2.preview.homarr.dev/api/oauth2-redirect`. Restart
|
||||||
|
after changing environment values, then verify the health endpoint, `/workshop`, a public listing request, GitHub
|
||||||
|
sign-in, and an installation from the Homarr preview.
|
||||||
|
|
||||||
|
Back up application and PocketBase data before deployment. Publish the combined image by immutable digest, test the
|
||||||
|
exact digest in staging, rehearse application rollback and PocketBase restore, then promote that same digest.
|
||||||
|
|
||||||
|
## Client architecture
|
||||||
|
|
||||||
|
Workshop access is centralized in `@homarr/workshop/backend`. It exports the typed `WorkshopBackend`, its typed
|
||||||
|
PocketBase instance, stable TanStack Query option factories, and the `useWorkshop…` query and mutation hooks used by
|
||||||
|
Homarr. The documentation site uses the same backend rather than maintaining a second API contract.
|
||||||
|
|
||||||
|
Listing fields derived by the `workshop_listings` view—such as submission type, score, and counts—are normalized by the
|
||||||
|
shared client. Healthy deployments keep filtering, sorting, and pagination in PocketBase. If a persistent development
|
||||||
|
volume still has an older view that rejects those fields, the client retries without them and applies the same
|
||||||
|
operations locally; it can also fall back to the base submissions collection. Production deployments should
|
||||||
|
nevertheless apply the current migration so the view exposes the complete metadata.
|
||||||
@@ -362,7 +362,7 @@ html[data-workshop-detail-loading] #workshop-detail-route-fallback {
|
|||||||
box-sizing: border-box;
|
box-sizing: border-box;
|
||||||
color: #4b5563;
|
color: #4b5563;
|
||||||
display: flex;
|
display: flex;
|
||||||
font: 500 0.875rem/1.5 Inter, system-ui, sans-serif;
|
font: 500 0.875rem/1.5 "Work Sans", system-ui, sans-serif;
|
||||||
justify-content: center;
|
justify-content: center;
|
||||||
min-height: 100vh;
|
min-height: 100vh;
|
||||||
padding: 2rem;
|
padding: 2rem;
|
||||||
|
|||||||
@@ -51,7 +51,6 @@
|
|||||||
"postcss": "^8.5.16",
|
"postcss": "^8.5.16",
|
||||||
"posthog-docusaurus": "^2.0.5",
|
"posthog-docusaurus": "^2.0.5",
|
||||||
"prism-react-renderer": "^2.4.1",
|
"prism-react-renderer": "^2.4.1",
|
||||||
"random-word-slugs": "^0.1.7",
|
|
||||||
"react": "catalog:",
|
"react": "catalog:",
|
||||||
"react-day-picker": "catalog:",
|
"react-day-picker": "catalog:",
|
||||||
"react-dom": "catalog:",
|
"react-dom": "catalog:",
|
||||||
|
|||||||
@@ -0,0 +1,41 @@
|
|||||||
|
.link {
|
||||||
|
display: inline-flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 0.5rem;
|
||||||
|
padding: 0.45rem 0.7rem;
|
||||||
|
border: 1px solid var(--ifm-color-emphasis-300);
|
||||||
|
border-radius: 0.5rem;
|
||||||
|
background: var(--ifm-background-surface-color);
|
||||||
|
color: var(--ifm-font-color-base);
|
||||||
|
font-size: 0.875rem;
|
||||||
|
font-weight: 600;
|
||||||
|
line-height: 1.25;
|
||||||
|
text-decoration: none;
|
||||||
|
transition:
|
||||||
|
background-color 150ms ease,
|
||||||
|
border-color 150ms ease;
|
||||||
|
}
|
||||||
|
|
||||||
|
.link:hover {
|
||||||
|
border-color: var(--ifm-color-emphasis-500);
|
||||||
|
background: var(--ifm-color-emphasis-100);
|
||||||
|
color: var(--ifm-font-color-base);
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.link:focus-visible {
|
||||||
|
outline: 2px solid var(--ifm-color-primary);
|
||||||
|
outline-offset: 2px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.logo {
|
||||||
|
width: 1.1rem;
|
||||||
|
height: 1.1rem;
|
||||||
|
flex: 0 0 auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
@media (prefers-reduced-motion: reduce) {
|
||||||
|
.link {
|
||||||
|
transition: none;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
import Translate from "@docusaurus/Translate";
|
||||||
|
|
||||||
|
import styles from "./open-collective-link.module.css";
|
||||||
|
|
||||||
|
export const OpenCollectiveLink = () => (
|
||||||
|
<a className={styles.link} href="https://opencollective.com/homarr">
|
||||||
|
<img className={styles.logo} src="/img/opencollective.svg" alt="" aria-hidden />
|
||||||
|
<Translate id="workshop.provider.donate">Donate to Homarr on OpenCollective</Translate>
|
||||||
|
</a>
|
||||||
|
);
|
||||||
@@ -1,147 +1,84 @@
|
|||||||
import React, { useRef } from "react";
|
import styles from "../../../../pages/index.module.css";
|
||||||
|
import { supportedIntegrations } from "../../../../constants/supported-integrations";
|
||||||
|
|
||||||
import LeaderLine, { SocketType } from "leader-line-new";
|
const nodePositions = [
|
||||||
|
styles.dataflowNodeTopLeft,
|
||||||
|
styles.dataflowNodeMiddleLeft,
|
||||||
|
styles.dataflowNodeBottomLeft,
|
||||||
|
styles.dataflowNodeTopRight,
|
||||||
|
styles.dataflowNodeMiddleRight,
|
||||||
|
styles.dataflowNodeBottomRight,
|
||||||
|
];
|
||||||
|
const cyclingIntegrations = supportedIntegrations.filter((integration) => integration.name !== "Homarr");
|
||||||
|
|
||||||
export const DataflowVisualizationComponent = () => {
|
const paths = [
|
||||||
const homarrRef = useRef<HTMLImageElement>(null);
|
"M145 82 C330 82 330 235 480 260",
|
||||||
const sonarrRef = useRef<HTMLImageElement>(null);
|
"M145 260 C300 260 360 260 480 260",
|
||||||
const lidarrRef = useRef<HTMLImageElement>(null);
|
"M145 438 C330 438 330 285 480 260",
|
||||||
const radarrRef = useRef<HTMLImageElement>(null);
|
"M480 260 C630 235 630 82 815 82",
|
||||||
const jellyfinRef = useRef<HTMLImageElement>(null);
|
"M480 260 C600 260 660 260 815 260",
|
||||||
const plexRef = useRef<HTMLImageElement>(null);
|
"M480 260 C630 285 630 438 815 438",
|
||||||
const sabnzbdRef = useRef<HTMLImageElement>(null);
|
];
|
||||||
|
|
||||||
return (
|
export const DataflowVisualizationComponent = () => (
|
||||||
<div className={"bg-black/[.10] py-20"}>
|
<section className={styles.dataflowSection}>
|
||||||
<h2 className={"text-center lg:text-5xl text-3xl font-extrabold mb-24"}>
|
<div className={styles.dataflowHeading}>
|
||||||
|
<h2>
|
||||||
No YAML configurations.
|
No YAML configurations.
|
||||||
<br />
|
<br />
|
||||||
Easy and quick to manage integrations.
|
Easy and quick to manage integrations.
|
||||||
</h2>
|
</h2>
|
||||||
|
<p>Homarr brings status, controls, and updates together in one dashboard.</p>
|
||||||
|
</div>
|
||||||
|
|
||||||
<div className="relative max-w-128 h-80 mx-auto animated-dataflow mx-5">
|
<div
|
||||||
<img
|
className={styles.dataflowDiagram}
|
||||||
ref={homarrRef}
|
role="img"
|
||||||
className={"absolute left-1/2 top-1/2 -translate-y-1/2 -translate-x-1/2 aspect-square object-contain"}
|
aria-label={`Information flowing both ways between Homarr and rotating examples from ${cyclingIntegrations.length} supported integrations`}
|
||||||
src={"/img/logo.png"}
|
>
|
||||||
alt={"Homarr Logo"}
|
<svg className={styles.dataflowLines} viewBox="0 0 960 520" preserveAspectRatio="none" aria-hidden="true">
|
||||||
width={100}
|
{paths.map((path) => (
|
||||||
height={50}
|
<g key={path}>
|
||||||
/>
|
<path className={styles.dataflowLine} d={path} pathLength="1" />
|
||||||
|
<path className={styles.dataflowSignal} d={path} pathLength="1" />
|
||||||
|
<path className={styles.dataflowSignalReverse} d={path} pathLength="1" />
|
||||||
|
</g>
|
||||||
|
))}
|
||||||
|
</svg>
|
||||||
|
|
||||||
<img
|
{nodePositions.map((position, nodeIndex) => {
|
||||||
ref={radarrRef}
|
const cycleStepInSeconds = 1.2 + nodeIndex * 0.13;
|
||||||
className={"absolute left-0 top-0"}
|
const phaseOffsetInSeconds = nodeIndex * 2.7;
|
||||||
src={"https://github.com/walkxcode/dashboard-icons/blob/main/png/radarr.png?raw=true"}
|
|
||||||
alt={"Radarr"}
|
|
||||||
width={50}
|
|
||||||
height={50}
|
|
||||||
/>
|
|
||||||
<img
|
|
||||||
ref={sonarrRef}
|
|
||||||
className={"absolute left-0 top-1/2 -translate-y-1/2"}
|
|
||||||
src={"https://github.com/walkxcode/dashboard-icons/blob/main/png/sonarr.png?raw=true"}
|
|
||||||
alt={"Sonarr"}
|
|
||||||
width={50}
|
|
||||||
height={50}
|
|
||||||
/>
|
|
||||||
<img
|
|
||||||
ref={lidarrRef}
|
|
||||||
className={"absolute left-0 bottom-0"}
|
|
||||||
src={"https://github.com/walkxcode/dashboard-icons/blob/main/png/lidarr.png?raw=true"}
|
|
||||||
alt={"Lidarr"}
|
|
||||||
width={50}
|
|
||||||
height={50}
|
|
||||||
/>
|
|
||||||
|
|
||||||
<img
|
return (
|
||||||
ref={jellyfinRef}
|
<div className={`${styles.dataflowNode} ${position}`} key={position}>
|
||||||
className={"absolute right-0 top-1/2 -translate-y-1/2"}
|
<div className={styles.dataflowCyclingIcons} aria-hidden="true">
|
||||||
src={"https://github.com/walkxcode/dashboard-icons/blob/main/png/jellyfin.png?raw=true"}
|
{cyclingIntegrations.map((_, integrationIndex) => {
|
||||||
alt={"Jellyfin"}
|
const integration =
|
||||||
width={50}
|
cyclingIntegrations[(integrationIndex + nodeIndex * 4) % cyclingIntegrations.length];
|
||||||
height={50}
|
|
||||||
/>
|
|
||||||
|
|
||||||
<img
|
return (
|
||||||
ref={plexRef}
|
<img
|
||||||
className={"absolute right-0 bottom-0"}
|
src={integration.iconUrl}
|
||||||
src={"https://github.com/walkxcode/dashboard-icons/blob/main/png/plex.png?raw=true"}
|
alt=""
|
||||||
alt={"Plex"}
|
width={54}
|
||||||
width={50}
|
height={54}
|
||||||
height={50}
|
key={integration.name}
|
||||||
/>
|
style={{
|
||||||
|
animationDelay: `${-(integrationIndex * cycleStepInSeconds + phaseOffsetInSeconds)}s`,
|
||||||
|
animationDuration: `${cyclingIntegrations.length * cycleStepInSeconds}s`,
|
||||||
|
}}
|
||||||
|
/>
|
||||||
|
);
|
||||||
|
})}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
})}
|
||||||
|
|
||||||
<img
|
<div className={`${styles.dataflowNode} ${styles.dataflowHub}`}>
|
||||||
ref={sabnzbdRef}
|
<img src="/img/logo.png" alt="" width={86} height={86} />
|
||||||
className={"absolute right-0 top-0"}
|
|
||||||
src={"https://github.com/walkxcode/dashboard-icons/blob/main/png/sabnzbd.png?raw=true"}
|
|
||||||
alt={"Sabnzbd"}
|
|
||||||
width={50}
|
|
||||||
height={50}
|
|
||||||
/>
|
|
||||||
|
|
||||||
<LineTree start={sonarrRef} end={homarrRef} startSocket={"right"} endSocket={"left"} />
|
|
||||||
<LineTree start={radarrRef} end={homarrRef} startSocket={"right"} endSocket={"left"} />
|
|
||||||
<LineTree start={lidarrRef} end={homarrRef} startSocket={"right"} endSocket={"left"} />
|
|
||||||
<LineTree start={plexRef} end={homarrRef} startSocket={"left"} endSocket={"right"} x={100} />
|
|
||||||
<LineTree start={jellyfinRef} end={homarrRef} startSocket={"left"} endSocket={"right"} x={100} />
|
|
||||||
<LineTree start={sabnzbdRef} end={homarrRef} startSocket={"left"} endSocket={"right"} x={100} />
|
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
);
|
</section>
|
||||||
};
|
);
|
||||||
|
|
||||||
export const LineTree = ({
|
|
||||||
start,
|
|
||||||
end,
|
|
||||||
startSocket,
|
|
||||||
endSocket,
|
|
||||||
x = 0,
|
|
||||||
}: {
|
|
||||||
start: any;
|
|
||||||
end: any;
|
|
||||||
startSocket: SocketType;
|
|
||||||
endSocket: SocketType;
|
|
||||||
x?: number;
|
|
||||||
}) => {
|
|
||||||
const line = useRef<LeaderLine | null>(null);
|
|
||||||
let leaderLine: LeaderLine;
|
|
||||||
|
|
||||||
React.useEffect(() => {
|
|
||||||
const drawLine = () => {
|
|
||||||
leaderLine = new LeaderLine(start.current, LeaderLine.pointAnchor(end.current, { x: `${x}%` }), {
|
|
||||||
startSocket: startSocket,
|
|
||||||
endSocket: endSocket,
|
|
||||||
color: "var(--ifm-color-primary)",
|
|
||||||
size: 3,
|
|
||||||
dash: {
|
|
||||||
animation: true,
|
|
||||||
},
|
|
||||||
});
|
|
||||||
};
|
|
||||||
const timer = setInterval(() => {
|
|
||||||
if (start.current) {
|
|
||||||
clearInterval(timer);
|
|
||||||
drawLine();
|
|
||||||
}
|
|
||||||
}, 5);
|
|
||||||
return () => {
|
|
||||||
timer && clearInterval(timer);
|
|
||||||
leaderLine.remove();
|
|
||||||
};
|
|
||||||
}, []);
|
|
||||||
|
|
||||||
React.useEffect(() => {
|
|
||||||
// scroll and resize listeners could be assigned here
|
|
||||||
setTimeout(() => {
|
|
||||||
// skip current even loop and wait
|
|
||||||
// the end of parent's render call
|
|
||||||
if (line.current && end?.current) {
|
|
||||||
(line.current as any).position();
|
|
||||||
}
|
|
||||||
}, 0);
|
|
||||||
});
|
|
||||||
|
|
||||||
return null;
|
|
||||||
};
|
|
||||||
@@ -1,22 +1,100 @@
|
|||||||
|
import { translate } from "@docusaurus/Translate";
|
||||||
|
import { IconBrandDocker, IconCpu, IconDeviceDesktopAnalytics } from "@tabler/icons-react";
|
||||||
|
|
||||||
|
import styles from "../../../../pages/index.module.css";
|
||||||
import { AppWidget } from "./widgets/app-widget";
|
import { AppWidget } from "./widgets/app-widget";
|
||||||
import { ClockWidget } from "./widgets/clock-widget";
|
import { ClockWidget } from "./widgets/clock-widget";
|
||||||
import { DownloadsWidget } from "./widgets/downloads-widget";
|
import { DownloadsWidget } from "./widgets/downloads-widget";
|
||||||
import { WeatherWidget } from "./widgets/weather-widget";
|
|
||||||
import { StockWidget } from "./widgets/stock-widget";
|
|
||||||
import { EntityStateWidget } from "./widgets/entity-state-widget";
|
import { EntityStateWidget } from "./widgets/entity-state-widget";
|
||||||
|
import { StockWidget } from "./widgets/stock-widget";
|
||||||
|
import { WeatherWidget } from "./widgets/weather-widget";
|
||||||
|
import { WidgetCard } from "./widgets/card";
|
||||||
|
|
||||||
export const HeroCards = () => {
|
export const HeroCards = () => {
|
||||||
return (
|
return (
|
||||||
<div className="argos-ignore hero-cards flex flex-wrap max-w-[504px] gap-y-4 gap-x-3 text-gray-700 dark:text-gray-300">
|
<div className={`argos-ignore hero-cards ${styles.heroCards}`}>
|
||||||
<StockWidget />
|
<StockWidget />
|
||||||
<AppWidget />
|
<AppWidget name="Plex" />
|
||||||
<AppWidget className="hidden 3xl:block" />
|
<AppWidget name="Jellyfin" />
|
||||||
<WeatherWidget />
|
<AppWidget name="Homeassistant" label="Home Assistant" />
|
||||||
<DownloadsWidget />
|
|
||||||
<EntityStateWidget />
|
|
||||||
<AppWidget />
|
|
||||||
|
|
||||||
<ClockWidget />
|
<ClockWidget />
|
||||||
|
<SystemResourcesWidget />
|
||||||
|
<WeatherWidget />
|
||||||
|
<EntityStateWidget />
|
||||||
|
<AppWidget name="PiHole" label="Pi-hole" />
|
||||||
|
<AppWidget name="qBittorrent" />
|
||||||
|
<DownloadsWidget />
|
||||||
|
<DockerWidget />
|
||||||
|
<AppWidget name="Sonarr" />
|
||||||
|
<AppWidget name="Radarr" />
|
||||||
</div>
|
</div>
|
||||||
);
|
);
|
||||||
};
|
};
|
||||||
|
|
||||||
|
const heroLabels = {
|
||||||
|
systemResources: translate({ id: "homepage.preview.systemResources", message: "System resources" }),
|
||||||
|
online: translate({ id: "homepage.preview.online", message: "Online" }),
|
||||||
|
cpu: translate({ id: "homepage.preview.cpu", message: "CPU" }),
|
||||||
|
memory: translate({ id: "homepage.preview.memory", message: "Memory" }),
|
||||||
|
disk: translate({ id: "homepage.preview.disk", message: "Disk" }),
|
||||||
|
docker: translate({ id: "homepage.preview.docker", message: "Docker" }),
|
||||||
|
dockerSummary: translate({ id: "homepage.preview.dockerSummary", message: "2 running · 1 failed" }),
|
||||||
|
healthy: translate({ id: "homepage.preview.healthy", message: "Healthy" }),
|
||||||
|
running: translate({ id: "homepage.preview.running", message: "Running" }),
|
||||||
|
exited: translate({ id: "homepage.preview.exited", message: "Exited" }),
|
||||||
|
};
|
||||||
|
|
||||||
|
const SystemResourcesWidget = () => (
|
||||||
|
<WidgetCard width={2} className={styles.resourcesWidget}>
|
||||||
|
<div className={styles.widgetHeading}>
|
||||||
|
<span className={styles.widgetTitle}>
|
||||||
|
<IconDeviceDesktopAnalytics size={17} aria-hidden="true" />
|
||||||
|
{heroLabels.systemResources}
|
||||||
|
</span>
|
||||||
|
<span className={styles.onlineStatus}>{heroLabels.online}</span>
|
||||||
|
</div>
|
||||||
|
<ResourceMeter icon={<IconCpu size={15} aria-hidden="true" />} label={heroLabels.cpu} value={34} />
|
||||||
|
<ResourceMeter label={heroLabels.memory} value={62} />
|
||||||
|
<ResourceMeter label={heroLabels.disk} value={98} />
|
||||||
|
</WidgetCard>
|
||||||
|
);
|
||||||
|
|
||||||
|
const ResourceMeter = ({ icon, label, value }: { icon?: React.ReactNode; label: string; value: number }) => (
|
||||||
|
<div className={`${styles.resourceMeter} ${value >= 90 ? styles.resourceMeterCritical : ""}`}>
|
||||||
|
<div className={styles.resourceLabel}>
|
||||||
|
<span>
|
||||||
|
{icon}
|
||||||
|
{label}
|
||||||
|
</span>
|
||||||
|
<span>{value}%</span>
|
||||||
|
</div>
|
||||||
|
<progress className={styles.resourceTrack} aria-label={`${label} usage`} max={100} value={value} />
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
|
||||||
|
const DockerWidget = () => (
|
||||||
|
<WidgetCard width={2} className={styles.dockerWidget}>
|
||||||
|
<div className={styles.widgetHeading}>
|
||||||
|
<span className={styles.widgetTitle}>
|
||||||
|
<IconBrandDocker size={18} aria-hidden="true" />
|
||||||
|
{heroLabels.docker}
|
||||||
|
</span>
|
||||||
|
<span className={styles.dockerCount}>{heroLabels.dockerSummary}</span>
|
||||||
|
</div>
|
||||||
|
<div className={styles.containerList}>
|
||||||
|
{[
|
||||||
|
{ name: "immich", status: heroLabels.healthy, failed: false },
|
||||||
|
{ name: "jellyfin", status: heroLabels.running, failed: false },
|
||||||
|
{ name: "paperless", status: heroLabels.exited, failed: true },
|
||||||
|
].map(({ name, status, failed }) => (
|
||||||
|
<div className={`${styles.containerRow} ${failed ? styles.containerRowFailed : ""}`} key={name}>
|
||||||
|
<span className={styles.containerName}>{name}</span>
|
||||||
|
<span className={styles.containerStatus}>
|
||||||
|
<span className={`${styles.statusDot} ${failed ? styles.statusDotFailed : ""}`} aria-hidden="true" />
|
||||||
|
{status}
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
))}
|
||||||
|
</div>
|
||||||
|
</WidgetCard>
|
||||||
|
);
|
||||||
@@ -1,4 +1,5 @@
|
|||||||
import Link from "@docusaurus/Link";
|
import Link from "@docusaurus/Link";
|
||||||
|
import { translate } from "@docusaurus/Translate";
|
||||||
import { IconDownload, IconExternalLink } from "@tabler/icons-react";
|
import { IconDownload, IconExternalLink } from "@tabler/icons-react";
|
||||||
import clsx from "clsx";
|
import clsx from "clsx";
|
||||||
import styles from "../../../../pages/index.module.css";
|
import styles from "../../../../pages/index.module.css";
|
||||||
@@ -7,9 +8,9 @@ import { HeroCards } from "./hero-cards";
|
|||||||
export default function HomeHero() {
|
export default function HomeHero() {
|
||||||
return (
|
return (
|
||||||
<header className={clsx("hero hero--primary", styles.heroBanner, styles.hero)}>
|
<header className={clsx("hero hero--primary", styles.heroBanner, styles.hero)}>
|
||||||
<div className="flex">
|
<div className={styles.heroContent}>
|
||||||
<div className="ps-0 lg:ps-52">
|
<div className={styles.heroCopy}>
|
||||||
<h1 className="font-extrabold lg:text-7xl text-3xl">
|
<h1 className={clsx("font-extrabold lg:text-7xl text-3xl", styles.heroTitle)}>
|
||||||
A simple, yet
|
A simple, yet
|
||||||
<br />
|
<br />
|
||||||
powerful dashboard
|
powerful dashboard
|
||||||
@@ -22,7 +23,7 @@ export default function HomeHero() {
|
|||||||
information.
|
information.
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<div className={"flex flex-nowrap gap-2"}>
|
<div className={styles.heroActions}>
|
||||||
<Link
|
<Link
|
||||||
data-attr="Install button"
|
data-attr="Install button"
|
||||||
className={"button button--secondary button--lg rounded-3xl dark:border-zinc-600 dark:bg-zinc-800"}
|
className={"button button--secondary button--lg rounded-3xl dark:border-zinc-600 dark:bg-zinc-800"}
|
||||||
@@ -57,9 +58,12 @@ export default function HomeHero() {
|
|||||||
</Link>
|
</Link>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<div className="flex-grow-1 w-full lg:block hidden hover-animation">
|
<section
|
||||||
|
className={clsx(styles.heroPreview, "hover-animation")}
|
||||||
|
aria-label={translate({ id: "homepage.preview.label", message: "Example Homarr dashboard" })}
|
||||||
|
>
|
||||||
<HeroCards />
|
<HeroCards />
|
||||||
</div>
|
</section>
|
||||||
</div>
|
</div>
|
||||||
</header>
|
</header>
|
||||||
);
|
);
|
||||||
|
|||||||
@@ -1,20 +1,21 @@
|
|||||||
import { supportedIntegrations } from "@site/src/constants/supported-integrations";
|
import { supportedIntegrations } from "@site/src/constants/supported-integrations";
|
||||||
import { CommonWidgetProps, WidgetCard } from "./card";
|
import { CommonWidgetProps, WidgetCard } from "./card";
|
||||||
import { getRndInteger } from "@site/src/tools/math";
|
|
||||||
import clsx from "clsx";
|
import clsx from "clsx";
|
||||||
|
|
||||||
export const AppWidget = ({ className }: CommonWidgetProps) => {
|
interface AppWidgetProps extends CommonWidgetProps {
|
||||||
const randomApp = supportedIntegrations[getRndInteger(0, supportedIntegrations.length - 1)];
|
name: string;
|
||||||
|
label?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export const AppWidget = ({ name, label, className }: AppWidgetProps) => {
|
||||||
|
const app = supportedIntegrations.find((integration) => integration.name === name);
|
||||||
|
if (!app) return null;
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<WidgetCard width={1} className={clsx("text-center", className)}>
|
<WidgetCard width={1} className={clsx("app-card text-center", className)}>
|
||||||
<span className={"text-sm font-bold"}>{randomApp.name}</span>
|
<span className={"text-sm font-bold"}>{label ?? app.name}</span>
|
||||||
<img
|
<img src={app.iconUrl} className="aspect-square scale-[0.6]" alt="" />
|
||||||
src={randomApp.iconUrl}
|
<div className="absolute bottom-3 right-3 rounded-full bg-green-500 w-2 h-2" aria-hidden="true" />
|
||||||
className="aspect-square scale-[0.6] transition-transform"
|
|
||||||
alt={`${randomApp.name} Icon`}
|
|
||||||
/>
|
|
||||||
<div className="absolute bottom-3 right-3 rounded-full bg-green-500 w-2 h-2"></div>
|
|
||||||
</WidgetCard>
|
</WidgetCard>
|
||||||
);
|
);
|
||||||
};
|
};
|
||||||
@@ -1,5 +1,6 @@
|
|||||||
import clsx from "clsx";
|
import clsx from "clsx";
|
||||||
import { ReactNode } from "react";
|
import { ReactNode } from "react";
|
||||||
|
import styles from "../../../../../pages/index.module.css";
|
||||||
|
|
||||||
export interface CommonWidgetProps {
|
export interface CommonWidgetProps {
|
||||||
className?: string;
|
className?: string;
|
||||||
@@ -16,15 +17,13 @@ export const WidgetCard = ({ width, children, className, onClick }: WidgetCardPr
|
|||||||
return (
|
return (
|
||||||
<Component
|
<Component
|
||||||
className={clsx(
|
className={clsx(
|
||||||
"rounded-xl flex flex-col justify-center items-center p-2 relative border-none bg-[var(--ifm-navbar-background-color)]",
|
styles.widgetCard,
|
||||||
|
"flex flex-col justify-center items-center p-2 relative border-none bg-[var(--ifm-navbar-background-color)]",
|
||||||
className,
|
className,
|
||||||
onClick ? "cursor-pointer" : undefined,
|
onClick ? "cursor-pointer" : undefined,
|
||||||
)}
|
)}
|
||||||
style={{
|
style={{ width: (128 * width + (width === 2 ? 16 : 0)) * 0.9, height: 128 }}
|
||||||
width: (128 * width + (width === 2 ? 16 : 0)) * 0.9,
|
type={onClick ? "button" : undefined}
|
||||||
height: 128,
|
|
||||||
background: "rgb(from var(--ifm-navbar-background-color) r g b / 80%)",
|
|
||||||
}}
|
|
||||||
onClick={onClick}
|
onClick={onClick}
|
||||||
>
|
>
|
||||||
{children}
|
{children}
|
||||||
|
|||||||
@@ -1,26 +1,40 @@
|
|||||||
import { getRndInteger } from "@site/src/tools/math";
|
import { translate } from "@docusaurus/Translate";
|
||||||
import { useEffect, useState } from "react";
|
import { useEffect, useState } from "react";
|
||||||
import { CommonWidgetProps, WidgetCard } from "./card";
|
import { CommonWidgetProps, WidgetCard } from "./card";
|
||||||
import clsx from "clsx";
|
import clsx from "clsx";
|
||||||
import { generateSlug } from "random-word-slugs";
|
import styles from "../../../../../pages/index.module.css";
|
||||||
|
|
||||||
|
const downloadQueue = ["family-photos.zip", "linux-isos.mkv", "server-backup.zip", "holiday-video.mp4"];
|
||||||
|
const downloadLabels = {
|
||||||
|
file: translate({ id: "homepage.preview.file", message: "File" }),
|
||||||
|
progress: translate({ id: "homepage.preview.progress", message: "Progress" }),
|
||||||
|
};
|
||||||
|
|
||||||
export const DownloadsWidget = ({ className }: CommonWidgetProps) => {
|
export const DownloadsWidget = ({ className }: CommonWidgetProps) => {
|
||||||
const [downloads, setDownloads] = useState<Download[]>([]);
|
const [downloads, setDownloads] = useState<Download[]>([
|
||||||
|
{ filename: "photos-backup.zip", progress: 72 },
|
||||||
|
{ filename: "media-library.mkv", progress: 38 },
|
||||||
|
]);
|
||||||
|
|
||||||
useEffect(() => {
|
useEffect(() => {
|
||||||
const intervalId = setInterval(() => {
|
const intervalId = setInterval(() => {
|
||||||
setDownloads((prev: Download[]) => {
|
setDownloads((prev: Download[]) => {
|
||||||
const filteredPrev = prev.filter((download) => download.progress !== 100);
|
const filteredPrev = prev.filter((download) => download.progress !== 100);
|
||||||
|
|
||||||
filteredPrev.forEach((download, index) => {
|
const progressedDownloads = filteredPrev.map((download, index) => ({
|
||||||
download.progress = Math.min(100, download.progress + getRndInteger(0, index < 2 ? 16 : 8));
|
...download,
|
||||||
});
|
progress: Math.min(100, download.progress + (index < 2 ? 8 : 4)),
|
||||||
|
}));
|
||||||
|
|
||||||
if (filteredPrev.length < 3 && filteredPrev.length === prev.length) {
|
if (progressedDownloads.length < 3 && progressedDownloads.length === prev.length) {
|
||||||
filteredPrev.push(generateRandomDownload());
|
const availableDownloads = downloadQueue.filter(
|
||||||
|
(filename) => !progressedDownloads.some((download) => download.filename === filename),
|
||||||
|
);
|
||||||
|
const filename = availableDownloads[0];
|
||||||
|
if (filename) progressedDownloads.push({ filename, progress: 0 });
|
||||||
}
|
}
|
||||||
|
|
||||||
return [...filteredPrev];
|
return progressedDownloads;
|
||||||
});
|
});
|
||||||
}, 500);
|
}, 500);
|
||||||
|
|
||||||
@@ -34,19 +48,31 @@ export const DownloadsWidget = ({ className }: CommonWidgetProps) => {
|
|||||||
<table className="mb-0 w-full h-full text-xs">
|
<table className="mb-0 w-full h-full text-xs">
|
||||||
<thead className="inline-block w-full">
|
<thead className="inline-block w-full">
|
||||||
<tr className="inline-block w-full">
|
<tr className="inline-block w-full">
|
||||||
<th className="border-none px-2 py-1 text-start inline-block w-1/2">File</th>
|
<th className="border-none px-2 py-1 text-start inline-block w-1/2">{downloadLabels.file}</th>
|
||||||
<th className="border-none px-2 py-1 text-start inline-block w-1/2">Progress</th>
|
<th className="border-none px-2 py-1 text-start inline-block w-1/2">{downloadLabels.progress}</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
{downloads.map((file: Download, index: number) => {
|
{downloads.map((file: Download) => {
|
||||||
return (
|
return (
|
||||||
<tr key={index}>
|
<tr key={file.filename}>
|
||||||
<td className="border-none text-nowrap p-2">{file.filename}</td>
|
<td className="border-none text-nowrap p-2">{file.filename}</td>
|
||||||
<td className="border-none p-2 w-full">
|
<td
|
||||||
<div className="overflow-hidden rounded-xl h-2 w-full bg-zinc-600">
|
className="border-none p-2 w-full"
|
||||||
<div className="bg-green-600 h-full animated-width" style={{ width: `${file.progress}%` }}></div>
|
aria-label={translate(
|
||||||
</div>
|
{ id: "homepage.preview.downloadComplete", message: "{progress}% complete" },
|
||||||
|
{ progress: file.progress },
|
||||||
|
)}
|
||||||
|
>
|
||||||
|
<progress
|
||||||
|
className={styles.downloadProgress}
|
||||||
|
value={file.progress}
|
||||||
|
max={100}
|
||||||
|
aria-label={translate(
|
||||||
|
{ id: "homepage.preview.downloadProgress", message: "{filename} download progress" },
|
||||||
|
{ filename: file.filename },
|
||||||
|
)}
|
||||||
|
/>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
);
|
);
|
||||||
@@ -61,15 +87,3 @@ interface Download {
|
|||||||
filename: string;
|
filename: string;
|
||||||
progress: number;
|
progress: number;
|
||||||
}
|
}
|
||||||
|
|
||||||
const formats = ["mkv", "mp4"];
|
|
||||||
|
|
||||||
const generateRandomDownload = (): Download => {
|
|
||||||
const randomMovie = generateSlug(2);
|
|
||||||
const randomFormat = formats[getRndInteger(0, formats.length - 1)];
|
|
||||||
|
|
||||||
return {
|
|
||||||
filename: `${randomMovie}.${randomFormat}`,
|
|
||||||
progress: 0,
|
|
||||||
};
|
|
||||||
};
|
|
||||||
@@ -27,6 +27,7 @@ export const StockWidget = ({ className }: CommonWidgetProps) => {
|
|||||||
HOMR
|
HOMR
|
||||||
</div>
|
</div>
|
||||||
<Line
|
<Line
|
||||||
|
ariaLabel="Simulated HOMR stock price trend"
|
||||||
height={128}
|
height={128}
|
||||||
width={244}
|
width={244}
|
||||||
colors={[upwardTrend ? "green" : "red"]}
|
colors={[upwardTrend ? "green" : "red"]}
|
||||||
|
|||||||
@@ -1,10 +1,10 @@
|
|||||||
import { IconArrowsMaximize, IconLayoutGrid, IconMouse2, IconRefresh } from "@tabler/icons-react";
|
import { IconArrowsMaximize, IconLayoutGrid, IconMouse2, IconPlus } from "@tabler/icons-react";
|
||||||
|
|
||||||
const advancedInteraction = {
|
const advancedInteraction = {
|
||||||
icon: IconArrowsMaximize,
|
icon: IconArrowsMaximize,
|
||||||
title: "Advanced view",
|
title: "Advanced view",
|
||||||
description:
|
description:
|
||||||
"Supported widgets explicitly opt into advanced view. Focus a widget and press Shift + Enter, hold Shift while hovering for about 500 ms, or choose Open advanced view from its menu. It is unavailable in edit mode and remains compact-only on widgets that do not opt in.",
|
"Hold Shift while hovering for an in-place preview, press Shift + Enter, or choose Open advanced view from the widget menu.",
|
||||||
} as const;
|
} as const;
|
||||||
|
|
||||||
const standardInteractions = [
|
const standardInteractions = [
|
||||||
@@ -12,19 +12,19 @@ const standardInteractions = [
|
|||||||
icon: IconMouse2,
|
icon: IconMouse2,
|
||||||
title: "Widget actions",
|
title: "Widget actions",
|
||||||
description:
|
description:
|
||||||
"Signed-in users can open the widget context menu outside edit mode when Enable right click on widgets is enabled. App tiles are excluded. Settings, quick options, and integration actions appear or enable only when the widget and your board or integration permissions allow them.",
|
"Right-click for live query status, refresh, settings, quick options, and actions supported by the widget.",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
icon: IconPlus,
|
||||||
|
title: "Place it precisely",
|
||||||
|
description:
|
||||||
|
"With board changes allowed, right-click or touch and hold empty grid space to add there. Keyboard users can press Shift + F10.",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
icon: IconLayoutGrid,
|
icon: IconLayoutGrid,
|
||||||
title: "Adaptive detail",
|
title: "Adaptive detail",
|
||||||
description:
|
description:
|
||||||
"Resize a widget to tune its density. Compact layouts hide lower-priority details and controls as space shrinks; compact-only widgets adapt in place instead of opening a separate advanced view.",
|
"Resize a widget to tune its density. Compact views keep primary status visible, then reveal details and controls as space or intent allows.",
|
||||||
},
|
|
||||||
{
|
|
||||||
icon: IconRefresh,
|
|
||||||
title: "Data status",
|
|
||||||
description:
|
|
||||||
"Widgets distinguish initial loading, successful empty results, terminal errors, stale cached data, and partial integration failures as applicable. Initial loads use a loading state, empty results use an empty state, and terminal failures can offer retry; retained data can stay visible with a stale warning, while healthy integrations can remain visible when another source fails. The shared menu reports Loading while matching active queries fetch, Idle when none are active, Error when any match is in error, otherwise Success with the latest data age when available. Refresh refetches only active queries owned by that widget and view and is disabled while they fetch.",
|
|
||||||
},
|
},
|
||||||
] as const;
|
] as const;
|
||||||
|
|
||||||
@@ -35,12 +35,14 @@ export const WidgetInteractionGuide = ({ advancedView = true }: { advancedView?:
|
|||||||
<details className="group my-6 overflow-hidden rounded-xl border border-solid border-[#e5e7eb] bg-slate-50/70 dark:border-[#333] dark:bg-gray-900/40">
|
<details className="group my-6 overflow-hidden rounded-xl border border-solid border-[#e5e7eb] bg-slate-50/70 dark:border-[#333] dark:bg-gray-900/40">
|
||||||
<summary className="flex cursor-pointer list-none items-center justify-between gap-3 px-4 py-3 font-semibold marker:hidden">
|
<summary className="flex cursor-pointer list-none items-center justify-between gap-3 px-4 py-3 font-semibold marker:hidden">
|
||||||
<span>Power-user controls</span>
|
<span>Power-user controls</span>
|
||||||
<span className="text-xs font-normal text-[#696969] group-open:hidden dark:text-[#999]">Show controls</span>
|
<span className="text-xs font-normal text-[#696969] group-open:hidden dark:text-[#999]">Show shortcuts</span>
|
||||||
<span className="hidden text-xs font-normal text-[#696969] group-open:inline dark:text-[#999]">
|
<span className="hidden text-xs font-normal text-[#696969] group-open:inline dark:text-[#999]">
|
||||||
Hide controls
|
Hide shortcuts
|
||||||
</span>
|
</span>
|
||||||
</summary>
|
</summary>
|
||||||
<div className="grid gap-3 border-0 border-t border-solid border-[#e5e7eb] p-4 md:grid-cols-2 xl:grid-cols-4 dark:border-[#333]">
|
<div
|
||||||
|
className={`grid gap-3 border-0 border-t border-solid border-[#e5e7eb] p-4 md:grid-cols-2 ${advancedView ? "xl:grid-cols-4" : "xl:grid-cols-3"} dark:border-[#333]`}
|
||||||
|
>
|
||||||
{interactions.map(({ icon: Icon, title, description }) => (
|
{interactions.map(({ icon: Icon, title, description }) => (
|
||||||
<div key={title} className="rounded-lg bg-white p-3 shadow-sm dark:bg-gray-950">
|
<div key={title} className="rounded-lg bg-white p-3 shadow-sm dark:bg-gray-950">
|
||||||
<Icon aria-hidden size={20} stroke={1.5} className="mb-2 stroke-red-500" />
|
<Icon aria-hidden size={20} stroke={1.5} className="mb-2 stroke-red-500" />
|
||||||
@@ -51,13 +53,8 @@ export const WidgetInteractionGuide = ({ advancedView = true }: { advancedView?:
|
|||||||
</div>
|
</div>
|
||||||
{advancedView && (
|
{advancedView && (
|
||||||
<p className="m-0 px-4 pb-4 text-xs text-[#696969] dark:text-[#999]">
|
<p className="m-0 px-4 pb-4 text-xs text-[#696969] dark:text-[#999]">
|
||||||
Advanced view reuses existing data where possible; some widgets request additional or denser data. Hold Shift
|
Advanced view reuses the widget's live data and cache. The rest of the board stays visible but dimmed. On
|
||||||
while hovering a supported widget for a temporary preview; it opens after about 500 ms and closes when Shift
|
touch devices, use the widget menu; compact-only widgets adapt in place instead.
|
||||||
is released, the pointer leaves, or the window loses focus. For a persistent view, focus the widget and press
|
|
||||||
Shift + Enter or use Open advanced view from its menu. Manual view closes with Escape after nested menus or
|
|
||||||
popovers handle their own Escape, its close button, or the backdrop; it restores focus, traps focus, and locks
|
|
||||||
background scrolling. Shift + wheel scrolls a scrollable advanced panel when it can consume the event. On
|
|
||||||
touch devices, use the widget menu when available; compact-only widgets adapt in place instead.
|
|
||||||
</p>
|
</p>
|
||||||
)}
|
)}
|
||||||
</details>
|
</details>
|
||||||
|
|||||||
@@ -758,7 +758,7 @@ const MarketplaceDetail = ({ workshopUrl }: { workshopUrl: string }) => {
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<Link
|
<Link
|
||||||
to="/docs/management/workshop/"
|
to="/docs/workshop/"
|
||||||
className="mt-4 inline-flex items-center gap-1.5 text-sm font-medium text-primary hover:underline"
|
className="mt-4 inline-flex items-center gap-1.5 text-sm font-medium text-primary hover:underline"
|
||||||
>
|
>
|
||||||
Installation guide <IconExternalLink size={13} />
|
Installation guide <IconExternalLink size={13} />
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
@import url("https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500;600&display=swap");
|
@import "https://fonts.googleapis.com/css2?family=JetBrains+Mono:wght@400;500;600&family=Work+Sans:wght@400;500;600;700&display=swap";
|
||||||
@import "tailwindcss/theme" layer(theme);
|
@import "tailwindcss/theme" layer(theme);
|
||||||
@import "tailwindcss/utilities" layer(utilities);
|
@import "tailwindcss/utilities" layer(utilities);
|
||||||
|
|
||||||
@@ -10,7 +10,7 @@
|
|||||||
--breakpoint-3xl: 1697px;
|
--breakpoint-3xl: 1697px;
|
||||||
|
|
||||||
--font-heading: var(--font-sans);
|
--font-heading: var(--font-sans);
|
||||||
--font-sans: "Inter", sans-serif;
|
--font-sans: "Work Sans", sans-serif;
|
||||||
|
|
||||||
--color-background: var(--background);
|
--color-background: var(--background);
|
||||||
--color-foreground: var(--foreground);
|
--color-foreground: var(--foreground);
|
||||||
@@ -137,7 +137,7 @@
|
|||||||
--sidebar-border: oklch(0.9276 0.0058 264.5313);
|
--sidebar-border: oklch(0.9276 0.0058 264.5313);
|
||||||
--sidebar-ring: oklch(0.56 0.205 25.6509);
|
--sidebar-ring: oklch(0.56 0.205 25.6509);
|
||||||
--destructive-foreground: oklch(0.9851 0 0);
|
--destructive-foreground: oklch(0.9851 0 0);
|
||||||
--font-sans: "Inter", sans-serif;
|
--font-sans: "Work Sans", sans-serif;
|
||||||
--font-serif: Georgia, serif;
|
--font-serif: Georgia, serif;
|
||||||
--font-mono: "JetBrains Mono", monospace;
|
--font-mono: "JetBrains Mono", monospace;
|
||||||
--shadow-color: #000000;
|
--shadow-color: #000000;
|
||||||
@@ -491,6 +491,10 @@ html[data-theme="dark"] div#__docusaurus div[role="banner"] button svg {
|
|||||||
}
|
}
|
||||||
|
|
||||||
@media (prefers-reduced-motion: reduce) {
|
@media (prefers-reduced-motion: reduce) {
|
||||||
|
.hover-animation {
|
||||||
|
animation: none;
|
||||||
|
}
|
||||||
|
|
||||||
.submit-step-enter {
|
.submit-step-enter {
|
||||||
animation: none;
|
animation: none;
|
||||||
}
|
}
|
||||||
@@ -541,7 +545,7 @@ html[data-theme="dark"] div#__docusaurus div[role="banner"] button svg {
|
|||||||
--sidebar-accent-foreground: oklch(0.6646 0.2222 25.6509);
|
--sidebar-accent-foreground: oklch(0.6646 0.2222 25.6509);
|
||||||
--sidebar-border: oklch(0.2739 0.0055 286.0326);
|
--sidebar-border: oklch(0.2739 0.0055 286.0326);
|
||||||
--sidebar-ring: oklch(0.72 0.16 25.6509);
|
--sidebar-ring: oklch(0.72 0.16 25.6509);
|
||||||
--font-sans: "Inter", sans-serif;
|
--font-sans: "Work Sans", sans-serif;
|
||||||
--font-serif: Georgia, serif;
|
--font-serif: Georgia, serif;
|
||||||
--font-mono: "JetBrains Mono", monospace;
|
--font-mono: "JetBrains Mono", monospace;
|
||||||
--shadow-color: #000000;
|
--shadow-color: #000000;
|
||||||
|
|||||||
@@ -28,13 +28,457 @@ section {
|
|||||||
}
|
}
|
||||||
|
|
||||||
.heroBanner {
|
.heroBanner {
|
||||||
padding: 4rem;
|
padding: clamp(3rem, 6vw, 6rem) clamp(1.25rem, 4vw, 4rem);
|
||||||
position: relative;
|
position: relative;
|
||||||
overflow: hidden;
|
overflow: hidden;
|
||||||
}
|
}
|
||||||
|
|
||||||
@media screen and (max-width: 996px) {
|
.heroContent {
|
||||||
.heroBanner {
|
display: grid;
|
||||||
padding: 2rem;
|
grid-template-columns: minmax(25rem, 1fr) minmax(44rem, 48rem);
|
||||||
|
align-items: center;
|
||||||
|
gap: clamp(1rem, 3vw, 3rem);
|
||||||
|
max-width: 108rem;
|
||||||
|
margin-inline: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
.heroCopy {
|
||||||
|
max-width: 52rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.heroTitle {
|
||||||
|
text-wrap: balance;
|
||||||
|
}
|
||||||
|
|
||||||
|
.heroActions {
|
||||||
|
display: flex;
|
||||||
|
flex-wrap: wrap;
|
||||||
|
gap: 0.5rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.heroPreview {
|
||||||
|
min-width: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.heroCards {
|
||||||
|
display: flex;
|
||||||
|
flex-wrap: wrap;
|
||||||
|
gap: 1rem 0.75rem;
|
||||||
|
width: min(100%, 48rem);
|
||||||
|
margin-inline: auto;
|
||||||
|
color: #343a40;
|
||||||
|
}
|
||||||
|
|
||||||
|
:global([data-theme="dark"]) .heroCards {
|
||||||
|
color: #dee2e6;
|
||||||
|
}
|
||||||
|
|
||||||
|
.widgetCard {
|
||||||
|
flex: none;
|
||||||
|
min-width: 0;
|
||||||
|
border-radius: 0.75rem;
|
||||||
|
border: 1px solid color-mix(in srgb, currentcolor 12%, transparent) !important;
|
||||||
|
color: inherit;
|
||||||
|
font: inherit;
|
||||||
|
background: color-mix(in srgb, var(--ifm-navbar-background-color) 76%, transparent) !important;
|
||||||
|
backdrop-filter: blur(12px);
|
||||||
|
box-shadow: 0 12px 28px rgb(31 41 55 / 14%);
|
||||||
|
}
|
||||||
|
|
||||||
|
.resourcesWidget,
|
||||||
|
.dockerWidget {
|
||||||
|
align-items: stretch !important;
|
||||||
|
justify-content: flex-start !important;
|
||||||
|
gap: 0.5rem;
|
||||||
|
padding: 0.75rem !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
.widgetHeading,
|
||||||
|
.resourceLabel,
|
||||||
|
.containerRow {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
justify-content: space-between;
|
||||||
|
gap: 0.5rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.widgetTitle {
|
||||||
|
display: inline-flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 0.375rem;
|
||||||
|
min-width: 0;
|
||||||
|
font-size: 0.8125rem;
|
||||||
|
font-weight: 700;
|
||||||
|
}
|
||||||
|
|
||||||
|
.onlineStatus,
|
||||||
|
.dockerCount {
|
||||||
|
flex: none;
|
||||||
|
font-size: 0.6875rem;
|
||||||
|
font-weight: 600;
|
||||||
|
}
|
||||||
|
|
||||||
|
.onlineStatus {
|
||||||
|
color: #087f5b;
|
||||||
|
}
|
||||||
|
|
||||||
|
:global([data-theme="dark"]) .onlineStatus {
|
||||||
|
color: #69dbb1;
|
||||||
|
}
|
||||||
|
|
||||||
|
.resourceMeter {
|
||||||
|
display: grid;
|
||||||
|
gap: 0.25rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.resourceMeterCritical .resourceLabel {
|
||||||
|
color: #a51111;
|
||||||
|
font-weight: 700;
|
||||||
|
}
|
||||||
|
|
||||||
|
.resourceLabel {
|
||||||
|
font-size: 0.6875rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.resourceLabel > span:first-child {
|
||||||
|
display: inline-flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 0.25rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.resourceTrack {
|
||||||
|
display: block;
|
||||||
|
appearance: none;
|
||||||
|
overflow: hidden;
|
||||||
|
width: 100%;
|
||||||
|
height: 0.375rem;
|
||||||
|
border: 0;
|
||||||
|
border-radius: 999px;
|
||||||
|
background: color-mix(in srgb, currentcolor 16%, transparent);
|
||||||
|
}
|
||||||
|
|
||||||
|
.resourceTrack::-webkit-progress-bar {
|
||||||
|
background: transparent;
|
||||||
|
}
|
||||||
|
|
||||||
|
.resourceTrack::-webkit-progress-value,
|
||||||
|
.resourceTrack::-moz-progress-bar {
|
||||||
|
height: 100%;
|
||||||
|
border-radius: inherit;
|
||||||
|
background: var(--ifm-color-primary);
|
||||||
|
}
|
||||||
|
|
||||||
|
.resourceMeterCritical .resourceTrack::-webkit-progress-value,
|
||||||
|
.resourceMeterCritical .resourceTrack::-moz-progress-bar {
|
||||||
|
background: #e03131;
|
||||||
|
}
|
||||||
|
|
||||||
|
.downloadProgress {
|
||||||
|
display: block;
|
||||||
|
appearance: none;
|
||||||
|
overflow: hidden;
|
||||||
|
width: 100%;
|
||||||
|
height: 0.5rem;
|
||||||
|
border: 0;
|
||||||
|
border-radius: 999px;
|
||||||
|
background: color-mix(in srgb, currentcolor 18%, transparent);
|
||||||
|
}
|
||||||
|
|
||||||
|
.downloadProgress::-webkit-progress-bar {
|
||||||
|
background: transparent;
|
||||||
|
}
|
||||||
|
|
||||||
|
.downloadProgress::-webkit-progress-value,
|
||||||
|
.downloadProgress::-moz-progress-bar {
|
||||||
|
border-radius: inherit;
|
||||||
|
background: #2f9e44;
|
||||||
|
}
|
||||||
|
|
||||||
|
.containerList {
|
||||||
|
display: grid;
|
||||||
|
gap: 0.25rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.containerRow {
|
||||||
|
font-size: 0.6875rem;
|
||||||
|
line-height: 1.25;
|
||||||
|
}
|
||||||
|
|
||||||
|
.containerName {
|
||||||
|
overflow: hidden;
|
||||||
|
font-weight: 600;
|
||||||
|
text-overflow: ellipsis;
|
||||||
|
white-space: nowrap;
|
||||||
|
}
|
||||||
|
|
||||||
|
.containerStatus {
|
||||||
|
display: inline-flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 0.25rem;
|
||||||
|
color: color-mix(in srgb, currentcolor 82%, transparent);
|
||||||
|
}
|
||||||
|
|
||||||
|
.statusDot {
|
||||||
|
width: 0.375rem;
|
||||||
|
height: 0.375rem;
|
||||||
|
border-radius: 999px;
|
||||||
|
background: #12b886;
|
||||||
|
}
|
||||||
|
|
||||||
|
.containerRowFailed {
|
||||||
|
color: #a51111;
|
||||||
|
font-weight: 700;
|
||||||
|
}
|
||||||
|
|
||||||
|
.dataflowSection {
|
||||||
|
margin-bottom: 0;
|
||||||
|
padding: clamp(4rem, 8vw, 7rem) clamp(1rem, 4vw, 3rem);
|
||||||
|
overflow: hidden;
|
||||||
|
background: rgb(0 0 0 / 10%);
|
||||||
|
}
|
||||||
|
|
||||||
|
.dataflowHeading {
|
||||||
|
max-width: 58rem;
|
||||||
|
margin: 0 auto clamp(2rem, 5vw, 4rem);
|
||||||
|
text-align: center;
|
||||||
|
}
|
||||||
|
|
||||||
|
.dataflowHeading h2 {
|
||||||
|
margin-bottom: 1rem;
|
||||||
|
font-size: clamp(2rem, 5vw, 4rem);
|
||||||
|
line-height: 1.08;
|
||||||
|
letter-spacing: -0.03em;
|
||||||
|
text-wrap: balance;
|
||||||
|
}
|
||||||
|
|
||||||
|
.dataflowHeading p {
|
||||||
|
margin: 0 auto;
|
||||||
|
max-width: 42rem;
|
||||||
|
color: color-mix(in srgb, var(--ifm-font-color-base) 76%, transparent);
|
||||||
|
font-size: clamp(1rem, 2vw, 1.25rem);
|
||||||
|
text-wrap: pretty;
|
||||||
|
}
|
||||||
|
|
||||||
|
.dataflowDiagram {
|
||||||
|
position: relative;
|
||||||
|
width: min(100%, 70rem);
|
||||||
|
aspect-ratio: 960 / 520;
|
||||||
|
margin-inline: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
.dataflowLines {
|
||||||
|
position: absolute;
|
||||||
|
inset: 0;
|
||||||
|
width: 100%;
|
||||||
|
height: 100%;
|
||||||
|
overflow: visible;
|
||||||
|
}
|
||||||
|
|
||||||
|
.dataflowLine,
|
||||||
|
.dataflowSignal,
|
||||||
|
.dataflowSignalReverse {
|
||||||
|
fill: none;
|
||||||
|
stroke-linecap: round;
|
||||||
|
}
|
||||||
|
|
||||||
|
.dataflowLine {
|
||||||
|
stroke: color-mix(in srgb, var(--ifm-color-primary) 30%, transparent);
|
||||||
|
stroke-width: 3;
|
||||||
|
}
|
||||||
|
|
||||||
|
.dataflowSignal,
|
||||||
|
.dataflowSignalReverse {
|
||||||
|
stroke: var(--ifm-color-primary);
|
||||||
|
stroke-width: 7;
|
||||||
|
stroke-dasharray: 0.035 0.965;
|
||||||
|
animation: dataflow-signal 2.8s linear infinite;
|
||||||
|
}
|
||||||
|
|
||||||
|
.dataflowSignalReverse {
|
||||||
|
animation-direction: reverse;
|
||||||
|
animation-delay: -1.4s;
|
||||||
|
}
|
||||||
|
|
||||||
|
.dataflowNode {
|
||||||
|
position: absolute;
|
||||||
|
display: flex;
|
||||||
|
flex-direction: column;
|
||||||
|
align-items: center;
|
||||||
|
justify-content: center;
|
||||||
|
gap: 0.5rem;
|
||||||
|
box-sizing: border-box;
|
||||||
|
width: clamp(4.5rem, 10vw, 7.5rem);
|
||||||
|
aspect-ratio: 1;
|
||||||
|
padding: clamp(0.6rem, 1.5vw, 1rem);
|
||||||
|
border-radius: 0.875rem;
|
||||||
|
color: var(--ifm-font-color-base);
|
||||||
|
background: var(--ifm-background-surface-color);
|
||||||
|
box-shadow: 0 6px 12px rgb(31 41 55 / 14%);
|
||||||
|
transform: translate(-50%, -50%);
|
||||||
|
}
|
||||||
|
|
||||||
|
.dataflowNode img {
|
||||||
|
width: clamp(2rem, 4.5vw, 3.4rem);
|
||||||
|
height: clamp(2rem, 4.5vw, 3.4rem);
|
||||||
|
object-fit: contain;
|
||||||
|
}
|
||||||
|
|
||||||
|
.dataflowCyclingIcons {
|
||||||
|
position: relative;
|
||||||
|
width: clamp(2rem, 4.5vw, 3.4rem);
|
||||||
|
aspect-ratio: 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
.dataflowCyclingIcons img {
|
||||||
|
position: absolute;
|
||||||
|
inset: 0;
|
||||||
|
width: 100%;
|
||||||
|
height: 100%;
|
||||||
|
opacity: 0;
|
||||||
|
animation: dataflow-icon-cycle linear infinite;
|
||||||
|
}
|
||||||
|
|
||||||
|
.dataflowNodeTopLeft,
|
||||||
|
.dataflowNodeMiddleLeft,
|
||||||
|
.dataflowNodeBottomLeft {
|
||||||
|
left: 15%;
|
||||||
|
}
|
||||||
|
|
||||||
|
.dataflowNodeTopRight,
|
||||||
|
.dataflowNodeMiddleRight,
|
||||||
|
.dataflowNodeBottomRight {
|
||||||
|
left: 85%;
|
||||||
|
}
|
||||||
|
|
||||||
|
.dataflowNodeTopLeft,
|
||||||
|
.dataflowNodeTopRight {
|
||||||
|
top: 16%;
|
||||||
|
}
|
||||||
|
|
||||||
|
.dataflowNodeMiddleLeft,
|
||||||
|
.dataflowNodeMiddleRight,
|
||||||
|
.dataflowHub {
|
||||||
|
top: 50%;
|
||||||
|
}
|
||||||
|
|
||||||
|
.dataflowNodeBottomLeft,
|
||||||
|
.dataflowNodeBottomRight {
|
||||||
|
top: 84%;
|
||||||
|
}
|
||||||
|
|
||||||
|
.dataflowHub {
|
||||||
|
left: 50%;
|
||||||
|
width: clamp(6rem, 13vw, 9rem);
|
||||||
|
}
|
||||||
|
|
||||||
|
.dataflowHub img {
|
||||||
|
width: clamp(3rem, 7vw, 5.4rem);
|
||||||
|
height: clamp(3rem, 7vw, 5.4rem);
|
||||||
|
}
|
||||||
|
|
||||||
|
@keyframes dataflow-signal {
|
||||||
|
to {
|
||||||
|
stroke-dashoffset: -1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@keyframes dataflow-icon-cycle {
|
||||||
|
0%,
|
||||||
|
3.7% {
|
||||||
|
opacity: 1;
|
||||||
|
transform: scale(1);
|
||||||
|
}
|
||||||
|
|
||||||
|
4.2%,
|
||||||
|
99% {
|
||||||
|
opacity: 0;
|
||||||
|
transform: scale(0.82);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
:global([data-theme="dark"]) .resourceMeterCritical .resourceLabel,
|
||||||
|
:global([data-theme="dark"]) .containerRowFailed {
|
||||||
|
color: #ffe3e3;
|
||||||
|
}
|
||||||
|
|
||||||
|
.statusDotFailed {
|
||||||
|
background: #fa5252;
|
||||||
|
animation: failed-container-pulse 1.4s ease-in-out infinite;
|
||||||
|
}
|
||||||
|
|
||||||
|
@keyframes failed-container-pulse {
|
||||||
|
50% {
|
||||||
|
opacity: 0.35;
|
||||||
|
transform: scale(1.65);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@media screen and (max-width: 1280px) {
|
||||||
|
.heroBanner {
|
||||||
|
padding: 3rem 1.5rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.heroContent {
|
||||||
|
grid-template-columns: minmax(0, 1fr);
|
||||||
|
gap: 2.5rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.heroCopy {
|
||||||
|
max-width: 46rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.heroCards {
|
||||||
|
width: min(100%, 48rem);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@media screen and (max-width: 996px) {
|
||||||
|
.heroBanner {
|
||||||
|
padding: 2.5rem 1rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.heroPreview {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.heroActions > :global(*) {
|
||||||
|
flex: 1 1 auto;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@media screen and (max-width: 640px) {
|
||||||
|
.dataflowSection {
|
||||||
|
padding-block: 4rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.dataflowHeading {
|
||||||
|
margin-bottom: 2rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.dataflowDiagram {
|
||||||
|
aspect-ratio: 4 / 5;
|
||||||
|
}
|
||||||
|
|
||||||
|
.dataflowNode {
|
||||||
|
width: 4.5rem;
|
||||||
|
padding: 0.6rem;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@media (prefers-reduced-motion: reduce) {
|
||||||
|
.statusDotFailed,
|
||||||
|
.dataflowSignal,
|
||||||
|
.dataflowSignalReverse,
|
||||||
|
.dataflowCyclingIcons img {
|
||||||
|
animation: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.dataflowSignal,
|
||||||
|
.dataflowSignalReverse {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.dataflowCyclingIcons img:first-child {
|
||||||
|
opacity: 1;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -5,9 +5,9 @@ import Layout from "@theme/Layout";
|
|||||||
import HomepageFeatures from "../components/pages/home/features/features";
|
import HomepageFeatures from "../components/pages/home/features/features";
|
||||||
import HomepageUserReviews from "../components/pages/home/review-list/review-list";
|
import HomepageUserReviews from "../components/pages/home/review-list/review-list";
|
||||||
import HomeHero from "../components/pages/home/hero/hero";
|
import HomeHero from "../components/pages/home/hero/hero";
|
||||||
|
import { DataflowVisualizationComponent } from "../components/pages/home/dataflow/dataflow";
|
||||||
|
|
||||||
import styles from "./index.module.css";
|
import styles from "./index.module.css";
|
||||||
import BrowserOnly from "@docusaurus/BrowserOnly";
|
|
||||||
import { SectionContainer } from "@site/src/components/pages/home/container/section-container";
|
import { SectionContainer } from "@site/src/components/pages/home/container/section-container";
|
||||||
import { DragAndDropShowcase } from "@site/src/components/pages/home/drag-and-drop/drag-and-drop-showcase";
|
import { DragAndDropShowcase } from "@site/src/components/pages/home/drag-and-drop/drag-and-drop-showcase";
|
||||||
import { AvailableIntegrations } from "@site/src/components/pages/home/integrations/available-integrations";
|
import { AvailableIntegrations } from "@site/src/components/pages/home/integrations/available-integrations";
|
||||||
@@ -32,13 +32,7 @@ export default function Home() {
|
|||||||
<SectionContainer>
|
<SectionContainer>
|
||||||
<HomepageFeatures />
|
<HomepageFeatures />
|
||||||
</SectionContainer>
|
</SectionContainer>
|
||||||
<BrowserOnly fallback={<span>loading...</span>}>
|
<DataflowVisualizationComponent />
|
||||||
{() => {
|
|
||||||
const DataflowVisualizationComponent =
|
|
||||||
require("../components/pages/home/dataflow/dataflow").DataflowVisualizationComponent;
|
|
||||||
return <DataflowVisualizationComponent />;
|
|
||||||
}}
|
|
||||||
</BrowserOnly>
|
|
||||||
<DragAndDropShowcase />
|
<DragAndDropShowcase />
|
||||||
<AvailableIntegrations />
|
<AvailableIntegrations />
|
||||||
<SectionContainer>
|
<SectionContainer>
|
||||||
|
|||||||
@@ -1,3 +0,0 @@
|
|||||||
export function getRndInteger(min: number, max: number) {
|
|
||||||
return Math.round(Math.random() * (max - min)) + min;
|
|
||||||
}
|
|
||||||
|
After Width: | Height: | Size: 141 KiB |
|
After Width: | Height: | Size: 32 KiB |
|
After Width: | Height: | Size: 15 KiB |
|
After Width: | Height: | Size: 24 KiB |
@@ -0,0 +1,7 @@
|
|||||||
|
<svg role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg">
|
||||||
|
<title>OpenCollective</title>
|
||||||
|
<path
|
||||||
|
fill="#7FADF2"
|
||||||
|
d="M12 0C5.373 0 0 5.373 0 12s5.373 12 12 12c2.54 0 4.894-.79 6.834-2.135l-3.107-3.109a7.715 7.715 0 1 1 0-13.512l3.107-3.109A11.943 11.943 0 0 0 12 0zm9.865 5.166-3.109 3.107A7.67 7.67 0 0 1 19.715 12a7.682 7.682 0 0 1-.959 3.727l3.109 3.107A11.943 11.943 0 0 0 24 12c0-2.54-.79-4.894-2.135-6.834z"
|
||||||
|
/>
|
||||||
|
</svg>
|
||||||
|
After Width: | Height: | Size: 447 B |
@@ -97,7 +97,6 @@
|
|||||||
"isomorphic-dompurify": "catalog:",
|
"isomorphic-dompurify": "catalog:",
|
||||||
"jotai": "catalog:",
|
"jotai": "catalog:",
|
||||||
"jszip": "catalog:",
|
"jszip": "catalog:",
|
||||||
"lucide-react": "catalog:",
|
|
||||||
"mantine-datatable": "catalog:",
|
"mantine-datatable": "catalog:",
|
||||||
"mantine-react-table": "catalog:",
|
"mantine-react-table": "catalog:",
|
||||||
"mermaid": "catalog:",
|
"mermaid": "catalog:",
|
||||||
|
|||||||
@@ -26,6 +26,7 @@ import {
|
|||||||
} from "@mantine/core";
|
} from "@mantine/core";
|
||||||
import {
|
import {
|
||||||
IconAlertTriangle,
|
IconAlertTriangle,
|
||||||
|
IconBrandGithub,
|
||||||
IconCheck,
|
IconCheck,
|
||||||
IconCircleCheck,
|
IconCircleCheck,
|
||||||
IconDatabaseSearch,
|
IconDatabaseSearch,
|
||||||
@@ -51,14 +52,14 @@ import type { AssistantProvider, AssistantProviderCategory } from "@homarr/defin
|
|||||||
import { showErrorNotification, showSuccessNotification } from "@homarr/notifications";
|
import { showErrorNotification, showSuccessNotification } from "@homarr/notifications";
|
||||||
import { useScopedI18n } from "@homarr/translation/client";
|
import { useScopedI18n } from "@homarr/translation/client";
|
||||||
|
|
||||||
|
import { getWorkshopAssistantProviderUrl } from "~/components/workshop/workshop-client";
|
||||||
|
|
||||||
import classes from "./assistant-configuration.module.css";
|
import classes from "./assistant-configuration.module.css";
|
||||||
import { formatAssistantContextWindow, getAssistantConnectionState } from "./assistant-configuration-state";
|
import { formatAssistantContextWindow, getAssistantConnectionState } from "./assistant-configuration-state";
|
||||||
|
|
||||||
type HeaderEntry = { id: number; name: string; value: string };
|
type HeaderEntry = { id: number; name: string; value: string };
|
||||||
type CredentialFlow = "idle" | "remove";
|
type CredentialFlow = "idle" | "remove";
|
||||||
type AssistantProviderOption = AssistantProvider | "homarr";
|
const ProviderIcon = ({ providerId, size = 20 }: { providerId: AssistantProvider; size?: number }) => {
|
||||||
|
|
||||||
const ProviderIcon = ({ providerId, size = 20 }: { providerId: AssistantProviderOption; size?: number }) => {
|
|
||||||
if (providerId === "homarr") {
|
if (providerId === "homarr") {
|
||||||
return <Image src="/logo/logo.png" alt="" aria-hidden w={size} h={size} fit="contain" />;
|
return <Image src="/logo/logo.png" alt="" aria-hidden w={size} h={size} fit="contain" />;
|
||||||
}
|
}
|
||||||
@@ -154,8 +155,13 @@ export const AssistantConfiguration = () => {
|
|||||||
const [webSearchEnabled, setWebSearchEnabled] = useState(false);
|
const [webSearchEnabled, setWebSearchEnabled] = useState(false);
|
||||||
|
|
||||||
useEffect(() => {
|
useEffect(() => {
|
||||||
setProvider(configuration?.provider ?? "openrouter");
|
const configuredProvider = configuration?.provider ?? "openrouter";
|
||||||
setBaseUrl(configuration?.baseUrl ?? assistantProviderPresets.openrouter.baseUrl);
|
setProvider(configuredProvider);
|
||||||
|
setBaseUrl(
|
||||||
|
configuredProvider === "homarr"
|
||||||
|
? getWorkshopAssistantProviderUrl()
|
||||||
|
: (configuration?.baseUrl ?? assistantProviderPresets.openrouter.baseUrl),
|
||||||
|
);
|
||||||
setModelDiscoveryPath(configuration?.modelDiscoveryPath ?? "");
|
setModelDiscoveryPath(configuration?.modelDiscoveryPath ?? "");
|
||||||
setModelId(configuration?.modelId ?? "");
|
setModelId(configuration?.modelId ?? "");
|
||||||
setEnabled(configuration?.enabled ?? false);
|
setEnabled(configuration?.enabled ?? false);
|
||||||
@@ -203,20 +209,7 @@ export const AssistantConfiguration = () => {
|
|||||||
label: t(`provider.options.${providerId}.label`),
|
label: t(`provider.options.${providerId}.label`),
|
||||||
}));
|
}));
|
||||||
|
|
||||||
return {
|
return { group: t(`provider.groups.${category}`), items };
|
||||||
group: t(`provider.groups.${category}`),
|
|
||||||
items:
|
|
||||||
category === "hosted"
|
|
||||||
? [
|
|
||||||
{
|
|
||||||
value: "homarr",
|
|
||||||
label: t("provider.options.homarr.label"),
|
|
||||||
disabled: true,
|
|
||||||
},
|
|
||||||
...items,
|
|
||||||
]
|
|
||||||
: items,
|
|
||||||
};
|
|
||||||
}),
|
}),
|
||||||
[t],
|
[t],
|
||||||
);
|
);
|
||||||
@@ -232,6 +225,7 @@ export const AssistantConfiguration = () => {
|
|||||||
}, [modelId, models]);
|
}, [modelId, models]);
|
||||||
|
|
||||||
const preset = assistantProviderPresets[provider];
|
const preset = assistantProviderPresets[provider];
|
||||||
|
const isHomarrProvider = provider === "homarr";
|
||||||
const headerValuesValid = headers.every((header) => header.name.trim().length > 0 && header.value.length > 0);
|
const headerValuesValid = headers.every((header) => header.name.trim().length > 0 && header.value.length > 0);
|
||||||
const { hasStoredApiKey, connectionPending, connectionReady } = getAssistantConnectionState({
|
const { hasStoredApiKey, connectionPending, connectionReady } = getAssistantConnectionState({
|
||||||
connectionConfigured: configuration?.connectionConfigured === true,
|
connectionConfigured: configuration?.connectionConfigured === true,
|
||||||
@@ -304,7 +298,7 @@ export const AssistantConfiguration = () => {
|
|||||||
const nextPreset = assistantProviderPresets[nextProvider];
|
const nextPreset = assistantProviderPresets[nextProvider];
|
||||||
clearDraftConnectionState();
|
clearDraftConnectionState();
|
||||||
setProvider(nextProvider);
|
setProvider(nextProvider);
|
||||||
setBaseUrl(nextPreset.baseUrl);
|
setBaseUrl(nextProvider === "homarr" ? getWorkshopAssistantProviderUrl() : nextPreset.baseUrl);
|
||||||
setModelDiscoveryPath(nextPreset.modelDiscoveryPath ?? "");
|
setModelDiscoveryPath(nextPreset.modelDiscoveryPath ?? "");
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -334,16 +328,19 @@ export const AssistantConfiguration = () => {
|
|||||||
};
|
};
|
||||||
|
|
||||||
const saveConnection = (clearApiKey = false) => {
|
const saveConnection = (clearApiKey = false) => {
|
||||||
const customHeaders =
|
const customHeaders = isHomarrProvider
|
||||||
headers.length > 0 ? Object.fromEntries(headers.map((header) => [header.name.trim(), header.value])) : undefined;
|
? undefined
|
||||||
|
: headers.length > 0
|
||||||
|
? Object.fromEntries(headers.map((header) => [header.name.trim(), header.value]))
|
||||||
|
: undefined;
|
||||||
updateConnection.mutate({
|
updateConnection.mutate({
|
||||||
provider,
|
provider,
|
||||||
baseUrl,
|
baseUrl,
|
||||||
modelDiscoveryPath: modelDiscoveryPath.trim() || null,
|
modelDiscoveryPath: modelDiscoveryPath.trim() || null,
|
||||||
apiKey: clearApiKey ? undefined : apiKey.trim() || undefined,
|
apiKey: clearApiKey || isHomarrProvider ? undefined : apiKey.trim() || undefined,
|
||||||
clearApiKey,
|
clearApiKey: clearApiKey || isHomarrProvider,
|
||||||
customHeaders,
|
customHeaders,
|
||||||
clearCustomHeaders: clearHeaders,
|
clearCustomHeaders: clearHeaders || isHomarrProvider,
|
||||||
});
|
});
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -434,17 +431,12 @@ export const AssistantConfiguration = () => {
|
|||||||
leftSection={<ProviderIcon providerId={provider} />}
|
leftSection={<ProviderIcon providerId={provider} />}
|
||||||
renderOption={({ option }) => (
|
renderOption={({ option }) => (
|
||||||
<Group gap="sm" wrap="nowrap" align="center" w="100%">
|
<Group gap="sm" wrap="nowrap" align="center" w="100%">
|
||||||
<ProviderIcon providerId={option.value as AssistantProviderOption} />
|
<ProviderIcon providerId={option.value as AssistantProvider} />
|
||||||
<Box flex={1} miw={0}>
|
<Box flex={1} miw={0}>
|
||||||
<Group gap="xs" wrap="nowrap" justify="space-between">
|
<Group gap="xs" wrap="nowrap" justify="space-between">
|
||||||
<Text size="sm" truncate>
|
<Text size="sm" truncate>
|
||||||
{option.label}
|
{option.label}
|
||||||
</Text>
|
</Text>
|
||||||
{option.value === "homarr" && (
|
|
||||||
<Badge size="xs" variant="light" color="gray" flex="0 0 auto">
|
|
||||||
{t("provider.comingSoon")}
|
|
||||||
</Badge>
|
|
||||||
)}
|
|
||||||
</Group>
|
</Group>
|
||||||
</Box>
|
</Box>
|
||||||
</Group>
|
</Group>
|
||||||
@@ -455,6 +447,7 @@ export const AssistantConfiguration = () => {
|
|||||||
description={t("baseUrl.description")}
|
description={t("baseUrl.description")}
|
||||||
leftSection={<IconWorld size={16} />}
|
leftSection={<IconWorld size={16} />}
|
||||||
value={baseUrl}
|
value={baseUrl}
|
||||||
|
disabled={isHomarrProvider}
|
||||||
onChange={(event) => changeBaseUrl(event.currentTarget.value)}
|
onChange={(event) => changeBaseUrl(event.currentTarget.value)}
|
||||||
placeholder="https://provider.example/v1"
|
placeholder="https://provider.example/v1"
|
||||||
/>
|
/>
|
||||||
@@ -462,6 +455,7 @@ export const AssistantConfiguration = () => {
|
|||||||
label={t("model.discoveryPath")}
|
label={t("model.discoveryPath")}
|
||||||
description={t("model.discoveryPathDescription")}
|
description={t("model.discoveryPathDescription")}
|
||||||
value={modelDiscoveryPath}
|
value={modelDiscoveryPath}
|
||||||
|
disabled={isHomarrProvider}
|
||||||
onChange={(event) => changeModelDiscoveryPath(event.currentTarget.value)}
|
onChange={(event) => changeModelDiscoveryPath(event.currentTarget.value)}
|
||||||
placeholder="/models"
|
placeholder="/models"
|
||||||
/>
|
/>
|
||||||
@@ -473,7 +467,11 @@ export const AssistantConfiguration = () => {
|
|||||||
title={t("credentials.title")}
|
title={t("credentials.title")}
|
||||||
description={t("credentials.description")}
|
description={t("credentials.description")}
|
||||||
status={
|
status={
|
||||||
hasStoredApiKey ? undefined : (
|
isHomarrProvider ? (
|
||||||
|
<Badge variant="light" color="blue">
|
||||||
|
{t("credentials.workshop")}
|
||||||
|
</Badge>
|
||||||
|
) : hasStoredApiKey ? undefined : (
|
||||||
<Badge variant="light" color={preset.requiresApiKey ? "yellow" : "gray"}>
|
<Badge variant="light" color={preset.requiresApiKey ? "yellow" : "gray"}>
|
||||||
{preset.requiresApiKey ? t("credentials.required") : t("credentials.optional")}
|
{preset.requiresApiKey ? t("credentials.required") : t("credentials.optional")}
|
||||||
</Badge>
|
</Badge>
|
||||||
@@ -494,7 +492,11 @@ export const AssistantConfiguration = () => {
|
|||||||
</Group>
|
</Group>
|
||||||
}
|
}
|
||||||
>
|
>
|
||||||
{hasStoredApiKey && credentialFlow === "idle" ? (
|
{isHomarrProvider ? (
|
||||||
|
<Alert color="blue" icon={<IconBrandGithub size={18} />} title={t("provider.homarrAuth.title")}>
|
||||||
|
{t("provider.homarrAuth.description")}
|
||||||
|
</Alert>
|
||||||
|
) : hasStoredApiKey && credentialFlow === "idle" ? (
|
||||||
<Group className={classes.credentialSummary} justify="space-between" align="center">
|
<Group className={classes.credentialSummary} justify="space-between" align="center">
|
||||||
<Group className={classes.credentialSummaryContent} gap="sm" wrap="nowrap">
|
<Group className={classes.credentialSummaryContent} gap="sm" wrap="nowrap">
|
||||||
<ThemeIcon color="teal" variant="light" radius="xl">
|
<ThemeIcon color="teal" variant="light" radius="xl">
|
||||||
@@ -545,80 +547,87 @@ export const AssistantConfiguration = () => {
|
|||||||
/>
|
/>
|
||||||
)}
|
)}
|
||||||
|
|
||||||
<Accordion variant="contained" radius="md">
|
{!isHomarrProvider && (
|
||||||
<Accordion.Item value="headers">
|
<Accordion variant="contained" radius="md">
|
||||||
<Accordion.Control className={classes.advancedControl} icon={<IconShieldLock size={18} />}>
|
<Accordion.Item value="headers">
|
||||||
<Group justify="space-between" wrap="nowrap">
|
<Accordion.Control className={classes.advancedControl} icon={<IconShieldLock size={18} />}>
|
||||||
<Box>
|
<Group justify="space-between" wrap="nowrap">
|
||||||
<Text size="sm" fw={600}>
|
<Box>
|
||||||
{t("headers.title")}
|
<Text size="sm" fw={600}>
|
||||||
</Text>
|
{t("headers.title")}
|
||||||
<Text size="xs" c="dimmed">
|
</Text>
|
||||||
{t("headers.description")}
|
<Text size="xs" c="dimmed">
|
||||||
</Text>
|
{t("headers.description")}
|
||||||
</Box>
|
</Text>
|
||||||
{configuration?.customHeadersConfigured && (
|
</Box>
|
||||||
<Badge variant="light" color={clearHeaders ? "yellow" : "green"}>
|
{configuration?.customHeadersConfigured && (
|
||||||
{clearHeaders ? t("headers.pendingRemoval") : t("headers.savedBadge")}
|
<Badge variant="light" color={clearHeaders ? "yellow" : "green"}>
|
||||||
</Badge>
|
{clearHeaders ? t("headers.pendingRemoval") : t("headers.savedBadge")}
|
||||||
)}
|
</Badge>
|
||||||
</Group>
|
)}
|
||||||
</Accordion.Control>
|
|
||||||
<Accordion.Panel>
|
|
||||||
<Stack gap="sm">
|
|
||||||
<Group justify="space-between" align="center">
|
|
||||||
<Text size="sm" c="dimmed">
|
|
||||||
{configuration?.customHeadersConfigured ? t("headers.configured") : t("headers.empty")}
|
|
||||||
</Text>
|
|
||||||
<Button variant="light" size="compact-sm" leftSection={<IconPlus size={14} />} onClick={addHeader}>
|
|
||||||
{t("headers.add")}
|
|
||||||
</Button>
|
|
||||||
</Group>
|
</Group>
|
||||||
{headers.map((header) => (
|
</Accordion.Control>
|
||||||
<Group key={header.id} align="flex-end" wrap="wrap">
|
<Accordion.Panel>
|
||||||
<TextInput
|
<Stack gap="sm">
|
||||||
flex={1}
|
<Group justify="space-between" align="center">
|
||||||
miw="12rem"
|
<Text size="sm" c="dimmed">
|
||||||
label={t("headers.name")}
|
{configuration?.customHeadersConfigured ? t("headers.configured") : t("headers.empty")}
|
||||||
value={header.name}
|
</Text>
|
||||||
onChange={(event) => updateHeader(header.id, "name", event.currentTarget.value)}
|
<Button
|
||||||
placeholder="X-Provider-Header"
|
variant="light"
|
||||||
/>
|
size="compact-sm"
|
||||||
<PasswordInput
|
leftSection={<IconPlus size={14} />}
|
||||||
flex={2}
|
onClick={addHeader}
|
||||||
miw="12rem"
|
>
|
||||||
label={t("headers.value")}
|
{t("headers.add")}
|
||||||
value={header.value}
|
</Button>
|
||||||
onChange={(event) => updateHeader(header.id, "value", event.currentTarget.value)}
|
|
||||||
placeholder={t("headers.valuePlaceholder")}
|
|
||||||
autoComplete="off"
|
|
||||||
/>
|
|
||||||
<Tooltip label={t("headers.remove")}>
|
|
||||||
<ActionIcon
|
|
||||||
size="lg"
|
|
||||||
variant="subtle"
|
|
||||||
color="red"
|
|
||||||
aria-label={t("headers.remove")}
|
|
||||||
onClick={() => setHeaders((current) => current.filter((item) => item.id !== header.id))}
|
|
||||||
>
|
|
||||||
<IconTrash size={17} />
|
|
||||||
</ActionIcon>
|
|
||||||
</Tooltip>
|
|
||||||
</Group>
|
</Group>
|
||||||
))}
|
{headers.map((header) => (
|
||||||
{configuration?.customHeadersConfigured && headers.length === 0 && (
|
<Group key={header.id} align="flex-end" wrap="wrap">
|
||||||
<Button
|
<TextInput
|
||||||
variant="light"
|
flex={1}
|
||||||
color={clearHeaders ? "gray" : "red"}
|
miw="12rem"
|
||||||
onClick={() => setClearHeaders(!clearHeaders)}
|
label={t("headers.name")}
|
||||||
>
|
value={header.name}
|
||||||
{clearHeaders ? t("headers.keep") : t("headers.clear")}
|
onChange={(event) => updateHeader(header.id, "name", event.currentTarget.value)}
|
||||||
</Button>
|
placeholder="X-Provider-Header"
|
||||||
)}
|
/>
|
||||||
</Stack>
|
<PasswordInput
|
||||||
</Accordion.Panel>
|
flex={2}
|
||||||
</Accordion.Item>
|
miw="12rem"
|
||||||
</Accordion>
|
label={t("headers.value")}
|
||||||
|
value={header.value}
|
||||||
|
onChange={(event) => updateHeader(header.id, "value", event.currentTarget.value)}
|
||||||
|
placeholder={t("headers.valuePlaceholder")}
|
||||||
|
autoComplete="off"
|
||||||
|
/>
|
||||||
|
<Tooltip label={t("headers.remove")}>
|
||||||
|
<ActionIcon
|
||||||
|
size="lg"
|
||||||
|
variant="subtle"
|
||||||
|
color="red"
|
||||||
|
aria-label={t("headers.remove")}
|
||||||
|
onClick={() => setHeaders((current) => current.filter((item) => item.id !== header.id))}
|
||||||
|
>
|
||||||
|
<IconTrash size={17} />
|
||||||
|
</ActionIcon>
|
||||||
|
</Tooltip>
|
||||||
|
</Group>
|
||||||
|
))}
|
||||||
|
{configuration?.customHeadersConfigured && headers.length === 0 && (
|
||||||
|
<Button
|
||||||
|
variant="light"
|
||||||
|
color={clearHeaders ? "gray" : "red"}
|
||||||
|
onClick={() => setClearHeaders(!clearHeaders)}
|
||||||
|
>
|
||||||
|
{clearHeaders ? t("headers.keep") : t("headers.clear")}
|
||||||
|
</Button>
|
||||||
|
)}
|
||||||
|
</Stack>
|
||||||
|
</Accordion.Panel>
|
||||||
|
</Accordion.Item>
|
||||||
|
</Accordion>
|
||||||
|
)}
|
||||||
</ConfigurationSection>
|
</ConfigurationSection>
|
||||||
|
|
||||||
<ConfigurationSection
|
<ConfigurationSection
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ import { assistantExecutionPolicy } from "./assistant-execution-policy";
|
|||||||
describe("assistantExecutionPolicy", () => {
|
describe("assistantExecutionPolicy", () => {
|
||||||
test("allows a sizeable batch of tool calls to finish in one request", () => {
|
test("allows a sizeable batch of tool calls to finish in one request", () => {
|
||||||
expect(assistantExecutionPolicy.maxSteps).toBeGreaterThanOrEqual(32);
|
expect(assistantExecutionPolicy.maxSteps).toBeGreaterThanOrEqual(32);
|
||||||
expect(assistantExecutionPolicy.maxOutputTokens).toBeGreaterThanOrEqual(65_536);
|
expect(assistantExecutionPolicy.maxOutputTokens).toBe(32_768);
|
||||||
expect(assistantExecutionPolicy.totalTimeoutMs).toBeGreaterThan(assistantExecutionPolicy.stepTimeoutMs);
|
expect(assistantExecutionPolicy.totalTimeoutMs).toBeGreaterThan(assistantExecutionPolicy.stepTimeoutMs);
|
||||||
expect(assistantExecutionPolicy.toolTimeoutMs).toBeGreaterThanOrEqual(60_000);
|
expect(assistantExecutionPolicy.toolTimeoutMs).toBeGreaterThanOrEqual(60_000);
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
export const assistantExecutionPolicy = {
|
export const assistantExecutionPolicy = {
|
||||||
maxSteps: 32,
|
maxSteps: 32,
|
||||||
maxOutputTokens: 65_536,
|
maxOutputTokens: 32_768,
|
||||||
totalTimeoutMs: 240_000,
|
totalTimeoutMs: 240_000,
|
||||||
stepTimeoutMs: 60_000,
|
stepTimeoutMs: 60_000,
|
||||||
toolTimeoutMs: 60_000,
|
toolTimeoutMs: 60_000,
|
||||||
|
|||||||