feat(docs): migrate documentation site into monorepo (#5912)

2026-06-11 18:48:39 +02:00
1 parent 3e464a76f2
commit 9e421c67bd
@@ -0,0 +1,9 @@
+{
+  "label": "Getting started",
+  "position": 1,
+  "collapsed": false,
+  "link": {
+    "type": "generated-index",
+    "title": "Getting started"
+  }
+}
@@ -0,0 +1,359 @@
+---
+title: After the installation
+sidebar_position: 3
+tags:
+  - Getting started
+  - Configuration
+---
+
+import imageStartFromScratchStepServerSettings from "./img/onboarding-from-scratch-step-server-settings.png";
+import imageStartFromScratchStepAdminUser from "./img/onboarding-from-scratch-step-admin-user.png";
+import imageStartFromScratchStepExternalAdminGroup from "./img/onboarding-from-scratch-step-external-admin-group.png";
+import imageStartFromScratchStepFinish from "./img/onboarding-from-scratch-step-finish.png";
+import manageBoardHeaderEditMode from "./img/manage-board-header-edit-mode.png";
+import manageBoardHeaderAddItem from "./img/manage-board-header-add-item-menu.png";
+import manageBoardHeaderChooseItem from "./img/manage-board-header-choose-item.png";
+import manageBoardNoApp from "./img/manage-board-no-app.png";
+import manageExportOldHomarr from "./img/old-homarr-export-data.png";
+import manageImportOldHomarrDropzone from "./img/old-homarr-import-dropzone.png";
+import manageImportOldHomarrChooseData from "./img/old-homarr-import-choose-imported-data.png";
+import manageImportDecryptionToken from "./img/old-homarr-import-decryption-token.png";
+
+:::tip
+
+Read our [glossary](./glossary) if you are new to Homarr.
+
+:::
+
+Congratulations on installing Homarr. Now it's time to get yourself familiar with the concepts of Homarr and how to use it.
+
+## Onboarding
+The onboard will show the first time you start Homarr.
+This process will help you with your first steps and adding some initial data, such as the administrator account.
+
+:::note
+
+If you see this screen repeatitly after you restarted the Homarr container, your Docker mounting paths may be missing,
+incorrect or read-only. Read [our installation instructions](/docs/getting-started/installation/docker) again to fix this issue.
+
+:::
+
+You can either import a previous dashboard using the ZIP archive or start from scratch:
+
+![Screenshot of Step 1 onboarding](./img/onboarding-step-1.png)
+
+You may refresh anytime and continue from a different device - the onboarding is saved immediately on the server for your convenience.
+
+### Starting from scratch
+Depending on your auth provider configuration you will either first see the admin user creation form or the external group creation form.
+If credentials provider was selected, you'll be prompted to create an admin user for Homarr.
+This user cannot be deleted and has full control over Homarr and all of it's boards.
+You must choose an username and password (both can later be changed).
+We enforce strict password requirements, when you enter your password, to protect your instance if you accidentially
+expose it to the Internet.
+
+<img src={imageStartFromScratchStepAdminUser} alt={"Screenshot form to create admin user"} width={300} />
+
+If you selected external providers (such as LDAP or OIDC), you'll be prompted to create an admin group.
+This group will be used to synchronize users from your provider to Homarr. 
+When a user is logged in through the provider the groups of him that match groups with any in Homarr will be added to the user.
+The name of the group has to match exactly the name of the group in the provider.
+
+<img src={imageStartFromScratchStepExternalAdminGroup} alt={"Screenshot form to create external admin group"} width={300} />
+
+Next, you can configure some basic settings for Homarr. We recommend to leave all settings at default for most users.
+Here you can also disable analytics. Please note that our analytics are completly anonymous and is fully compliant with GDPR and PECR.
+
+<img src={imageStartFromScratchStepServerSettings} alt={"Screenshot of analytics and indexing settings in the onboarding"} width={300} />
+
+### Setting up integrations
+
+After configuring server settings, the onboarding guides you through setting up your integrations.
+
+#### Docker service discovery
+If Docker is available (socket mounted), Homarr automatically detects running containers and matches them to known integration types.
+Matching integrations are pre-selected in the integration list, saving you from manually picking each one.
+
+#### URL templating
+You can define a base URL template to auto-fill integration URLs in bulk.
+Two modes are supported:
+- **Subdomain mode** — e.g. `{app}.example.com` where `{app}` is replaced with the integration name
+- **Port mode** — e.g. `192.168.1.1:{port}` where `{port}` is replaced with the integration's default port
+
+#### API key helper links
+For integrations that require API keys (such as Sonarr, Radarr, SABnzbd, or Seerr), a helper link opens the relevant settings page in the target application so you can quickly copy your key.
+
+#### Creating apps from Docker containers
+You can optionally auto-create bookmark apps for all discovered Docker containers, making them immediately available on your board.
+
+:::note
+
+Some niche and registry integrations (GitHub, npm, Docker Hub, GitLab, Codeberg, LinuxServer.io, GHCR, Quay, Search.ch) are hidden from the onboarding selection grid but remain available on the manage integrations page.
+
+:::
+
+After this step, you finished the onboarding.
+The onboarding can no longer be started again.
+From here you can click on one of the provided links to continue your journey.
+We recommend you to continue with the section [creating your first board on this page](#creating-your-first-board).
+
+<img src={imageStartFromScratchStepFinish} alt={"Screenshot of the finish onboarding process with links"} width={300} />
+
+### Importing a ZIP from version before 1.0.0
+This is recommended when you used Homarr before and want to re-import your data.
+It is important that you first migrate correctly using [the list of breaking changes for 1.0](/blog/2024/09/23/version-1.0).
+
+<img src={manageExportOldHomarr} alt="Export from old Homarr" style={{ maxWidth: 500 }} />
+
+**How to export and import data**
+1. Navigate to your old Homarr, open your management pages, open the tools submenu and open ``Migrate to 1.0``.
+2. Check the contents that you want to export. We recommend you to export all data.
+3. Click on the export data button
+4. Save the ZIP file, that is being downloaded, on your device. If you selected "integrations" or "users", you also get an encryption / decryption key.
+Copy it and do not loose it!
+5. Go to your new >1.0.0 Homarr instance and start the onboarding. Choose ``Import from Homarr before 1.0``
+6. Drag and drop your previously downloaded ZIP archive into the file upload: <br/><img src={manageImportOldHomarrDropzone} style={{ maxWidth: 500 }} />
+7. Next, choose the data that you want to import and how to import it. Since screen sizes were removed in 1.0, we create a new board for every screen size by default. We recommend you to only keep the best layout and adjust it later in 1.0.0 - but you can also import all of them and pick later.<br/><img src={manageImportOldHomarrChooseData} style={{ maxWidth: 500 }} />
+8. If you previously exported integrations or users, you will be asked to decrypt the data safely using your obtained encryption token. Paste into the modal and confirm your action.<br/><img src={manageImportDecryptionToken} style={{ maxWidth: 500 }} />
+9. Next, you can [follow the same setup as when starting from scratch](#starting-from-scratch). After you completed the onboarding, all of your data will be migrated and available.
+
+## Creating your first board
+In Homarr, you organize your apps and widgets on boards.
+Boards can be organized using the interactive drag and drop.
+Let's create your first board by navigating here: ``Manage`` > ``Boards`` > ``New board``:
+![](./img/manage-create-board-button.png)
+
+A board must always have a name and can either be public or private.
+Public boards are also accessible for users, that are not logged in ([see access control for boards](/docs/management/boards/#access-control)).
+
+![](./img/manage-create-board-modal.png)
+
+Congratulations - you've just created your first board. You can see boards, that you have access to, on this page:
+
+![](./img/manage-view-board.png)
+
+## Add your first app to Homarr
+To add links to your dashboard, you must first add them as an "app".
+Navigate to this page to add an app:
+
+![](./img/manage-navigate-apps.png)
+
+Next, click on the ``New app`` button. You'll need to provide a name and an icon to create an app.
+The name must be at least one character long but you can provide any image URL for the icon.
+Homarr ships with over 11K icons - so you can just search by entering a search text instead.
+
+![](./img/manage-add-app-form.png)
+
+After you created the app, you'll see in on the apps page:
+
+![](./img/manage-created-app.png)
+
+## Arrange and organize your board
+Let's add your freshly created app, from the previous step, to the board.
+To do this, edit your previously created board by clicking on the big ``Open board`` button:
+
+![](./img/manage-view-board.png)
+
+Here you have the following options in the header:
+
+![](./img/manage-board-header.png)
+
+- **Search**: Here you can search for data. You can search for integrations, boards, actions, sites and much more. Some actions may be context dependent (eg. will only show when certain widgets are on your page)
+- **Edit mode**: Clicking this button will toggle the edit mode. In this mode you can edit the contents of your board.
+- **Settings**: Clicking this button will redirect you to a settings page where you can adjust the board settings (page title, colors, ...).
+- **Profile**: This avatar will be visible on every page. Clicking it will show a menu with actions.
+
+When entering the edit mode, you'll get some additional buttons to work with:
+
+<img src={manageBoardHeaderEditMode} alt={"Screenshot of buttons in the edit mode"} width={200} />
+
+- **Add item**: Click this button to add new elements to your page.
+- **Exit edit mode**: Click this btuton to save your changes and exit edit mode.
+
+To continue, click the option "New Item":
+
+<img src={manageBoardHeaderAddItem} alt={"Screenshot of the add item menu"} width={200} />
+
+Next, you can choose what item you'd like to add.
+We will discuss the other options in the following sections - for now choose "App" to continue.
+
+<img src={manageBoardHeaderChooseItem} alt={"Screenshot of choosing the app item in the modal"} width={300} />
+
+As soon as you chose the app, the modal will close and you'll get the following item on your board:
+
+<img src={manageBoardNoApp} alt="Screenshot of the No app element on the board" />
+
+This is expected, because you haven't told Homarr what app it should show in this item.
+To configure this, click on the small 3 dots at the top of the item in the edit mode and choose "Edit item" in the menu.
+
+![](./img/manage-board-edit-app.gif)
+
+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.
+
+![](./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.
+
+![](./img/move-item.gif)
+
+:::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.
+
+:::
+
+:::tip
+
+We recommend you to experiment for a few minutes, before you start building your actual dashboard.
+This helps you to explore the capabilities of Homarr before you build your board in a suboptimal way.
+
+:::
+
+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:
+
+![](./img/manage-board-move-resize-item-menu.png)
+
+Be sure to save your changes by exiting edit mode!
+
+![](./img/exit-edit-mode.png)
+
+## Adding your first integration
+Now it's time to integrate some basic data into your board.
+To do this, we first need to create an integration.
+An integration is a connection between Homarr and a third party application - usually something that you run and deploy yourself.
+
+Navigate to ``Manage`` > ``Integrations`` (for example via your user menu).
+As an example, we are going to use the public demo instance of **Dash.** - a popular application to monitor CPU / hardware usage.
+Choose the **Dash.** integration from the list of available integrations:
+
+![](./img/choose-integration.gif)
+
+Next, choose a name (or leave it at default), enter ``https://dash.mauz.dev/`` as the URL in the form and click on ``Test connection and create``.
+Pressing the save button will perform a test request to the integration, to confirm that the networking setup is working as expected.
+Sometimes invalid configurations, firewalls and other mistakes can lead to connectivity problems - [follow this guide here](/docs/management/integrations/#troubleshooting-connection) if you experience issues.
+
+If connection was successful, you will be redirect back to the list of integrations.
+Now let's embed it to your board (see next section).
+
+:::note
+
+Some integrations may require additional configuration, such as a username, password or API tokens.
+Depending on your networking setup and applications, the connection from Homarr might also get blocked by firewalls,
+the target application or your router.
+
+:::
+
+## Embed integration data using widgets
+Let's add your integration, that you have configured in the section above, as a widget to your board.
+First, navigate back to your board that you want to add it to.
+Next, enter edit mode again and add another item to your board:
+
+![](./img/manage-board-header-add-item-menu.png)
+
+Instead of choosing an app, let's choose ``System Health Monitoring`` this time.
+Click on "Add to board":
+
+![](./img/manage-board-header-choose-system-health.png)
+
+Resize the item slightly and then edit it using the three dots menu at the top:
+
+![](./img/edit-system-health-widget.gif)
+
+Next, choose your newly created Dash. integration in the integrations dropdown:
+
+![](./img/manage-board-edit-system-health.png)
+
+:::note
+
+Some widgets may support multiple integrations at the same time.
+If they do not support multiple integrations, you will be unable to select more than one.
+
+:::
+
+Confirm your changes by pressing save.
+Editing a widget will trigger a data update and data will soon appear:
+
+![](./img/widget-system-health.png)
+
+As with every change, don't forget to save your changes using the exit edit mode button:
+
+![](./img/exit-edit-mode.png)
+
+## Grouping your items
+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.
+
+### Using dynamic sections
+Dynamic sections are a simple, resizable visual group to group items.
+
+![](./img/create-dynamic-section.png)
+
+After adding a dynamic section, you can simply drag and drop items into the section:
+
+![](./img/dynamic-section.gif)
+
+### 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.
+
+:::
+
+## Guided tours
+
+After completing the onboarding, Homarr provides interactive guided tours to help you discover key features.
+
+### Management tour
+When you first visit the management area (`/manage`), Homarr walks you through the main pages: boards, apps, integrations, and users (admin only).
+Each page highlights the list view and the create action so you know where to find and add things.
+
+### Board tour
+When you first open a board, a tour highlights the board header elements: search, edit mode, settings, board switcher, and user menu.
+
+### Tour controls
+- Press **Enter** (or click **Next**) to advance through tour steps
+- Tours auto-start on first visit and do not repeat once completed
+- Tours are skipped on mobile screens (below `sm` breakpoint)
+- You can **reset tours** from the user settings page under **Manage > Users > [Your user] > General**
+
+## Next steps
+You're done with the basic setup 🔥. Now it's time to organize and customize even more.
+We highly recommend you to experiment with different options, styles and configurations.
+See these curated pages for your next steps:
+- Create new apps using the [apps management](../management/apps/)
+- Customize your board or add more boards using the [boards management](../management/boards/)
+- Integrate software that you use using the [integrations management](../management/integrations)
+- Choose from our beautiful and interactive [widgets](/docs/category/widgets)
+- See [all supported integrations](/docs/category/integrations)
+- Integrate with Homarr with your own application using [the API](../management/api/)
+
+:::danger
+
+The Homarr Team will never ask for your credentials. Do not send people your credentials, as they manage the access to your applications and can cause harm to your device if they are abused.
+
+:::
@@ -0,0 +1,12 @@
+# 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                              |
@@ -0,0 +1,44 @@
+---
+title: Prerequisites
+sidebar_position: 1
+tags:
+  - Getting Started
+  - Installation
+  - Docker
+  - Unraid
+---
+
+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
+- Stable network connection, Wi-Fi use is not recommended
+
+## Architecture
+
+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       |
+|--------------|-----------------|
+| linux/amd64  | ✅ Supported     |
+| linux/arm64  | ✅ Supported     |
+| linux/arm/v7 | ❌ Not supported |
+
+## Getting started with installation
+
+<Link
+  data-attr="Go to installation"
+  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'}>
+    <span className={"dark:text-gray-200"}>Go to Installation</span>
+    <IconArrowRight className={"dark:text-gray-200"} size={20} />
+  </div>
+</Link>
@@ -0,0 +1,9 @@
+{
+  "label": "Installation",
+  "position": 1,
+  "collapsed": true,
+  "link": {
+    "type": "generated-index",
+    "title": "Getting started"
+  }
+}
@@ -0,0 +1,105 @@
+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*
+
+### Installation
+
+<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
+
+Docker compose creates a network by default. Some integrations may not work (specifically Dash.) when the network internal hostname is used since clients do not know this name. It is recommended that you either use a local network wide hostname or the IP directly. An alternative is to create a DNS record with the same internal compose stack hostname for all clients outside.
+
+:::
+
+### Updating
+
+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*)
+
+You can automate this process using [Watchtower](https://containrrr.dev/watchtower/).
+
+### Uninstalling
+
+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*)
+- (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
+
+[Docker Compose](#docker-compose) is easier and recommended for beginners. Consider using compose instead.
+
+:::
+
+### 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/)
+
+### Installation
+
+To install Homarr using Docker, simply run the following command.
+
+```bash
+docker run  \
+  --name homarr \
+  --restart unless-stopped \
+  -p 7575:7575 \
+  -v /var/run/docker.sock:/var/run/docker.sock \
+  -v <your-path>/homarr/appdata:/appdata \
+  -e SECRET_ENCRYPTION_KEY='your_64_character_hex_string' \
+  -d ghcr.io/homarr-labs/homarr:latest
+```
+
+:::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.
+
+:::
+
+### 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``.
+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)
+
+:::tip
+
+Want to update all your containers automatically? Checkout [Watchtower](https://containrrr.dev/watchtower/) a service which will automatically update your containers on a set interval.
+
+:::
+
+### 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*)
+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.
@@ -0,0 +1,9 @@
+# EasyPanel
+
+:::caution
+Easypanel has not updated to 1.0 yet. There template is still on 0.15.4.
+:::
+
+Easypanel is a modern server control panel. If you [run Easypanel](https://easypanel.io/docs) on your server, you can deploy Homarr with 1 click on it.
+
+[![Deploy to Easypanel](https://easypanel.io/img/deploy-on-easypanel-40.svg)](https://easypanel.io/docs/templates/homarr)
@@ -0,0 +1,484 @@
+# Helm
+
+<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.19.0](https://img.shields.io/badge/Version-8.19.0-informational?style=flat)
+![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat)
+![AppVersion: v1.60.0](https://img.shields.io/badge/AppVersion-v1.60.0-informational?style=flat)
+
+A Helm chart to deploy homarr for Kubernetes
+
+**Homepage:** <https://homarr-labs.github.io/charts/charts/homarr/>
+
+## Source Code
+
+* <https://github.com/homarr-labs/homarr>
+
+## Requirements
+
+Kubernetes: `>=1.24.0-0`
+
+## Dependencies
+
+This chart has no dependencies.
+
+## Installing the Chart
+
+To install the chart with the release name `homarr`
+
+### OCI (Recommended)
+
+```console
+helm install homarr oci://ghcr.io/homarr-labs/charts/homarr
+```
+
+### Traditional
+
+```console
+helm repo add homarr-labs https://homarr-labs.github.io/charts/
+helm repo update
+helm install homarr homarr-labs/homarr
+```
+
+## Uninstalling the Chart
+
+To uninstall the `homarr` deployment
+
+```console
+helm uninstall homarr
+```
+
+The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
+
+## Configuration
+
+Read through the [values.yaml](https://github.com/homarr-labs/charts/blob/dev/charts/homarr/values.yaml) file. It has several commented out suggested values.
+
+Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
+
+```console
+helm install homarr \
+  --set env.TZ="America/New York" \
+    homarr-labs/homarr
+```
+
+Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
+
+```console
+helm install homarr homarr-labs/homarr -f values.yaml
+```
+
+## Custom configuration
+
+### Secrets
+
+To avoid including sensitive information in plain text within your version control, consider using a declarative approach by applying secrets directly with kubectl apply. For example, instead of including repository credentials in your Helm values, you can leverage a kubernetes secrets manager.
+
+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      |
+
+### 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    |
+
+#### 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.
+
+To create the necessary database secret, execute the following command:
+
+<details>
+<summary>Required Secrets</summary>
+
+````yaml
+kubectl create secret generic db-encryption \
+--from-literal=db-encryption-key='<SECRET_ENCRYPTION_KEY_SECRET_TO_CHANGE>' \
+--namespace homarr
+````
+
+</details>
+
+#### PVC
+
+To persist data, you need to enable the `homarr-database` PVC. This will store the Homarr database on a mounted volume.
+
+Associated secret to create :
+
+<details>
+<summary>DB Required Secrets</summary>
+
+````yaml
+kubectl create secret generic db-encryption \
+--from-literal=db-encryption-key='<SECRET_ENCRYPTION_KEY_SECRET_TO_CHANGE>' \
+--namespace homarr
+````
+
+</details>
+
+Bellow an example of the override value file :
+
+<details>
+<summary>values.yaml</summary>
+
+````yaml
+persistence:
+  homarrDatabase:
+    enabled: true
+    storageClassName: "default"
+    size: "1Gi"
+````
+
+</details>
+
+#### External MySql database
+
+To create the necessary database secrets, execute the following command:
+
+<details>
+<summary>Required Secrets</summary>
+
+````yaml
+kubectl create secret generic db-encryption \
+--from-literal=db-encryption-key='<SECRET_ENCRYPTION_KEY_SECRET_TO_CHANGE>' \
+--namespace homarr
+````
+
+````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:
+
+<details>
+<summary>values.yaml</summary>
+
+````yaml
+database:
+  type: mysql
+````
+</details>
+
+#### External Postgresql database
+
+To create the necessary database secrets, execute the following command:
+
+<details>
+<summary>Required Secrets</summary>
+
+````yaml
+kubectl create secret generic db-encryption \
+--from-literal=db-encryption-key='<SECRET_ENCRYPTION_KEY_SECRET_TO_CHANGE>' \
+--namespace homarr
+````
+
+````yaml
+kubectl create secret generic db-secret \
+--from-literal=db-url='postgresql://user:password@host:port/homarrdb' \
+--namespace homarr
+````
+
+</details>
+
+Below is an example of the override values file:
+
+<details>
+<summary>values.yaml</summary>
+
+````yaml
+database:
+  type: postgresql
+````
+</details>
+
+### Ingress
+
+The ingress section in the values.yaml file allows you to configure how external traffic accesses your application through an Ingress resource. This section defines whether Ingress is enabled, the class to use, and how to set up hosts, paths, and TLS for secure connections.
+
+<details>
+<summary>values.yaml</summary>
+
+````yaml
+service:
+  enabled: true # Ensure the service is enabled for Ingress to route traffic
+ingress:
+  enabled: true
+  ingressClassName: "traefik"
+  annotations:
+  # Add any additional annotations as needed
+  hosts:
+    - host: homarr.homelab.dev
+      paths:
+        - path: /
+          pathType: ImplementationSpecific
+  tls:
+    - hosts:
+        - "homarr.homelab.dev"
+        - "www.homarr.homelab.dev"
+      secretName: homelab-tls
+````
+</details>
+
+### HTTPRoute (Gateway API)
+
+The httproute section in the values.yaml file allows you to configure how external traffic accesses your application using the Kubernetes Gateway API.
+This provides a more expressive and future-proof alternative to Ingress, with support for advanced routing, filters, and multiple parent Gateways.
+
+<details>
+<summary>values.yaml</summary>
+
+````yaml
+service:
+  enabled: true  # must be enabled for HTTPRoute to forward traffic
+httproute:
+  enabled: true
+  parentRefs:
+    - name: my-gateway
+      namespace: default
+  hostnames:
+    - homarr.homelab.dev
+  rules:
+    - matches:
+        - path:
+            type: PathPrefix
+            value: /
+      backendRefs:
+        - name: homarr
+          port: 8080
+````
+</details>
+
+#### Notes:
+
+- 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
+- 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
+
+Configuration for trusted certificate persistence. Supports:
+
+- Declarative config via `configmap` or `secret`
+- Pre-existing secret with `existingSecret`
+
+#### type: configmap
+
+Use inline certificates to generate a ConfigMap, mounted as individual files.
+
+<details>
+<summary>values.yaml</summary>
+
+````yaml
+persistence:
+  homarrTrustedCerts:
+    enabled: true
+    type: configmap
+    certificates:
+      cert1.crt: |
+        -----BEGIN CERTIFICATE-----
+        MIID...ABCD==
+        -----END CERTIFICATE-----
+      cert2.crt: |
+        -----BEGIN CERTIFICATE-----
+        MIID...EFGH==
+        -----END CERTIFICATE-----
+````
+</details>
+
+Behavior:
+
+- Helm creates a ConfigMap with keys cert1.crt and cert2.crt
+- Mounts them as /appdata/trusted-certificates/cert1.crt and /appdata/trusted-certificates/cert2.crt
+
+#### type: secret
+
+Use inline certificates to generate a Kubernetes Secret, mounted as files.
+
+<details>
+<summary>values.yaml</summary>
+
+````yaml
+persistence:
+  homarrTrustedCerts:
+    enabled: true
+    type: secret
+    certificates:
+      cert1.crt: |
+        -----BEGIN CERTIFICATE-----
+        MIIC...XYZ==
+        -----END CERTIFICATE-----
+      cart2.crt: |
+        -----BEGIN CERTIFICATE-----
+        MIIC...XYZ==
+        -----END CERTIFICATE-----
+````
+</details>
+
+Behavior:
+
+- Helm creates a Kubernetes Secret with cert1.crt and cart2.crt keys
+- Mounts it into the container
+
+#### type: existingSecret
+
+Use an existing Kubernetes Secret, assuming its keys are filenames.
+
+<details>
+<summary>values.yaml</summary>
+
+````yaml
+persistence:
+  homarrTrustedCerts:
+    enabled: true
+    type: existingSecret
+    existingSecretName: "existingSecretName"
+    existingSecretKeys:
+        - cert3.crt
+        - cert4.crt
+````
+</details>
+
+Behavior:
+
+- No new Secret is created
+- Uses existingSecretName directly
+- Mounts all keys as files in /appdata/trusted-certificates
+
+#### Summary Table
+
+| Type             | Creates Resource | Requires Certificates | Uses Existing | Mounts As Files |
+| ---------------- | ---------------- | --------------------- | ------------- | --------------- |
+| `configmap`      | ConfigMap        | Yes (`certificates`)  | ❌            | ✅              |
+| `secret`         | Secret           | Yes (`certificates`)  | ❌            | ✅              |
+| `existingSecret` | ❌               | ❌                    | ✅            | ✅              |
+
+All available values are listed on the [artifacthub](https://artifacthub.io/packages/helm/homarr-labs/homarr?modal=values). If you find any issue please open an issue on [github](https://github.com/homarr-labs/charts/issues/new?assignees=maintainers&labels=bug&projects=&template=bug_report.yaml)
+
+## Values
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| additionalObjects | list | `[]` | Additional resources to deploy. These objects are templated. |
+| affinity | object | `{}` | Node affinity for pod scheduling |
+| autoscaling.enabled | bool | `false` | Enable autoscaling |
+| autoscaling.maxReplicas | int | `100` | Maximum replicas |
+| autoscaling.minReplicas | int | `1` | Minimum replicas |
+| autoscaling.targetCPUUtilizationPercentage | int | `80` | Target CPU utilization for autoscaling |
+| containerPorts | object | `{"http":{"port":7575,"protocol":"TCP"}}` | containerPorts defines the ports to open on the container. It is a map where each entry specifies:    - `port`     (int)    (required): The port number to expose inside the container.    - `protocol` (string) (required): The network protocol (TCP or UDP) used for the port.    - `disabled` (bool)              : Optional flag to disable this port (defaults to false). Can be overridden via Helm values.  By default, this configuration exposes TCP port 7575 with the name `http`. |
+| database.migrationEnabled | bool | `true` | Database migration configuration. DB_MIGRATIONS_DISABLED Set to `true` to disable database migrations. Migrations are enabled by default (`false`). |
+| database.type | string | `"sqlite"` | Database type: sqlite, mysql or postgresql |
+| env.AUTH_LDAP_BASE | string | `nil` | Base dn of your LDAP server |
+| env.AUTH_LDAP_BIND_DN | string | `nil` | User used for finding users and groups |
+| env.AUTH_LDAP_GROUP_CLASS | string | `"groupOfUniqueNames"` | Class used for querying groups |
+| env.AUTH_LDAP_GROUP_FILTER_EXTRA_ARG | string | `nil` | Extra arguments for user's groups search filter (& based) |
+| env.AUTH_LDAP_GROUP_MEMBER_ATTRIBUTE | string | `"member"` | Attribute used for querying group member |
+| env.AUTH_LDAP_GROUP_MEMBER_USER_ATTRIBUTE | string | `"dn"` | User attribute used for comparing with group member |
+| env.AUTH_LDAP_SEARCH_SCOPE | string | `"base"` | LDAP search scope between base, one or sub |
+| env.AUTH_LDAP_URI | string | `nil` | URI of your LDAP server |
+| env.AUTH_LDAP_USERNAME_ATTRIBUTE | string | `"uid"` | Attribute used for username |
+| env.AUTH_LDAP_USERNAME_FILTER_EXTRA_ARG | string | `nil` | Extra arguments for user search filter (& based) |
+| env.AUTH_LDAP_USER_MAIL_ATTRIBUTE | string | `"mail"` | Attribute used for mail field |
+| env.AUTH_LOGOUT_REDIRECT_URL | string | `nil` | URL to redirect to after clicking logging out. |
+| env.AUTH_OIDC_AUTO_LOGIN | string | `"false"` | Automatically redirect to OIDC login |
+| env.AUTH_OIDC_CLIENT_NAME | string | `"OIDC"` | Display name of provider (in login screen) |
+| env.AUTH_OIDC_GROUPS_ATTRIBUTE | string | `"groups"` | Attribute used for groups (roles) claim |
+| env.AUTH_OIDC_ISSUER | string | `nil` | Issuer URI of OIDC provider without trailing slash (/) |
+| env.AUTH_OIDC_NAME_ATTRIBUTE_OVERWRITE | string | `nil` | Overwrite name attribute. By default, it will use preferred_username if it does not contain a @ and otherwise name. |
+| env.AUTH_OIDC_SCOPE_OVERWRITE | string | `"openid email profile groups"` | Override the OIDC scopes |
+| env.AUTH_PROVIDERS | string | `"credentials"` | Enabled authentication methods. Multiple providers can be enabled with by separating them with , (ex. AUTH_PROVIDERS=credentials,oidc, it is highly recommended to just enable one provider). |
+| env.AUTH_SESSION_EXPIRY_TIME | string | `"30d"` | 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") |
+| env.ENABLE_DNS_CACHING | string | `"false"` | Enables dns caching. This is not yet working for all users. See #4006 |
+| env.LOG_LEVEL | string | `"info"` | Log level to use. Possible values: debug/info/warn/error |
+| env.NO_EXTERNAL_CONNECTION | string | `"false"` | Disables some requests that need internet connection |
+| env.TZ | string | `"Europe/Paris"` | Your local time zone |
+| envSecrets.authLdapCredentials.existingSecret | string | `"auth-ldap-secret"` | Name of existing secret containing LDAP credentials |
+| envSecrets.authLdapCredentials.ldapBindingPassword | string | `"bind-password"` | Password for bind user secret key |
+| envSecrets.authOidcCredentials.existingSecret | string | `"auth-oidc-secret"` | Name of existing secret containing OIDC credentials |
+| envSecrets.authOidcCredentials.oidcClientId | string | `"oidc-client-id"` | ID of OIDC client (application) secret key |
+| envSecrets.authOidcCredentials.oidcClientSecret | string | `"oidc-client-secret"` | Secret of OIDC client (application) secret key |
+| envSecrets.dbCredentials.dbUrlKey | string | `"db-url"` | Secret key for DB_URL Example for external database: `mysql://username:password@host:port/homarrdb` or `postgresql://username:password@host:port/homarrdb` |
+| envSecrets.dbCredentials.existingSecret | string | `"db-secret"` | Name of existing secret containing DB credentials |
+| envSecrets.dbEncryption.existingSecret | string | `"db-encryption"` | Name of existing secret containing DB encryption |
+| envSecrets.dbEncryption.key | string | `"db-encryption-key"` | Secret key for SECRET_ENCRYPTION_KEY can be generated with `openssl rand -hex 32` |
+| fullnameOverride | string | `""` | Overrides chart's fullname |
+| hostAliases | list | `[]` | Add static entries to /etc/hosts in the Pod. This is useful in the following cases: - You are running in a dual-stack cluster (IPv4 + IPv6) and want to force usage of IPv4 for specific hostnames - Your application is having DNS resolution issues or IPv6 preference issues - You need to override or simulate DNS entries without changing global DNS - You are running in an air-gapped or isolated environment without external DNS Example: hostAliases:   - ip: "192.168.1.10"     hostnames:       - "example.com"       - "example.internal" |
+| httproute | object | `{"enabled":false,"hostnames":["chart-example.local"],"parentRefs":[{"name":"my-gateway","namespace":"default"}],"rules":[{"backendRefs":[{"name":"homarr","port":8080}],"filters":[],"matches":[{"path":{"type":"PathPrefix","value":"/"}}]}]}` | Gateway API HTTPRoute configuration |
+| httproute.enabled | bool | `false` | Enable HTTPRoute |
+| httproute.hostnames | list | `["chart-example.local"]` | Hostnames this route matches (similar to ingress.hosts.host) |
+| httproute.parentRefs | list | `[{"name":"my-gateway","namespace":"default"}]` | References to the parent Gateway(s) this route attaches to. Each item must include at least a `name`, and optionally a `namespace`. |
+| httproute.rules | list | `[{"backendRefs":[{"name":"homarr","port":8080}],"filters":[],"matches":[{"path":{"type":"PathPrefix","value":"/"}}]}]` | List of routing rules. Each rule can include: - matches: path/header/query matching - filters: optional transformations (redirects, header modifications, etc.) - backendRefs: one or more Kubernetes Services to forward traffic to |
+| httproute.rules[0].filters | list | `[]` | Optional filters for this rule (default: empty) |
+| httproute.rules[0].matches[0].path.type | string | `"PathPrefix"` | Path match type. One of: Exact, PathPrefix, RegularExpression |
+| 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.60.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 |
+| ingress.hosts | list | `[{"host":"chart-example.local","paths":[{"path":"/"}]}]` | Ingress hosts configuration |
+| ingress.ingressClassName | string | `""` | Ingress class name |
+| ingress.tls | list | `[]` | Ingress TLS configuration |
+| livenessProbe.failureThreshold | int | `3` | Failure threshold for liveness probe - number of consecutive failures before pod is restarted |
+| livenessProbe.httpGet.path | string | `"/api/health/live"` | This is the liveness check endpoint used by Kubernetes to determine if the application is still running. |
+| livenessProbe.httpGet.port | int | `7575` | The port on which the liveness check will be performed. This must be the same as the container port exposed by the application. |
+| livenessProbe.initialDelaySeconds | int | `10` | Initial delay in seconds before the liveness probe starts |
+| livenessProbe.periodSeconds | int | `10` | Period in seconds between liveness probe checks |
+| livenessProbe.timeoutSeconds | int | `1` | Timeout in seconds for each liveness probe check |
+| nameOverride | string | `""` | Overrides chart's name |
+| nodeSelector | object | `{}` | Node selectors for pod scheduling |
+| persistence.homarrDatabase.accessMode | string | `"ReadWriteOnce"` | homarr-database access mode |
+| persistence.homarrDatabase.enabled | bool | `false` | Enable homarr-database persistent storage |
+| persistence.homarrDatabase.mountPath | string | `"/appdata"` | homarr-database mount path inside the pod |
+| persistence.homarrDatabase.name | string | `"homarr-database"` | homarr-database persistent storage name |
+| persistence.homarrDatabase.size | string | `"50Mi"` | homarr-database storage size |
+| persistence.homarrDatabase.storageClassName | string | `"local-path"` | homarr-database storage class name |
+| persistence.homarrDatabase.volumeClaimName | string | `""` | homarr-database optional volumeClaimName to target specific PV |
+| persistence.homarrTrustedCerts.certificates | string | `nil` | homarr-trusted-certificates certificates, each entry will become a new trusted certificate as a dedicated file (works only for "configmap" and "secret" mode) |
+| persistence.homarrTrustedCerts.enabled | bool | `false` | Enable trusted certificates persistence |
+| persistence.homarrTrustedCerts.existingSecretKeys | string | `nil` | List of keys (filenames) to mount from the existing secret (used only when type is "existingSecret") |
+| persistence.homarrTrustedCerts.existingSecretName | string | `""` | Name of the existing Kubernetes Secret to mount (required if type is "existingSecret") |
+| persistence.homarrTrustedCerts.mountPath | string | `"/appdata/trusted-certificates"` | homarr-trusted-certificates  mount path inside the pod |
+| persistence.homarrTrustedCerts.type | string | `"configmap"` | Persistence mode can be : configmap (declarative), secret (declarative) or existingSecret (mount an existing Kubernetes Secret by name and specify which keys to mount as files) |
+| podAnnotations | object | `{}` | Pod annotations |
+| podLabels | object | `{}` | Pod labels |
+| podSecurityContext | object | `{}` | Pod security context |
+| rbac | object | `{"enabled":false}` | Enable RBAC resources for Kubernetes integration Creates Role, ClusterRole, and associated bindings for Homarr's Kubernetes features |
+| rbac.enabled | bool | `false` | Enable to create RBAC resources and activate Kubernetes integration |
+| readinessProbe.failureThreshold | int | `3` | Failure threshold for readiness probe - number of consecutive failures before pod is considered unready |
+| readinessProbe.httpGet.path | string | `"/api/health/ready"` | This is the readiness check endpoint used by Kubernetes to determine if the application is ready to handle traffic. |
+| readinessProbe.httpGet.port | int | `7575` | The port on which the readiness check will be performed. This must match the container's exposed port. |
+| readinessProbe.initialDelaySeconds | int | `10` | Initial delay in seconds before the readiness probe starts. increase this value if the pod is slow to fully start. |
+| readinessProbe.periodSeconds | int | `10` | Period in seconds between readiness probe checks |
+| readinessProbe.timeoutSeconds | int | `1` | Timeout in seconds for each readiness probe check |
+| replicaCount | int | `1` | Number of replicas |
+| resources | object | `{}` | Resource configuration |
+| securityContext | object | `{}` | Security context |
+| service.enabled | bool | `true` | Enable service |
+| service.ipFamilies | list | `[]` | List of IP families to use for the service. Examples: - ["IPv4"] - ["IPv6"] - ["IPv4", "IPv6"] for dual-stack Leave empty to use cluster default behavior |
+| service.ipFamilyPolicy | string | `"SingleStack"` | Defines how the service assigns IP families (IPv4/IPv6) Possible values: - SingleStack (default): Only one IP family, usually IPv4 - PreferDualStack: Use dual-stack if the cluster supports it, fallback to single - RequireDualStack: Fail if dual-stack cannot be assigned |
+| service.ports.app.port | int | `7575` | Service port |
+| service.ports.app.protocol | string | `"TCP"` | Service protocol |
+| service.ports.app.targetPort | string | `"http"` | Service target port |
+| service.type | string | `"ClusterIP"` | Service type |
+| strategyType | string | `"RollingUpdate"` | `strategyType` specifies the strategy used to replace old Pods by new ones. `strategyType` can be `"Recreate"` or `"RollingUpdate"`. `"RollingUpdate"` is the default value and updates Pods in a rolling update fashion. `"Recreate"` will kill all existing Pods before new ones are created. The `"Recreate"` strategy is necessary when persistent volume's `accessMode` is set to `"ReadWriteOnce"` when using `helm upgrade`, as pod volume attachments to an existing PersistentVolumeClaim need to be cleared before a new pod can attach to it. |
+| tolerations | list | `[]` | Node tolerations for pod scheduling |
+
+---
+Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs)
@@ -0,0 +1,25 @@
+# Home Assistant Add-on
+
+:::caution
+Home Assistant Add-on is now updated to 1.0. Please add the new repository to your Add-on store. Also make sure to follow the [migration guide](https://homarr.dev/blog/2025/01/19/migration-guide-1.0/) so you don't lose your existing setup.
+:::
+
+Homarr can be seamlessly integrated into your Home Assistant setup with this add-on. This is perfect for users who rely on Home Assistant as their primary server and don't have a separate device for hosting.
+
+## Prerequisites
+
+- [Home Assistant](https://www.home-assistant.io/getting-started/)
+- Add-ons are only available if you've used the Home Assistant Operating System or Home Assistant Supervised installation method.
+
+## 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)
+
+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.
+
+3. **Start the Add-on**: Once installed and configured, start the Homarr Server add-on from the Home Assistant Supervisor panel.
+
+4. **Access Homarr**: Homarr will be available at `http://<your-home-assistant-ip>:7575`. Open this address in your browser to access your Homarr dashboard.
+
+Your configuration, data and icons will be saved at /shares
@@ -0,0 +1,5 @@
+# Pika Pods
+
+Pika Pods is a hosting platform for open source apps. You can deploy Homarr on Pika Pods with just a few clicks:
+
+[_![Deploy on PikaPods](https://www.pikapods.com/static/run-button.svg)_](https://www.pikapods.com/pods?run=homarr-v1)
@@ -0,0 +1,47 @@
+# Portainer
+## Portainer Stacks
+### Prerequisites
+
+- [Portainer Stacks](https://www.portainer.io/blog/stacks-docker-compose-the-portainer-way)
+
+### Installing
+
+To install Homarr using Portainer Stacks, simply create a new stack and paste the following code into it.
+
+```yml title="docker-compose.yml"
+#---------------------------------------------------------------------#
+#     Homarr - A simple, yet powerful dashboard for your server.      #
+#---------------------------------------------------------------------#
+services:
+  homarr:
+    container_name: homarr
+    image: ghcr.io/homarr-labs/homarr:latest
+    restart: unless-stopped
+    volumes:
+      - /var/run/docker.sock:/var/run/docker.sock # Optional, only if you want docker integration
+      - <your-path>/appdata:/appdata
+    environment:
+      - SECRET_ENCRYPTION_KEY=your_64_character_hex_string # <--- can be generated with `openssl rand -hex 32`
+    ports:
+      - '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.
+:::
+
+Then, click on ``Deploy the stack`` and wait until the container has started.
+
+:::tip
+
+If you're unsure how to create a stack, checkout the [Portainer Documentation](https://docs.portainer.io/user/docker/stacks/add).
+
+:::
+
+### Updating
+
+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.
@@ -0,0 +1,73 @@
+# Proxmox
+
+This guide covers how to install homarr inside of a linux-container in ProxmoxVE, using a fully automated approach.
+
+# What is community-scripts?
+
+https://community-scripts.org/
+
+This installation method is provided by the Proxmox Community-Scripts. We are a community-driven initiative that simplifies the setup of Proxmox Virtual Environment (VE).
+With hundreds of scripts to help you manage your Proxmox VE environment. Whether you're a seasoned user or a newcomer, we've got you covered.
+
+# Installation
+
+It's as simple as pasting the following snippet into your Proxmox node's console
+
+```bash
+bash -c "$(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/ct/homarr.sh)"
+```
+
+Check out the website for more info: https://community-scripts.org/scripts?q=homarr
+
+:::warning
+Never trust any script directly injected from the web, without prior looking through it or searching the web for other's opinions.
+
+:::
+
+After executing this command, you will get asked, if you want to accept defaults or would like to specify things like IP-Adress, DNS etc, then choose advanced.
+
+After confirming the installation, the script will install the required dependencies, which may take a few minutes. Do not interrupt the installation.
+After you've installed Homarr, you can find a new LXC "homarr".
+
+# Updating
+
+Updating is as simple as executing 
+
+```bash
+update
+```
+
+or running the script again but this time inside the container's shell:
+
+```bash
+bash -c "$(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/ct/homarr.sh)"
+```
+
+# Configuration
+
+Some Homarr features require setting environment variables. When installing Homarr on Proxmox using the community-scripts installer, these can be configured in the file /opt/homarr.env. This path is also documented on the community-scripts website as the configuration path.
+
+# Troubleshooting
+
+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
+systemctl status homarr
+```
+
+As Homarr logs really a log, it sometimes feels like the log is endless till you get the bottom, so a command like this only shows the latest 100 lines:
+
+```bash
+journalctl -u homarr | tail -n 100
+```
@@ -0,0 +1,9 @@
+# QNAP
+
+:::caution
+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/).
+
+There is also a guide available, but note that it is written in Chinese: https://post.smzdm.com/p/awzm7op2/
@@ -0,0 +1,5 @@
+# Railway
+
+Railway is a cloud platform that allows you to deploy your apps with ease. You can deploy Homarr on Railway with a few clicks.
+
+[_![Deploy on Railway](https://railway.com/button.svg)_](https://railway.com/deploy/_c4Kr9?referralCode=vishify)
@@ -0,0 +1,30 @@
+#  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.
+
+https://runtipi.io
+
+## Prerequisites
+
+- [Runtipi](https://runtipi.io/docs/getting-started/installation)
+
+# 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"**
+
+# Maintenance
+
+After installation, all you need is available from the WebUI in **"My apps"** > **"Homarr"** :
+ - 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.
@@ -0,0 +1,10 @@
+# Saltbox
+
+:::caution
+Saltbox installation command has not updated to 1.0 yet. There command still runs 0.15.10.
+:::
+
+You can also use this to install on Saltbox:
+```bash
+sb install sandbox-homarr
+```
@@ -0,0 +1,43 @@
+---
+title: From source
+---
+
+# (Not recommended): From source
+
+:::caution
+
+Installing from source is a bad idea in many ways:
+
+- No isolation between applications
+- Dependency conflicts on your root operating system
+- Cumbersome update process
+- Permission management
+- Handling of conflicts
+
+Therefore, we highly discourage you from using this as a normal user.
+This method is only useful, when you want to develop on Homarr or extend it with your own functionality.
+
+:::
+
+## Prerequisites
+
+- [Node.js](https://nodejs.org/en/download/)
+- [pnpm](https://pnpm.io/installation)
+- [Redis](https://redis.io/download)
+
+## 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>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>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>
+</ol>
@@ -0,0 +1,6 @@
+# Synology
+
+The installation process is quite easy and fast on Synology devices.
+Since this method is used less often, we recommend you to follow this guide written by mariushosting.
+
+https://mariushosting.com/how-to-install-homarr-on-your-synology-nas/
@@ -0,0 +1,49 @@
+import Link from '@docusaurus/Link';
+import { IconDownload } from '@tabler/icons-react';
+
+# Unraid
+
+You can install Homarr directly from your Unraid Dashboard, no terminal required.
+
+#### Prerequisites
+
+- [Unraid](https://unraid.net/)
+- [Community Apps](https://forums.unraid.net/topic/38582-plug-in-community-applications/)
+
+#### Install the Community Apps Plugin
+
+<Link
+  data-attr="Install Unraid Community Apps"
+  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'}>
+    <span className={"dark:text-gray-200"}>Install community applications plugin</span>
+    <IconDownload className={"dark:text-gray-200"} size={20} />
+  </div>
+</Link>
+
+<br/>
+<br/>
+
+:::tip
+
+Don't know whether you have the plugin installed or not? Search for this tab in the navigation:
+
+![](img/unraid-navigation-app-manager.webp)
+:::
+
+#### Installing
+
+After you've installed the Community Apps Plugin, you can install Homarr from the Unraid Dashboard.
+
+1. Navigate to the tab "Apps".
+2. Search for "Homarr" and click on the result.
+3. Click on "Install" and adjust the settings to your liking.
+
+![](img/unraid-apps-homarr.webp)
+
+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.
+