docs(versioning): add versioning for version 1.19.0

Author: Meierschlumpf

versioned_docs/version-1.19.0/advanced/_category_.json

@@ -0,0 +1,9 @@
+{
+  "label": "Advanced",
+  "collapsed": true,
+  "position": 4,
+  "link": {
+    "type": "generated-index",
+    "title": "Advanced Concepts or features"
+  }
+}

versioned_docs/version-1.19.0/advanced/command-line/_category_.json

@@ -0,0 +1,4 @@
+{
+  "collapsed": true,
+  "label": "Command line interface"
+}

versioned_docs/version-1.19.0/advanced/command-line/fix-usernames/img/screenshot-cli.png

@@ -0,0 +1,17 @@
+# Fix usernames
+
+:::info
+
+This guide requires that you understand [how to access the CLI](../).
+
+:::
+
+If you somehow get into a situation where you have users with usernames that contain uppercase characters and you are no longer able to log in, you can use the following command to fix the usernames.
+
+```bash
+homarr fix-usernames
+```
+
+This will convert all credential usernames to lowercase and update the database accordingly.
+
+![](./img/screenshot-cli.png)

versioned_docs/version-1.19.0/advanced/command-line/fix-usernames/index.mdx

@@ -0,0 +1,27 @@
+# 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.
+
+:::caution
+
+Using the recovery CLi tool can cause problems when requests are being sent to Homarr while the tool is running. \
+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).
+
+## Execute CLI with QNAP
+
+1. Open Container Station in the QNAP Web Interface ![](img/334116069-e7ec4726-3df7-4dc6-a3e0-b745e7eef17f.png)
+2. Select Containers in the menu bar on the left ![](img/334116205-aa09ce40-0701-4f7d-b9f9-b431b9d207c5.png)
+3. Select your Homarr Container ![](img/334116303-714b5e07-b9de-4ec0-a2bc-def7ee38750f.png)
+4. Click "Execute" in the top right of the Window. ![](img/334116411-df1482f9-3aa9-4686-b77f-e0dca09e60b2.png)
+5. Select /bin/bash and click Execute ![](img/334116518-e1ddb515-99c7-4159-81bf-76e889d1e808.png)
+6. Run the Homarr command and press enter (eg. homarr reset-owner-password) ![](img/334116642-08c4f204-5cd0-4e4e-a785-0142e1b279ca.png)

versioned_docs/version-1.19.0/advanced/command-line/img/334116069-e7ec4726-3df7-4dc6-a3e0-b745e7eef17f.png

@@ -0,0 +1,19 @@
+# Password Recovery
+
+:::info
+
+This guide requires that you understand [how to access the CLI](../).
+
+:::
+
+Using this command, you can forcefully reset the password of a user.
+It will be set to a random value and the hash for the user will be updated.
+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.
+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)

versioned_docs/version-1.19.0/advanced/command-line/img/334116205-aa09ce40-0701-4f7d-b9f9-b431b9d207c5.png

@@ -0,0 +1,9 @@
+{
+    "label": "Developer guides",
+    "position": 6,
+    "collapsed": true,
+    "link": {
+      "type": "generated-index"
+    }
+  }
+  

versioned_docs/version-1.19.0/advanced/command-line/img/334116303-714b5e07-b9de-4ec0-a2bc-def7ee38750f.png

@@ -0,0 +1,68 @@
+---
+title: Getting started
+tags:
+  - Developer
+  - Technical documentation
+  - Code
+  - Programming
+sidebar_position: 1
+---
+
+## Setting up your development environment
+
+This guide will help you set up your development environment to start contributing to homarr.
+
+### 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`.
+- **Git**: You can download it from the [official website](https://git-scm.com/).
+- **Docker or Docker Desktop**: You can download it from the [official website](https://www.docker.com/).
+- **A GitHub account**: You can create one on the [official website](https://github.com/).
+
+### Setting up the project
+
+1. Fork the repository by clicking on the "Fork" button on the top right corner of the repository page.
+
+![Fork button](./img/fork.png)
+
+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.
+
+![Clone button](./img/clone.png)
+
+3. Change directory to the project folder with `cd homarr`.
+
+4. Install the dependencies with `pnpm install`.
+
+5. Start redis by running `pnpm run docker:dev`. This will run a docker-compose file with a redis service.
+
+6. 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='C:\\Dev\\homarr\\packages\\db\\db.sqlite'`
+
+7. Run the migrations to create the sqlite db file with `pnpm run db:migration:sqlite:run`.
+
+8. Start the development server with `pnpm dev` and wait for a message that says `✓ Ready in 10.7s`
+
+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)
+
+### Useful npm scripts
+
+#### During development
+
+- `pnpm dev`: Start the development server.
+- `pnpm cli`: Run cli commands.
+- `pnpm db:migration:sqlite:run`: Run the migrations to create or update the sqlite db file.
+- `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.
+
+#### Checking code quality
+
+- `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.
+
+#### Building the project
+- `pnpm build`: Build the project for production.
+- `docker build -t homarr .`: Build a docker image for the project.
+- `docker run -p 7575:7575 -e SECRET_ENCRYPTION_KEY='your_64_character_hex_string' homarr:latest`: Run the created docker image.

versioned_docs/version-1.19.0/advanced/command-line/img/334116411-df1482f9-3aa9-4686-b77f-e0dca09e60b2.png

@@ -0,0 +1,135 @@
+---
+title: Kubernetes
+tags:
+  - Developer
+  - Technical documentation
+  - Code
+  - Programming
+sidebar_position: 1
+---
+
+This guide provides step-by-step instructions for setting up a Kubernetes cluster using kind, configuring multiple nodes, and installing the Metrics Server.
+
+## Prerequisites
+
+Ensure you have the following installed:
+
+- [Docker](https://docs.docker.com/get-started/get-docker/) (required for running `kind` clusters).
+- [Kind](https://kind.sigs.k8s.io/docs/user/quick-start/) (Kubernetes in Docker).
+- [Kubectl](https://kubernetes.io/docs/tasks/tools/) (Kubernetes command-line tool).
+
+Additionally, ensure that Kubernetes tools are enabled in your environment by setting the following variable in your `.env` file:
+
+```bash
+# Enable Kubernetes tool
+ENABLE_KUBERNETES=true
+```
+
+### 1. Creating a Kubernetes Cluster with Multiple Nodes
+
+We will create a Kubernetes cluster using `kind` with one control plane node and two worker nodes.
+
+#### Define the Cluster Configuration
+
+Create a configuration file named `kind-config.yaml` with the following content:
+
+```bash
+cat > kind-config.yaml <<EOF
+# three node (two workers) cluster config
+kind: Cluster
+apiVersion: kind.x-k8s.io/v1alpha4
+nodes:
+- role: control-plane
+  kubeadmConfigPatches:
+    - |
+      kind: KubeletConfiguration
+      apiVersion: kubelet.config.k8s.io/v1beta1
+      kubeReserved:
+        cpu: "250m"
+        memory: "256Mi"
+      systemReserved:
+        cpu: "500m"
+        memory: "512Mi"
+      evictionHard:
+        memory.available: "200Mi"
+- role: worker
+- role: worker
+EOF
+```
+
+#### Create the Cluster
+
+Run the following command to create the Kubernetes cluster:
+
+```bash
+kind create cluster --name k8s-playground --config kind-config.yaml
+```
+
+This will provision a cluster named `k8s-playground` with the specified node configuration.
+
+### 2. Installing the Metrics Server
+
+The Metrics Server is required for gathering resource utilization metrics like CPU and memory usage. It is essential for features such as Horizontal Pod Autoscaling.
+
+#### Deploy the Metrics Server
+
+Run the following command to install the Metrics Server:
+
+```bash
+kubectl apply -f https://github.com/kubernetes-sigs/metrics-server/releases/download/v0.7.2/components.yaml
+```
+
+#### Disable TLS Verification (For Local Development)
+
+In local environments, Kubernetes nodes might not have valid certificates. To disable TLS verification, patch the deployment:
+
+```bash
+kubectl patch -n kube-system deployment metrics-server --type=json \
+  -p '[{"op":"add","path":"/spec/template/spec/containers/0/args/-","value":"--kubelet-insecure-tls"}]'
+```
+
+This allows the Metrics Server to communicate with kubelets that use self-signed certificates.
+
+### 3. Verifying the Setup
+
+After completing the setup, verify that the cluster is running correctly:
+
+#### Check the Cluster Nodes
+
+```bash
+kubectl get nodes
+```
+
+Expected output:
+
+```bash
+NAME                           STATUS   ROLES           AGE     VERSION
+k8s-playground-control-plane   Ready    control-plane   Xs      vX.Y.Z
+k8s-playground-worker          Ready    worker          Xs      vX.Y.Z
+k8s-playground-worker2         Ready    worker          Xs      vX.Y.Z
+```
+
+#### Check Metrics Server Status
+
+```bash
+kubectl get deployment -n kube-system metrics-server
+```
+
+Expected output:
+
+```bash
+NAME             READY   UP-TO-DATE   AVAILABLE   AGE
+metrics-server   1/1     1            1           Xs
+```
+
+#### Get Node Resource Metrics
+
+```bash
+kubectl top nodes
+```
+
+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.

versioned_docs/version-1.19.0/advanced/command-line/img/334116518-e1ddb515-99c7-4159-81bf-76e889d1e808.png

@@ -0,0 +1,79 @@
+---
+title: Environment variables
+tags:
+  - Configuration
+  - Docker
+  - Advanced
+  - Env
+  - Environment variables
+  - Variables
+  - Database
+---
+
+Homarr offers a Docker Container, which can be run on any compatible system, such as Unraid, Kubernetes and many more systems! Our Docker container is based on the ``22.12.0-alpine`` image and serves per standard on the port `7575`.
+
+---
+
+Homarr offers a few environment variables, which can be used to configure the container.
+
+## General
+
+:::warning
+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`` |
+
+
+## Authentication
+
+See [Single Sign-On](/docs/advanced/single-sign-on) for more informations.
+
+## Security
+
+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 | - |
+
+:::info
+A random secret can be generated by using the following command: `openssl rand -hex 32`
+:::
+
+## Docker
+
+| Environment Variable     | Description | Possible values | Default |
+| ------------------------ | ----------- | --------------- | ------- |
+| ``DOCKER_HOSTNAMES``          | Comma seperated list of hostnames to connect to | For example `localhost,docker.example.com` | - |
+| ``DOCKER_PORTS``             | Comma seperated list of ports to connect to | For example `2375,2376` | - |
+
+## Database
+| Environment Variable     | Description | Possible values | Default |
+| ------------------------ | ----------- | --------------- | ------- |
+| ``DB_DRIVER``            | Database driver to use. Currently `better-sqlite3` is used for sqlite and `mysql2` for mysql | ``better-sqlite3`` / ``mysql2`` | ``better-sqlite3`` |
+| ``DB_DIALECT``           | Database dialect to use. | ``sqlite`` / ``mysql`` | ``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.
+
+
+
+## Advanced deployments
+
+:::warning
+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 |