Pandore/homarr
Public Access
1
0 Fork 0
Code Actions Activity

merge: stack widget modernization on dnd kit

Browse Source
This commit is contained in:
Thomas Camlong committed 2026-08-08 20:40:26 +02:00
2 parents 4bb862ee76 93276abc8c
commit 9edeba5cd2
940 files changed
+104475 -33649
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

apps/docs/.vscode/settings.json
Vendored
+2 -9
View File
@@ -1,10 +1,3 @@
{
"cSpell.words": [
"Homarr",
"Lidarr",
"Nextcloud",
"Radarr",
"Readarr",
"Sonarr"
]
}
"cSpell.words": ["Homarr", "Lidarr", "Nextcloud", "Radarr", "Readarr", "Sonarr"]
}
apps/docs/README.md
+16 -10
View File
@@ -21,8 +21,14 @@ pnpm dev:docs
# Or from within this directory
pnpm dev
# Point the docs at a local PocketBase instance
WORKSHOP_API_URL=http://127.0.0.1:8090 pnpm dev:docs
```
The standalone docs use `WORKSHOP_API_URL` for PocketBase and `HOMARR_WEBSITE_URL` for the public site origin. The old
`WORKSHOP_URL` name is a deprecated one-release alias.
## Build
```bash
@@ -40,7 +46,7 @@ Uses oxlint and oxfmt (same as the rest of the monorepo):
```bash
pnpm lint # oxlint
pnpm format # oxfmt (check)
pnpm format -- --write # oxfmt (fix)
pnpm format:fix # oxfmt (fix)
```
## Typecheck
@@ -71,7 +77,7 @@ Each integration/widget doc follows a consistent pattern:
The docs app has `@homarr/definitions` as a workspace dependency. You can import integration kinds, widget kinds, and other definitions directly:
```typescript
import { IntegrationKind } from '@homarr/definitions';
import { IntegrationKind } from "@homarr/definitions";
```
This enables type-safe references to homarr domain concepts within documentation code.
@@ -90,15 +96,15 @@ pnpm verify:search
## Tech Stack
| Layer | Technology |
|---|---|
| Layer | Technology |
| -------------- | ------------------------------------------- |
| Site generator | Docusaurus 3 (`@docusaurus/preset-classic`) |
| Styling | Tailwind CSS 3 + Docusaurus Infima |
| Icons | `@tabler/icons-react` |
| Diagrams | Mermaid (`@docusaurus/theme-mermaid`) |
| Search | Algolia DocSearch |
| Analytics | PostHog |
| Charts | @nivo/line |
| Styling | Tailwind CSS 4 + Docusaurus Infima |
| Icons | `@tabler/icons-react` |
| Diagrams | Mermaid (`@docusaurus/theme-mermaid`) |
| Search | Algolia DocSearch |
| Analytics | PostHog |
| Charts | @nivo/line |
## Contributing
apps/docs/components.json
+24
View File
@@ -0,0 +1,24 @@
{
"$schema": "https://ui.shadcn.com/schema.json",
"style": "base-nova",
"rsc": false,
"tsx": true,
"tailwind": {
"config": "",
"css": "src/css/custom.css",
"baseColor": "mist",
"cssVariables": true,
"prefix": ""
},
"aliases": {
"components": "@/components",
"utils": "@/lib/utils",
"ui": "@/components/ui",
"lib": "@/lib",
"hooks": "@/hooks"
},
"iconLibrary": "tabler",
"rtl": false,
"menuColor": "default",
"menuAccent": "subtle"
}
apps/docs/docs/advanced/command-line/_category_.json
+1 -1
View File
@@ -1,4 +1,4 @@
{
"collapsed": true,
"label": "Command line interface"
}
}
apps/docs/docs/advanced/command-line/fix-usernames/index.mdx
+1 -1
View File
@@ -14,4 +14,4 @@ homarr fix-usernames
This will convert all credential usernames to lowercase and update the database accordingly.
![](./img/screenshot-cli.png)
![](./img/screenshot-cli.png)
apps/docs/docs/advanced/command-line/index.mdx
+5 -5
View File
@@ -1,7 +1,7 @@
# Command line interface
The Homarr image ships with a built-in recovery tool. This can be useful, if you do not have access to Homarr or if something is not working.
Please note that the CLI is an *emergency tool*, not an API tool.
Please note that the CLI is an _emergency tool_, not an API tool.
:::caution
@@ -12,10 +12,10 @@ You should also create a backup of the database, in case you break something.
## Execute CLI with Docker
1. Execute ``docker ps | grep homarr`` on the root system with Docker to find the container ID of your Homarr container.
2. Run ``docker exec -it <container-id> /bin/bash homarr <your-command-goes-here>``. \
Replace ``<container-id>`` with your container ID from step 1. \
Replace ``<your-command-goes-here>`` with the command you want to execute (see sub-pages).
1. Execute `docker ps | grep homarr` on the root system with Docker to find the container ID of your Homarr container.
2. Run `docker exec -it <container-id> /bin/bash homarr <your-command-goes-here>`. \
Replace `<container-id>` with your container ID from step 1. \
Replace `<your-command-goes-here>` with the command you want to execute (see sub-pages).
## Execute CLI with QNAP
apps/docs/docs/advanced/command-line/integrations/index.mdx
+3 -2
View File
@@ -7,6 +7,7 @@ This guide requires that you understand [how to access the CLI](../).
:::
Using these commands, you can manage the integrations from the CLI:
```bash
Group of commands to manage integrations
@@ -43,7 +44,7 @@ Flags:
## Delete Integration
- Requires a database connection
- Requires one parameter: ``id`` or ``name``
- Requires one parameter: `id` or `name`
- Deletes an integration permanently from the database
```bash
@@ -57,4 +58,4 @@ Flags:
-n, --name string Name of the integration
-h, --help help for integrations delete
-v, --version version for homarr-cli
```
```
apps/docs/docs/advanced/command-line/password-recovery/index.mdx
+2 -2
View File
@@ -12,8 +12,8 @@ All sessions for that user will be terminated and the user must re-login.
![](./img/screenshot-cli.png)
Using the ``--username`` parameter, you can specify who you want to reset the password for.
Using the `--username` parameter, you can specify who you want to reset the password for.
Executing the command will create a new random password, update the database and display the new password.
All sessions for this user will be terminated and they must re-login.
![](./img/screenshot-cli-result.png)
![](./img/screenshot-cli-result.png)
apps/docs/docs/advanced/command-line/users/index.mdx
+3 -2
View File
@@ -7,6 +7,7 @@ This guide requires that you understand [how to access the CLI](../).
:::
Using these commands, you can manage the users from the CLI:
```bash
Group of commands to manage users
@@ -42,7 +43,7 @@ yj52ek5cyb6du4bp4osbkjry admin xxxx@example.com
## Delete User
- Requires a database connection
- Requires one parameter: ``id`` or ``username``
- Requires one parameter: `id` or `username`
```bash
Delete a user by id or username
@@ -76,4 +77,4 @@ Flags:
-p, --password New password
-h, --help help for users update-password
-v, --version version for homarr-cli
```
```
apps/docs/docs/advanced/development/_category_.json
+6 -7
View File
@@ -1,9 +1,8 @@
{
"label": "Developer guides",
"position": 6,
"collapsed": true,
"link": {
"type": "generated-index"
}
"label": "Developer guides",
"position": 6,
"collapsed": true,
"link": {
"type": "generated-index"
}
}
apps/docs/docs/advanced/development/getting-started.mdx
+92 -41
View File
@@ -8,70 +8,121 @@ tags:
sidebar_position: 1
---
## Setting up your development environment
This guide will help you set up your development environment to start contributing to homarr.
## Set up your development environment
### Prerequisites
- **Node.js (lts)**: You can download it from the [official website](https://nodejs.org/).
- **pnpm (latest)**: You can install it by running `npm install -g pnpm`.
- **Node.js 24.18 or newer**: You can download it from the [official website](https://nodejs.org/).
- **Corepack**: Run `corepack enable` so the repository selects its pinned pnpm 11 version.
- **Git**: You can download it from the [official website](https://git-scm.com/).
- **Docker or Docker Desktop**: Required for the Redis service and the developer Docker CLI.
- **Go 1.25+**: Required only for the developer Docker CLI. You can download it from the [official website](https://go.dev/).
- **GitHub CLI**: Required only for pull-request image features. Install it from the [official website](https://cli.github.com/), then authenticate with `gh auth login`.
### Setting up the project
The versions in the root `package.json` are the supported baseline. Let Corepack select the repository version instead
of installing an unrelated global pnpm:
1. Fork the repository by clicking on the "Fork" button on the top right corner of the repository page.
```sh
corepack enable
corepack install
pnpm install --frozen-lockfile
```
![Fork button](./img/fork.png)
### Run the Homarr application
2. Clone the repository to your local machine with `git clone`. You can find the url to use by clicking on the "Code" button on the top right corner of your forks repository page.
1. Copy `.env.example` to `.env`.
2. Set `DB_URL` to an absolute writable SQLite file path.
3. Keep Redis and the optional local databases running in one terminal.
4. Apply migrations and start Next.js in another terminal.
![Clone button](./img/clone.png)
```sh
cp .env.example .env
```
3. Change directory to the project folder with `cd homarr`.
Terminal 1:
4. Install the dependencies with `pnpm install`.
```sh
pnpm docker:dev
```
5. Create `.env` from `.env.example`. In a POSIX shell, run `cp .env.example .env`; in PowerShell, run `Copy-Item .env.example .env`. Set `DB_URL` to an absolute path for your SQLite file.
Terminal 2:
6. Start Redis in the background with `pnpm docker:dev:up` if your development workflow needs it.
```sh
pnpm db:migration:sqlite:run
pnpm dev
```
7. Create or update the database with `pnpm db:migration:sqlite:run`. This also seeds the default data. To run the seed explicitly later, use `pnpm db:seed`.
The infrastructure command remains in the foreground. Open `http://127.0.0.1:3000`; the first user created through
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
default data; use `pnpm db:seed` to seed it explicitly later.
8. Start the development server with `pnpm dev` and wait for a message that says `✓ Ready in 10.7s`
### Run PocketBase and documentation
9. Open your browser and navigate to [http://localhost:3000](http://localhost:3000). (Loading the page might take up to 2 minutes the first time)
Start PocketBase in another terminal:
### Useful npm scripts
```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
```
#### During development
Then start Docusaurus in a third terminal:
- `pnpm dev`: Start the development server.
- `pnpm dev:cli -- dev`: Browse and run local images and remote pull-request images.
- `pnpm dev:cli -- build <name>`: Build the current checkout as `homarr:<name>`.
- `pnpm dev:cli -- build --pr <number>`: Build a pull request locally from a temporary checkout.
- `pnpm dev:cli -- rebuild <name>`: Rebuild a local image from its recorded checkout or pull request.
- `pnpm dev:cli:install`: Optionally install the developer CLI as a `homarr` binary.
- `pnpm cli`: Run cli commands.
- `pnpm db:migration:sqlite:run`: Run the migrations to create or update the sqlite db file.
- `pnpm db:seed`: Explicitly seed the default database data.
- `pnpm docker:dev:up`: Start the Redis development service in the background.
- `pnpm db:migration:sqlite:generate`: Generate a new migration file for the sqlite db. Also works with `mysql`.
- `pnpm db:studio`: Open a visual studio for the database.
- `pnpm package:new`: Create a new package in the monorepo.
```sh
WORKSHOP_API_URL=http://127.0.0.1:8090 pnpm dev:docs
```
#### Checking code quality
PocketBase runs on port 8090 and Docusaurus on port 3003. Stopping the services preserves the PocketBase volume.
- `pnpm lint`: Run the linter to check for code quality issues.
- `pnpm format:fix`: Run the formatter to fix code style issues.
- `pnpm test`: Run the tests. You can also use `pnpm test:ui` to get a UI for the tests.
- `pnpm typecheck`: Run the typescript type checker.
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`.
#### Building the project
Point Homarr at the local services with:
- `pnpm build`: Build the project for production.
- `pnpm dev:cli -- build <name>`: Build a `homarr:<name>` image and record its checkout for later rebuilds.
- `docker run -p 7575:7575 -e SECRET_ENCRYPTION_KEY='your_64_character_hex_string' homarr:<name>`: Run the created docker image.
```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
- `pnpm dev` — Next.js on port 3000.
- `pnpm dev:benchmark` — authenticated-board benchmark; readiness-only `--smoke` runs are not performance claims.
- `pnpm dev:cli -- dev` — browse and run local images and remote pull-request images.
- `pnpm dev:cli -- build <name>` — build the current checkout as `homarr:<name>`.
- `pnpm dev:cli -- build --pr <number>` — build a pull request from a temporary checkout.
- `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: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 cli` — Homarr operations CLI.
- `pnpm db:migration:sqlite:run` — create or update a SQLite database.
- `pnpm db:seed` — seed the default database data explicitly.
- `pnpm db:studio` — inspect the database.
- `pnpm format` / `pnpm format:fix` — check or apply oxfmt.
- `pnpm lint` / `pnpm lint:fix` — check or apply oxlint.
- `pnpm typecheck` — typecheck all workspaces.
- `pnpm test` — unit and contract suites.
- `pnpm test:workshop` — disposable Workshop integration suite.
- `pnpm build` — production monorepo build.
- `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.
apps/docs/docs/advanced/development/kubernetes.mdx
+1 -1
View File
@@ -132,4 +132,4 @@ This command should return CPU and memory usage statistics for each node.
## Conclusion
You have successfully set up a multi-node Kubernetes cluster using kind and installed the Metrics Server for monitoring resource usage. This setup is useful for local development and testing Kubernetes workloads before deploying them to a production environment.
You have successfully set up a multi-node Kubernetes cluster using kind and installed the Metrics Server for monitoring resource usage. This setup is useful for local development and testing Kubernetes workloads before deploying them to a production environment.
apps/docs/docs/advanced/environment-variables/index.mdx
+53 -47
View File
@@ -25,15 +25,17 @@ This is especially useful for [docker secrets](https://docs.docker.com/engine/sw
Using the `PUID` and `PGID` will require you to set the correct permissions on the mounted volumes and if used the docker socket. See more in the [Running as a different user](/docs/advanced/running-as-different-user) documentation.
:::
| Environment Variable | Description | Possible values | Default |
| ------------------------ | ----------- | --------------- | ------- |
| ``PUID`` | User ID to run the container as | Any valid user ID | ``0`` |
| ``PGID`` | Group ID to run the container as | Any valid group ID | ``0`` |
| ``LOG_LEVEL`` | Log level to use | ``debug`` / ``info`` / ``warn`` / ``error`` | ``info`` |
| ``NO_EXTERNAL_CONNECTION`` | Disables some requests that need internet connection | `true` or `false` | `false` |
| ``ENABLE_DNS_CACHING`` | Enables dns caching. Enabled by default, but if you experience issues with IPv6 or static IPs, see [#4006](https://github.com/homarr-labs/homarr/issues/4006) or disable this flag | `true` or `false` | `true` |
| Environment Variable | Description | Possible values | Default |
| ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | ----------------------------- |
| `PUID` | User ID to run the container as | Any valid user ID | `0` |
| `PGID` | Group ID to run the container as | Any valid group ID | `0` |
| `LOG_LEVEL` | Log level to use | `debug` / `info` / `warn` / `error` | `info` |
| `NO_EXTERNAL_CONNECTION` | Disables Homarr's internet-backed requests, including update checks, weather, and RSS feeds | `true` or `false` | `false` |
| `ENABLE_DNS_CACHING` | Enables dns caching. Enabled by default, but if you experience issues with IPv6 or static IPs, see [#4006](https://github.com/homarr-labs/homarr/issues/4006) or disable this flag | `true` or `false` | `true` |
| `HOMARR_DISABLE_IPV6` | Disables the IPv6 listener of the internal nginx proxy, even when the host supports IPv6. IPv6 is normally disabled automatically when the host has no IPv6 configured. See [#4596](https://github.com/homarr-labs/homarr/issues/4596) | `true` or `false` | `false` |
| `HOMARR_WEBSITE_URL` | Main Homarr documentation/site base used by runtime links. Must be an absolute HTTP(S) URL. | HTTP(S) URL | `https://homarr.dev` |
| `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` |
## Authentication
@@ -43,9 +45,9 @@ See [Single Sign-On](/docs/advanced/single-sign-on) for more informations.
The `SECRET_ENCRYPTION_KEY` is required. If none is specified before starting the container, a random key will be shown in the error message and the container will exit.
| Environment Variable | Description | Possible values | Default |
| ------------------------ | ----------- | --------------- | ------- |
| ``SECRET_ENCRYPTION_KEY`` | Secret used to encrypt secrets in database. | 64 character hex string | - |
| Environment Variable | Description | Possible values | Default |
| ----------------------- | ------------------------------------------- | ----------------------- | ------- |
| `SECRET_ENCRYPTION_KEY` | Secret used to encrypt secrets in database. | 64 character hex string | - |
:::info
A random secret can be generated by using the following command: `openssl rand -hex 32`
@@ -53,27 +55,27 @@ A random secret can be generated by using the following command: `openssl rand -
## Docker
| Environment Variable | Description | Possible values | Default |
| ------------------------ | ----------- | --------------- | ------- |
| ``DOCKER_HOSTNAMES`` | Comma-separated list of hostnames to connect to | For example `localhost,docker.example.com` | - |
| ``DOCKER_PORTS`` | Comma-separated list of ports to connect to | For example `2375,2376` | - |
| ``DOCKER_SOCKET_PATHS`` | Comma-separated list of mounted Docker-compatible socket paths. See the [Docker and Podman integration guide](/docs/integrations/docker) | For example `/var/run/docker.sock,/var/run/podman.sock` | - |
| Environment Variable | Description | Possible values | Default |
| --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | ------- |
| `DOCKER_HOSTNAMES` | Comma-separated list of hostnames to connect to | For example `localhost,docker.example.com` | - |
| `DOCKER_PORTS` | Comma-separated list of ports to connect to | For example `2375,2376` | - |
| `DOCKER_SOCKET_PATHS` | Comma-separated list of mounted Docker-compatible socket paths. See the [Docker and Podman integration guide](/docs/integrations/docker) | For example `/var/run/docker.sock,/var/run/podman.sock` | - |
## Database
| Environment Variable | Description | Possible values | Default |
| ------------------------ | ----------- | --------------- | ------- |
| ``DB_DRIVER`` | Database driver to use. Currently `better-sqlite3` is used for sqlite, `mysql2` for mysql and `node-postgres` for postgresql | ``better-sqlite3`` / ``mysql2`` / ``node-postgres`` | ``better-sqlite3`` |
| ``DB_DIALECT`` | Database dialect to use. | ``sqlite`` / ``mysql`` / ``postgresql`` | ``sqlite`` |
| ``DB_URL`` | Database URL to connect to. | Any valid database URL | ``/appdata/db/db.sqlite`` |
| ``DB_HOST`` | Database host to connect to. | Any valid database host | - |
| ``DB_PORT`` | Database port to connect to. | Any valid database port | - |
| ``DB_NAME`` | Database name to connect to. | Any valid database name | - |
| ``DB_USER`` | Database user to connect with. | Any valid database user | - |
| ``DB_PASSWORD`` | Database password to connect with. | Any valid database password | - |
| Environment Variable | Description | Possible values | Default |
| -------------------- | ---------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- | ----------------------- |
| `DB_DRIVER` | Database driver to use. Currently `better-sqlite3` is used for sqlite, `mysql2` for mysql and `node-postgres` for postgresql | `better-sqlite3` / `mysql2` / `node-postgres` | `better-sqlite3` |
| `DB_DIALECT` | Database dialect to use. | `sqlite` / `mysql` / `postgresql` | `sqlite` |
| `DB_URL` | Database URL to connect to. | Any valid database URL | `/appdata/db/db.sqlite` |
| `DB_HOST` | Database host to connect to. | Any valid database host | - |
| `DB_PORT` | Database port to connect to. | Any valid database port | - |
| `DB_NAME` | Database name to connect to. | Any valid database name | - |
| `DB_USER` | Database user to connect with. | Any valid database user | - |
| `DB_PASSWORD` | Database password to connect with. | Any valid database password | - |
You can either use the url or host, port, name and credentials combined. The URL will be prioritized over the other values.
## Redis
By default Redis is running within the installation. (for example in Docker).
@@ -83,25 +85,23 @@ However for example for K8s it can be useful to use an external Redis instance.
External redis is currently not supported with Proxmox Community Scripts
:::
| Environment Variable | Description | Possible values | Default |
| ------------------------ | ----------- | --------------- | ------- |
| `REDIS_IS_EXTERNAL` | Whether Redis is running externally. | `true` / `false` | `false` |
| `REDIS_HOST` | Hostname of the Redis instance. | Any valid hostname | - |
| `REDIS_PORT` | Port of the Redis instance. | Any valid port | `6379` |
| `REDIS_USERNAME` | Username to connect to the Redis instance. | Any valid username | - |
| `REDIS_PASSWORD` | Password to connect to the Redis instance. | Any valid password | - |
| `REDIS_DATABASE_INDEX` | Select which database of your redis instance should be used. | Any numeric index | - |
| `REDIS_TLS_CA` | CA certificate for Redis TLS connections. If a certificate is specified the connection will use TLS. | Any valid CA certificate | - |
| Environment Variable | Description | Possible values | Default |
| ---------------------- | ---------------------------------------------------------------------------------------------------- | ------------------------ | ------- |
| `REDIS_IS_EXTERNAL` | Whether Redis is running externally. | `true` / `false` | `false` |
| `REDIS_HOST` | Hostname of the Redis instance. | Any valid hostname | - |
| `REDIS_PORT` | Port of the Redis instance. | Any valid port | `6379` |
| `REDIS_USERNAME` | Username to connect to the Redis instance. | Any valid username | - |
| `REDIS_PASSWORD` | Password to connect to the Redis instance. | Any valid password | - |
| `REDIS_DATABASE_INDEX` | Select which database of your redis instance should be used. | Any numeric index | - |
| `REDIS_TLS_CA` | CA certificate for Redis TLS connections. If a certificate is specified the connection will use TLS. | Any valid CA certificate | - |
## Proxy
| Environment Variable | Description | Possible values | Default |
| ------------------------ | ----------- | --------------- | ------- |
| ``HTTP_PROXY`` | HTTP proxy to use | Any valid HTTP proxy URL | - |
| ``HTTPS_PROXY`` | HTTPS proxy to use | Any valid HTTPS proxy URL | - |
| ``NO_PROXY`` | Comma separated list of hosts that should be excluded from proxying | Any valid hostnames | - |
| Environment Variable | Description | Possible values | Default |
| -------------------- | ------------------------------------------------------------------- | ------------------------- | ------- |
| `HTTP_PROXY` | HTTP proxy to use | Any valid HTTP proxy URL | - |
| `HTTPS_PROXY` | HTTPS proxy to use | Any valid HTTPS proxy URL | - |
| `NO_PROXY` | Comma separated list of hosts that should be excluded from proxying | Any valid hostnames | - |
## Advanced deployments
@@ -109,6 +109,12 @@ 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.
:::
| Environment Variable | Description |
| ------------------------ | ----------- |
| ``DB_MIGRATIONS_DISABLED`` | Disable db migrations. For example for helm charts |
| Environment Variable | Description |
| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------- |
| `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. |
| `PB_ALLOWED_ORIGINS` | Browser origins accepted by PocketBase. The central public community defaults to `*` so self-hosted Homarr instances can use OAuth. |
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
`WORKSHOP_API_URL` for one release. `WORKSHOP_API_URL` takes precedence.
apps/docs/docs/advanced/icons/index.mdx
+10 -7
View File
@@ -9,14 +9,16 @@ tags:
---
## Icon picker
Icons in Homarr are automatically requested from multiple sources:
- [Dashboard Icons](https://dashboardicons.com/) - Our recommended source with over 1888+ curated, high-quality icons
- [selfh.st icons](https://github.com/selfhst/icons)
- [Simple icons](https://github.com/simple-icons/simple-icons)
- [Tabler icons](https://tabler-icons.io/)
- [Papirus icons](https://github.com/PapirusDevelopmentTeam/papirus-icon-theme)
- [Homelab Svg assets](https://github.com/loganmarchione/homelab-svg-assets)
- **Local icons**: automatically fetched from the [medias feature](/docs/management/media/)
- [Dashboard Icons](https://dashboardicons.com/) - Our recommended source with over 1888+ curated, high-quality icons
- [selfh.st icons](https://github.com/selfhst/icons)
- [Simple icons](https://github.com/simple-icons/simple-icons)
- [Tabler icons](https://tabler-icons.io/)
- [Papirus icons](https://github.com/PapirusDevelopmentTeam/papirus-icon-theme)
- [Homelab Svg assets](https://github.com/loganmarchione/homelab-svg-assets)
- **Local icons**: automatically fetched from the [medias feature](/docs/management/media/)
Using these icon sources, Homarr provides a total collection of over 11,000 icons at your fingertips.
The icon picker is a fast searcher that helps you to find your desired icon simply by entering a search term.
@@ -30,5 +32,6 @@ If you can't find the icon you're looking for in Homarr's built-in picker, we st
Icons that are high quality and printable ([SVG](https://wikipedia.org/wiki/Scalable_Vector_Graphics)) are marked with a red badge "SVG" at the top right.
### Using external icons
If you don't find the icon you're looking for on Dashboard Icons or wish to use a different source, you can simply enter a URL that points to an icon.
Direct HTTP(S) image URLs are used as entered instead of being searched in the built-in repositories. It is important that the URL directly points to the file without any advertisements or elements around it.
apps/docs/docs/advanced/keyboard-shortcuts/index.mdx
+14 -13
View File
@@ -1,28 +1,29 @@
---
title: Keyboard Shortcuts
tags:
- Advanced
- Advanced
---
Homarr has the following keyboard shortcuts:
| Shortcut | Description |
| ---------------------------------------------- | ---------------------------------------------------------- |
| `MOD` + `K` | Opens the search bar |
| `MOD` + `J` | Toggles Dark Mode |
| `MOD` + `E` | Toggles Edit Mode |
| Hold `Shift` while hovering a supported widget | Opens its temporary advanced view |
| `Shift` + `Enter` on a supported widget | Opens its advanced view until it is closed |
| `Esc` | Closes an open advanced view or board menu |
| `Shift` + `F10` on a focused board section | Opens the precise add-item menu at the next available cell |
| Shortcut | Description |
| ---------------------------------------------- | ------------------------------------------ |
| `MOD` + `K` | Opens the search bar |
| `MOD` + `J` | Toggles Dark Mode |
| `MOD` + `E` | Toggles Edit Mode |
| Hold `Shift` while hovering a supported widget | Opens its temporary advanced view |
| `Shift` + `Enter` on a supported widget | Opens its advanced view until it is closed |
| `Esc` | Closes an open advanced view or board menu |
:::tip
Here `MOD` refers to the modifier key, which is `Ctrl` on Windows and `Cmd` on macOS.
Advanced view and precise placement are available outside edit mode. Widgets without a distinct advanced experience
adapt to their normal dimensions instead. Precise placement still requires permission to change the board and the
right-click interaction preference to be enabled.
Advanced view is available outside edit mode. Widgets without a distinct advanced experience adapt to their normal
dimensions instead.
:::
apps/docs/docs/advanced/proxy/index.mdx
+12 -9
View File
@@ -9,16 +9,17 @@ tags:
- Security
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
## Allowing self-signed certificates
Some users may come across a barrier, where they're unable to receive a 200 response from the Ping widget for some apps, while using self-signed certificates or a local certificate authory.
:::note What's going on?
Homarr is trying to communicate to your apps via the integrations.
It usually doesn't matter if Homarr is running on ``http`` or ``https``.
It usually doesn't matter if Homarr is running on `http` or `https`.
Your apps have a self-signed certificate - Homarr will recognize that the certificate was signed by an unknown authority and requests will be blocked.
:::
@@ -28,8 +29,9 @@ To allow self-signed certificates, you can configure them on the certificates ma
## Securing Homarr with Traefik
Copying the configuration straight from the docker-compose file won't work if you are running Homarr behind Traefik, such as a Portainer setup, or docker-swarm. In that case, you should use the following slightly modified configuration:
```yaml
version: '3'
version: "3"
services:
homarr:
container_name: homarr
@@ -47,18 +49,18 @@ services:
traefik.http.routers.homarr.rule: Host(`your.internal.dns.address.here.com`)
traefik.http.routers.homarr.entrypoints: websecure
traefik.http.routers.homarr-secure.app: homarr
traefik.http.apps.homarr.loadbalancer.server.port: 7575
networks:
proxy:
external: true
```
<br/>
<br />
A sample Traefik docker-compose.yml using Cloudflare for certificate generation that works with the configuration above would be:
```yaml
version: '3'
version: "3"
apps:
traefik:
@@ -104,7 +106,6 @@ networks:
external: true
```
:::tip
Of particular note here is that both configurations explicitly define which network they are using, in this case "proxy", but it can be named anything. It just has to be the same across all apps for which Traefik is serving as a proxy. These are marked as external because the proxy network was manually created by running: `docker network create proxy` but this might be unnecessary depending on HOW exactly you are running Traefik. For example, if running [Traefik with Portainer](https://docs.portainer.io/advanced/reverse-proxy/traefik#deploying-in-a-docker-standalone-scenario), you can follow their official docs on how to set up Traefik and Portainer together, and you can just focus on the Homarr docker labels instead.
:::
@@ -115,7 +116,6 @@ If you are using Caddy as the reverse proxy for your setup, your `docker-compose
```yaml
services:
# <-- [Homarr installation]
caddy:
@@ -141,14 +141,17 @@ networks:
proxy:
external: true
```
:::important
Homarr needs to be on the same network so you will need to add the following property to your homarr install:
```yaml
homarr:
...
networks:
- proxy
```
:::
Next, create a file named `Caddyfile` at the same level as your `docker-compose.yml` file with the following content:
apps/docs/docs/advanced/running-as-different-user/index.mdx
+10 -10
View File
@@ -8,7 +8,7 @@ tags:
- PUID
---
By default the container is running with user `root` and group `root`.
By default the container is running with user `root` and group `root`.
You can change the user and group by using the `PUID` and `PGID` environment variables.
Important to note is, that you'll also need to change the permissions for the mounted directories accordingly.
@@ -32,11 +32,11 @@ services:
volumes:
- ./homarr/appdata:/appdata
environment:
- SECRET_ENCRYPTION_KEY=your_64_character_hex_string # <--- can be generated with `openssl rand -hex 32`
- PUID=1000
- PGID=1000
- SECRET_ENCRYPTION_KEY=your_64_character_hex_string # <--- can be generated with `openssl rand -hex 32`
- PUID=1000
- PGID=1000
ports:
- '7575:7575'
- "7575:7575"
```
After that you'll need to create the appdata directory and set the correct permissions:
@@ -76,11 +76,11 @@ services:
- /var/run/docker.sock:/var/run/docker.sock
- ./homarr/appdata:/appdata
environment:
- SECRET_ENCRYPTION_KEY=your_64_character_hex_string # <--- can be generated with `openssl rand -hex 32`
- PUID=1000
- PGID=999
- SECRET_ENCRYPTION_KEY=your_64_character_hex_string # <--- can be generated with `openssl rand -hex 32`
- PUID=1000
- PGID=999
ports:
- '7575:7575'
- "7575:7575"
```
And set the permissions for the mounted directories:
@@ -90,4 +90,4 @@ mkdir -p ./homarr/appdata
chown -R 1000:999 ./homarr/appdata
```
Important here is that the group ID is set to `999` as we created the `docker` group with this ID.
Important here is that the group ID is set to `999` as we created the `docker` group with this ID.
apps/docs/docs/advanced/single-sign-on/index.mdx
+9 -8
View File
@@ -10,20 +10,21 @@ tags:
- Active Directory
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
# Single Sign On
Homarr supports multiple authentication options, from internal userbase (credentials), to LDAP (with Active directory support), and OIDC.
### Auth configuration common variables
| Environment Variable | Description | Default Value |
|---------------------------|-------------|---------------|
| AUTH_PROVIDERS | Select Which provider to use between *credentials*, *ldap* and *oidc*. <br /> Multiple providers can be enabled with by separating them with `,`, (ex. `AUTH_PROVIDERS=credentials,oidc`, it is highly recommended to just enable one provider). | credentials |
| AUTH_LOGOUT_REDIRECT_URL | URL to redirect to after clicking logging out. | --- |
| AUTH_SESSION_EXPIRY_TIME | Time for the session to time out. Can be set as pure number, which will automatically be used in seconds, or followed by s, m, h or d for seconds, minutes, hours or days. (ex: "30m") | "30d" |
| AUTH_COOKIE_PREFIX | Prefix used for all authentication cookies (session, csrf, callback, pkce, state, nonce). Change this if you run another Auth.js/NextAuth app on the same hostname as Homarr (browsers scope cookies by host, not by port) to avoid cookie name collisions. Only letters, numbers, hyphens and underscores are allowed. | `homarr` |
| Environment Variable | Description | Default Value |
| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| AUTH_PROVIDERS | Select Which provider to use between _credentials_, _ldap_ and _oidc_. <br /> Multiple providers can be enabled with by separating them with `,`, (ex. `AUTH_PROVIDERS=credentials,oidc`, it is highly recommended to just enable one provider). | credentials |
| AUTH_LOGOUT_REDIRECT_URL | URL to redirect to after clicking logging out. | --- |
| AUTH_SESSION_EXPIRY_TIME | Time for the session to time out. Can be set as pure number, which will automatically be used in seconds, or followed by s, m, h or d for seconds, minutes, hours or days. (ex: "30m") | "30d" |
| AUTH_COOKIE_PREFIX | Prefix used for all authentication cookies (session, csrf, callback, pkce, state, nonce). Change this if you run another Auth.js/NextAuth app on the same hostname as Homarr (browsers scope cookies by host, not by port) to avoid cookie name collisions. Only letters, numbers, hyphens and underscores are allowed. | `homarr` |
<Tabs>
<TabItem value="credentials" label="Credentials Provider" default>
apps/docs/docs/advanced/styling/index.mdx
+19 -11
View File
@@ -19,12 +19,14 @@ Homarr uses https://mantine.dev/ under the hood. You can change the look & feel
using custom CSS, that extends or overwrites the styles from Mantine.
## Getting into CSS
If you don't have any experience with CSS,
we strongly recommend you to go through the courses here: https://www.w3schools.com/css/.
Due to the infinite scenarios and setups possible with custom CSS,
our support team will not provide any support with your own written CSS.
## Limitations and dangers
When using custom CSS, you can break the page or certain functionalities.
Although CSS can improve the design & feel of the page, it **<ins>cannot do any of the following</ins>**:
@@ -33,21 +35,23 @@ Although CSS can improve the design & feel of the page, it **<ins>cannot do any
- Completely revamp the design of the page, only smaller changes are possible
Here are some dangers of using custom CSS:
- Updates may contain breaking changes in the structure, built-in styling or how styling is processed. Therefore,
custom CSS may break unexpectedly without any warning
custom CSS may break unexpectedly without any warning
- Custom CSS may make certain elements invisible or not possible to click / interact with
- Custom CSS could make readability and accessibility worse for impaired people
## How to inspect the page
When styling the page, you can use the ``Inspector`` to inspect elements on the page and try out styles.
When styling the page, you can use the `Inspector` to inspect elements on the page and try out styles.
This may vary depending on your browser and operating system, but the workflow usually goes like this:
- Open the Homarr page
- Press ``Ctrl`` + ``Shift`` + ``I`` at the same time.
Alternatively, right-click on the page and choose ``Inspect`` or ``Inspect element``.
- Open the tab ``Elements`` if it isn't open yet.
- Press `Ctrl` + `Shift` + `I` at the same time.
Alternatively, right-click on the page and choose `Inspect` or `Inspect element`.
- Open the tab `Elements` if it isn't open yet.
- Search the element you want to change in the DOM tree or use the element picker (usually at the top left)
to select it by clicking on the page.
to select it by clicking on the page.
- Experiment by changing the CSS code on the right side
When writing custom CSS, it is important to also remember or create a selector, which tells the browser
@@ -55,17 +59,19 @@ which element to apply the styles to. If you accidentally broke something or wan
simply reload the page.
## Using Homarr's classes
Homarr's elements will already have a lot of classes and styles pre-applied.
You can reuse those classes to apply additional styles or overwrite them.
When overwriting, remember to add the ``!important`` flag to your CSS property to tell the browser to use our instruction instead.
When overwriting, remember to add the `!important` flag to your CSS property to tell the browser to use our instruction instead.
Classes with random number suffixes, such as ``mantine-Card-x2fske``, should be avoided, since those are dynamic
Classes with random number suffixes, such as `mantine-Card-x2fske`, should be avoided, since those are dynamic
CSS classes that will change with every build. This means, every time you update Homarr,
your styles will no longer apply to them
## Defining custom classes for widgets
If you want to apply the styles only for one widget, you can define custom class names only for that widget.
To do that, enter edit mode on your board, click the three dots of your widget, click ``Edit item`` and click ``Advanced options``.
To do that, enter edit mode on your board, click the three dots of your widget, click `Edit item` and click `Advanced options`.
Then, you can enter as many custom classes as you'd like:
![](./img/widget-custom-classes.png)
@@ -73,6 +79,7 @@ Then, you can enter as many custom classes as you'd like:
To save them, click `Save changes` on both modals and exit edit mode.
## Where to enter custom CSS
After you wrote your custom CSS, it is time to permanently save it, so you don't need to use the inspector anymore.
To do this, enter the board settings:
@@ -84,11 +91,12 @@ Here you can enter your CSS code, which will be applied on the respective board
![](./img/custom-css-setting.png)
## Using variables
You can also change the values of the theme variables, which are located here: https://mantine.dev/styles/css-variables-list/.
To do this, see the following example CSS:
```css
:root {
--mantine-primary-color-filled: #ffbb00;
--mantine-primary-color-filled: #ffbb00;
}
```
```
apps/docs/docs/community/donate.mdx
+5 -1
View File
@@ -7,12 +7,15 @@ tags:
---
# Donate
## Why to donate
Our team of 4 developers is working on Homarr in their free time.
Homarr has become a big part of our daily things we work on - and therefore we invest a lot of time into maintaining Homarr,
providing support and implementing new features.
We also incur monetary costs while developing Homarr for the tools that we need.
A few examples include:
- Renting for a Cloud VPS for our cloud services (status page, monitoring, email, analytics, [demo instance](https://demo.homarr.dev/), ...)
- Paying for (IDE-) licenses
@@ -20,6 +23,7 @@ Using a donation, you help us to cover these expenses and enable the development
Homarr is completely free to use. We'd highly appreciate if you consider donating, especially if you use Homarr in a commercial environment.
## Where to donate
We accept donations on our official [OpenCollective](https://opencollective.com/homarr).
You may also sponsor us directly by providing a useful service / product to us other means.
You can get into contact with us [here](/docs/community/get-in-touch).
You can get into contact with us [here](/docs/community/get-in-touch).
apps/docs/docs/community/faq.mdx
+34 -14
View File
@@ -5,43 +5,57 @@ tags:
- Help
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
### Can I install Homarr on a Raspberry Pi?
Yes, Homarr is compatible with the architecture of the Raspberry Pi. Have a look in our <a href="/docs/category/installation-1">installation guide</a> on how to do so.
### I have a suggestion / idea for improvement or want to report a bug
You can report issues, suggestions, or ideas for improvements <a href="https://github.com/homarr-labs/homarr/issues/new/choose">here</a>.
### Can I use my own custom icons for apps?
Yes, check out our guide on <a href="/docs/advanced/customizations/icons">how to add your custom icons</a>.
### Some of my online icons are not working (anymore)
It seems the `cdn.jsdelivr.net` database of icon sometimes appear in the lists for DNS-Holes (PiHole, AdGuard Home...). <br />
So make sure to manually whitelist this address.
### Can I add my own widgets? Do I need programming skills?
We have decided, not to support custom widgets, until Homarr is in a stable and highly polished state.
Enabling users to write their own widgets is easy at the first glance, but there are some major issues with it:
- There are mainly two options for adding plugins or custom widgets to Homarr. The first option is, to allow and inject custom code in Homarr. Apps like Nextcloud can do this easily, because they use the Runtime to render all components of the application (In reality, the process is still a bit more complicated). In contrast, Homarr is using Next.js - a framework that needs to be compiled in production. That means, that each time you would modify a custom widget or plugin, the app would have to be restarted. There are options to avoid this, but they are quite flakey and bring disadvantages in our experience. The second option is, to write widgets declaratively instead of imperatively. This way, we would be able to render and modify widgets without any restarting at all. However, we'd have to write our own interpreter for said declarative schema. This is totally possible, but requires a lot of planning and architecture design to function properly. The required work to implement either option is therefore quite substantial.
- Custom widgets would need to be able to request data, so they work properly. We use tRPC for this. Many APIs use different formats and we'd have to convert and read those.
- Using custom widgets, one could easily create harmful widgets, leak your personal data (potentially including your tokens) and trick your users. A proper implementation (eg. official plugin store, where we can ban harmful widgets from) would resolve this problem to a certain extent, but again requires additional work and time to be put in.
Yes. A [Custom Widget](/docs/management/custom-widgets) can read a public or private HTTP API.
If you still want to add a widget, please consider to contribute it directly to Homarr. For that, basic programming skills are required. Our [Developer Guides](/docs/advanced/development/getting-started) explain this even more detailed.
It can show responsive Mantine JSX. It can also use widget options and actions with board permission checks.
Custom JSX v2 is the only Custom Widget format. Write the JSON and JSX in the workbench.
You can also use the AI copy prompt. An MCP agent can validate and preview a definition before it saves the definition.
The workbench reads a pasted AI response. It shows request capabilities and redacted diagnostics.
A template cannot import packages or run arbitrary JavaScript. It cannot call browser `fetch`.
Named requests use the Homarr server. The server applies board permissions and the network policy.
Before installation, examine the origins, methods, permissions, and actions. Use the same review before publication.
### Is it secure to expose Homarr to the web?
Yes, since v0.14.0, we are confident that Homarr is secure enough to be exposed to the web.
Yes, since v0.14.0, we are confident that Homarr is secure enough to be exposed to the web.
Make sure to enable the "allow anonymous access" [option in the settings](/docs/management/boards#access-control), if you want to allow people without an account to be able to see your dashboard (not edit)
### How do I open the console / log?
There are two different sources of information:
- console: This is your client (browser). It can tell us, if there is an issue on the client (crash, bug, ...).
- log: This is your server. It will tell us, if there are issues with connections for the integrations, crashes and errors.
Both variants *can* contain personal data. It's recommended, that you don't post them publicly or remove personal data from it.
Both variants _can_ contain personal data. It's recommended, that you don't post them publicly or remove personal data from it.
<Tabs>
<TabItem value="apple" label="Read console" default>
@@ -49,39 +63,45 @@ Both variants *can* contain personal data. It's recommended, that you don't post
> Note: This will not work on most mobile browsers.
Open your browser and ensure, that Homarr is your current tab.
Press ``CTRL`` + ``SHIFT`` + ``I`` on your keyboard. If this shortcut doesn't work, please use one of the alternatives: https://developer.chrome.com/docs/devtools/open/.
Click on ``Console`` in the new window, that opened. There, you should see white, orange and sometimes red messages. You can use the Windows Snip & Sketch tool (or your respective tool on Linux / MacOS) to screenshot those messages.
Press `CTRL` + `SHIFT` + `I` on your keyboard. If this shortcut doesn't work, please use one of the alternatives: https://developer.chrome.com/docs/devtools/open/.
Click on `Console` in the new window, that opened. There, you should see white, orange and sometimes red messages. You can use the Windows Snip & Sketch tool (or your respective tool on Linux / MacOS) to screenshot those messages.
> Please never execute any commands in the console. Scammers are using the console to let you execute harmful commands. If you want to resolve an issue in Homarr, **you'll never have to execute any commands here**
</TabItem>
<TabItem value="orange" label="Read log">
This depends on your installation method. If you use Unraid, you can simply click on the App and on ``Log``. If you have a bare Docker install, use ``docker container logs homarr``. If you used a different name than ``homarr`` for your container, you need to replace said argument. Here is some additional information about the command: https://geekflare.com/check-docker-logs/.
This depends on your installation method. If you use Unraid, you can simply click on the App and on `Log`. If you have a bare Docker install, use `docker container logs homarr`. If you used a different name than `homarr` for your container, you need to replace said argument. Here is some additional information about the command: https://geekflare.com/check-docker-logs/.
</TabItem>
</Tabs>
### How do I post logs?
Please check [the section above](#how-do-i-open-the-console--log), on how to obtain logs. Logs should always be posted to https://pastebin.com/ or https://rentry.co/.
### Can I use Homarr at my company?
Yes, you can! But please consider a donation, if our work has been useful to you.
### I think I found a bug. What can I do?
If you think, that you found a bug, please create an issue <a href="https://github.com/homarr-labs/homarr/issues/new/choose">here</a>.
### Why can't I use my custom icons?
You need to restart the Homarr Docker container after adding icons.
### Why can't homarr see/ping containers running locally behind GluetunVPN?
This is because GluetunVPN, and many other docker VPN services, secure their VPN connections with strict firewalls. These firewalls often block access to local containers, even on the same docker network. The workaround for <a href="https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/firewall.md">GluetunVPN</a> is to add "- FIREWALL_OUTBOUND_SUBNETS=192.168.1.0/24" into the environmental variables of the docker compose file. If you are using a firewall on your system, you will need to add a rule that allows requests from ip's in the range of 192.168.xxx.xxx . If you are using UFW the command would be "sudo ufw allow from 192.168.0.0/16".
Tip: If you are running your torrent client behind a VPN, and running Sonarr (or something similar) normally, make sure to open your torrent client's port in your firewall. If you don't, Sonarr will not be able to see it. Furthermore, use your machines IP (192.168.x.x) rather then 127.0.0.1 or localhost.
### Can I get in touch with you?
Yes, go <a href="/docs/community/get-in-touch">here</a> to get with us in touch.
<hr/>
<hr />
:::tip
apps/docs/docs/community/get-in-touch.mdx
+2 -2
View File
@@ -9,16 +9,16 @@ tags:
We're happy to talk with you! Shoot us a message at the following places:
## E-Mail
We are open to discuss sponsorships, security vulnerabilities and other private requests through our email.
Please do not report any bugs / feature requests here - they will be ignored and deleted.
[homarr-labs@proton.me](mailto:homarr-labs@proton.me)
## Discord
We have a Discord Server, where we announce new releases, discuss features and bugs and show off our dashboards.
There are over 4'000 members and we're happy to answer your questions or concerns.
You're also open to discuss new / upcoming features and any offtopic selfhosting content.
[_![](https://discordapp.com/api/guilds/972958686051962910/widget.png?style=banner2)_](https://discord.gg/aCsmEV5RgA)
apps/docs/docs/community/license.mdx
+1 -2
View File
@@ -7,6 +7,7 @@ tags:
Homarr is licensed under [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0).
## TL;DR
| Action | Allowed |
| -------------- | ------- |
| Copy | ✅ |
@@ -24,8 +25,6 @@ Please consider [making a donation](/docs/community/donate) to Homarr, if this p
:::
## Full License
```txt
apps/docs/docs/community/translations.mdx
+14 -12
View File
@@ -5,30 +5,31 @@ tags:
- Translations
---
We want to make Homarr accessible for everyone.
But to do that, we need your help.
We are running a community program that enables everyone to translate Homarr into their language – no programming required.
We are using [Crowdin](https://crowdin.com/) to manage our translations.
We want to make Homarr accessible for everyone.
But to do that, we need your help.
We are running a community program that enables everyone to translate Homarr into their language – no programming required.
We are using [Crowdin](https://crowdin.com/) to manage our translations.
You can find the translations [here](https://translate.homarr.dev/).
## How to translate
### Using crowdin's online platform
Go to the [Crowdin translations](https://translate.homarr.dev/) and select a language you want to translate.
You can then enter the translation mode and start translating.
After you've submitted your translations, a Proofreader will review your changes.
After a translation has been approved, it will be merged to the language development branch.
We merge this one periodically to the development branch.
Go to the [Crowdin translations](https://translate.homarr.dev/) and select a language you want to translate.
You can then enter the translation mode and start translating.
After you've submitted your translations, a Proofreader will review your changes.
After a translation has been approved, it will be merged to the language development branch.
We merge this one periodically to the development branch.
After the next update of Homarr, all changes from the development branch will be merged, including the changes in the translations.
### Using live translate
You can also help translate homarr directly from the app!
For this you can simply change your language to "Crowdin (live translations)"
![](./img/crowdin-language-select.png)
Then you'll be prompted to connect to your Crowdin account and choose the language in which you want to transalte.
Then you'll be prompted to connect to your Crowdin account and choose the language in which you want to transalte.
You can then start translating directly from the app by selecting some text on the app.
If some text cannot be selected to be edited with the live translation tool, you can still translate it inside of the In-Context popup at the Home tab, it will be red if it's not translated yet.
@@ -47,7 +48,8 @@ Do you want to become a proofreader? [Let us know on our Discord](/docs/communit
:::
## Guidelines
1. Translate with context: Some translations can't be translated 1:1 - they need context. Ensure that your translations make sense in the context.
2. Keep things simple and original - no additional characters are needed.
3. Don't translate the same thing twice - if you see a translation that is already translated, don't translate it again unless you have a better translation.
5. Keep your translations as close to the original as possible.
4. Keep your translations as close to the original as possible.
apps/docs/docs/getting-started/after-the-installation.mdx
+49 -45
View File
@@ -1,9 +1,12 @@
---
title: After the installation
sidebar_position: 3
tags:
- Getting started
- Configuration
- Getting started
- Configuration
---
import imageStartFromScratchStepServerSettings from "./img/onboarding-from-scratch-step-server-settings.png";
@@ -137,7 +140,8 @@ It is important that you first migrate correctly using [the list of breaking cha
## Creating your first board
In Homarr, you organize your apps and widgets on boards.
Boards can be organized using the interactive drag and drop.
Boards use fixed-size tiles so the same widget keeps the same proportions on every screen.
Drag, resize, and section controls are available in edit mode.
Let's create your first board by navigating here: `Manage` > `Boards` > `New board`:
![](./img/manage-create-board-button.png)
@@ -193,9 +197,7 @@ When entering the edit mode, you'll get some additional buttons to work with:
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
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. If you
can change the board, right-click empty grid space to add an item at that position.
On a touch device, touch and hold empty grid space for the same precise-placement menu.
keep its advanced view open until you close it. Widgets without a distinct advanced experience adapt in place.
To continue, click the option "New Item":
@@ -220,21 +222,28 @@ In the modal you can edit the app that you want to display:
![](./img/manage-board-choose-app.png)
As soon as you save your changes, the tile on the board will refresh and display your app.
Using the small bidirectional arrow at the bottom right you can resize the element.
Start pressing with your mouse button down, move your mouse to resize and release your finger as soon your you're happy with the size.
Use the resize handle at the bottom right to resize the tile.
Press and hold the handle, move the pointer, and release it when the tile has the size you want.
![](./img/resize-item.gif)
To move your item to a different position on the board, simply hold the mouse button anywhere on the item and move with the mouse to the desired position.
As soon as you release your finger, the item will snap in place in the grid.
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.
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.
![](./img/move-item.gif)
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.
Homarr scales the complete board uniformly, like zooming a page.
It stops shrinking at 75% and lets you scroll horizontally instead of making text and controls too small.
It does not squeeze or reflow the content of individual widgets, so a widget keeps the same design and proportions across screen sizes.
:::note
You cannot move items freely on the vertical axis.
We always align all items to the top of the page to simply organization.
To move items to the bottom, you must add more items or resize items.
Viewing a board initially uses the lightweight, non-interactive layout.
For users with edit access, Homarr prepares drag-and-drop and resize controls in the background after the board becomes interactive.
If you enter edit mode before that finishes, the existing board stays visible until the editor is ready.
:::
@@ -245,8 +254,10 @@ This helps you to explore the capabilities of Homarr before you build your board
:::
Users on touch or mobile devices may not be able to drag and drop or move items.
They can use the "Move / resize item" option in the edit menu of items instead:
Keyboard users can focus a tile, press Enter or Space, then use arrow keys to move and Shift plus arrow keys to resize.
Press Escape to stop.
For precise numeric controls or touch input, choose **Move / resize item** from the tile's edit menu.
The dialog can also move the tile to another section or fixed sidebar:
![](./img/manage-board-move-resize-item-menu.png)
@@ -318,43 +329,36 @@ As with every change, don't forget to save your changes using the exit edit mode
![](./img/exit-edit-mode.png)
## Grouping your items
## Organizing items with Containers
As the last step, let's organize your freshly created items using two different options.
You can choose either or both of them on your boards.
Containers are resizable areas for apps, widgets, and nested Containers.
The same Container works on the main canvas, inside a fixed rail, or inside another Container.
Each Container can configure:
### Using dynamic sections
- Its label and whether that label is visible.
- Allow or disable collapsing.
- Show or hide **Open all in new tabs**.
- Change its border color and custom CSS classes.
Dynamic sections are a simple, resizable visual group to group items.
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.
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.
![](./img/create-dynamic-section.png)
### Collapsing and opening apps
After adding a dynamic section, you can simply drag and drop items into the section:
Users can collapse an eligible Container like an accordion in view mode without changing its saved expanded size.
The full-width header becomes the compact expansion bar, so the half-row state has no empty pill-shaped spacer.
Expanding it restores its bounds and makes room for its contents.
If **Open all in new tabs** is enabled, the Container menu can open every app link it contains.
![](./img/dynamic-section.gif)
### Fixed rails
### Using categories
Categories are more advanced and complicated than dynamic sections.
To create a category, open the add item modal and choose "new category":
![](./img/add-category.png)
Every category must have a name. After you click "Add category", you will get a new item on your board:
![](./img/category.gif)
You can drag and drop items in to this category in the edit mode.
Categories will have a big space before and after them in the edit mode to
enable you to drag and drop items outside the category.
You can also collapse or open categories in edit mode to facilitate your editing process.
:::note
A current limitation of categories is, that they will always have a width of 100%.
You cannot reduce their horizontal width.
:::
Open the board's **Layout** settings to enable the left or right rail for each responsive layout.
Choose one, two, or three columns with the slider and use the preview to check the remaining canvas width.
The rail reserves those columns from the dashboard, so Homarr moves canvas items into the next available positions.
Rail content stays visible while the page scrolls and remains editable.
Each responsive layout keeps its own rail widths, item positions, and item sizes.
## Guided tours
apps/docs/docs/getting-started/glossary.mdx
+11 -10
View File
@@ -1,12 +1,13 @@
# Glossary
In the glossary, you'll learn the different components and their names of Homarr.
| Term | Definition |
|-----------------|----------------------------------------------------------------------------------------------------------------|
| Apps | An piece of software that you or a third party hosts (eg. Google) |
| Integration | A connection to a service outside of Homarr |
| Dynamic section | Resizeable area where items on your board can be placed and grouped |
| Widget | A tile that uses your integrations to display data or enables you to interact with with them |
| Edit mode | Temporary state that you can enter where you can drag and drop, edit or customize your board |
| Board | Customizable page which can be edited using the edit mode. This is where apps, sections and widgets are placed |
| Tasks | Workloads that are performed in the background - even if there is no user present |
This glossary explains Homarr's main components and the terms used for them.
| Term | Definition |
| ----------- | --------------------------------------------------------------------------------------- |
| Apps | A piece of software that you or a third party hosts (for example, Google) |
| Integration | A connection to a service outside of Homarr |
| Container | A resizable area that can hold apps, widgets, and nested Containers |
| Widget | A tile that uses your integrations to display data or enables you to interact with them |
| Edit mode | A temporary state where you can drag, resize, edit, or customize your board |
| Board | A customizable page where apps, widgets, and Containers are arranged |
| Tasks | Workloads that are performed in the background, even if no user is present |
apps/docs/docs/getting-started/index.mdx
+7 -6
View File
@@ -8,13 +8,14 @@ tags:
- Unraid
---
import Link from '@docusaurus/Link';
import { IconArrowRight } from '@tabler/icons-react';
import Link from "@docusaurus/Link";
import { IconArrowRight } from "@tabler/icons-react";
Before you try to install Homarr, please review if your device meets the requirements.
Installing on an unsupported device may lead to unstable behaviour and no support will be provided.
## Hardware
- At least 500MB RAM
- At least 600MB of free disk space for the Docker image. SSD is preferred.
- Single or dual core CPU
@@ -24,8 +25,8 @@ Installing on an unsupported device may lead to unstable behaviour and no suppor
We build Homarr for a bunch of different architectures, including ARM. Please ensure that your device architecture is supported by Homarr. We won't be able to provide support for unusual or outdated architectures.
| Architecture | Supported |
|--------------|-----------------|
| Architecture | Supported |
| ------------ | ---------------- |
| linux/amd64 | ✅ Supported |
| linux/arm64 | ✅ Supported |
| linux/arm/v7 | ❌ Not supported |
@@ -34,10 +35,10 @@ We build Homarr for a bunch of different architectures, including ARM. Please en
<Link
data-attr="Go to installation"
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"}
to="/docs/category/installation-1"
>
<div className={'flex items-center gap-3'}>
<div className={"flex items-center gap-3"}>
<span className={"dark:text-gray-200"}>Go to Installation</span>
<IconArrowRight className={"dark:text-gray-200"} size={20} />
</div>
apps/docs/docs/getting-started/installation/docker.mdx
+22 -20
View File
@@ -1,21 +1,23 @@
import { DockerInstallSnippet } from '@site/src/components/pages/installation/docker/dynamic-docker-install'
import { DockerInstallSnippet } from "@site/src/components/pages/installation/docker/dynamic-docker-install";
# Docker
Docker is our recommended installation method for beginners and professionals.
It is easy to use, ships with all dependencies inside a single container and is easy to use and maintain.
It requires at least some basic knowledge of [Docker](https://www.docker.com/).
We recommend [NetworkChuck's Docker Containers 101](https://www.youtube.com/watch?v=eGz9DS-aIeY) as a good start for complete beginners.
## Docker compose
### Prerequisites
- A Linux or Windows based system that meets the [hardware prerequisites](/docs/getting-started/#hardware) and [architecture prerequisites](/docs/getting-started/#architecture).
- [Docker](https://docs.docker.com/get-docker/)
- [Docker Compose](https://docs.docker.com/compose/install/) - *preinstalled on many systems nowadays*
- [Docker Compose](https://docs.docker.com/compose/install/) - _preinstalled on many systems nowadays_
### Installation
<DockerInstallSnippet data-visual-test="blackout"/>
<DockerInstallSnippet data-visual-test="blackout" />
Finally, run ``docker compose up -d`` in the same directory. This will start the Homarr container in the background.
:::caution
@@ -26,27 +28,26 @@ Docker compose creates a network by default. Some integrations may not work (spe
### Updating
To update, navigate to the directory with the ``docker-compose.yaml`` located.
To update, navigate to the directory with the `docker-compose.yaml` located.
- Stop Homarr using ``docker compose down``
- Pull the newest image of Homarr using ``docker compose pull``
- Start Homarr again using ``docker compose up -d`` (``-d`` for detached mode - start in background)
- Delete the old image using ``docker image prune`` (*Warning: this also removes you other unused images - not just Homarr*)
- Stop Homarr using `docker compose down`
- Pull the newest image of Homarr using `docker compose pull`
- Start Homarr again using `docker compose up -d` (`-d` for detached mode - start in background)
- Delete the old image using `docker image prune` (_Warning: this also removes you other unused images - not just Homarr_)
You can automate this process using [Watchtower](https://containrrr.dev/watchtower/).
### Uninstalling
To uninstall, navigate to the directory with the ``docker-compose.yaml`` located.
To uninstall, navigate to the directory with the `docker-compose.yaml` located.
- Stop Homarr using ``docker compose down``
- Delete the created directories & files on your root file system (check ``docker-compose.yaml`` file for your specific locations)
- Delete compose file using ``rm docker-compose.yaml``
- Prune unused Docker images using ``docker image prune`` (*Warning: this also removes you other unused images - not just Homarr*)
- Stop Homarr using `docker compose down`
- Delete the created directories & files on your root file system (check `docker-compose.yaml` file for your specific locations)
- Delete compose file using `rm docker-compose.yaml`
- Prune unused Docker images using `docker image prune` (_Warning: this also removes you other unused images - not just Homarr_)
- (Optional): Prune any network or volumes if you use any.
- (Optional): Remove Homarr from your reverse proxy, VPNs or tunnels if you use any.
## Docker standalone
:::caution
@@ -77,15 +78,16 @@ docker run \
:::note
Docker will mount the configuration files and icons to your host machine. Please make sure to replace ``<your-path>`` from the docker run command with your desired storage location. The path must be absolute.
Docker will mount the configuration files and icons to your host machine. Please make sure to replace `<your-path>` from the docker run command with your desired storage location. The path must be absolute.
:::
### Updating
To update Homarr, you must remove your container first. Make sure that you've mounted your data and that you have access to it, so your configuration doesn't get lost.
1. Run ``docker rm homarr`` to remove the container.
2. Pull the latest Homarr image ``docker pull ghcr.io/homarr-labs/homarr:latest``.
1. Run `docker rm homarr` to remove the container.
2. Pull the latest Homarr image `docker pull ghcr.io/homarr-labs/homarr:latest`.
3. Re-run the command you used to install Homarr.
This process can get tideous, if you update frequently. Thus, we recommend [using docker-compose](#docker-compose)
@@ -98,8 +100,8 @@ Want to update all your containers automatically? Checkout [Watchtower](https://
### Uninstalling
1. Obtain the container ID of your Homarr container using ``docker ps | grep homarr``.
2. Delete the container using ``docker rm <your-container-id>``
3. Prune unused Docker images using ``docker image prune`` (*Warning: this also removes you other unused images - not just Homarr*)
1. Obtain the container ID of your Homarr container using `docker ps | grep homarr`.
2. Delete the container using `docker rm <your-container-id>`
3. Prune unused Docker images using `docker image prune` (_Warning: this also removes you other unused images - not just Homarr_)
4. (Optional): Prune any network or volumes if you use any.
5. (Optional): Remove Homarr from your reverse proxy, VPNs or tunnels if you use any.
apps/docs/docs/getting-started/installation/helm.md
+56 -48
View File
@@ -2,9 +2,9 @@
<img src="https://raw.githubusercontent.com/homarr-labs/charts/refs/heads/main/charts/homarr/icon.svg" align="right" width="92" alt="homarr logo">
![Version: 8.25.0](https://img.shields.io/badge/Version-8.25.0-informational?style=flat)
![Version: 8.26.0](https://img.shields.io/badge/Version-8.26.0-informational?style=flat)
![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat)
![AppVersion: v1.73.0](https://img.shields.io/badge/AppVersion-v1.73.0-informational?style=flat)
![AppVersion: v1.74.0](https://img.shields.io/badge/AppVersion-v1.74.0-informational?style=flat)
A Helm chart to deploy homarr for Kubernetes
@@ -12,7 +12,7 @@ A Helm chart to deploy homarr for Kubernetes
## Source Code
* <https://github.com/homarr-labs/homarr>
- <https://github.com/homarr-labs/homarr>
## Requirements
@@ -76,38 +76,38 @@ To avoid including sensitive information in plain text within your version contr
Below is an exhaustive list of all secrets:
| FEATURE | SECRET NAME | SECRET KEYS | Required |
|-----------|-------------------------|-----------------------------------------|----------|
| OIDC | auth-oidc-secret | oidc-client-id<br>oidc-client-secret | No |
| LDAP | auth-ldap-secret | bind-password | No |
| DATABASE | db-secret | db-url | No |
| DATABASE | db-encryption | db-encryption-key | yes |
| FEATURE | SECRET NAME | SECRET KEYS | Required |
| -------- | ---------------- | ------------------------------------ | -------- |
| OIDC | auth-oidc-secret | oidc-client-id<br>oidc-client-secret | No |
| LDAP | auth-ldap-secret | bind-password | No |
| DATABASE | db-secret | db-url | No |
| DATABASE | db-encryption | db-encryption-key | yes |
### Database
You have multiple options for configuring the database:
| DRIVER TYPE | Persistence mode |
|----------------|---------------------------------|
| better-sqlite3 | Pod disk |
| better-sqlite3 | homarr-database PVC |
| mysql2 | External MySql database |
| node-postgres | External Postgresql database |
| DRIVER TYPE | Persistence mode |
| -------------- | ---------------------------- |
| better-sqlite3 | Pod disk |
| better-sqlite3 | homarr-database PVC |
| mysql2 | External MySql database |
| node-postgres | External Postgresql database |
#### Pod disk
No additional configuration is required. However, keep in mind that if the pod restarts, all data will be lost. This setup is not *recommended* for production use.
No additional configuration is required. However, keep in mind that if the pod restarts, all data will be lost. This setup is not _recommended_ for production use.
To create the necessary database secret, execute the following command:
<details>
<summary>Required Secrets</summary>
````yaml
```yaml
kubectl create secret generic db-encryption \
--from-literal=db-encryption-key='<SECRET_ENCRYPTION_KEY_SECRET_TO_CHANGE>' \
--namespace homarr
````
```
</details>
@@ -120,11 +120,11 @@ Associated secret to create :
<details>
<summary>DB Required Secrets</summary>
````yaml
```yaml
kubectl create secret generic db-encryption \
--from-literal=db-encryption-key='<SECRET_ENCRYPTION_KEY_SECRET_TO_CHANGE>' \
--namespace homarr
````
```
</details>
@@ -133,13 +133,13 @@ Bellow an example of the override value file :
<details>
<summary>values.yaml</summary>
````yaml
```yaml
persistence:
homarrDatabase:
enabled: true
storageClassName: "default"
size: "1Gi"
````
```
</details>
@@ -150,17 +150,18 @@ To create the necessary database secrets, execute the following command:
<details>
<summary>Required Secrets</summary>
````yaml
```yaml
kubectl create secret generic db-encryption \
--from-literal=db-encryption-key='<SECRET_ENCRYPTION_KEY_SECRET_TO_CHANGE>' \
--namespace homarr
````
```
````yaml
```yaml
kubectl create secret generic db-secret \
--from-literal=db-url='mysql://user:password@host:port/homarrdb' \
--namespace homarr
````
```
</details>
Below is an example of the override values file:
@@ -168,10 +169,11 @@ Below is an example of the override values file:
<details>
<summary>values.yaml</summary>
````yaml
```yaml
database:
type: mysql
````
```
</details>
#### External Postgresql database
@@ -181,17 +183,17 @@ To create the necessary database secrets, execute the following command:
<details>
<summary>Required Secrets</summary>
````yaml
```yaml
kubectl create secret generic db-encryption \
--from-literal=db-encryption-key='<SECRET_ENCRYPTION_KEY_SECRET_TO_CHANGE>' \
--namespace homarr
````
```
````yaml
```yaml
kubectl create secret generic db-secret \
--from-literal=db-url='postgresql://user:password@host:port/homarrdb' \
--namespace homarr
````
```
</details>
@@ -200,10 +202,11 @@ Below is an example of the override values file:
<details>
<summary>values.yaml</summary>
````yaml
```yaml
database:
type: postgresql
````
```
</details>
### Ingress
@@ -213,7 +216,7 @@ The ingress section in the values.yaml file allows you to configure how external
<details>
<summary>values.yaml</summary>
````yaml
```yaml
service:
enabled: true # Ensure the service is enabled for Ingress to route traffic
ingress:
@@ -231,7 +234,8 @@ ingress:
- "homarr.homelab.dev"
- "www.homarr.homelab.dev"
secretName: homelab-tls
````
```
</details>
### HTTPRoute (Gateway API)
@@ -242,9 +246,9 @@ This provides a more expressive and future-proof alternative to Ingress, with su
<details>
<summary>values.yaml</summary>
````yaml
```yaml
service:
enabled: true # must be enabled for HTTPRoute to forward traffic
enabled: true # must be enabled for HTTPRoute to forward traffic
httproute:
enabled: true
parentRefs:
@@ -267,7 +271,7 @@ httproute:
- parentRefs: the Gateway(s) this route attaches to. Gateways must already exist.
- hostnames: domain names this route applies to.
- rules: each rule can define matches (paths, headers, queries), optional filters, and backendRefs to services
- rules: each rule can define matches (paths, headers, queries), optional filters, and backendRefs to services
- TLS must be configured on the Gateway (not on HTTPRoute). For example, the Gateway can have a TLS listener for homarr.homelab.dev, and this route will automatically apply once matched.
### Certificates
@@ -284,7 +288,7 @@ Use inline certificates to generate a ConfigMap, mounted as individual files.
<details>
<summary>values.yaml</summary>
````yaml
```yaml
persistence:
homarrTrustedCerts:
enabled: true
@@ -298,7 +302,8 @@ persistence:
-----BEGIN CERTIFICATE-----
MIID...EFGH==
-----END CERTIFICATE-----
````
```
</details>
Behavior:
@@ -313,7 +318,7 @@ Use inline certificates to generate a Kubernetes Secret, mounted as files.
<details>
<summary>values.yaml</summary>
````yaml
```yaml
persistence:
homarrTrustedCerts:
enabled: true
@@ -327,7 +332,8 @@ persistence:
-----BEGIN CERTIFICATE-----
MIIC...XYZ==
-----END CERTIFICATE-----
````
```
</details>
Behavior:
@@ -342,16 +348,17 @@ Use an existing Kubernetes Secret, assuming its keys are filenames.
<details>
<summary>values.yaml</summary>
````yaml
```yaml
persistence:
homarrTrustedCerts:
enabled: true
type: existingSecret
existingSecretName: "existingSecretName"
existingSecretKeys:
- cert3.crt
- cert4.crt
````
- cert3.crt
- cert4.crt
```
</details>
Behavior:
@@ -429,7 +436,7 @@ All available values are listed on the [artifacthub](https://artifacthub.io/pack
| httproute.rules[0].matches[0].path.value | string | `"/"` | Path value to match |
| image.pullPolicy | string | `"IfNotPresent"` | Image pull policy |
| image.repository | string | `"ghcr.io/homarr-labs/homarr"` | Image repository |
| image.tag | string | `"v1.73.0"` | Overrides the image tag whose default is the chart appVersion |
| image.tag | string | `"v1.74.0"` | Overrides the image tag whose default is the chart appVersion |
| imagePullSecrets | list | `[]` | Secrets for Docker registry |
| ingress.annotations | object | `{}` | Ingress annotations |
| ingress.enabled | bool | `false` | Enable ingress |
@@ -482,4 +489,5 @@ All available values are listed on the [artifacthub](https://artifacthub.io/pack
| tolerations | list | `[]` | Node tolerations for pod scheduling |
---
Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs)
apps/docs/docs/getting-started/installation/home-assistant.mdx
+1 -1
View File
@@ -14,7 +14,7 @@ Homarr can be seamlessly integrated into your Home Assistant setup with this add
## Installation
1. **Add Repository**: Navigate to your Home Assistant Supervisor panel, and go to the Add-on Store. Add the following repository URL: `https://github.com/Wiggen94/ha-homarr-v1-server` or click this button
[![Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2FWiggen94%2Fha-homarr-v1-server)
[![Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2FWiggen94%2Fha-homarr-v1-server)
2. **Install the Add-on**: Search for "Homarr Server" in the Add-on Store and select it. Click on "Install" to start the installation process.
apps/docs/docs/getting-started/installation/portainer.mdx
+7 -6
View File
@@ -1,5 +1,7 @@
# Portainer
## Portainer Stacks
### Prerequisites
- [Portainer Stacks](https://www.portainer.io/blog/stacks-docker-compose-the-portainer-way)
@@ -23,15 +25,14 @@ services:
environment:
- SECRET_ENCRYPTION_KEY=your_64_character_hex_string # <--- can be generated with `openssl rand -hex 32`
ports:
- '7575:7575'
- "7575:7575"
```
:::note
Portainer will mount the files to your host machine. Please make sure to replace ``<your-path>`` from the docker run command with your desired storage location. The path must be absolute.
Portainer will mount the files to your host machine. Please make sure to replace `<your-path>` from the docker run command with your desired storage location. The path must be absolute.
:::
Then, click on ``Deploy the stack`` and wait until the container has started.
Then, click on `Deploy the stack` and wait until the container has started.
:::tip
@@ -43,5 +44,5 @@ If you're unsure how to create a stack, checkout the [Portainer Documentation](h
To update Homarr using Docker Compose or Portainer Stacks, simply pull the latest image and restart the container.
1. Run ``docker pull ghcr.io/homarr-labs/homarr:latest`` to pull the latest image.
2. Re-run ``docker-compose up -d`` or re-deploy the stack in Portainer.
1. Run `docker pull ghcr.io/homarr-labs/homarr:latest` to pull the latest image.
2. Re-run `docker-compose up -d` or re-deploy the stack in Portainer.
apps/docs/docs/getting-started/installation/proxmox.mdx
+4 -2
View File
@@ -31,7 +31,7 @@ After you've installed Homarr, you can find a new LXC "homarr".
# Updating
Updating is as simple as executing
Updating is as simple as executing
```bash
update
@@ -49,17 +49,19 @@ Some Homarr features require setting environment variables. When installing Homa
# Troubleshooting
If something does not work after an update, please first try rebooting the LXC or the homarr Service with
If something does not work after an update, please first try rebooting the LXC or the homarr Service with
```bash
systemctl restart homarr
```
# Getting help
- If you are looking for help with the script, updating the LXC or troubleshooting the installer, please get in contact with the support of the community scripts. They provide support on their [Discord](https://discord.gg/2wvnMDgdnU). If you found vulnerabilities, bugs or have a request for the script, [create a new issue here](https://github.com/community-scripts/ProxmoxVE/issues/new/choose).
- If you are looking to report a bug, vulnerability or request a new feature, use https://github.com/homarr-labs/homarr . You can ask for help on our Discord.
# How to find logs
Homarr runs under a system service called `homarr`, so getting the logs is a simple as using the following command inside the LXC (Container) Shell
```bash
apps/docs/docs/getting-started/installation/qnap.mdx
+1 -1
View File
@@ -4,6 +4,6 @@
QNAP installation guide has not updated to 1.0 yet. There guide is still for 0.15.10.
:::
When installing on QNAP, we recommend you to install Homarr using [Container Station]( https://www.qnap.com/en/software/container-station) or [this third-party image](https://www.myqnap.org/product/homarr/).
When installing on QNAP, we recommend you to install Homarr using [Container Station](https://www.qnap.com/en/software/container-station) or [this third-party image](https://www.myqnap.org/product/homarr/).
There is also a guide available, but note that it is written in Chinese: https://post.smzdm.com/p/awzm7op2/
apps/docs/docs/getting-started/installation/runtipi.mdx
+10 -7
View File
@@ -1,4 +1,4 @@
# Runtipi
# Runtipi
Runtipi is a self-hosted orchestrator that makes it easy to manage and run multiple services on a single server. It is based on Docker and comes with a simple web interface to manage your services. Runtipi is designed to be easy to use, so you don't have to worry about manual configuration or networking.
@@ -11,6 +11,7 @@ https://runtipi.io
# Installation
Installing Homarr is pretty untuitive, the app is available in the default appstore :
1. Search for **"Homarr"** in the App-Store page and select it
2. Click on **"Install"**.
3. Choose the method you want to access Homarr, through any port or domain name then select **"Install"**
@@ -18,13 +19,15 @@ Installing Homarr is pretty untuitive, the app is available in the default appst
# Maintenance
After installation, all you need is available from the WebUI in **"My apps"** > **"Homarr"** :
- Start/Stop
- Update
- Backup
- Logs
- Start/Stop
- Update
- Backup
- Logs
If you like to tinker with your apps, you can also edit your app's docker-compose with a [user-config](https://runtipi.io/docs/guides/customize-app-config).
# Getting help
- If you are looking for help with anything in Runtipi. They provide support on their [Discord](https://discord.gg/Bu9qEPnHsc) and [forums](https://forums.runtipi.io/). If you found vulnerabilities or bugs, [create a new issue here](https://github.com/runtipi/runtipi-appstore/issues).
- If you are looking to report a bug, vulnerability or request a new feature for Homarr, use https://github.com/homarr-labs/homarr . You can ask for help on our Discord.
- If you are looking to report a bug, vulnerability or request a new feature for Homarr, use https://github.com/homarr-labs/homarr . You can ask for help on our Discord.
apps/docs/docs/getting-started/installation/saltbox.mdx
+2 -1
View File
@@ -5,6 +5,7 @@ Saltbox installation command has not updated to 1.0 yet. There command still run
:::
You can also use this to install on Saltbox:
```bash
sb install sandbox-homarr
```
```
apps/docs/docs/getting-started/installation/source.mdx
+20 -6
View File
@@ -28,15 +28,29 @@ This method is only useful, when you want to develop on Homarr or extend it with
## Steps
<ol>
<li>Clone the Repository using <code>git clone https://github.com/homarr-labs/homarr.git</code></li>
<li>Enter the created directory using <code>cd homarr</code></li>
<li>Install all dependencies using <code>pnpm install</code></li>
<li>Copy the `.env.example` file to `.env` and replace `DB_URL` with the full path you want to use for the sqlite database file. For example `DB_URL='/home/username/homarr/db.sqlite`</li>
<li>Replace `AUTH_SECRET` and `SECRET_ENCRYPTION_KEY` both with a secure random string by using `openssl rand -hex 32`</li>
<li>
Clone the Repository using <code>git clone https://github.com/homarr-labs/homarr.git</code>
</li>
<li>
Enter the created directory using <code>cd homarr</code>
</li>
<li>
Install all dependencies using <code>pnpm install</code>
</li>
<li>
Copy the `.env.example` file to `.env` and replace `DB_URL` with the full path you want to use for the sqlite
database file. For example `DB_URL='/home/username/homarr/db.sqlite`
</li>
<li>
Replace `AUTH_SECRET` and `SECRET_ENCRYPTION_KEY` both with a secure random string by using `openssl rand -hex 32`
</li>
<li>Replace `CRON_JOB_API_KEY` with a secure random string by using `openssl rand -base64 32`</li>
<li>Run `pnpm run db:migration:sqlite:run` and wait that it completes</li>
<li>Build the source using `pnpm build`</li>
<li>Copy better-sqlite3.node files with `mkdir build` and `cp ./node_modules/better-sqlite3/build/Release/better_sqlite3.node ./build/better_sqlite3.node`</li>
<li>
Copy better-sqlite3.node files with `mkdir build` and `cp
./node_modules/better-sqlite3/build/Release/better_sqlite3.node ./build/better_sqlite3.node`
</li>
<li>Start a redis server using `redis-server`</li>
<li>Run the server using `pnpm start`</li>
<li>Open `http://localhost:3000` in your browser</li>
apps/docs/docs/getting-started/installation/unraid.mdx
+6 -7
View File
@@ -1,5 +1,5 @@
import Link from '@docusaurus/Link';
import { IconDownload } from '@tabler/icons-react';
import Link from "@docusaurus/Link";
import { IconDownload } from "@tabler/icons-react";
# Unraid
@@ -14,17 +14,17 @@ You can install Homarr directly from your Unraid Dashboard, no terminal required
<Link
data-attr="Install Unraid Community Apps"
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"}
to="https://forums.unraid.net/topic/38582-plug-in-community-applications/"
>
<div className={'flex items-center gap-3'}>
<div className={"flex items-center gap-3"}>
<span className={"dark:text-gray-200"}>Install community applications plugin</span>
<IconDownload className={"dark:text-gray-200"} size={20} />
</div>
</Link>
<br/>
<br/>
<br />
<br />
:::tip
@@ -46,4 +46,3 @@ After you've installed the Community Apps Plugin, you can install Homarr from th
After you've installed Homarr, you can find it under the tab "Docker".
The official support thread is located [here](https://forums.unraid.net/topic/123478-support-smartphonelover-homarr/), but we prefer to communicate over GitHub and Discord instead.
apps/docs/docs/integrations/adguard-home/index.mdx
+28 -21
View File
@@ -1,37 +1,44 @@
---
title: 'AdGuard Home'
title: "AdGuard Home"
description: "AdGuard Home is a network-wide software for blocking ads and trackers, providing a safer and faster internet experience."
hide_title: true
---
import { IntegrationHeader } from '@site/src/components/integrations/header';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import { AddingIntegration } from '@site/src/components/integrations/adding';
import {IntegrationSecrets} from '@site/src/components/integrations/secrets';
import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { AddingIntegration } from "@site/src/components/integrations/adding";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { IconAd, IconDeviceGamepad } from "@tabler/icons-react";
import { adguardHomeIntegration } from '.';
import { dnsHoleSummaryWidget } from '@site/docs/widgets/dns-hole-summary';
import { dnsHoleControlsWidget } from '@site/docs/widgets/dns-hole-controls';
import { adguardHomeIntegration } from ".";
import { dnsHoleSummaryWidget } from "@site/docs/widgets/dns-hole-summary";
import { dnsHoleControlsWidget } from "@site/docs/widgets/dns-hole-controls";
<IntegrationHeader
integration={adguardHomeIntegration}
categories={['DNS Hole']}
/>
<IntegrationHeader integration={adguardHomeIntegration} categories={["DNS Hole"]} />
### Widgets & Capabilities
<IntegrationCapabilites
items={[{
widget: dnsHoleSummaryWidget,
},{
widget: dnsHoleControlsWidget
}]}
items={[
{
widget: dnsHoleSummaryWidget,
},
{
widget: dnsHoleControlsWidget,
},
]}
/>
### Adding the integration
<AddingIntegration />
### Secrets
<IntegrationSecrets secrets={[{
credentials: ['username', 'password'],
steps: []
}]} />
<IntegrationSecrets
secrets={[
{
credentials: ["username", "password"],
steps: [],
},
]}
/>
apps/docs/docs/integrations/anchor/index.mdx
+28 -23
View File
@@ -1,40 +1,45 @@
---
title: 'Anchor'
title: "Anchor"
description: "Anchor is a self-hosted note-taking application."
hide_title: true
---
import { IntegrationHeader } from '@site/src/components/integrations/header';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import { AddingIntegration } from '@site/src/components/integrations/adding';
import { IntegrationSecrets } from '@site/src/components/integrations/secrets';
import { anchorIntegration } from '.';
import { anchorNoteWidget } from '@site/docs/widgets/anchor-note';
import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { AddingIntegration } from "@site/src/components/integrations/adding";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { anchorIntegration } from ".";
import { anchorNoteWidget } from "@site/docs/widgets/anchor-note";
<IntegrationHeader
integration={anchorIntegration}
categories={['Notes']}
/>
<IntegrationHeader integration={anchorIntegration} categories={["Notes"]} />
The Anchor integration lets Homarr connect to your Anchor instance so you can display and edit selected notes directly from your dashboard.
### Widgets & Capabilities
<IntegrationCapabilites
items={[{
widget: anchorNoteWidget
}]}
items={[
{
widget: anchorNoteWidget,
},
]}
/>
### Adding the integration
<AddingIntegration />
### Secrets
<IntegrationSecrets secrets={[{
credentials: ['apiKey'],
steps: [
'Open your Anchor instance.',
'Generate or copy an API key from Anchor settings.',
'Paste that key into the API Key secret field in Homarr.'
]
}]} />
<IntegrationSecrets
secrets={[
{
credentials: ["apiKey"],
steps: [
"Open your Anchor instance.",
"Generate or copy an API key from Anchor settings.",
"Paste that key into the API Key secret field in Homarr.",
],
},
]}
/>
apps/docs/docs/integrations/aria2/index.mdx
+28 -23
View File
@@ -1,38 +1,43 @@
---
title: 'Aria2'
title: "Aria2"
description: "Lightweight multiprotocol & multi-source command-line download utility. It supports HTTP/HTTPS, FTP, SFTP, BitTorrent and Metalink"
hide_title: true
---
import { IntegrationHeader } from '@site/src/components/integrations/header';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import { AddingIntegration } from '@site/src/components/integrations/adding';
import { IntegrationSecrets } from '@site/src/components/integrations/secrets';
import { aria2Integration } from '.';
import { downloadsWidget } from '@site/docs/widgets/downloads';
import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { AddingIntegration } from "@site/src/components/integrations/adding";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { aria2Integration } from ".";
import { downloadsWidget } from "@site/docs/widgets/downloads";
<IntegrationHeader
integration={aria2Integration}
categories={['Download', 'Multiprotocol', 'Multi-source']}
/>
<IntegrationHeader integration={aria2Integration} categories={["Download", "Multiprotocol", "Multi-source"]} />
### Widgets & Capabilities
<IntegrationCapabilites
items={[{
widget: downloadsWidget,
}]}
items={[
{
widget: downloadsWidget,
},
]}
/>
### Adding the integration
<AddingIntegration />
### Secrets
<IntegrationSecrets secrets={[
{
credentials: ['apiKey'],
steps: []
},
{
credentials: [],
steps: []
}]} />
<IntegrationSecrets
secrets={[
{
credentials: ["apiKey"],
steps: [],
},
{
credentials: [],
steps: [],
},
]}
/>
apps/docs/docs/integrations/audiobookshelf/index.mdx
+25 -26
View File
@@ -1,41 +1,40 @@
---
title: 'Audiobookshelf'
title: "Audiobookshelf"
description: "Audiobookshelf is a self-hosted audiobook and podcast server that lets you manage and stream your audio library."
hide_title: true
---
import { IntegrationHeader } from '@site/src/components/integrations/header';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import { AddingIntegration } from '@site/src/components/integrations/adding';
import { IntegrationSecrets } from '@site/src/components/integrations/secrets';
import { audiobookshelfIntegration } from '.';
import { audioStatsWidget } from '@site/docs/widgets/audio-stats';
import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { AddingIntegration } from "@site/src/components/integrations/adding";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { audiobookshelfIntegration } from ".";
import { audioStatsWidget } from "@site/docs/widgets/audio-stats";
<IntegrationHeader
integration={audiobookshelfIntegration}
categories={['Media']}
/>
<IntegrationHeader integration={audiobookshelfIntegration} categories={["Media"]} />
Audiobookshelf provides library statistics including audiobook and podcast counts, listening time, and active sessions.
### Widgets & Capabilities
<IntegrationCapabilites
items={[
{ widget: audioStatsWidget },
]}
/>
<IntegrationCapabilites items={[{ widget: audioStatsWidget }]} />
### Adding the integration
<AddingIntegration />
### Secrets
<IntegrationSecrets secrets={[{
credentials: ['apiKey'],
steps: [
'Open your Audiobookshelf instance',
'Go to Settings → Users',
'Click on your user account',
'Copy the API token from the user details',
]
}]} />
<IntegrationSecrets
secrets={[
{
credentials: ["apiKey"],
steps: [
"Open your Audiobookshelf instance",
"Go to Settings → Users",
"Click on your user account",
"Copy the API token from the user details",
],
},
]}
/>
apps/docs/docs/integrations/bazarr/index.mdx
+28 -24
View File
@@ -1,31 +1,30 @@
---
title: 'Bazarr'
title: "Bazarr"
description: "Bazarr is a companion application to Sonarr and Radarr that manages and downloads subtitles."
hide_title: true
---
import { IntegrationHeader } from '@site/src/components/integrations/header';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import { AddingIntegration } from '@site/src/components/integrations/adding';
import { IntegrationSecrets } from '@site/src/components/integrations/secrets';
import { bazarrIntegration } from '.';
import { bazarrWidget } from '@site/docs/widgets/bazarr';
import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { AddingIntegration } from "@site/src/components/integrations/adding";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { bazarrIntegration } from ".";
import { bazarrWidget } from "@site/docs/widgets/bazarr";
<IntegrationHeader
integration={bazarrIntegration}
categories={['Subtitles', 'Media']}
/>
<IntegrationHeader integration={bazarrIntegration} categories={["Subtitles", "Media"]} />
Bazarr complements Sonarr and Radarr by managing subtitle downloads. The Homarr integration uses your Bazarr API key to fetch missing subtitle counts and health badges.
### Screenshots
import apiKeySettings from './img/api-key-settings.png';
import widgetOverview from '@site/docs/widgets/bazarr/img/widget-overview.png';
import apiKeySettings from "./img/api-key-settings.png";
import widgetOverview from "@site/docs/widgets/bazarr/img/widget-overview.png";
<div className="flex flex-col gap-4">
<div>
<p>API key location in Bazarr (<strong>Settings → General → Security</strong>):</p>
<p>
API key location in Bazarr (<strong>Settings → General → Security</strong>):
</p>
<img src={apiKeySettings} alt="bazarr-api-key-settings" width={128 * 4} />
</div>
<div>
@@ -35,20 +34,25 @@ import widgetOverview from '@site/docs/widgets/bazarr/img/widget-overview.png';
</div>
### Widgets & Capabilities
<IntegrationCapabilites
items={[{ widget: bazarrWidget }]}
/>
<IntegrationCapabilites items={[{ widget: bazarrWidget }]} />
### Adding the integration
<AddingIntegration />
### Secrets
You can find your Bazarr API key under **Settings → General → Security**.
<IntegrationSecrets secrets={[{
credentials: ['apiKey'],
steps: [
"Open Bazarr and go to Settings → General → Security.",
"Copy the API key and paste it into Homarr when creating the integration.",
],
}]} />
<IntegrationSecrets
secrets={[
{
credentials: ["apiKey"],
steps: [
"Open Bazarr and go to Settings → General → Security.",
"Copy the API key and paste it into Homarr when creating the integration.",
],
},
]}
/>
apps/docs/docs/integrations/beszel/index.mdx
+32 -28
View File
@@ -1,25 +1,22 @@
---
title: 'Beszel'
title: "Beszel"
description: "Beszel is a lightweight server monitoring platform with Docker stats, historical data, and alert functions."
hide_title: true
---
import { IntegrationHeader } from '@site/src/components/integrations/header';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import { AddingIntegration } from '@site/src/components/integrations/adding';
import { IntegrationSecrets } from '@site/src/components/integrations/secrets';
import { beszelIntegration } from '.';
import { beszelSystemStatsWidget } from '@site/docs/widgets/beszel-system-stats';
import { beszelSystemGridWidget } from '@site/docs/widgets/beszel-system-grid';
import { beszelSystemTableWidget } from '@site/docs/widgets/beszel-system-table';
import { beszelAlertsWidget } from '@site/docs/widgets/beszel-alerts';
import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { AddingIntegration } from "@site/src/components/integrations/adding";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { beszelIntegration } from ".";
import { beszelSystemStatsWidget } from "@site/docs/widgets/beszel-system-stats";
import { beszelSystemGridWidget } from "@site/docs/widgets/beszel-system-grid";
import { beszelSystemTableWidget } from "@site/docs/widgets/beszel-system-table";
import { beszelAlertsWidget } from "@site/docs/widgets/beszel-alerts";
import beszelDashboard from './img/beszel-dashboard.png';
import beszelDashboard from "./img/beszel-dashboard.png";
<IntegrationHeader
integration={beszelIntegration}
categories={['System Monitoring']}
/>
<IntegrationHeader integration={beszelIntegration} categories={["System Monitoring"]} />
Beszel monitors your servers in real time via lightweight agents, collecting CPU, memory, disk, network, GPU, temperature, and Docker container metrics. It stores historical data and supports configurable alerts.
@@ -28,26 +25,33 @@ Beszel monitors your servers in real time via lightweight agents, collecting CPU
<img src={beszelDashboard} alt="Beszel dashboard overview showing all four widgets" />
### Widgets & Capabilities
<IntegrationCapabilites
items={[
{ widget: beszelSystemStatsWidget },
{ widget: beszelSystemGridWidget },
{ widget: beszelSystemTableWidget },
{ widget: beszelAlertsWidget },
]}
items={[
{ widget: beszelSystemStatsWidget },
{ widget: beszelSystemGridWidget },
{ widget: beszelSystemTableWidget },
{ widget: beszelAlertsWidget },
]}
/>
### Adding the integration
<AddingIntegration />
### Secrets
<IntegrationSecrets secrets={[{
credentials: ['username', 'password'],
steps: [
'Open your Beszel hub instance (default port 8090)',
'Use the same credentials you use to log in to the Beszel web UI',
]
}]} />
<IntegrationSecrets
secrets={[
{
credentials: ["username", "password"],
steps: [
"Open your Beszel hub instance (default port 8090)",
"Use the same credentials you use to log in to the Beszel web UI",
],
},
]}
/>
:::tip
Beszel uses PocketBase under the hood. The default admin credentials are set during the initial Beszel setup.
apps/docs/docs/integrations/coolify/index.mdx
+37 -30
View File
@@ -1,29 +1,24 @@
---
title: 'Coolify'
description: 'Self-hosted PaaS and deployment platform'
title: "Coolify"
description: "Self-hosted PaaS and deployment platform"
hide_title: true
---
import { IntegrationHeader } from '@site/src/components/integrations/header';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import { AddingIntegration } from '@site/src/components/integrations/adding';
import { IntegrationSecrets } from '@site/src/components/integrations/secrets';
import { coolifyIntegration } from '.';
import { coolifyWidget } from '../../widgets/coolify';
import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { AddingIntegration } from "@site/src/components/integrations/adding";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { coolifyIntegration } from ".";
import { coolifyWidget } from "../../widgets/coolify";
<IntegrationHeader
integration={coolifyIntegration}
categories={['System monitoring', 'Deployment']}
/>
<IntegrationHeader integration={coolifyIntegration} categories={["System monitoring", "Deployment"]} />
### Widgets & Capabilities
<IntegrationCapabilites
items={[
{ widget: coolifyWidget }
]}
/>
<IntegrationCapabilites items={[{ widget: coolifyWidget }]} />
### Adding the integration
<AddingIntegration />
:::info URL configuration
@@ -31,16 +26,28 @@ Use the root URL of your Coolify instance, for example `https://coolify.example.
:::
### Secrets
<IntegrationSecrets secrets={[{
credentials: ['apiKey'],
steps: [
'Open your Coolify instance and make sure you are in the team you want Homarr to monitor.',
(<span>Enable API access under <strong>Settings &gt; Advanced</strong> if it is disabled.</span>),
(<span>Go to <strong>Security &gt; API Tokens</strong>.</span>),
'Enter a name, e.g. "Homarr".',
(<span>Select the <code>read</code> permission. The Coolify widget only reads version, server, project, application, and service data.</span>),
'Click "Create".',
'Copy the generated token immediately. Coolify only shows it once.',
'Paste the token into the API Key field in Homarr.'
]
}]} />
<IntegrationSecrets
secrets={[
{
credentials: ["apiKey"],
steps: [
"Open your Coolify instance and make sure you are in the team you want Homarr to monitor.",
<span>
Enable API access under <strong>Settings &gt; Advanced</strong> if it is disabled.
</span>,
<span>
Go to <strong>Security &gt; API Tokens</strong>.
</span>,
'Enter a name, e.g. "Homarr".',
<span>
Select the <code>read</code> permission. The Coolify widget only reads version, server, project, application,
and service data.
</span>,
'Click "Create".',
"Copy the generated token immediately. Coolify only shows it once.",
"Paste the token into the API Key field in Homarr.",
],
},
]}
/>
apps/docs/docs/integrations/dash-dot/index.mdx
+20 -19
View File
@@ -1,32 +1,33 @@
---
title: 'Dash.'
title: "Dash."
description: "Dash. is a system performance and resource monitoring tool"
hide_title: true
---
import { IntegrationHeader } from '@site/src/components/integrations/header';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import { AddingIntegration } from '@site/src/components/integrations/adding';
import {IntegrationSecrets} from '@site/src/components/integrations/secrets';
import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { AddingIntegration } from "@site/src/components/integrations/adding";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { IconHeartRateMonitor } from "@tabler/icons-react";
import { dashDotIntegration } from '.';
import { healthMonitoringWidget } from '@site/docs/widgets/health-monitoring';
import { systemResourcesWidget } from '@site/docs/widgets/system-resources';
import { dashDotIntegration } from ".";
import { healthMonitoringWidget } from "@site/docs/widgets/health-monitoring";
import { systemResourcesWidget } from "@site/docs/widgets/system-resources";
<IntegrationHeader
integration={dashDotIntegration}
categories={['System monitoring']}
/>
<IntegrationHeader integration={dashDotIntegration} categories={["System monitoring"]} />
### Widgets & Capabilities
<IntegrationCapabilites
items={[{
widget: healthMonitoringWidget
}, {
widget: systemResourcesWidget
}]}
items={[
{
widget: healthMonitoringWidget,
},
{
widget: systemResourcesWidget,
},
]}
/>
### Adding the integration
<AddingIntegration />
<AddingIntegration />
apps/docs/docs/integrations/deluge/index.mdx
+25 -20
View File
@@ -1,36 +1,41 @@
---
title: 'Deluge'
title: "Deluge"
description: "Deluge is a lightweight, Free Software, cross-platform BitTorrent client."
hide_title: true
---
import { IntegrationHeader } from '@site/src/components/integrations/header';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import { AddingIntegration } from '@site/src/components/integrations/adding';
import { IntegrationSecrets } from '@site/src/components/integrations/secrets';
import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { AddingIntegration } from "@site/src/components/integrations/adding";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { IconDownload } from "@tabler/icons-react";
import Alert from '@theme/Admonition';
import { delugeIntegration } from '.';
import { downloadsWidget } from '@site/docs/widgets/downloads';
import Alert from "@theme/Admonition";
import { delugeIntegration } from ".";
import { downloadsWidget } from "@site/docs/widgets/downloads";
<IntegrationHeader
integration={delugeIntegration}
categories={['Torrent client']}
/>
<IntegrationHeader integration={delugeIntegration} categories={["Torrent client"]} />
### Widgets & Capabilities
<IntegrationCapabilites
items={[{
widget: downloadsWidget
}]}
items={[
{
widget: downloadsWidget,
},
]}
/>
### Adding the integration
<AddingIntegration />
### Secrets
<IntegrationSecrets secrets={[{
credentials: ['password'],
steps: [],
}]} />
<IntegrationSecrets
secrets={[
{
credentials: ["password"],
steps: [],
},
]}
/>
apps/docs/docs/integrations/docker/index.mdx
+29 -17
View File
@@ -1,32 +1,31 @@
---
title: 'Docker'
title: "Docker"
description: "Docker is a platform where you can run your applications in containers, allowing for easy deployment and management of applications."
hide_title: true
---
import { IntegrationHeader } from '@site/src/components/integrations/header';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import {IntegrationSecrets} from '@site/src/components/integrations/secrets';
import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { IconBrandDocker, IconTool } from "@tabler/icons-react";
import { dockerIntegration } from '.';
import { dockerContainersWidget } from '@site/docs/widgets/docker-containers';
import { dockerIntegration } from ".";
import { dockerContainersWidget } from "@site/docs/widgets/docker-containers";
<IntegrationHeader
integration={dockerIntegration}
categories={['Containers']}
/>
<IntegrationHeader integration={dockerIntegration} categories={["Containers"]} />
### Widgets & Capabilities
<IntegrationCapabilites
items={[{
items={[
{
widget: dockerContainersWidget,
note: "This widget can only be used with administrator privileges"
}]}
note: "This widget can only be used with administrator privileges",
},
]}
/>
## Enabling the Docker integration
This integration must first be enabled.
If you directly run on the host system and you have docker installed, it will be enabled by default.
Otherwise, you'll need to mount the [docker socket](https://docs.docker.com/engine/security/protect-access/) to the Homarr container,
@@ -49,7 +48,7 @@ services:
environment:
- SECRET_ENCRYPTION_KEY=your_64_character_hex_string # <--- can be generated with `openssl rand -hex 32`
ports:
- '7575:7575'
- "7575:7575"
```
With docker run, add this parameter: `-v /var/run/docker.sock:/var/run/docker.sock`.
@@ -124,8 +123,10 @@ services:
```
### Managing your Docker containers within Homarr
Homarr allows you to interact with Docker containers running on your system.
Each container row has an action menu with the following options:
- **View logs** - opens a dedicated logs page with a live terminal
- **Start** - start a stopped container
- **Stop** - stop a running container
@@ -166,11 +167,13 @@ Currently Homarr supports one label for configuration of the containers:
- **homarr.hide:** If set to any value, the container will be hidden from the Docker Containers widget and tools page.
### Security
Mounting docker sockets can be risky, as they permit full control over your docker service.
As an example, a thread actor could abuse Homarr use the socket to start, stop or delete containers on your system.
Therefore we recommend the usage of a socket proxy, which can prohibit certain actions.
A few examples include:
- https://github.com/linuxserver/docker-socket-proxy
- https://github.com/Tecnativa/docker-socket-proxy
@@ -178,36 +181,44 @@ See documentation of the respective proxies on how to configure them.
Homarr may behave in unexpected ways when you use proxies.
#### Permissions
Homarr needs the following permissions from the Docker API:
- Containers/Start
- Containers/Stop
- Containers/Restart
- Containers/Remove
For socket proxies, you will need these permissions:
- `CONTAINERS=1`
- `POST=1`
**Caution:** `POST` access is security critical as it provides extensive capabilities to modify your docker environment. Please leave it disabled if you're concerned about this.
As a workaround, you can use [LSIO's socket proxy](https://github.com/linuxserver/docker-socket-proxy) and set the following:
- ALLOW_START=1
- ALLOW_STOP=1
- ALLOW_RESTARTS=1
These will work even with `POST=0`.
These will work even with `POST=0`.
You lose the ability to remove containers, but start, stop and restarts should work just fine.
#### Connecting to Docker via Socket Proxies
To connect to Docker via a socket proxy, you'll need to add these two environment variables in the compose file:
- `DOCKER_HOSTNAMES=<name of the socket proxy container>`
- `DOCKER_PORTS=<socket proxy port, usually 2375>`
Refer: https://homarr.dev/docs/advanced/environment-variables/
You will also need to add Homarr to the network of your socket proxy. You can do it like this:
1. Add the network to your compose file (with appropriate changes):
```yaml
networks:
socket-proxy:
@@ -216,6 +227,7 @@ networks:
```
2. Add the network to the homarr service in the compose file:
```yaml
networks:
- socket-proxy
apps/docs/docs/integrations/emby/index.mdx
+21 -23
View File
@@ -1,37 +1,35 @@
---
title: 'Emby'
title: "Emby"
description: "Emby is a media server platform that allows you to organize, manage, and stream your personal media collection."
hide_title: true
---
import { IntegrationHeader } from '@site/src/components/integrations/header';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import { AddingIntegration } from '@site/src/components/integrations/adding';
import {IntegrationSecrets} from '@site/src/components/integrations/secrets';
import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { AddingIntegration } from "@site/src/components/integrations/adding";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { IconVideo, IconTicket } from "@tabler/icons-react";
import { embyIntegration } from '.';
import { mediaServerWidget } from '@site/docs/widgets/media-server';
import { mediaReleasesWidget } from '@site/docs/widgets/media-releases';
import { embyIntegration } from ".";
import { mediaServerWidget } from "@site/docs/widgets/media-server";
import { mediaReleasesWidget } from "@site/docs/widgets/media-releases";
<IntegrationHeader
integration={embyIntegration}
categories={['Media server']}
/>
<IntegrationHeader integration={embyIntegration} categories={["Media server"]} />
### Widgets & Capabilities
<IntegrationCapabilites
items={[
{ widget: mediaServerWidget },
{ widget: mediaReleasesWidget }
]}
/>
<IntegrationCapabilites items={[{ widget: mediaServerWidget }, { widget: mediaReleasesWidget }]} />
### Adding the integration
<AddingIntegration />
### Secrets
<IntegrationSecrets secrets={[{
credentials: ['apiKey'],
steps: []
}]} />
<IntegrationSecrets
secrets={[
{
credentials: ["apiKey"],
steps: [],
},
]}
/>
apps/docs/docs/integrations/glances/index.mdx
+28 -22
View File
@@ -1,37 +1,43 @@
---
title: 'Glances'
title: "Glances"
description: "Glances is a cross-platform system monitoring tool."
hide_title: true
---
import { IntegrationHeader } from '@site/src/components/integrations/header';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import { AddingIntegration } from '@site/src/components/integrations/adding';
import { IntegrationSecrets } from '@site/src/components/integrations/secrets';
import { glancesIntegration } from '.';
import { systemResourcesWidget } from '@site/docs/widgets/system-resources';
import { healthMonitoringWidget } from '@site/docs/widgets/health-monitoring';
import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { AddingIntegration } from "@site/src/components/integrations/adding";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { glancesIntegration } from ".";
import { systemResourcesWidget } from "@site/docs/widgets/system-resources";
import { healthMonitoringWidget } from "@site/docs/widgets/health-monitoring";
<IntegrationHeader
integration={glancesIntegration}
categories={['System Monitoring']}
/>
<IntegrationHeader integration={glancesIntegration} categories={["System Monitoring"]} />
### Widgets & Capabilities
<IntegrationCapabilites
items={[{
widget: systemResourcesWidget
}, {
widget: healthMonitoringWidget
}]}
items={[
{
widget: systemResourcesWidget,
},
{
widget: healthMonitoringWidget,
},
]}
/>
### Adding the integration
<AddingIntegration />
### Secrets
<IntegrationSecrets secrets={[{
credentials: [],
steps: []
}]} />
<IntegrationSecrets
secrets={[
{
credentials: [],
steps: [],
},
]}
/>
apps/docs/docs/integrations/gluetun/index.mdx
+31 -25
View File
@@ -1,20 +1,17 @@
---
title: 'Gluetun'
description: 'Connect Gluetun to Homarr as a VPN integration.'
title: "Gluetun"
description: "Connect Gluetun to Homarr as a VPN integration."
hide_title: true
---
import { IntegrationHeader } from '@site/src/components/integrations/header';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import { AddingIntegration } from '@site/src/components/integrations/adding';
import { IntegrationSecrets } from '@site/src/components/integrations/secrets';
import { gluetunIntegration } from '.';
import { vpnWidget } from '@site/docs/widgets/vpn';
import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { AddingIntegration } from "@site/src/components/integrations/adding";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { gluetunIntegration } from ".";
import { vpnWidget } from "@site/docs/widgets/vpn";
<IntegrationHeader
integration={gluetunIntegration}
categories={['VPN', 'Network']}
/>
<IntegrationHeader integration={gluetunIntegration} categories={["VPN", "Network"]} />
[Gluetun](https://github.com/qdm12/gluetun) exposes a control server that Homarr can query to report the VPN tunnel
status, DNS status, public IP address, and active provider details in the VPN widget.
@@ -22,9 +19,11 @@ status, DNS status, public IP address, and active provider details in the VPN wi
### Widgets & Capabilities
<IntegrationCapabilites
items={[{
widget: vpnWidget,
}]}
items={[
{
widget: vpnWidget,
},
]}
/>
### Setting up the Gluetun control server
@@ -40,13 +39,20 @@ Refer to the [Gluetun control server documentation](https://github.com/qdm12/glu
Gluetun's control server can be left unprotected or secured with either an API key or HTTP Basic authentication.
Choose the option that matches how your Gluetun instance integration is set up.
<IntegrationSecrets secrets={[{
credentials: [],
steps: [],
},{
credentials: ['username', 'password'],
steps: [],
},{
credentials: ['apiKey'],
steps: [],
},,]} />
<IntegrationSecrets
secrets={[
{
credentials: [],
steps: [],
},
{
credentials: ["username", "password"],
steps: [],
},
{
credentials: ["apiKey"],
steps: [],
},
,
]}
/>
apps/docs/docs/integrations/gotify/index.mdx
+24 -18
View File
@@ -1,33 +1,39 @@
---
title: 'Gotify'
title: "Gotify"
description: "Gotify is a simple, self-hosted server for sending and receiving messages in real time."
hide_title: true
---
import { notificationsWidget } from '@site/docs/widgets/notifications';
import { AddingIntegration } from '@site/src/components/integrations/adding';
import { IntegrationHeader } from '@site/src/components/integrations/header';
import { IntegrationSecrets } from '@site/src/components/integrations/secrets';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import { gotifyIntegration } from '.';
import { notificationsWidget } from "@site/docs/widgets/notifications";
import { AddingIntegration } from "@site/src/components/integrations/adding";
import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { gotifyIntegration } from ".";
<IntegrationHeader
integration={gotifyIntegration}
categories={['Notifications', 'Messaging']}
/>
<IntegrationHeader integration={gotifyIntegration} categories={["Notifications", "Messaging"]} />
### Widgets & Capabilities
<IntegrationCapabilites
items={[{
widget: notificationsWidget
}]}
items={[
{
widget: notificationsWidget,
},
]}
/>
### Adding the integration
<AddingIntegration />
### Secrets
<IntegrationSecrets secrets={[{
credentials: ['username', 'password'],
steps: []
}]} />
<IntegrationSecrets
secrets={[
{
credentials: ["username", "password"],
steps: [],
},
]}
/>
apps/docs/docs/integrations/home-assistant/index.mdx
+29 -23
View File
@@ -1,45 +1,51 @@
---
title: 'Home Assistant'
title: "Home Assistant"
description: "Home Assistant is an open-source home automation platform that focuses on privacy and local control, allowing you to automate and control your smart home devices."
hide_title: true
---
import { IntegrationHeader } from '@site/src/components/integrations/header';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import { AddingIntegration } from '@site/src/components/integrations/adding';
import {IntegrationSecrets} from '@site/src/components/integrations/secrets';
import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { AddingIntegration } from "@site/src/components/integrations/adding";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { IconBinaryTree } from "@tabler/icons-react";
import { homeAssistantIntegration } from '.';
import { smartHomeEntityStateWidget } from '@site/docs/widgets/smart-home-entity-state';
import { smartHomeExecuteAutomationWidget } from '@site/docs/widgets/smart-home-execute-automation';
import { homeAssistantIntegration } from ".";
import { smartHomeEntityStateWidget } from "@site/docs/widgets/smart-home-entity-state";
import { smartHomeExecuteAutomationWidget } from "@site/docs/widgets/smart-home-execute-automation";
<IntegrationHeader
integration={homeAssistantIntegration}
categories={['Smart Home', 'Automation']}
/>
<IntegrationHeader integration={homeAssistantIntegration} categories={["Smart Home", "Automation"]} />
### Widgets & Capabilities
<IntegrationCapabilites
items={[{
widget: smartHomeEntityStateWidget
}, {
widget: smartHomeExecuteAutomationWidget,
}]}
items={[
{
widget: smartHomeEntityStateWidget,
},
{
widget: smartHomeExecuteAutomationWidget,
},
]}
/>
### Adding the integration
<AddingIntegration />
### Secrets
<IntegrationSecrets secrets={[{
credentials: ['apiKey'],
steps: [
<IntegrationSecrets
secrets={[
{
credentials: ["apiKey"],
steps: [
"Click on your profile in the bottom left corner of Home Assistant.",
"Switch to the Security tab.",
"Scroll down to the Long-lived access tokens section.",
"Click on the Create Token button.",
"Enter a name for the token (e.g., 'Homarr Integration') and click Create.",
"Copy the generated token and paste it into the Homarr integration settings.",
]
}]} />
],
},
]}
/>
apps/docs/docs/integrations/ical/index.mdx
+25 -19
View File
@@ -1,38 +1,44 @@
---
title: 'iCal'
title: "iCal"
description: "iCal is a standard for calendar data exchange, allowing users to share and manage calendar events across different platforms."
hide_title: true
---
import { IntegrationHeader } from '@site/src/components/integrations/header';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import { AddingIntegration } from '@site/src/components/integrations/adding';
import {IntegrationSecrets} from '@site/src/components/integrations/secrets';
import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { AddingIntegration } from "@site/src/components/integrations/adding";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { IconZoomQuestion, IconChartBar, IconSearch } from "@tabler/icons-react";
import { icalIntegration } from '.';
import { calendarWidget } from '@site/docs/widgets/calendar';
import { icalIntegration } from ".";
import { calendarWidget } from "@site/docs/widgets/calendar";
<IntegrationHeader
integration={icalIntegration}
categories={['Calendar']}
/>
<IntegrationHeader integration={icalIntegration} categories={["Calendar"]} />
### Widgets & Capabilities
<IntegrationCapabilites
items={[{
widget: calendarWidget
}]}
items={[
{
widget: calendarWidget,
},
]}
/>
### Adding the integration
<AddingIntegration />
### Secrets
<IntegrationSecrets secrets={[{
credentials: ['url'],
steps: []
}]} />
<IntegrationSecrets
secrets={[
{
credentials: ["url"],
steps: [],
},
]}
/>
## Using the iCal integration
The iCal integration allows you to add external calendars to Homarr. Any calendar that provides a public iCal URL can be integrated, such as Google Calendar, Apple Calendar, or Outlook.
The iCal integration allows you to add external calendars to Homarr. Any calendar that provides a public iCal URL can be integrated, such as Google Calendar, Apple Calendar, or Outlook.
apps/docs/docs/integrations/immich/index.mdx
+15 -22
View File
@@ -1,36 +1,29 @@
---
title: 'Immich'
title: "Immich"
description: "Self-hosted photo and video management solution"
hide_title: true
---
import { immichAlbumCarouselWidget } from '../../widgets/immich-album-carousel';import {
IntegrationHeader
} from '@site/src/components/integrations/header';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import { AddingIntegration } from '@site/src/components/integrations/adding';
import { IntegrationSecrets } from '@site/src/components/integrations/secrets';
import { immichIntegration } from '.';
import { immichServerStatsWidget } from '../../widgets/immich-server-stats';
import { immichAlbumCarouselWidget } from "../../widgets/immich-album-carousel";
import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { AddingIntegration } from "@site/src/components/integrations/adding";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { immichIntegration } from ".";
import { immichServerStatsWidget } from "../../widgets/immich-server-stats";
<IntegrationHeader
integration={immichIntegration}
categories={['Photo server']}
/>
<IntegrationHeader integration={immichIntegration} categories={["Photo server"]} />
### Widgets & Capabilities
<IntegrationCapabilites
items={[
{ widget: immichAlbumCarouselWidget },
{ widget: immichServerStatsWidget }
]}
/>
<IntegrationCapabilites items={[{ widget: immichAlbumCarouselWidget }, { widget: immichServerStatsWidget }]} />
### Adding the integration
<AddingIntegration />
### Secrets
<IntegrationSecrets secrets={[{
credentials: ['apiKey'],
steps: [
@@ -58,6 +51,6 @@ import { immichServerStatsWidget } from '../../widgets/immich-server-stats';
</span>
),
'Create the integration in Homarr and copy the API key to there'
]
'Create the integration in Homarr and copy the API key to there'
]
}]} />
apps/docs/docs/integrations/jellyfin/index.mdx
+25 -26
View File
@@ -1,40 +1,39 @@
---
title: 'Jellyfin'
title: "Jellyfin"
description: "Jellyfin is a free and open-source media server software that allows you to organize, manage, and share your media files."
hide_title: true
---
import { IntegrationHeader } from '@site/src/components/integrations/header';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import { AddingIntegration } from '@site/src/components/integrations/adding';
import {IntegrationSecrets} from '@site/src/components/integrations/secrets';
import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { AddingIntegration } from "@site/src/components/integrations/adding";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { IconVideo, IconTicket } from "@tabler/icons-react";
import { jellyfinIntegration } from '.';
import { mediaServerWidget } from '@site/docs/widgets/media-server';
import { mediaReleasesWidget } from '@site/docs/widgets/media-releases';
import { jellyfinIntegration } from ".";
import { mediaServerWidget } from "@site/docs/widgets/media-server";
import { mediaReleasesWidget } from "@site/docs/widgets/media-releases";
<IntegrationHeader
integration={jellyfinIntegration}
categories={['Media server']}
/>
<IntegrationHeader integration={jellyfinIntegration} categories={["Media server"]} />
### Widgets & Capabilities
<IntegrationCapabilites
items={[
{ widget: mediaServerWidget },
{ widget: mediaReleasesWidget }
]}
/>
<IntegrationCapabilites items={[{ widget: mediaServerWidget }, { widget: mediaReleasesWidget }]} />
### Adding the integration
<AddingIntegration />
### Secrets
<IntegrationSecrets secrets={[{
credentials: ['apiKey'],
steps: []
},{
credentials: ['username', 'password'],
steps: []
}]} />
<IntegrationSecrets
secrets={[
{
credentials: ["apiKey"],
steps: [],
},
{
credentials: ["username", "password"],
steps: [],
},
]}
/>
apps/docs/docs/integrations/jellyseerr/index.mdx
+36 -29
View File
@@ -1,45 +1,52 @@
---
title: 'Jellyseerr'
title: "Jellyseerr"
description: "Jellyseerr is a self-hosted media request management system that integrates with Jellyfin and other media servers."
hide_title: true
---
import { IntegrationHeader } from '@site/src/components/integrations/header';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import { AddingIntegration } from '@site/src/components/integrations/adding';
import {IntegrationSecrets} from '@site/src/components/integrations/secrets';
import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { AddingIntegration } from "@site/src/components/integrations/adding";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { IconZoomQuestion, IconChartBar, IconSearch } from "@tabler/icons-react";
import { jellyseerrIntegration } from '.';
import { mediaRequestListWidget } from '@site/docs/widgets/media-request-list';
import { mediaRequestStatsWidget } from '@site/docs/widgets/media-request-stats';
import { jellyseerrIntegration } from ".";
import { mediaRequestListWidget } from "@site/docs/widgets/media-request-list";
import { mediaRequestStatsWidget } from "@site/docs/widgets/media-request-stats";
<IntegrationHeader
integration={jellyseerrIntegration}
categories={['Media requests']}
/>
<IntegrationHeader integration={jellyseerrIntegration} categories={["Media requests"]} />
### Widgets & Capabilities
<IntegrationCapabilites
items={[{
widget: mediaRequestListWidget,
},{
widget: mediaRequestStatsWidget,
}, {
capability: {
icon: IconSearch,
name: "Media Search",
description: "Search for movies and TV shows directly from Spotlight and request them.",
path: "../../management/search-engines/#media-request-search"
}
}]}
items={[
{
widget: mediaRequestListWidget,
},
{
widget: mediaRequestStatsWidget,
},
{
capability: {
icon: IconSearch,
name: "Media Search",
description: "Search for movies and TV shows directly from Spotlight and request them.",
path: "../../management/search-engines/#media-request-search",
},
},
]}
/>
### Adding the integration
<AddingIntegration />
### Secrets
<IntegrationSecrets secrets={[{
credentials: ['apiKey'],
steps: []
}]} />
<IntegrationSecrets
secrets={[
{
credentials: ["apiKey"],
steps: [],
},
]}
/>
apps/docs/docs/integrations/kubernetes/index.mdx
+7 -11
View File
@@ -1,20 +1,16 @@
---
title: 'Kubernetes'
title: "Kubernetes"
description: "Kubernetes is a powerful container orchestration platform that automates the deployment, scaling, and management of containerized applications."
hide_title: true
---
import { IntegrationHeader } from '@site/src/components/integrations/header';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import {IntegrationSecrets} from '@site/src/components/integrations/secrets';
import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { IconBrandDocker, IconTool } from "@tabler/icons-react";
import { kubernetesIntegration } from '.';
import { kubernetesIntegration } from ".";
<IntegrationHeader
integration={kubernetesIntegration}
categories={['Containers']}
/>
<IntegrationHeader integration={kubernetesIntegration} categories={["Containers"]} />
Homarr provides a user-friendly Kubernetes dashboard that offers an overview of your cluster’s resources in a clear and structured interface. It allows users to view key Kubernetes objects, including `Pods`, `Services`, `Ingresses`, `Nodes`, `ConfigMaps`, `Secrets`, `Namespaces`, and `Volumes`, as well as basic metrics when the Kubernetes Metrics Server is enabled.
@@ -47,7 +43,7 @@ Enabling RBAC in the Helm chart creates the necessary Kubernetes Role-Based Acce
- Service Account: A dedicated service account for Homarr.
- Role & RoleBinding: Grants permissions within a specific namespace to list, watch, and get pods, services, secrets, configmaps, and more.
- ClusterRole & ClusterRoleBinding: Extends the same permissions cluster-wide for additional flexibility.
:::
:::
### Homarr Dashboard Overview
apps/docs/docs/integrations/lidarr/index.mdx
+24 -19
View File
@@ -1,35 +1,40 @@
---
title: 'Lidarr'
title: "Lidarr"
description: "Lidarr is a music management tool that automates the process of downloading, sorting, and renaming music."
hide_title: true
---
import { IntegrationHeader } from '@site/src/components/integrations/header';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import { AddingIntegration } from '@site/src/components/integrations/adding';
import {IntegrationSecrets} from '@site/src/components/integrations/secrets';
import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { AddingIntegration } from "@site/src/components/integrations/adding";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { IconCalendar } from "@tabler/icons-react";
import { lidarrIntegration } from '.';
import { calendarWidget } from '@site/docs/widgets/calendar';
import { lidarrIntegration } from ".";
import { calendarWidget } from "@site/docs/widgets/calendar";
<IntegrationHeader
integration={lidarrIntegration}
categories={['Media manager', "Servarr"]}
/>
<IntegrationHeader integration={lidarrIntegration} categories={["Media manager", "Servarr"]} />
### Widgets & Capabilities
<IntegrationCapabilites
items={[{
widget: calendarWidget
}]}
items={[
{
widget: calendarWidget,
},
]}
/>
### Adding the integration
<AddingIntegration />
### Secrets
<IntegrationSecrets secrets={[{
credentials: ['apiKey'],
steps: []
}]} />
<IntegrationSecrets
secrets={[
{
credentials: ["apiKey"],
steps: [],
},
]}
/>
apps/docs/docs/integrations/navidrome/index.mdx
+14 -8
View File
@@ -1,5 +1,5 @@
---
title: 'Navidrome'
title: "Navidrome"
description: "Navidrome is a self-hosted music server and streamer compatible with the Subsonic API."
hide_title: true
---
@@ -29,13 +29,19 @@ Navidrome provides music library statistics including artist, album, and song co
/>
### Adding the integration
<AddingIntegration />
### Secrets
<IntegrationSecrets secrets={[{
credentials: ['username', 'password'],
steps: [
'Use the same credentials you use to log in to Navidrome',
'The user must have access to the Subsonic API (enabled by default)',
]
}]} />
<IntegrationSecrets
secrets={[
{
credentials: ["username", "password"],
steps: [
"Use the same credentials you use to log in to Navidrome",
"The user must have access to the Subsonic API (enabled by default)",
],
},
]}
/>
apps/docs/docs/integrations/nextcloud/index.mdx
+29 -26
View File
@@ -1,40 +1,43 @@
---
title: 'Nextcloud'
title: "Nextcloud"
description: "Nextcloud is a self-hosted productivity platform that provides file storage, collaboration tools, and more."
hide_title: true
---
import { IntegrationHeader } from '@site/src/components/integrations/header';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import { AddingIntegration } from '@site/src/components/integrations/adding';
import {IntegrationSecrets} from '@site/src/components/integrations/secrets';
import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { AddingIntegration } from "@site/src/components/integrations/adding";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { IconCalendar } from "@tabler/icons-react";
import Alert from '@theme/Admonition';
import { nextcloudIntegration } from '.';
import { calendarWidget } from '@site/docs/widgets/calendar';
import { notificationsWidget } from '@site/docs/widgets/notifications';
import Alert from "@theme/Admonition";
import { nextcloudIntegration } from ".";
import { calendarWidget } from "@site/docs/widgets/calendar";
import { notificationsWidget } from "@site/docs/widgets/notifications";
<IntegrationHeader
integration={nextcloudIntegration}
categories={['Calendar', 'Notifications']}
/>
<IntegrationHeader integration={nextcloudIntegration} categories={["Calendar", "Notifications"]} />
### Widgets & Capabilities
<IntegrationCapabilites
items={[
{ widget: calendarWidget },
{ widget: notificationsWidget }
]}
/>
<IntegrationCapabilites items={[{ widget: calendarWidget }, { widget: notificationsWidget }]} />
### Adding the integration
<AddingIntegration />
### Secrets
<IntegrationSecrets secrets={[{
credentials: ['username', 'password'],
steps: [],
header: <Alert type="info">
Users who use 2FA will have to use Nextcloud's App Password tool to grant Homarr access, as 2FA breaks the traditional process. For more information, see [Nextcloud's Documentation](https://docs.nextcloud.com/server/stable/admin_manual/configuration_user/authentication.html#app-passwords)
</Alert>,
}]} />
<IntegrationSecrets
secrets={[
{
credentials: ["username", "password"],
steps: [],
header: (
<Alert type="info">
Users who use 2FA will have to use Nextcloud's App Password tool to grant Homarr access, as 2FA breaks the
traditional process. For more information, see [Nextcloud's
Documentation](https://docs.nextcloud.com/server/stable/admin_manual/configuration_user/authentication.html#app-passwords)
</Alert>
),
},
]}
/>
apps/docs/docs/integrations/ntfy/index.mdx
+28 -21
View File
@@ -1,37 +1,44 @@
---
title: 'Ntfy'
title: "Ntfy"
description: "Ntfy is a simple, open-source notification service that allows you to send and receive notifications across devices."
hide_title: true
---
import { notificationsWidget } from '@site/docs/widgets/notifications';
import { AddingIntegration } from '@site/src/components/integrations/adding';
import { IntegrationHeader } from '@site/src/components/integrations/header';
import { IntegrationSecrets } from '@site/src/components/integrations/secrets';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import { notificationsWidget } from "@site/docs/widgets/notifications";
import { AddingIntegration } from "@site/src/components/integrations/adding";
import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { IconMessage } from "@tabler/icons-react";
import { ntfyIntegration } from '.';
import { ntfyIntegration } from ".";
<IntegrationHeader
integration={ntfyIntegration}
categories={['Notifications', 'Messaging']}
/>
<IntegrationHeader integration={ntfyIntegration} categories={["Notifications", "Messaging"]} />
### Widgets & Capabilities
<IntegrationCapabilites
items={[{
widget: notificationsWidget
}]}
items={[
{
widget: notificationsWidget,
},
]}
/>
### Adding the integration
<AddingIntegration />
### Secrets
<IntegrationSecrets secrets={[{
credentials: ['topic'],
steps: []
}, {
credentials: ['topic', 'apiKey'],
steps: []
}]} />
<IntegrationSecrets
secrets={[
{
credentials: ["topic"],
steps: [],
},
{
credentials: ["topic", "apiKey"],
steps: [],
},
]}
/>
apps/docs/docs/integrations/nzbget/index.mdx
+25 -20
View File
@@ -1,36 +1,41 @@
---
title: 'NZBGet'
title: "NZBGet"
description: "NZBGet is a lightweight and efficient Usenet downloader."
hide_title: true
---
import { IntegrationHeader } from '@site/src/components/integrations/header';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import { AddingIntegration } from '@site/src/components/integrations/adding';
import { IntegrationSecrets } from '@site/src/components/integrations/secrets';
import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { AddingIntegration } from "@site/src/components/integrations/adding";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { IconDownload } from "@tabler/icons-react";
import { nzbgetIntegration } from '.';
import Alert from '@theme/Admonition';
import { downloadsWidget } from '@site/docs/widgets/downloads';
import { nzbgetIntegration } from ".";
import Alert from "@theme/Admonition";
import { downloadsWidget } from "@site/docs/widgets/downloads";
<IntegrationHeader
integration={nzbgetIntegration}
categories={['Usenet client']}
/>
<IntegrationHeader integration={nzbgetIntegration} categories={["Usenet client"]} />
### Widgets & Capabilities
<IntegrationCapabilites
items={[{
widget: downloadsWidget,
}]}
items={[
{
widget: downloadsWidget,
},
]}
/>
### Adding the integration
<AddingIntegration />
### Secrets
<IntegrationSecrets secrets={[{
credentials: ['username', 'password'],
steps: [],
}]} />
<IntegrationSecrets
secrets={[
{
credentials: ["username", "password"],
steps: [],
},
]}
/>
apps/docs/docs/integrations/open-media-vault/index.mdx
+36 -26
View File
@@ -1,42 +1,52 @@
---
title: 'Open Media Vault'
title: "Open Media Vault"
description: "Open Media Vault is a free network-attached storage server based on the Debian operating system."
hide_title: true
---
import { IntegrationHeader } from '@site/src/components/integrations/header';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import { AddingIntegration } from '@site/src/components/integrations/adding';
import {IntegrationSecrets} from '@site/src/components/integrations/secrets';
import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { AddingIntegration } from "@site/src/components/integrations/adding";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { IconHeartRateMonitor } from "@tabler/icons-react";
import { openMediaVaultIntegration } from '.';
import Alert from '@theme/Admonition'
import { healthMonitoringWidget } from '@site/docs/widgets/health-monitoring';
import { systemResourcesWidget } from '@site/docs/widgets/system-resources';
import { openMediaVaultIntegration } from ".";
import Alert from "@theme/Admonition";
import { healthMonitoringWidget } from "@site/docs/widgets/health-monitoring";
import { systemResourcesWidget } from "@site/docs/widgets/system-resources";
<IntegrationHeader
integration={openMediaVaultIntegration}
categories={['System monitoring']}
/>
<IntegrationHeader integration={openMediaVaultIntegration} categories={["System monitoring"]} />
### Widgets & Capabilities
<IntegrationCapabilites
items={[{
widget: healthMonitoringWidget,
note: "To use this widget, you must have the OpenMediaVault plugin openmediavault-cputemp installed.",
}, {
widget: systemResourcesWidget
}]}
items={[
{
widget: healthMonitoringWidget,
note: "To use this widget, you must have the OpenMediaVault plugin openmediavault-cputemp installed.",
},
{
widget: systemResourcesWidget,
},
]}
/>
### Adding the integration
<AddingIntegration />
### Secrets
<IntegrationSecrets secrets={[{
credentials: ['username', 'password'],
steps: [],
body: <Alert type="caution">
The user used here must have administrative permissions or Homarr won't be able to read the system performance and resource data.
</Alert>
}]} />
<IntegrationSecrets
secrets={[
{
credentials: ["username", "password"],
steps: [],
body: (
<Alert type="caution">
The user used here must have administrative permissions or Homarr won't be able to read the system performance
and resource data.
</Alert>
),
},
]}
/>
apps/docs/docs/integrations/opnsense/index.mdx
+47 -37
View File
@@ -1,65 +1,75 @@
---
title: 'OPNsense'
title: "OPNsense"
description: "OPNsense is an open-source, easy-to-use, and easy-to-build firewall and routing platform."
hide_title: true
---
import { IntegrationHeader } from '@site/src/components/integrations/header';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import { AddingIntegration } from '@site/src/components/integrations/adding';
import {IntegrationSecrets} from '@site/src/components/integrations/secrets';
import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { AddingIntegration } from "@site/src/components/integrations/adding";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { IconHeartRateMonitor } from "@tabler/icons-react";
import { opnsenseIntegration } from '.';
import Alert from '@theme/Admonition'
import { firewallWidget } from '../../widgets/firewall';
import { opnsenseIntegration } from ".";
import Alert from "@theme/Admonition";
import { firewallWidget } from "../../widgets/firewall";
<IntegrationHeader
integration={opnsenseIntegration}
categories={['Firewall']}
/>
<IntegrationHeader integration={opnsenseIntegration} categories={["Firewall"]} />
### Widgets & Capabilities
<IntegrationCapabilites
items={[{
widget: firewallWidget,
}]}
items={[
{
widget: firewallWidget,
},
]}
/>
### Adding the integration
<AddingIntegration />
### Secrets
<IntegrationSecrets secrets={[{
tabLabel: "ApiKey (Key & Secret)",
credentials: ['opnsenseApiKey', 'opnsenseApiSecret'],
header: <Alert type="info">
This integration does not require full API access to the firewall. The following guide outlines the process for creating a restricted OPNsense user with a scrambled password, designed exclusively for API access. This ensures minimal permissions and prevents local login capability.
</Alert>,
steps: [
<IntegrationSecrets
secrets={[
{
tabLabel: "ApiKey (Key & Secret)",
credentials: ["opnsenseApiKey", "opnsenseApiSecret"],
header: (
<Alert type="info">
This integration does not require full API access to the firewall. The following guide outlines the process
for creating a restricted OPNsense user with a scrambled password, designed exclusively for API access. This
ensures minimal permissions and prevents local login capability.
</Alert>
),
steps: [
"Log in to the OPNsense web interface as an administrator",
"Navigate to System → Access → Users",
"Click the + (Add) button to create a new user",
<>
Fill in the user details:
<ul>
<li>Username: Enter a unique name</li>
<li>Password: Leave empty</li>
<li>Scrambled Password: Enable this option</li>
<li>Full name: (Optional) Add a descriptive name</li>
</ul>
Fill in the user details:
<ul>
<li>Username: Enter a unique name</li>
<li>Password: Leave empty</li>
<li>Scrambled Password: Enable this option</li>
<li>Full name: (Optional) Add a descriptive name</li>
</ul>
</>,
<>
In Privileges section → Select the option below:
<ul>
<li>Lobby: Dashboard</li>
<li>Reporting: Traffic</li>
</ul>
In Privileges section → Select the option below:
<ul>
<li>Lobby: Dashboard</li>
<li>Reporting: Traffic</li>
</ul>
</>,
"Click Save",
"Return to the Users list",
"Find the user and click the ticket icon in the Commands column",
"Click Yes in the popup to confirm",
"A txt file will download automatically, containing: Key and Secret",
"Save this file securely—this information will only be shown once"
],
}]} />
"Save this file securely—this information will only be shown once",
],
},
]}
/>
apps/docs/docs/integrations/overseerr/index.mdx
+36 -29
View File
@@ -1,45 +1,52 @@
---
title: 'Overseerr'
title: "Overseerr"
description: "Overseerr is a self-hosted media request management system that integrates with Plex."
hide_title: true
---
import { IntegrationHeader } from '@site/src/components/integrations/header';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import { AddingIntegration } from '@site/src/components/integrations/adding';
import {IntegrationSecrets} from '@site/src/components/integrations/secrets';
import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { AddingIntegration } from "@site/src/components/integrations/adding";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { IconZoomQuestion, IconChartBar, IconSearch } from "@tabler/icons-react";
import { overseerrIntegration } from '.';
import { mediaRequestListWidget } from '@site/docs/widgets/media-request-list';
import { mediaRequestStatsWidget } from '@site/docs/widgets/media-request-stats';
import { overseerrIntegration } from ".";
import { mediaRequestListWidget } from "@site/docs/widgets/media-request-list";
import { mediaRequestStatsWidget } from "@site/docs/widgets/media-request-stats";
<IntegrationHeader
integration={overseerrIntegration}
categories={['Media requests']}
/>
<IntegrationHeader integration={overseerrIntegration} categories={["Media requests"]} />
### Widgets & Capabilities
<IntegrationCapabilites
items={[{
widget: mediaRequestListWidget
}, {
widget: mediaRequestStatsWidget
}, {
capability: {
icon: IconSearch,
name: "Media Search",
description: "Search for movies and TV shows directly from Spotlight and request them.",
path: "../../management/search-engines/#media-request-search"
}
}]}
items={[
{
widget: mediaRequestListWidget,
},
{
widget: mediaRequestStatsWidget,
},
{
capability: {
icon: IconSearch,
name: "Media Search",
description: "Search for movies and TV shows directly from Spotlight and request them.",
path: "../../management/search-engines/#media-request-search",
},
},
]}
/>
### Adding the integration
<AddingIntegration />
### Secrets
<IntegrationSecrets secrets={[{
credentials: ['apiKey'],
steps: []
}]} />
<IntegrationSecrets
secrets={[
{
credentials: ["apiKey"],
steps: [],
},
]}
/>
apps/docs/docs/integrations/paperless-ngx/index.mdx
+25 -26
View File
@@ -1,41 +1,40 @@
---
title: 'Paperless-ngx'
title: "Paperless-ngx"
description: "Paperless-ngx is a document management system that transforms your physical documents into a searchable online archive."
hide_title: true
---
import { IntegrationHeader } from '@site/src/components/integrations/header';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import { AddingIntegration } from '@site/src/components/integrations/adding';
import { IntegrationSecrets } from '@site/src/components/integrations/secrets';
import { paperlessNgxIntegration } from '.';
import { paperlessNgxWidget } from '@site/docs/widgets/paperless-ngx';
import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { AddingIntegration } from "@site/src/components/integrations/adding";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { paperlessNgxIntegration } from ".";
import { paperlessNgxWidget } from "@site/docs/widgets/paperless-ngx";
<IntegrationHeader
integration={paperlessNgxIntegration}
categories={['Documents']}
/>
<IntegrationHeader integration={paperlessNgxIntegration} categories={["Documents"]} />
Paperless-ngx provides document statistics including total documents, inbox count, correspondents, tags, and document types.
### Widgets & Capabilities
<IntegrationCapabilites
items={[
{ widget: paperlessNgxWidget },
]}
/>
<IntegrationCapabilites items={[{ widget: paperlessNgxWidget }]} />
### Adding the integration
<AddingIntegration />
### Secrets
<IntegrationSecrets secrets={[{
credentials: ['apiKey'],
steps: [
'Open your Paperless-ngx instance',
'Navigate to Settings → Django Admin → Tokens',
'Create a new token for your user',
'Copy the token value',
]
}]} />
<IntegrationSecrets
secrets={[
{
credentials: ["apiKey"],
steps: [
"Open your Paperless-ngx instance",
"Navigate to Settings → Django Admin → Tokens",
"Create a new token for your user",
"Copy the token value",
],
},
]}
/>
apps/docs/docs/integrations/patchmon/index.mdx
+25 -26
View File
@@ -1,43 +1,42 @@
---
title: 'PatchMon'
title: "PatchMon"
description: "PatchMon is a patch management and monitoring solution for Linux hosts."
hide_title: true
---
import { IntegrationHeader } from '@site/src/components/integrations/header';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import { AddingIntegration } from '@site/src/components/integrations/adding';
import { IntegrationSecrets } from '@site/src/components/integrations/secrets';
import { patchmonIntegration } from '.';
import { patchmonWidget } from '@site/docs/widgets/patchmon';
import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { AddingIntegration } from "@site/src/components/integrations/adding";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { patchmonIntegration } from ".";
import { patchmonWidget } from "@site/docs/widgets/patchmon";
<IntegrationHeader
integration={patchmonIntegration}
categories={['Health Monitoring']}
/>
<IntegrationHeader integration={patchmonIntegration} categories={["Health Monitoring"]} />
PatchMon provides host and package update statistics including total hosts, hosts needing updates, and security update counts.
The PatchMon widget requires users to be **signed in to Homarr**; see the [PatchMon widget documentation](/docs/widgets/patchmon#authentication) for details on authentication and public boards.
### Widgets & Capabilities
<IntegrationCapabilites
items={[
{ widget: patchmonWidget },
]}
/>
<IntegrationCapabilites items={[{ widget: patchmonWidget }]} />
### Adding the integration
<AddingIntegration />
### Secrets
<IntegrationSecrets secrets={[{
credentials: ['patchmonApiKey', 'patchmonApiSecret'],
steps: [
'Open your PatchMon instance',
'Navigate to Settings and create a new GetHomepage API key',
'Copy the API key and secret from the success dialog',
'Paste them into Homarr — Basic authentication is handled automatically',
]
}]} />
<IntegrationSecrets
secrets={[
{
credentials: ["patchmonApiKey", "patchmonApiSecret"],
steps: [
"Open your PatchMon instance",
"Navigate to Settings and create a new GetHomepage API key",
"Copy the API key and secret from the success dialog",
"Paste them into Homarr — Basic authentication is handled automatically",
],
},
]}
/>
apps/docs/docs/integrations/peanut/index.mdx
+31 -26
View File
@@ -1,48 +1,53 @@
---
title: 'PeaNUT'
description: 'A tiny dashboard for Network UPS Tools (NUT) servers.'
title: "PeaNUT"
description: "A tiny dashboard for Network UPS Tools (NUT) servers."
hide_title: true
---
import { IntegrationHeader } from '@site/src/components/integrations/header';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import { AddingIntegration } from '@site/src/components/integrations/adding';
import { IntegrationSecrets } from '@site/src/components/integrations/secrets';
import { peaNutIntegration } from '.';
import { upsWidget } from '@site/docs/widgets/ups';
import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { AddingIntegration } from "@site/src/components/integrations/adding";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { peaNutIntegration } from ".";
import { upsWidget } from "@site/docs/widgets/ups";
<IntegrationHeader
integration={peaNutIntegration}
categories={['UPS', 'Hardware']}
/>
<IntegrationHeader integration={peaNutIntegration} categories={["UPS", "Hardware"]} />
[PeaNUT](https://github.com/Brandawg93/PeaNUT) exposes the data of your [Network UPS Tools](https://networkupstools.org/) servers
over a REST API, which Homarr reads to display the status of your UPS devices.
### Widgets & Capabilities
<IntegrationCapabilites
items={[{
items={[
{
widget: upsWidget,
}]}
},
]}
/>
### Adding the integration
<AddingIntegration />
### Secrets
PeaNUT secures its API with HTTP Basic authentication when the `WEB_USERNAME` and `WEB_PASSWORD` environment variables
are set on the PeaNUT instance. Provide the same credentials here. If the instance runs with `AUTH_DISABLED=true`, no
secrets are required.
<IntegrationSecrets secrets={[{
credentials: ['username', 'password'],
steps: [
"Set WEB_USERNAME and WEB_PASSWORD on your PeaNUT instance.",
"Create an integration in Homarr with the PeaNUT URL and those credentials.",
],
},{
credentials: [],
steps: [
"If PeaNUT runs with AUTH_DISABLED=true, create the integration with no credentials.",
],
}]} />
<IntegrationSecrets
secrets={[
{
credentials: ["username", "password"],
steps: [
"Set WEB_USERNAME and WEB_PASSWORD on your PeaNUT instance.",
"Create an integration in Homarr with the PeaNUT URL and those credentials.",
],
},
{
credentials: [],
steps: ["If PeaNUT runs with AUTH_DISABLED=true, create the integration with no credentials."],
},
]}
/>
apps/docs/docs/integrations/pi-hole/index.mdx
+36 -29
View File
@@ -1,47 +1,54 @@
---
title: 'Pi-hole'
title: "Pi-hole"
description: "Pi-hole is a network-wide ad blocker that acts as a DNS sinkhole, blocking unwanted content and improving your browsing experience."
hide_title: true
---
import { IntegrationHeader } from '@site/src/components/integrations/header';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import { AddingIntegration } from '@site/src/components/integrations/adding';
import { IntegrationSecrets } from '@site/src/components/integrations/secrets';
import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { AddingIntegration } from "@site/src/components/integrations/adding";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { IconAd, IconDeviceGamepad } from "@tabler/icons-react";
import Alert from '@theme/Admonition';
import { dnsHoleSummaryWidget } from '@site/docs/widgets/dns-hole-summary';
import { dnsHoleControlsWidget } from '@site/docs/widgets/dns-hole-controls';
import { piHoleIntegration } from '.';
import Alert from "@theme/Admonition";
import { dnsHoleSummaryWidget } from "@site/docs/widgets/dns-hole-summary";
import { dnsHoleControlsWidget } from "@site/docs/widgets/dns-hole-controls";
import { piHoleIntegration } from ".";
<IntegrationHeader integration={piHoleIntegration} categories={["DNS Hole"]} />
<IntegrationHeader
integration={piHoleIntegration}
categories={['DNS Hole']}
/>
<Alert type="note" className='my-2'>
Homarr supports both Pi-hole v5 and v6. It automatically detects the version and uses the correct API.
<Alert type="note" className="my-2">
Homarr supports both Pi-hole v5 and v6. It automatically detects the version and uses the correct API.
</Alert>
### Widgets & Capabilities
<IntegrationCapabilites
items={[{
widget: dnsHoleSummaryWidget,
},{
widget: dnsHoleControlsWidget
}]}
items={[
{
widget: dnsHoleSummaryWidget,
},
{
widget: dnsHoleControlsWidget,
},
]}
/>
### Adding the integration
<AddingIntegration />
### Secrets
<IntegrationSecrets secrets={[{
credentials: ['apiKey'],
steps: [],
body: "Please note, that in v6 of Pi-hole you no longer specify an API key, but instead either a password or application password. We suggest to use the application password when possible."
}, {
credentials: [],
steps: []
}]} />
<IntegrationSecrets
secrets={[
{
credentials: ["apiKey"],
steps: [],
body: "Please note, that in v6 of Pi-hole you no longer specify an API key, but instead either a password or application password. We suggest to use the application password when possible.",
},
{
credentials: [],
steps: [],
},
]}
/>
apps/docs/docs/integrations/plex/index.mdx
+32 -26
View File
@@ -1,41 +1,47 @@
---
title: 'Plex'
title: "Plex"
description: "Plex is a media server platform that allows you to organize, manage, and stream your personal media collection."
hide_title: true
---
import { IntegrationHeader } from '@site/src/components/integrations/header';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import { AddingIntegration } from '@site/src/components/integrations/adding';
import {IntegrationSecrets} from '@site/src/components/integrations/secrets';
import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { AddingIntegration } from "@site/src/components/integrations/adding";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { IconVideo, IconTicket } from "@tabler/icons-react";
import { plexIntegration } from '.';
import { mediaServerWidget } from '@site/docs/widgets/media-server';
import { mediaReleasesWidget } from '@site/docs/widgets/media-releases';
import { plexIntegration } from ".";
import { mediaServerWidget } from "@site/docs/widgets/media-server";
import { mediaReleasesWidget } from "@site/docs/widgets/media-releases";
<IntegrationHeader
integration={plexIntegration}
categories={['Media server']}
/>
<IntegrationHeader integration={plexIntegration} categories={["Media server"]} />
### Widgets & Capabilities
<IntegrationCapabilites
items={[
{ widget: mediaServerWidget },
{ widget: mediaReleasesWidget }
]}
/>
<IntegrationCapabilites items={[{ widget: mediaServerWidget }, { widget: mediaReleasesWidget }]} />
### Adding the integration
<AddingIntegration />
### Secrets
<IntegrationSecrets secrets={[{
credentials: ['apiKey'],
steps: [
<IntegrationSecrets
secrets={[
{
credentials: ["apiKey"],
steps: [
<span>
Follow the official <a href="https://support.plex.tv/articles/204059436-finding-an-authentication-token-x-plex-token/" target="_blank" rel="noopener noreferrer">Plex documentation</a> to find your authentication token.
</span>
]
}]} />
Follow the official{" "}
<a
href="https://support.plex.tv/articles/204059436-finding-an-authentication-token-x-plex-token/"
target="_blank"
rel="noopener noreferrer"
>
Plex documentation
</a>{" "}
to find your authentication token.
</span>,
],
},
]}
/>
apps/docs/docs/integrations/prowlarr/index.mdx
+20 -18
View File
@@ -1,32 +1,34 @@
---
title: 'Prowlarr'
title: "Prowlarr"
description: "Prowlarr is an indexer manager for Usenet and BitTorrent, providing a unified interface to manage your indexers."
hide_title: true
---
import { IntegrationHeader } from '@site/src/components/integrations/header';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import { AddingIntegration } from '@site/src/components/integrations/adding';
import {IntegrationSecrets} from '@site/src/components/integrations/secrets';
import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { AddingIntegration } from "@site/src/components/integrations/adding";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { IconHeartRateMonitor } from "@tabler/icons-react";
import { prowlarrIntegration } from '.';
import { indexerManagerWidget } from '@site/docs/widgets/indexer-manager';
import { prowlarrIntegration } from ".";
import { indexerManagerWidget } from "@site/docs/widgets/indexer-manager";
<IntegrationHeader
integration={prowlarrIntegration}
categories={['Indexer']}
/>
<IntegrationHeader integration={prowlarrIntegration} categories={["Indexer"]} />
### Widgets & Capabilities
<IntegrationCapabilites
items={[{ widget: indexerManagerWidget }]}
/>
<IntegrationCapabilites items={[{ widget: indexerManagerWidget }]} />
### Adding the integration
<AddingIntegration />
### Secrets
<IntegrationSecrets secrets={[{
credentials: ['apiKey'],
steps: []
}]} />
<IntegrationSecrets
secrets={[
{
credentials: ["apiKey"],
steps: [],
},
]}
/>
apps/docs/docs/integrations/proxmox/index.mdx
+70 -66
View File
@@ -1,103 +1,107 @@
---
title: 'Proxmox'
title: "Proxmox"
description: "Proxmox is a powerful open-source virtualization platform that allows you to run virtual machines and containers."
hide_title: true
---
import { IntegrationHeader } from '@site/src/components/integrations/header';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import { AddingIntegration } from '@site/src/components/integrations/adding';
import {IntegrationSecrets} from '@site/src/components/integrations/secrets';
import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { AddingIntegration } from "@site/src/components/integrations/adding";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { IconHeartRateMonitor } from "@tabler/icons-react";
import { proxmoxIntegration } from '.';
import Alert from '@theme/Admonition'
import { healthMonitoringWidget } from '@site/docs/widgets/health-monitoring';
import { systemResourcesWidget } from '@site/docs/widgets/system-resources';
import { proxmoxIntegration } from ".";
import Alert from "@theme/Admonition";
import { healthMonitoringWidget } from "@site/docs/widgets/health-monitoring";
import { systemResourcesWidget } from "@site/docs/widgets/system-resources";
<IntegrationHeader
integration={proxmoxIntegration}
categories={['System monitoring']}
/>
<IntegrationHeader integration={proxmoxIntegration} categories={["System monitoring"]} />
### Widgets & Capabilities
<IntegrationCapabilites
items={[
{ widget: healthMonitoringWidget },
]}
/>
<IntegrationCapabilites items={[{ widget: healthMonitoringWidget }]} />
### Adding the integration
<AddingIntegration />
### Secrets
<IntegrationSecrets secrets={[{
header: <Alert type="caution">
The Proxmox API may not work with Linux PAM standard authentication. It is strongly recommended to use the Proxmox VE authentication server realm when creating your API user.
</Alert>,
credentials: ['username', 'tokenId', 'realm', 'apiKey'],
steps: [
<IntegrationSecrets
secrets={[
{
header: (
<Alert type="caution">
The Proxmox API may not work with Linux PAM standard authentication. It is strongly recommended to use the
Proxmox VE authentication server realm when creating your API user.
</Alert>
),
credentials: ["username", "tokenId", "realm", "apiKey"],
steps: [
"Navigate to the Proxmox portal, click on Datacenter",
"Expand Permissions, click on Groups",
"Click the Create button",
"Name the group something informative, like api-users",
"Click on the Permissions 'folder'",
<>
Click Add {"->"} Group Permission
<ul>
<li>Path: /</li>
<li>Group: group from Step 4 above</li>
<li>Role: PVEAuditor</li>
<li>Propagate: Checked</li>
</ul>
Click Add {"->"} Group Permission
<ul>
<li>Path: /</li>
<li>Group: group from Step 4 above</li>
<li>Role: PVEAuditor</li>
<li>Propagate: Checked</li>
</ul>
</>,
"Expand Permissions, click on Users",
<>
Click the Add button
<ul>
<li>User name: something informative like api</li>
<li>Realm: Proxmox VE authentication server</li>
<li>Password: create a secure password for the user</li>
<li>Confirm Password: re-enter the password</li>
<li>Group: group from Step 4 above</li>
</ul>
Click the Add button
<ul>
<li>User name: something informative like api</li>
<li>Realm: Proxmox VE authentication server</li>
<li>Password: create a secure password for the user</li>
<li>Confirm Password: re-enter the password</li>
<li>Group: group from Step 4 above</li>
</ul>
</>,
"Expand Permissions, click on API Tokens",
<>
Click the Add button
<ul>
<li>User: user from Step 8 above</li>
<li>Token ID: something informative like the application or purpose like homarr</li>
<li>Privilege Separation: unchecked</li>
</ul>
Click the Add button
<ul>
<li>User: user from Step 8 above</li>
<li>Token ID: something informative like the application or purpose like homarr</li>
<li>Privilege Separation: unchecked</li>
</ul>
</>,
"Copy the Secret that is shown in Step 10 because it is only shown once",
"Go back to the 'Permissions' menu",
<>
Click Add {"->"} API Token Permission
<ul>
<li>Path: /</li>
<li>API Token: select the API token created in Step 10</li>
<li>Role: PVE Auditor</li>
<li>Propagate: Checked</li>
</ul>
Click Add {"->"} API Token Permission
<ul>
<li>Path: /</li>
<li>API Token: select the API token created in Step 10</li>
<li>Role: PVE Auditor</li>
<li>Propagate: Checked</li>
</ul>
</>,
],
body: <>
<span>
Sometimes you'll also find the <code>api@pve!homarr</code> format,
within Homarr you'll have to split it up into:
</span>
<ul>
],
body: (
<>
<span>
Sometimes you'll also find the <code>api@pve!homarr</code> format, within Homarr you'll have to split it up
into:
</span>
<ul>
<li>
<b>Username:</b> api
<b>Username:</b> api
</li>
<li>
<b>Realm:</b> pve
<b>Realm:</b> pve
</li>
<li>
<b>Token ID:</b> homarr
<b>Token ID:</b> homarr
</li>
</ul>
</>
}]} />
</ul>
</>
),
},
]}
/>
apps/docs/docs/integrations/q-bittorent/index.mdx
+25 -23
View File
@@ -1,37 +1,39 @@
---
title: 'qBittorrent'
title: "qBittorrent"
description: "qBittorrent is a free and open-source BitTorrent client."
hide_title: true
---
import { IntegrationHeader } from '@site/src/components/integrations/header';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import { AddingIntegration } from '@site/src/components/integrations/adding';
import { IntegrationSecrets } from '@site/src/components/integrations/secrets';
import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { AddingIntegration } from "@site/src/components/integrations/adding";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { IconDownload } from "@tabler/icons-react";
import { qBittorentIntegration } from '.';
import Alert from '@theme/Admonition';
import { downloadsWidget } from '@site/docs/widgets/downloads';
import { qBittorentIntegration } from ".";
import Alert from "@theme/Admonition";
import { downloadsWidget } from "@site/docs/widgets/downloads";
<IntegrationHeader
integration={qBittorentIntegration}
categories={['Torrent client']}
/>
<IntegrationHeader integration={qBittorentIntegration} categories={["Torrent client"]} />
### Widgets & Capabilities
<IntegrationCapabilites
items={[{ widget: downloadsWidget }]}
/>
<IntegrationCapabilites items={[{ widget: downloadsWidget }]} />
### Adding the integration
<AddingIntegration />
### Secrets
<IntegrationSecrets secrets={[{
credentials: ['apiKey'],
steps: []
},{
credentials: ['username', 'password'],
steps: [],
}]} />
<IntegrationSecrets
secrets={[
{
credentials: ["apiKey"],
steps: [],
},
{
credentials: ["username", "password"],
steps: [],
},
]}
/>
apps/docs/docs/integrations/radarr/index.mdx
+20 -19
View File
@@ -1,33 +1,34 @@
---
title: 'Radarr'
title: "Radarr"
description: "Radarr is a movie management tool that automates the process of downloading, sorting, and renaming movies."
hide_title: true
---
import { IntegrationHeader } from '@site/src/components/integrations/header';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import { AddingIntegration } from '@site/src/components/integrations/adding';
import {IntegrationSecrets} from '@site/src/components/integrations/secrets';
import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { AddingIntegration } from "@site/src/components/integrations/adding";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { IconCalendar } from "@tabler/icons-react";
import { radarrIntegration } from '.';
import { calendarWidget } from '@site/docs/widgets/calendar';
import { radarrIntegration } from ".";
import { calendarWidget } from "@site/docs/widgets/calendar";
<IntegrationHeader
integration={radarrIntegration}
categories={['Media manager', "Servarr"]}
/>
<IntegrationHeader integration={radarrIntegration} categories={["Media manager", "Servarr"]} />
### Widgets & Capabilities
<IntegrationCapabilites
items={[{ widget: calendarWidget }]}
/>
<IntegrationCapabilites items={[{ widget: calendarWidget }]} />
### Adding the integration
<AddingIntegration />
### Secrets
<IntegrationSecrets secrets={[{
credentials: ['apiKey'],
steps: []
}]} />
<IntegrationSecrets
secrets={[
{
credentials: ["apiKey"],
steps: [],
},
]}
/>
apps/docs/docs/integrations/readarr/index.mdx
+20 -19
View File
@@ -1,33 +1,34 @@
---
title: 'Readarr'
title: "Readarr"
description: "Readarr is a book management tool that automates the process of downloading, sorting, and renaming books."
hide_title: true
---
import { IntegrationHeader } from '@site/src/components/integrations/header';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import { AddingIntegration } from '@site/src/components/integrations/adding';
import {IntegrationSecrets} from '@site/src/components/integrations/secrets';
import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { AddingIntegration } from "@site/src/components/integrations/adding";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { IconCalendar } from "@tabler/icons-react";
import { readarrIntegration } from '.';
import { calendarWidget } from '@site/docs/widgets/calendar';
import { readarrIntegration } from ".";
import { calendarWidget } from "@site/docs/widgets/calendar";
<IntegrationHeader
integration={readarrIntegration}
categories={['Media manager', "Servarr"]}
/>
<IntegrationHeader integration={readarrIntegration} categories={["Media manager", "Servarr"]} />
### Widgets & Capabilities
<IntegrationCapabilites
items={[{ widget: calendarWidget }]}
/>
<IntegrationCapabilites items={[{ widget: calendarWidget }]} />
### Adding the integration
<AddingIntegration />
### Secrets
<IntegrationSecrets secrets={[{
credentials: ['apiKey'],
steps: []
}]} />
<IntegrationSecrets
secrets={[
{
credentials: ["apiKey"],
steps: [],
},
]}
/>
apps/docs/docs/integrations/sabnzbd/index.mdx
+21 -20
View File
@@ -1,34 +1,35 @@
---
title: 'SABnzbd'
title: "SABnzbd"
description: "SABnzbd is an Open Source Binary Newsreader."
hide_title: true
---
import { IntegrationHeader } from '@site/src/components/integrations/header';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import { AddingIntegration } from '@site/src/components/integrations/adding';
import { IntegrationSecrets } from '@site/src/components/integrations/secrets';
import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { AddingIntegration } from "@site/src/components/integrations/adding";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { IconDownload } from "@tabler/icons-react";
import { sabnzbdIntegration } from '.';
import Alert from '@theme/Admonition';
import { downloadsWidget } from '@site/docs/widgets/downloads';
import { sabnzbdIntegration } from ".";
import Alert from "@theme/Admonition";
import { downloadsWidget } from "@site/docs/widgets/downloads";
<IntegrationHeader
integration={sabnzbdIntegration}
categories={['Usenet client']}
/>
<IntegrationHeader integration={sabnzbdIntegration} categories={["Usenet client"]} />
### Widgets & Capabilities
<IntegrationCapabilites
items={[{ widget: downloadsWidget}]}
/>
<IntegrationCapabilites items={[{ widget: downloadsWidget }]} />
### Adding the integration
<AddingIntegration />
### Secrets
<IntegrationSecrets secrets={[{
credentials: ['apiKey'],
steps: [],
}]} />
<IntegrationSecrets
secrets={[
{
credentials: ["apiKey"],
steps: [],
},
]}
/>
apps/docs/docs/integrations/seerr/index.mdx
+36 -29
View File
@@ -1,45 +1,52 @@
---
title: 'Seerr'
title: "Seerr"
description: "Seerr is a self-hosted media request management system that integrates with various media servers."
hide_title: true
---
import { IntegrationHeader } from '@site/src/components/integrations/header';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import { AddingIntegration } from '@site/src/components/integrations/adding';
import {IntegrationSecrets} from '@site/src/components/integrations/secrets';
import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { AddingIntegration } from "@site/src/components/integrations/adding";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { IconZoomQuestion, IconChartBar, IconSearch } from "@tabler/icons-react";
import { seerrIntegration } from '.';
import { mediaRequestListWidget } from '@site/docs/widgets/media-request-list';
import { mediaRequestStatsWidget } from '@site/docs/widgets/media-request-stats';
import { seerrIntegration } from ".";
import { mediaRequestListWidget } from "@site/docs/widgets/media-request-list";
import { mediaRequestStatsWidget } from "@site/docs/widgets/media-request-stats";
<IntegrationHeader
integration={seerrIntegration}
categories={['Media requests']}
/>
<IntegrationHeader integration={seerrIntegration} categories={["Media requests"]} />
### Widgets & Capabilities
<IntegrationCapabilites
items={[{
widget: mediaRequestListWidget
}, {
widget: mediaRequestStatsWidget
}, {
capability: {
icon: IconSearch,
name: "Media Search",
description: "Search for movies and TV shows directly from Spotlight and request them.",
path: "../../management/search-engines/#media-request-search"
}
}]}
items={[
{
widget: mediaRequestListWidget,
},
{
widget: mediaRequestStatsWidget,
},
{
capability: {
icon: IconSearch,
name: "Media Search",
description: "Search for movies and TV shows directly from Spotlight and request them.",
path: "../../management/search-engines/#media-request-search",
},
},
]}
/>
### Adding the integration
<AddingIntegration />
### Secrets
<IntegrationSecrets secrets={[{
credentials: ['apiKey'],
steps: []
}]} />
<IntegrationSecrets
secrets={[
{
credentials: ["apiKey"],
steps: [],
},
]}
/>
apps/docs/docs/integrations/slskd/index.mdx
+24 -19
View File
@@ -1,34 +1,39 @@
---
title: 'Slskd'
title: "Slskd"
description: "A modern client-server application for the Soulseek file sharing network."
hide_title: true
---
import { IntegrationHeader } from '@site/src/components/integrations/header';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import { AddingIntegration } from '@site/src/components/integrations/adding';
import { IntegrationSecrets } from '@site/src/components/integrations/secrets';
import { slskdIntegration } from '.';
import { downloadsWidget } from '@site/docs/widgets/downloads';
import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { AddingIntegration } from "@site/src/components/integrations/adding";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { slskdIntegration } from ".";
import { downloadsWidget } from "@site/docs/widgets/downloads";
<IntegrationHeader
integration={slskdIntegration}
categories={['System Monitoring']}
/>
<IntegrationHeader integration={slskdIntegration} categories={["System Monitoring"]} />
### Widgets & Capabilities
<IntegrationCapabilites
items={[{
widget: downloadsWidget
}]}
items={[
{
widget: downloadsWidget,
},
]}
/>
### Adding the integration
<AddingIntegration />
### Secrets
<IntegrationSecrets secrets={[{
credentials: ["apiKey"],
steps: []
}]} />
<IntegrationSecrets
secrets={[
{
credentials: ["apiKey"],
steps: [],
},
]}
/>
apps/docs/docs/integrations/sonarr/index.mdx
+20 -19
View File
@@ -1,33 +1,34 @@
---
title: 'Sonarr'
title: "Sonarr"
description: "Sonarr is a TV series management tool that automates the process of downloading, sorting, and renaming episodes."
hide_title: true
---
import { IntegrationHeader } from '@site/src/components/integrations/header';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import { AddingIntegration } from '@site/src/components/integrations/adding';
import {IntegrationSecrets} from '@site/src/components/integrations/secrets';
import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { AddingIntegration } from "@site/src/components/integrations/adding";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { IconCalendar } from "@tabler/icons-react";
import { sonarrIntegration } from '.';
import { calendarWidget } from '@site/docs/widgets/calendar';
import { sonarrIntegration } from ".";
import { calendarWidget } from "@site/docs/widgets/calendar";
<IntegrationHeader
integration={sonarrIntegration}
categories={['Media manager', "Servarr"]}
/>
<IntegrationHeader integration={sonarrIntegration} categories={["Media manager", "Servarr"]} />
### Widgets & Capabilities
<IntegrationCapabilites
items={[{ widget: calendarWidget }]}
/>
<IntegrationCapabilites items={[{ widget: calendarWidget }]} />
### Adding the integration
<AddingIntegration />
### Secrets
<IntegrationSecrets secrets={[{
credentials: ['apiKey'],
steps: []
}]} />
<IntegrationSecrets
secrets={[
{
credentials: ["apiKey"],
steps: [],
},
]}
/>
apps/docs/docs/integrations/speedtest-tracker/index.mdx
+25 -20
View File
@@ -1,34 +1,39 @@
---
title: 'Speedtest Tracker'
description: 'Speedtest Tracker is a self-hosted internet performance tracking application.'
title: "Speedtest Tracker"
description: "Speedtest Tracker is a self-hosted internet performance tracking application."
hide_title: true
---
import { IntegrationHeader } from '@site/src/components/integrations/header';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import { AddingIntegration } from '@site/src/components/integrations/adding';
import { IntegrationSecrets } from '@site/src/components/integrations/secrets';
import { speedtestTrackerIntegration } from '.';
import { speedtestTrackerWidget } from '@site/docs/widgets/speedtest-tracker';
import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { AddingIntegration } from "@site/src/components/integrations/adding";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { speedtestTrackerIntegration } from ".";
import { speedtestTrackerWidget } from "@site/docs/widgets/speedtest-tracker";
<IntegrationHeader
integration={speedtestTrackerIntegration}
categories={['Speedtest']}
/>
<IntegrationHeader integration={speedtestTrackerIntegration} categories={["Speedtest"]} />
### Widgets & Capabilities
<IntegrationCapabilites
items={[{
widget: speedtestTrackerWidget
}]}
items={[
{
widget: speedtestTrackerWidget,
},
]}
/>
### Adding the integration
<AddingIntegration />
### Secrets
<IntegrationSecrets secrets={[{
credentials: ['apiKey'],
steps: []
}]} />
<IntegrationSecrets
secrets={[
{
credentials: ["apiKey"],
steps: [],
},
]}
/>
apps/docs/docs/integrations/synology/index.mdx
+1 -5
View File
@@ -19,11 +19,7 @@ import Alert from "@theme/Admonition";
### Widgets & Capabilities
<IntegrationCapabilites
items={[
{ widget: healthMonitoringWidget },
{ widget: systemResourcesWidget },
{ widget: systemDisksWidget },
]}
items={[{ widget: healthMonitoringWidget }, { widget: systemResourcesWidget }, { widget: systemDisksWidget }]}
/>
### Supported metrics
apps/docs/docs/integrations/tdarr/index.mdx
+24 -22
View File
@@ -1,36 +1,38 @@
---
title: 'Tdarr'
title: "Tdarr"
description: "Tdarr is a distributed media transcoding system that allows you to process and optimize your media files across multiple nodes."
hide_title: true
---
import { IntegrationHeader } from '@site/src/components/integrations/header';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import { AddingIntegration } from '@site/src/components/integrations/adding';
import {IntegrationSecrets} from '@site/src/components/integrations/secrets';
import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { AddingIntegration } from "@site/src/components/integrations/adding";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { IconTransform } from "@tabler/icons-react";
import { tdarrIntegration } from '.';
import { mediaTranscodingWidget } from '@site/docs/widgets/media-transcoding';
import { tdarrIntegration } from ".";
import { mediaTranscodingWidget } from "@site/docs/widgets/media-transcoding";
<IntegrationHeader
integration={tdarrIntegration}
categories={['Media Transcoding']}
/>
<IntegrationHeader integration={tdarrIntegration} categories={["Media Transcoding"]} />
### Widgets & Capabilities
<IntegrationCapabilites
items={[{ widget: mediaTranscodingWidget }]}
/>
<IntegrationCapabilites items={[{ widget: mediaTranscodingWidget }]} />
### Adding the integration
<AddingIntegration />
### Secrets
<IntegrationSecrets secrets={[{
credentials: ['apiKey'],
steps: []
}, {
credentials: [],
steps: []
}]} />
<IntegrationSecrets
secrets={[
{
credentials: ["apiKey"],
steps: [],
},
{
credentials: [],
steps: [],
},
]}
/>
apps/docs/docs/integrations/technitium-dns/index.mdx
+49 -39
View File
@@ -1,62 +1,72 @@
---
title: 'Technitium DNS'
title: "Technitium DNS"
description: "Technitium DNS Server is a self-hosted DNS server with ad-blocking and network-wide filtering capabilities."
hide_title: true
---
import { IntegrationHeader } from '@site/src/components/integrations/header';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import { AddingIntegration } from '@site/src/components/integrations/adding';
import { IntegrationSecrets } from '@site/src/components/integrations/secrets';
import Alert from '@theme/Admonition';
import { technitiumDnsIntegration } from '.';
import { dnsHoleSummaryWidget } from '@site/docs/widgets/dns-hole-summary';
import { dnsHoleControlsWidget } from '@site/docs/widgets/dns-hole-controls';
import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { AddingIntegration } from "@site/src/components/integrations/adding";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import Alert from "@theme/Admonition";
import { technitiumDnsIntegration } from ".";
import { dnsHoleSummaryWidget } from "@site/docs/widgets/dns-hole-summary";
import { dnsHoleControlsWidget } from "@site/docs/widgets/dns-hole-controls";
<IntegrationHeader
integration={technitiumDnsIntegration}
categories={['DNS Hole']}
/>
<IntegrationHeader integration={technitiumDnsIntegration} categories={["DNS Hole"]} />
<Alert type="note" className='my-2'>
Homarr supports Technitium DNS v11 and above. The correct API version is detected automatically - no manual configuration is required.
<Alert type="note" className="my-2">
Homarr supports Technitium DNS v11 and above. The correct API version is detected automatically - no manual
configuration is required.
</Alert>
### Widgets & Capabilities
<IntegrationCapabilites
items={[{
widget: dnsHoleSummaryWidget,
},{
widget: dnsHoleControlsWidget
}]}
items={[
{
widget: dnsHoleSummaryWidget,
},
{
widget: dnsHoleControlsWidget,
},
]}
/>
### Adding the integration
<AddingIntegration />
### Secrets
<Alert type="info" className='my-2'>
The **API token** option is recommended. API tokens are non-expiring and do not require storing your admin password in Homarr.
Username and password authentication uses a session token that expires after inactivity, triggering a silent re-login on the next request.
<Alert type="info" className="my-2">
The **API token** option is recommended. API tokens are non-expiring and do not require storing your admin password in
Homarr. Username and password authentication uses a session token that expires after inactivity, triggering a silent
re-login on the next request.
</Alert>
<Alert type="warning" className='my-2'>
The **DNS Hole Controls** widget (enabling, disabling, and timed disabling of blocking) requires the token to have settings-level permissions.
The **DNS Hole Summary** widget (stats only) works with any valid token.
If Homarr cannot read the blocking status due to insufficient permissions, the status indicator will be hidden but statistics will still be shown.
<Alert type="warning" className="my-2">
The **DNS Hole Controls** widget (enabling, disabling, and timed disabling of blocking) requires the token to have
settings-level permissions. The **DNS Hole Summary** widget (stats only) works with any valid token. If Homarr cannot
read the blocking status due to insufficient permissions, the status indicator will be hidden but statistics will
still be shown.
</Alert>
<IntegrationSecrets secrets={[{
credentials: ['apiKey'],
steps: [
<IntegrationSecrets
secrets={[
{
credentials: ["apiKey"],
steps: [
"Open the Technitium DNS web console and sign in.",
"Click on your username in the top-right corner and select \"Create API Token\".",
"Give the token a name (e.g. \"Homarr\") and click \"Create Token\".",
"Copy the generated token and paste it into the API Key field in Homarr."
]
}, {
credentials: ['username', 'password'],
steps: [],
body: "Enter your Technitium DNS admin credentials. Homarr will exchange them for a session token and transparently re-authenticate when the session expires."
}]} />
'Click on your username in the top-right corner and select "Create API Token".',
'Give the token a name (e.g. "Homarr") and click "Create Token".',
"Copy the generated token and paste it into the API Key field in Homarr.",
],
},
{
credentials: ["username", "password"],
steps: [],
body: "Enter your Technitium DNS admin credentials. Homarr will exchange them for a session token and transparently re-authenticate when the session expires.",
},
]}
/>
apps/docs/docs/integrations/tracearr/index.mdx
+23 -24
View File
@@ -1,38 +1,37 @@
---
title: 'Tracearr'
title: "Tracearr"
description: "Tracearr is a comprehensive media monitoring solution that tracks streams, user activity, and policy violations in your media server (including Plex, Jellyfin, Emby)."
hide_title: true
---
import { IntegrationHeader } from '@site/src/components/integrations/header';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import { AddingIntegration } from '@site/src/components/integrations/adding';
import {IntegrationSecrets} from '@site/src/components/integrations/secrets';
import { tracearrIntegration } from '.';
import { tracearrWidget } from '@site/docs/widgets/tracearr';
import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { AddingIntegration } from "@site/src/components/integrations/adding";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { tracearrIntegration } from ".";
import { tracearrWidget } from "@site/docs/widgets/tracearr";
<IntegrationHeader
integration={tracearrIntegration}
categories={['Media Monitoring']}
/>
<IntegrationHeader integration={tracearrIntegration} categories={["Media Monitoring"]} />
### Widgets & Capabilities
<IntegrationCapabilites
items={[
{ widget: tracearrWidget }
]}
/>
<IntegrationCapabilites items={[{ widget: tracearrWidget }]} />
### Adding the integration
<AddingIntegration />
### Secrets
<IntegrationSecrets secrets={[{
credentials: ['apiKey'],
steps: [
<IntegrationSecrets
secrets={[
{
credentials: ["apiKey"],
steps: [
<span>
In Tracearr, go to <strong>Settings → API</strong> and generate or copy your API key.
</span>
]
}]} />
In Tracearr, go to <strong>Settings → API</strong> and generate or copy your API key.
</span>,
],
},
]}
/>
apps/docs/docs/integrations/transmission/index.mdx
+21 -20
View File
@@ -1,34 +1,35 @@
---
title: 'Transmission'
title: "Transmission"
description: "A Fast, Easy and Free Bittorrent Client."
hide_title: true
---
import { IntegrationHeader } from '@site/src/components/integrations/header';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import { AddingIntegration } from '@site/src/components/integrations/adding';
import { IntegrationSecrets } from '@site/src/components/integrations/secrets';
import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { AddingIntegration } from "@site/src/components/integrations/adding";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { IconDownload } from "@tabler/icons-react";
import { transmissionIntegration } from '.';
import Alert from '@theme/Admonition';
import { downloadsWidget } from '@site/docs/widgets/downloads';
import { transmissionIntegration } from ".";
import Alert from "@theme/Admonition";
import { downloadsWidget } from "@site/docs/widgets/downloads";
<IntegrationHeader
integration={transmissionIntegration}
categories={['Torrent client']}
/>
<IntegrationHeader integration={transmissionIntegration} categories={["Torrent client"]} />
### Widgets & Capabilities
<IntegrationCapabilites
items={[{ widget: downloadsWidget }]}
/>
<IntegrationCapabilites items={[{ widget: downloadsWidget }]} />
### Adding the integration
<AddingIntegration />
### Secrets
<IntegrationSecrets secrets={[{
credentials: ['username', 'password'],
steps: [],
}]} />
<IntegrationSecrets
secrets={[
{
credentials: ["username", "password"],
steps: [],
},
]}
/>
apps/docs/docs/integrations/truenas/index.mdx
+47 -41
View File
@@ -1,61 +1,67 @@
---
title: 'TrueNAS'
title: "TrueNAS"
description: "Enterprise network-attached storage for your home, office, and cloud."
hide_title: true
---
import { IntegrationHeader } from '@site/src/components/integrations/header';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import { AddingIntegration } from '@site/src/components/integrations/adding';
import { IntegrationSecrets } from '@site/src/components/integrations/secrets';
import { truenasIntegration } from '.';
import { systemResourcesWidget } from '@site/docs/widgets/system-resources';
import { healthMonitoringWidget } from '@site/docs/widgets/health-monitoring';
import Alert from '@theme/Admonition';
import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { AddingIntegration } from "@site/src/components/integrations/adding";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { truenasIntegration } from ".";
import { systemResourcesWidget } from "@site/docs/widgets/system-resources";
import { healthMonitoringWidget } from "@site/docs/widgets/health-monitoring";
import Alert from "@theme/Admonition";
<IntegrationHeader
integration={truenasIntegration}
categories={['NAS', 'Hardware']}
/>
<IntegrationHeader integration={truenasIntegration} categories={["NAS", "Hardware"]} />
### Widgets & Capabilities
<IntegrationCapabilites
items={[
{ widget: healthMonitoringWidget },
{ widget: systemResourcesWidget },
]}
/>
<IntegrationCapabilites items={[{ widget: healthMonitoringWidget }, { widget: systemResourcesWidget }]} />
### Adding the integration
<AddingIntegration />
<Alert type="info" title="Use the HTTPS address">
TrueNAS only serves its API over HTTPS, so enter the <code>https://</code> URL of your TrueNAS web interface. If it uses a self-signed certificate (the default), add it under <a href="/docs/management/certificates">Management &gt; Tools &gt; Certificates</a> so Homarr can establish the connection.
TrueNAS only serves its API over HTTPS, so enter the <code>https://</code> URL of your TrueNAS web interface. If it
uses a self-signed certificate (the default), add it under{" "}
<a href="/docs/management/certificates">Management &gt; Tools &gt; Certificates</a> so Homarr can establish the
connection.
</Alert>
### Secrets
<IntegrationSecrets secrets={[
<IntegrationSecrets
secrets={[
{
credentials: ['apiKey'],
header: <Alert type="tip" title="Recommended">
API key authentication is the recommended method. It works across current TrueNAS versions and does not depend on user group membership.
</Alert>,
steps: [
"In the TrueNAS web interface, click your user avatar in the top-right corner and select \"API Keys\".",
"Click \"Add\", give the key a name such as \"Homarr\", and confirm.",
"Copy the generated key immediately - TrueNAS only shows it once - and paste it as the API Key when creating the integration in Homarr.",
],
credentials: ["apiKey"],
header: (
<Alert type="tip" title="Recommended">
API key authentication is the recommended method. It works across current TrueNAS versions and does not depend
on user group membership.
</Alert>
),
steps: [
'In the TrueNAS web interface, click your user avatar in the top-right corner and select "API Keys".',
'Click "Add", give the key a name such as "Homarr", and confirm.',
"Copy the generated key immediately - TrueNAS only shows it once - and paste it as the API Key when creating the integration in Homarr.",
],
},
{
credentials: ['username', 'password'],
steps: [
"In the TrueNAS web interface, go to \"Credentials\" > \"Users\" > \"Add\" and create a user with a secure password.",
"Grant the user administrative access so Homarr can read system, pool, and reporting data.",
"Save the user and create the integration in Homarr with these credentials.",
],
body: <Alert type="caution" title="Administrative access required">
The account must have administrative API access. The <code>auxiliary_administrator</code> group was removed in TrueNAS 25.10; on that version or newer, use API key authentication instead, or assign the user a full-admin role.
</Alert>,
credentials: ["username", "password"],
steps: [
'In the TrueNAS web interface, go to "Credentials" > "Users" > "Add" and create a user with a secure password.',
"Grant the user administrative access so Homarr can read system, pool, and reporting data.",
"Save the user and create the integration in Homarr with these credentials.",
],
body: (
<Alert type="caution" title="Administrative access required">
The account must have administrative API access. The <code>auxiliary_administrator</code> group was removed in
TrueNAS 25.10; on that version or newer, use API key authentication instead, or assign the user a full-admin
role.
</Alert>
),
},
]} />
]}
/>
apps/docs/docs/integrations/umami/index.mdx
+36 -37
View File
@@ -1,53 +1,52 @@
---
title: 'Umami'
description: 'Privacy-focused, open-source web analytics'
title: "Umami"
description: "Privacy-focused, open-source web analytics"
hide_title: true
---
import { IntegrationHeader } from '@site/src/components/integrations/header';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import { AddingIntegration } from '@site/src/components/integrations/adding';
import { IntegrationSecrets } from '@site/src/components/integrations/secrets';
import { umamiIntegration } from '.';
import { umamiWidget } from '../../widgets/umami';
import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { AddingIntegration } from "@site/src/components/integrations/adding";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { umamiIntegration } from ".";
import { umamiWidget } from "../../widgets/umami";
<IntegrationHeader
integration={umamiIntegration}
categories={['Analytics']}
/>
<IntegrationHeader integration={umamiIntegration} categories={["Analytics"]} />
### Widgets & Capabilities
<IntegrationCapabilites
items={[
{ widget: umamiWidget }
]}
/>
<IntegrationCapabilites items={[{ widget: umamiWidget }]} />
### Adding the integration
<AddingIntegration />
:::tip URL configuration
- **Umami Cloud:** Use `https://api.umami.is/v1`
- **Self-hosted:** Use `http://your-umami-host:3000/api`
:::
:::
### Secrets
<IntegrationSecrets secrets={[
{
credentials: ['apiKey'],
steps: [
'Log in to your Umami instance (or Umami Cloud at https://cloud.umami.is)',
'Open Settings → API Keys',
'Click "Create API key"',
'Enter a name, e.g. "Homarr", and save',
'Copy the generated API key into Homarr',
]
},
{
credentials: ['username', 'password'],
steps: [
'Use the username and password of your Umami account',
'Note: username/password auth is for self-hosted instances only - Umami Cloud requires an API key',
]
}
]} />
<IntegrationSecrets
secrets={[
{
credentials: ["apiKey"],
steps: [
"Log in to your Umami instance (or Umami Cloud at https://cloud.umami.is)",
"Open Settings → API Keys",
'Click "Create API key"',
'Enter a name, e.g. "Homarr", and save',
"Copy the generated API key into Homarr",
],
},
{
credentials: ["username", "password"],
steps: [
"Use the username and password of your Umami account",
"Note: username/password auth is for self-hosted instances only - Umami Cloud requires an API key",
],
},
]}
/>
apps/docs/docs/integrations/unifi-controller/index.mdx
+21 -21
View File
@@ -1,40 +1,40 @@
---
title: 'Unifi Controller'
title: "Unifi Controller"
description: "Unifi Controller is a network management platform for Unifi devices."
hide_title: true
---
import { IntegrationHeader } from '@site/src/components/integrations/header';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import { AddingIntegration } from '@site/src/components/integrations/adding';
import {IntegrationSecrets} from '@site/src/components/integrations/secrets';
import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { AddingIntegration } from "@site/src/components/integrations/adding";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { IconTopologyFull } from "@tabler/icons-react";
import { unifiControllerIntegration } from '.';
import { networkControllerSummaryWidget } from '@site/docs/widgets/network-controller-summary';
import { networkControllerStatusWidget } from '@site/docs/widgets/network-controller-status';
import { unifiControllerIntegration } from ".";
import { networkControllerSummaryWidget } from "@site/docs/widgets/network-controller-summary";
import { networkControllerStatusWidget } from "@site/docs/widgets/network-controller-status";
<IntegrationHeader
integration={unifiControllerIntegration}
categories={['Network controller']}
/>
<IntegrationHeader integration={unifiControllerIntegration} categories={["Network controller"]} />
This integration is using the [node-unifi](https://www.npmjs.com/package/node-unifi) library under the hood to connect to the Unifi Controller.
Therfore it should support CloudKey Gen1, CloudKey Gen2, UnifiOS-based UDM-Pro controllers as well as self-hosted UniFi controllers.
### Widgets & Capabilities
<IntegrationCapabilites
items={[
{ widget: networkControllerSummaryWidget },
{ widget: networkControllerStatusWidget}
]}
items={[{ widget: networkControllerSummaryWidget }, { widget: networkControllerStatusWidget }]}
/>
### Adding the integration
<AddingIntegration />
### Secrets
<IntegrationSecrets secrets={[{
credentials: ['username', 'password'],
steps: []
}]} />
<IntegrationSecrets
secrets={[
{
credentials: ["username", "password"],
steps: [],
},
]}
/>
apps/docs/docs/integrations/unraid/index.mdx
+53 -41
View File
@@ -1,59 +1,71 @@
---
title: 'Unraid'
title: "Unraid"
description: "Versatile operating system that lets you run applications, virtual machines, and storage devices on your server"
hide_title: true
---
import { IntegrationHeader } from '@site/src/components/integrations/header';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import { AddingIntegration } from '@site/src/components/integrations/adding';
import { IntegrationSecrets } from '@site/src/components/integrations/secrets';
import { unraidIntegration } from '.';
import { systemResourcesWidget } from '@site/docs/widgets/system-resources';
import { healthMonitoringWidget } from '@site/docs/widgets/health-monitoring';
import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { AddingIntegration } from "@site/src/components/integrations/adding";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { unraidIntegration } from ".";
import { systemResourcesWidget } from "@site/docs/widgets/system-resources";
import { healthMonitoringWidget } from "@site/docs/widgets/health-monitoring";
import imgManagement from "./imgs/unraid-management.png";
import imgCreateApiKey from "./imgs/unraid-create-api-key.png";
import imgCopyApiKey from "./imgs/copy-api-key.png";
import imgSelectApikeyPreset from "./imgs/unraid-select-api-key-preset.png";
<IntegrationHeader
integration={unraidIntegration}
categories={['NAS', 'Hardware']}
/>
<IntegrationHeader integration={unraidIntegration} categories={["NAS", "Hardware"]} />
### Widgets & Capabilities
<IntegrationCapabilites
items={[
{ widget: healthMonitoringWidget },
{ widget: systemResourcesWidget },
]}
/>
<IntegrationCapabilites items={[{ widget: healthMonitoringWidget }, { widget: systemResourcesWidget }]} />
### Adding the integration
<AddingIntegration />
### Secrets
<IntegrationSecrets secrets={[{
credentials: ['apiKey'],
steps: [
<span>Are you using Unraid pre-7.2? If yes, please first <a href={"https://docs.unraid.net/API/#plugin-installation-pre-72-and-advanced-users"} target={"_blank"}>follow the steps here to install the Unraid API</a>.</span>,
<>
<span>Open the settings and open the management access</span><br/>
<img src={imgManagement} alt="Unraid management" style={{ height: 160 }} />
</>,
<>
<span>Click on the "API Keys" tab at the top and click on the "create API key" button. Choose "Create new"</span><br/>
<img src={imgCreateApiKey} alt="Unraid management" style={{ height: 120 }} />
</>,
<>
<span>Enter a suitable name for your API key (e.g. Homarr), select the "Viewer" preset and submit the modal.</span><br/>
<img src={imgSelectApikeyPreset} alt="Unraid management" style={{ height: 350 }} />
</>,
<>
<span>Last, copy the API key after your API key has been created</span><br/>
<img src={imgCopyApiKey} alt="Unraid management" style={{ height: 200 }} />
</>
],
}]} />
<IntegrationSecrets
secrets={[
{
credentials: ["apiKey"],
steps: [
<span>
Are you using Unraid pre-7.2? If yes, please first{" "}
<a href={"https://docs.unraid.net/API/#plugin-installation-pre-72-and-advanced-users"} target={"_blank"}>
follow the steps here to install the Unraid API
</a>
.
</span>,
<>
<span>Open the settings and open the management access</span>
<br />
<img src={imgManagement} alt="Unraid management" style={{ height: 160 }} />
</>,
<>
<span>
Click on the "API Keys" tab at the top and click on the "create API key" button. Choose "Create new"
</span>
<br />
<img src={imgCreateApiKey} alt="Unraid management" style={{ height: 120 }} />
</>,
<>
<span>
Enter a suitable name for your API key (e.g. Homarr), select the "Viewer" preset and submit the modal.
</span>
<br />
<img src={imgSelectApikeyPreset} alt="Unraid management" style={{ height: 350 }} />
</>,
<>
<span>Last, copy the API key after your API key has been created</span>
<br />
<img src={imgCopyApiKey} alt="Unraid management" style={{ height: 200 }} />
</>,
],
},
]}
/>
apps/docs/docs/integrations/uptime-kuma/index.mdx
+23 -24
View File
@@ -1,43 +1,42 @@
---
title: 'Uptime Kuma'
title: "Uptime Kuma"
description: "Uptime Kuma is a self-hosted monitoring tool that tracks the availability of your services and websites."
hide_title: true
---
import { IntegrationHeader } from '@site/src/components/integrations/header';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import { AddingIntegration } from '@site/src/components/integrations/adding';
import { IntegrationSecrets } from '@site/src/components/integrations/secrets';
import { uptimeKumaIntegration } from '.';
import { uptimeKumaWidget } from '@site/docs/widgets/uptime-kuma';
import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { AddingIntegration } from "@site/src/components/integrations/adding";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { uptimeKumaIntegration } from ".";
import { uptimeKumaWidget } from "@site/docs/widgets/uptime-kuma";
<IntegrationHeader
integration={uptimeKumaIntegration}
categories={['Monitoring']}
/>
<IntegrationHeader integration={uptimeKumaIntegration} categories={["Monitoring"]} />
Uptime Kuma monitors the availability of your services and provides uptime statistics through its status page API.
### Widgets & Capabilities
<IntegrationCapabilites
items={[
{ widget: uptimeKumaWidget },
]}
/>
<IntegrationCapabilites items={[{ widget: uptimeKumaWidget }]} />
### Adding the integration
<AddingIntegration />
### Secrets
<IntegrationSecrets secrets={[{
credentials: ['slug'],
steps: [
'Navigate to your Uptime Kuma instance',
'Go to Status Pages and create or select a status page',
<IntegrationSecrets
secrets={[
{
credentials: ["slug"],
steps: [
"Navigate to your Uptime Kuma instance",
"Go to Status Pages and create or select a status page",
'The slug is the URL path of your status page (e.g. "default" for /status/default)',
]
}]} />
],
},
]}
/>
:::tip
If you don't specify a slug, Homarr will use `default` as the status page slug.
apps/docs/docs/management/api/index.mdx
+26 -3
View File
@@ -1,9 +1,12 @@
---
title: API
tags:
- API
- Development
- Interface
- API
- Development
- Interface
---
Using the Homarr API, you can interface with the application with your own code and business logic.
@@ -90,3 +93,23 @@ Multi-integration widget queries keep data from integrations that remain availab
an optional `error` on a failed integration; media-request responses expose a `failedIntegrations` array, and the latest
requests endpoint returns its items in `requests`. When every selected integration fails, the query returns an error instead
of a partial response.
### Saving dashboard layouts
The dashboard editor saves item positions and sections as one board update.
Canvas height follows its content automatically and does not require a separate API setting.
Responsive layouts store optional left and right gutter widths from zero to three columns.
Gutter columns are reserved from the layout's total column count, and changing them reflows affected items.
## Get Custom Widget authoring resources
Custom JSX v2 provides four HTTP discovery endpoints:
- `GET /api/custom-widgets/authoring-prompt` returns the current prompt plus MCP and HTTP resource identifiers.
- `GET /api/custom-widgets/schema` returns the canonical widget JSON Schema.
- `GET /api/custom-widgets/components` returns the release-matched static component catalog.
- `GET /api/custom-widgets/skill` returns the concise live `SKILL.md` plus skills.sh, source, and install metadata. Retrieve the schema, component catalog, and examples through their dedicated resources only when needed.
Call `customWidget_configurationRequestUser` to create a temporary API source setup URL where the user can confirm their server URL and enter credentials. Do not construct or save this URL.
Authenticated tRPC and MCP procedures support definition management, validation, previews, template patches, and credential writes. An exported definition does not contain credentials.
apps/docs/docs/management/apps/index.mdx
+7 -4
View File
@@ -7,8 +7,8 @@ tags:
- Ping
---
Apps are the building blocks of your Homarr board.
Most of the time they are a simple link to a website, but used on your board they also support a simple ping to check if your service is up.
Apps are the building blocks of your Homarr board.
Most of the time they are a simple link to a website, but used on your board they also support a simple ping to check if your service is up.
Apps are used in the bookmark and app widget.
## Create an app
@@ -27,7 +27,7 @@ The name must be at least one character long and can be chosen freely.
### Icon URL
This is the URL to the icon that will be displayed on the app widget.
This is the URL to the icon that will be displayed on the app widget.
You can paste a direct HTTP(S) URL to an image, search the included icon repositories by name, or upload a local file through the upload button. Direct image URLs are used as entered and are not searched in the icon repositories.
![Icon URL](./img/app-icon-url.png)
@@ -40,11 +40,14 @@ An optional description that can be shown as tooltip on the app widget.
The URL to the website you want to link to. Clicking on the app widget or bookmark will open this URL.
You can also use custom URI schemes such as `vscode://file/path`, `microsoft-edge:https://example.com`, or `myapp://open` to link to local applications or third-party programs. We trust that you know what you are doing — only `javascript:` URIs are blocked for security reasons.
### Ping URL
When you want to use another url for the simple status check you can set it here.
When you want to use another url for the simple status check you can set it here.
This will allow you to set a different URL for the ping than the URL that is opened when clicking on the app widget.
It's useful when you want to ping the service internally for example with a custom ip but open the website externally.
Note that the ping URL only accepts `http://` and `https://` URLs — custom URI schemes are not supported for pings.
## List of apps
apps/docs/docs/management/backup.mdx
+5 -5
View File
@@ -24,12 +24,12 @@ Navigate to `Management` → `Tools` → `Backup`. You must have **admin** permi
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 |
| -------------------- | ------------------------------------------------------------------- |
| `db.sqlite` | Full SQLite database with all entities |
| `metadata.json` | Backup metadata: Homarr version, creation timestamp, encryption key |
| File | Description |
| --------------- | ------------------------------------------------------------------- |
| `db.sqlite` | Full SQLite database with all entities |
| `metadata.json` | Backup metadata: Homarr version, creation timestamp, encryption key |
The backup includes everything: apps, integrations, secrets, boards, users, groups, permissions, search engines, custom widgets, and server settings. (It just backs-up the whole database)
The backup contains the complete database. It includes Custom Widgets and all other Homarr configuration.
## Restoring a Backup
apps/docs/docs/management/boards/index.mdx
+84 -12
View File
@@ -36,8 +36,9 @@ Underscores and hyphen-minus are allowed.
### Column count
Homarr has a complex drag-and-drop system that can be used from the browser.
The column count defines how many horizontal columns are available to drag and drop elements to.
The column count defines how many fixed-width cells are available in each row.
One cell contains a `200 × 200` logical-pixel tile.
Homarr scales the whole board uniformly instead of changing widget proportions, with horizontal scrolling when further shrinking would make controls too small.
### Public
@@ -55,6 +56,8 @@ Alternatively, you can also navigate from the board page itself using the cog ic
![](./img/navigate-to-settings-2.png)
All board settings are edited on a single page. Click the **Save changes** button in the save bar at the bottom to apply them, or **Discard** to restore the last saved values. The save bar only appears when you have unsaved changes. Access control and the Danger zone are independent sections and are applied immediately.
### General
#### Page title
@@ -86,27 +89,78 @@ Homarr will fall back to the Homarr logo if nothing is set.
### Layout
In this section you can configure the different responsive layouts. Depending on your screens width the layout will change.
In this section you can configure the different responsive layouts.
Homarr selects a layout from the screen width, then scales its complete fixed-size canvas uniformly.
![](./img/layout-settings.png)
On each element the position and size of items can be changed separately.
When adding a new layout the position and sizes will automatically be generated depending on the column count.
New widgets use their default size and the first available position on each layout. Adding from an empty grid cell anchors
the widget near that cell on the active layout; Homarr still chooses safe free positions for the other responsive layouts.
Every `1 × 1` tile has a `200 × 200` logical-pixel content area.
The `24` logical-pixel gap between tiles is separate from that size.
A `2 × 1` tile therefore contains two fixed cell widths plus the gap between them.
Widgets see their logical size, while the board's visual scale makes the complete layout larger or smaller.
When fitting below 100%, Homarr keeps widget typography and control density at their normal readable size.
On larger canvases, the complete board grows together like browser zoom.
The scale never drops below 75%; on narrower screens the canvas scrolls horizontally instead of shrinking controls below an accessible size.
The position and size of every item are independent in each responsive layout.
Moving or resizing an item in one layout does not change any other layout.
When adding a new layout, its initial positions and sizes are generated from the column count.
New items use their widget's default grid size, while a new Container starts at a useful `4 × 3` size when the layout has enough columns.
Both are placed in the first available position.
The current board edge is a hard drag boundary, so moving a tile outside the canvas cancels that placement instead of creating empty rows.
Adding content can still create the rows required for the new tile.
Nested Containers keep their own resizable bounds.
#### Name
The name of the layout can be choosen freely. It is only used for the management and will not be visible on the board.
The name of the layout can be chosen freely. It is only used for management and will not be visible on the board.
#### Column count
Amount of columns for this layout. Defines how many items can be placed in a row. When changed it will automatically adjust the position and size of the items.
Total number of columns for this layout.
When changed, Homarr moves items into the next available positions without overlap.
#### Fixed rails
Each responsive layout can enable a fixed left rail, a fixed right rail, or both.
Set a rail width to zero to disable it for that layout.
Choose a width from one to three columns with the three-step slider.
The preview shows how much space remains for the main canvas.
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.
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.
Rails remain visible while the page scrolls.
Apps, widgets, and Containers inside them still use the same fixed `200 × 200` cells and can be rearranged in edit mode.
#### Breakpoint
Minimum width of the screen where the layout will be used.
Once the minimum width of the next layout is reached, the layout will change.
Once the minimum of the next layout is reached, the layout will change.
#### View and edit modes
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.
Entering edit mode keeps the static board visible until that preparation finishes, then enables collision-aware movement and resizing without changing the board geometry.
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.
For other collisions, or when a tile grows into occupied space, nearby tiles are compacted out of the way.
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.
Exit edit mode to save the resulting positions.
Pointer users can drag anywhere on a widget tile. Containers use the grab button at their top-left corner.
Resize tiles from any edge or corner handle.
On a touch screen, press and hold the tile before moving it; 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.
Press Enter, Space, or Escape to stop keyboard editing.
Keyboard moves and resizes apply immediately; 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.
The **Move / resize item** action in the edit menu remains available for precise numeric input.
#### Preview
@@ -114,6 +168,24 @@ Once the minimum width of the next layout is reached, the layout will change.
<img src={layoutMediumImage} height={256} />
<img src={layoutLargeImage} height={256} />
### Containers and rails
Containers can hold apps, widgets, and nested Containers.
The same Container model works on the main canvas, inside a fixed rail, or inside another Container.
Move and resize Containers directly in edit mode; nested content stays within the Container's local bounds.
Resize outlines follow the pointer continuously while a dashed preview marks the grid size that will be applied on release.
Each responsive layout stores its own Container position and size.
Each Container can configure:
- Its label and whether that label is visible.
- Whether users can collapse and expand it like an accordion.
- Whether its menu shows **Open all in new tabs** for the app links it contains.
- Its border color and custom CSS classes.
Collapsing a Container reduces its full-width header to a half-row expansion bar and compacts the surrounding layout without losing its expanded size.
Expanding it smoothly restores those bounds and moves following items out of the way without reloading the widgets inside it.
### Background
#### Background image URL
@@ -158,7 +230,7 @@ Change the color of your bookmark / app icons.
#### Item radius
Change the radius of your items / categories.
Change the radius of your items and Containers.
<img src={itemRadiusImage} height={100} />
@@ -234,7 +306,7 @@ This action is irreversible and cannot be undone.
The deletion of boards is permanent and cannot be undone.
There are two ways to delete a board:
- Navigate to the settings of your board, open the "Danger zone" dropdown and click on the "delete this board" button.
- Navigate to the settings of your board, open the "Danger zone" section and click on the "delete this board" button.
- Navigate to the list of boards in the management pages, click the three dots and click on "delete permanently".
Both actions will execute the same deletion process.
apps/docs/docs/management/certificates/index.mdx
+13 -11
View File
@@ -7,27 +7,29 @@ tags:
---
# Certificates
On this page you can manage your trusted certificates.
On this page you can manage your trusted certificates.
For example if you use a self signed certificate for one of the integrations you want to connect, you can add it here.
Below you can see a screenshot of the certificates page.
The items show the subject, filename and when it expires.
Below you can see a screenshot of the certificates page.
The items show the subject, filename and when it expires.
The color of the icon indicates how long it is valid.
![](./img/screenshot.png)
| Color | Meaning |
| --- | --- |
| 🟩 Green | Valid for more than 30 days |
| Color | Meaning |
| --------- | --------------------------- |
| 🟩 Green | Valid for more than 30 days |
| 🟨 Yellow | Valid for less than 30 days |
| 🟧 Orange | Valid for less than a week |
| 🟥 Red | Valid for less than a day |
| 🟧 Orange | Valid for less than a week |
| 🟥 Red | Valid for less than a day |
## Opening the certificates page
Navigate to ``Management`` > ``Tools`` > ``Certificates``.
Navigate to `Management` > `Tools` > `Certificates`.
## Add a certificate
To add a certificate click on the "Add certificate" button.
![](./img/add-button.png)
@@ -62,4 +64,4 @@ Below you can find instructions for some of the integrations.
Since version 6 of Pi-hole, the web interface can be accessed through HTTPS.
The certificate can be found in the path `/etc/pihole/tls_ca.crt`. To add the certificate, this file needs to be copied and uploaded to Homarr.
You can find more details regarding SSL / TLS for Pi-hole [here](https://docs.pi-hole.net/api/tls/).
You can find more details regarding SSL / TLS for Pi-hole [here](https://docs.pi-hole.net/api/tls/).
apps/docs/docs/management/custom-widgets/_category_.json
+9
View File
@@ -0,0 +1,9 @@
{
"label": "Custom Widgets",
"collapsed": true,
"position": 8,
"link": {
"type": "doc",
"id": "management/custom-widgets/index"
}
}
apps/docs/docs/management/custom-widgets/agent-authoring.mdx
+104
View File
@@ -0,0 +1,104 @@
# Use agents and skills.sh
An external agent creates one widget at a time with the Homarr MCP server. The agent harness manages the list for multiple widgets.
Homarr does not create widget packs or drafts for multiple widgets.
The MCP API key must belong to a Homarr administrator. Non-administrator keys do not list Custom Widget tools, prompts,
or resources. The same administrator requirement applies to the matching HTTP authoring endpoints.
<a className="button button--primary" href="https://www.skills.sh/homarr-labs/homarr/homarr-custom-widget">
View the Custom Widget Skill on skills.sh
</a>
Install the Agent Skill from the verified Homarr repository:
```sh
npx skills add https://github.com/homarr-labs/homarr --skill homarr-custom-widget
```
The portable skill gives concise authoring guidance. The Homarr MCP prompt gives connected agents a retrieval workflow: read the live schema, then fetch only the component documentation needed for the widget.
The workbench's **Copy AI prompt** action is separate. It creates a self-contained prompt below 12,000 characters for an ordinary ChatGPT or Claude conversation. It includes the lean contract, bindings, recommended components, and two polished examples. It never tells an offline model to call MCP tools.
The source is in [`.agents/skills/homarr-custom-widget`](https://github.com/homarr-labs/homarr/tree/HEAD/.agents/skills/homarr-custom-widget). `HEAD` follows the repository default branch, so the link is not tied to an unreleased feature branch. Homarr does not provide a ZIP archive.
After publication, run the installation command once. This action registers installation activity.
Then, verify the skills.sh page. Request official maker attribution for `homarr-labs` from skills.sh.
Repository code cannot give this attribution.
## Get MCP resources
- Prompt: `homarr-custom-widget-author`
- Resources: `homarr://custom-widgets/schema`, `components`, `components/{name}`, `examples/{name}`, and `skill`
- HTTP: `GET /api/custom-widgets/authoring-prompt`, `schema`, `components`, and `skill`
The authoring-prompt tool description contains one sentence. The prompt contains the workflow instructions and resource links.
`GET /api/custom-widgets/skill` and the MCP tool return the concise skill discovery payload:
```ts
{
name: "homarr-custom-widget";
version: string;
skillMd: string;
skillsShUrl: string;
sourceUrl: string;
installCommand: string;
}
```
The full installed component catalog stays available through `homarr://custom-widgets/components` and per-component resources. It is deliberately not embedded in the skill or clipboard prompt.
These interfaces do not return an archive URL or archive hash.
## Create a Custom Widget with MCP
1. Get the prompt, live schema, and component catalog.
2. Read the external API documentation.
3. Build one definition.
4. Validate the definition without saving it.
5. Create a preview session.
6. Test the queries and actions.
7. Open the preview URL with browser tools.
8. Inspect the redacted journal and revise the local candidate until it is valid.
9. Create the widget, including any source URLs and credentials the user already supplied.
10. Otherwise, ask the user to configure the saved definition with the ten-minute Homarr source-setup URL.
11. Create a final preview with the saved definition ID so Homarr loads its stored credentials, then test it again.
12. Update the saved definition if the final verification finds a problem.
13. Repeat the procedure for the next widget.
Each source-configuration URL applies to one definition or preview and one source. It is short-lived, single-use, and
can only be opened and completed by an authenticated Homarr administrator. The administrator confirms the server URL,
network scope, and required credential fields directly in Homarr. The agent receives only request status and never
receives plaintext credentials. Preview-scoped values expire with that preview; definition-scoped values persist.
Agents can install existing widgets without regenerating them:
1. Search with `customWidget_workshopSearch`.
2. Inspect and validate a result with `customWidget_workshopGet`.
3. Install it with `customWidget_workshopInstall`.
4. Configure deployment-specific URLs and supplied credentials with `customWidget_sourceConfigure`.
5. If the agent does not have those values, call `customWidget_configurationRequestUser` and wait for completion.
6. Test the installed definition, then use `board_addItem` with kind `customApi` and the returned definition ID.
Homarr encrypts the plaintext immediately. Homarr does not return the plaintext.
## Evaluate the copied prompt
Homarr maintainers can run the same self-contained prompt that the workbench copies through the live generation-quality suite:
```sh
OPENROUTER_API_KEY=... pnpm --filter @homarr/custom-widgets test:ai
```
The suite uses DeepSeek V4 Pro to author Pokédex, Portainer, football, Jellyfin, and Home Assistant widgets. Before DeepSeek V4 Flash judges a result, it must pass Homarr's real clipboard parser, canonical schema, and deterministic scenario checks for the documented API routes, authentication, bindings, actions, and essential runtime components. It saves every response, validated widget manifest, and detailed category scores under `packages/custom-widgets/.ai-evaluations/`.
Each scenario stops as soon as it passes and has a hard limit of ten generation attempts. Override the models or
per-scenario limit with `OPENROUTER_GENERATOR_MODEL`, `OPENROUTER_JUDGE_MODEL`, and
`CUSTOM_WIDGET_AI_MAX_LOOPS`. Generated artifacts are local and ignored by Git; promote a reviewed, validated result
into the bundled-widget source deliberately.
The reference API check uses a real PokeAPI list/detail request and a read-only Portainer container query when `PORTAINER_BASE_URL` and `PORTAINER_API_KEY` are set. Use `pnpm --filter @homarr/custom-widgets test:reference-apis -- --pokeapi-only` for the public PokeAPI check alone. To exercise start, restart, and stop against a disposable container, also set `PORTAINER_TEST_CONTAINER_ID` and the explicit safeguard `PORTAINER_ALLOW_MUTATIONS=1`; the script restores the container's original running state.
apps/docs/docs/management/custom-widgets/authoring.mdx
+38
View File
@@ -0,0 +1,38 @@
# Create a Custom Widget
import { CanonicalCustomWidgetExample } from "@site/src/components/custom-widget-code";
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.
## Manual workflow
1. Configure the default API source, network scope, authentication, and credential.
2. Add query/action cards. Values can be literals, widget options, or invocation parameters.
3. Add widget options with their control and default value.
4. Write responsive JSX using `data`, `status`, `options`, and temporary `inputs`.
5. Test and preview, inspect Data and the redacted request journal, then save.
<CanonicalCustomWidgetExample
id="named-widget-requests"
label="Named queries and actions"
example="requests"
height="420px"
/>
<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` with a query ID and value/label paths.
## ChatGPT or Claude
Enter the desired widget and optional API documentation URL, then select **Copy AI prompt**. The single self-contained prompt is below 12,000 characters, starts with your request, includes the lean contract and two polished examples, and never claims that an offline chat has MCP tools.
The model must return one fenced `json` block containing the complete widget, including the JSX in its `template`
field. Copy that single block and select **Paste AI response**. Homarr fills the visual builders and the JSX editor
without any placeholder replacement or second paste.
Homarr shows all actionable schema or JSX errors inline. Enter credentials separately. The prompt deliberately
recommends a focused Mantine component set, visual hierarchy, responsive layout, theme compatibility, and loading,
empty, failure, and success states.
Connected agents should use the skills.sh skill and retrieve the live schema and individual component metadata only as needed.
apps/docs/docs/management/custom-widgets/component-reference.mdx
+13
View File
@@ -0,0 +1,13 @@
---
title: Component reference
sidebar_position: 3
tags: [Custom Widgets, JSX, Mantine, Components]
---
import { CustomJsxComponentReference } from "@site/src/components/custom-jsx-component-reference";
# Custom JSX component reference
Search the components and properties exposed by Homarr's safe Custom JSX runtime. The live schema and diagnostics remain authoritative: properties marked as blocked cannot be passed from widget code, and denied components are shown only for explanation.
<CustomJsxComponentReference />
apps/docs/docs/management/custom-widgets/custom-jsx.mdx
+45
View File
@@ -0,0 +1,45 @@
# Use the safe JSX runtime
Templates are JSX expressions interpreted inside a widget-local safety and render budget. They can read:
- `data.requestId` — the latest response
- `status.requestId` — `{ loading, ok, status, statusText, error }`
- `options.name` — saved widget configuration
- `inputs.name` — temporary values from declarative `bind`
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.
## Temporary inputs
```jsx
<Stack>
<TextInput bind="search" defaultValue="" label="Search" />
<SubFetch requestId="search" params={{ query: inputs.search }}>
{(results) => (
<Stack>
{(results ?? []).map((item) => (
<Text key={item.id}>{item.name}</Text>
))}
</Stack>
)}
</SubFetch>
</Stack>
```
Bound values live only in React memory while the widget is mounted. They are not saved to the database, board options, exports, browser storage, or `localStorage`. Remounting resets them. Components can share a binding when their adapter types agree.
## Expression language
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. Patterns with lookbehind, backreferences, nested quantifiers, excessive length, or unsupported flags are rejected.
## Runtime components
- `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.
- `ActionButton` and `ToggleSwitch` run actions.
- `RefreshButton` renders a compact, accessible icon control that refreshes load queries for authenticated viewers. It
is disabled for anonymous public-board viewers because refreshing invalidates shared server cache state.
- `Icon`/`TablerIcon` resolves installed safe icons.
Always include responsive loading, empty, error, and success states. Runtime failures remain inside the widget tile.
Loaded 100 of 940 files, more files were not shown because too many files have changed in this diff. Show more