chore(release): automatic release v0.1.0

.github/workflows/deployment-docker-image.yml

@@ -4,6 +4,8 @@ on:
   push:
     branches:
       - main
+      - beta
+      - dev
   workflow_dispatch:
     inputs:
       send-notifications:
@@ -18,7 +20,7 @@ on:
         description: Push Docker Image
 
 permissions:
-  contents: write
+  contents: read
   packages: write
 
 env:
@@ -30,31 +32,84 @@ env:
 concurrency: production
 
 jobs:
+  release:
+    name: Create tag and release
+    runs-on: ubuntu-latest
+    env:
+      SKIP_RELEASE: ${{ github.event_name == 'workflow_dispatch' || github.ref_name == 'dev' }}
+    outputs:
+      version: ${{ steps.read-semver.outputs.version || steps.version-fallback.outputs.version }}
+
+    steps:
+      - run: echo "Skipping release for workflow_dispatch event"
+        if: env.SKIP_RELEASE == 'true'
+        # The below generated version fallback represents a normalized branch name, for example "feature/branch-name" -> "feature-branch-name"
+      - run: echo "version="$(echo ${{github.ref_name}} | sed 's/[^a-zA-Z0-9\-]/-/g') >> "$GITHUB_OUTPUT"
+        id: version-fallback
+        if: env.SKIP_RELEASE == 'true' && github.ref_name != 'main' && github.ref_name != 'beta'
+
+      - name: Obtain token
+        if: env.SKIP_RELEASE == 'false'
+        id: obtainToken
+        uses: tibdex/github-app-token@v2
+        with:
+          private_key: ${{ secrets.RENOVATE_MERGE_PRIVATE_KEY }}
+          app_id: ${{ secrets.RENOVATE_MERGE_APP_ID }}
+      - uses: actions/checkout@v4
+        if: env.SKIP_RELEASE == 'false'
+      - uses: actions/setup-node@v4
+        if: env.SKIP_RELEASE == 'false'
+        with:
+          node-version: 22
+      - run: npm i -g pnpm
+        if: env.SKIP_RELEASE == 'false'
+      - name: Install dependencies
+        if: env.SKIP_RELEASE == 'false'
+        run: |
+          pnpm install
+      - name: Run Semantic Release
+        if: env.SKIP_RELEASE == 'false'
+        env:
+          GITHUB_TOKEN: ${{ steps.obtainToken.outputs.token }}
+          GIT_AUTHOR_NAME: "Releases Homarr"
+          GIT_AUTHOR_EMAIL: "175486441+homarr-releases[bot]@users.noreply.github.com"
+          GIT_COMMITTER_NAME: "Releases Homarr"
+          GIT_COMMITTER_EMAIL: "175486441+homarr-releases[bot]@users.noreply.github.com"
+        run: |
+          pnpm release
+      - name: Read semver output
+        # We read the last tag either from the created release or from the current branch, this is to rerun the deployment job for the currently released version when it failed
+        if: env.SKIP_RELEASE == 'false' || github.ref_name == 'main' || github.ref_name == 'beta'
+        id: read-semver
+        run: |
+          git fetch --tags
+          echo "version=$(git describe --tags --abbrev=0)" >> "$GITHUB_OUTPUT"
+      - name: Update dev branch
+        if: env.SKIP_RELEASE == 'false'
+        continue-on-error: true # Prevent pipeline from failing when merge fails
+        run: |
+          git fetch origin dev
+          git checkout dev
+          git pull origin dev
+          git merge ${{ github.ref_name }}
+          git push origin dev
   deploy:
     name: Deploy docker image
+    needs: release
     runs-on: ubuntu-latest
+    env:
+      NEXT_VERSION: ${{ needs.release.outputs.version }}
+      DEPLOY_LATEST: ${{ github.ref_name == 'main' }}
+      PUSH_IMAGE: ${{ github.event_name != 'workflow_dispatch' || github.events.inputs.push-image == 'true' }}
     steps:
-      - name: Discord notification
-        if: ${{ github.events.inputs.send-notifications != false }}
-        env:
-          DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
-        uses: Ilshidur/action-discord@master
-        with:
-          args: "Deployment of an image has been triggered: [run ${{ github.run_number }}](<${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}>)"
       - uses: actions/checkout@v4
-      - name: Get Next Version
-        id: semver
-        uses: ietf-tools/semver-action@v1
-        with:
-          token: ${{ github.token }}
-          branch: dev
       - name: Discord notification
         if: ${{ github.events.inputs.send-notifications != false }}
         env:
           DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
         uses: Ilshidur/action-discord@master
         with:
-          args: "Semver computed next tag to be ${{ steps.semver.outputs.next }}. Current is ${{ steps.semver.outputs.current }}. Building images..."
+          args: "Deployment of an image for version '${{env.NEXT_VERSION}}' has been triggered: [run ${{ github.run_number }}](<${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}>)"
       - name: Log in to the Container registry
         uses: docker/login-action@v3
         with:
@@ -71,48 +126,23 @@ jobs:
         with:
           images: "${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}"
           tags: |
-            type=raw,value=alpha
-            type=raw,value=early-adopters
-      #          tags: |
-      #            type=raw,value=latest
-      #            type=raw,value=${{ steps.semver.outputs.next }}
-      - name: Build and push
+            ${{ env.DEPLOY_LATEST == true && 'type=raw,value=latest' || null }}
+            type=raw,value=${{ env.NEXT_VERSION }}
+      - name: Build and maybe push
         id: buildPushAction
         uses: docker/build-push-action@v6
-        if: ${{ github.events.inputs.push-image == 'true' || github.events.inputs.push-image == null }}
         with:
           platforms: linux/amd64,linux/arm64
           context: .
-          push: true
-          tags: ${{ steps.meta.outputs.tags }}
-          labels: ${{ steps.meta.outputs.labels }}
-          network: host
-        env:
-          SKIP_ENV_VALIDATION: true
-      - name: Build
-        id: buildPushDryAction
-        uses: docker/build-push-action@v6
-        if: ${{ github.events.inputs.push-image == 'false' }}
-        with:
-          platforms: linux/amd64,linux/arm64
-          context: .
-          push: false
+          push: ${{ env.PUSH_IMAGE}}
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
           network: host
         env:
           SKIP_ENV_VALIDATION: true
       - name: Discord notification
-        if: ${{ github.events.inputs.send-notifications != false && (github.events.inputs.push-image == 'true' || github.events.inputs.push-image == null) }}
         env:
           DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
         uses: Ilshidur/action-discord@master
         with:
-          args: "Deployment of image has completed. Image ID is '${{ steps.buildPushAction.outputs.imageid }}'."
-      - name: Discord notification
-        if: ${{ github.events.inputs.send-notifications != false && !(github.events.inputs.push-image == 'true' || github.events.inputs.push-image == null) }}
-        env:
-          DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
-        uses: Ilshidur/action-discord@master
-        with:
-          args: "Deployment of image has completed. Image ID is '${{ steps.buildPushDryAction.outputs.imageid }}'. This was a dry run."
+          args: "Deployment of image has completed. Image ID is '${{ steps.buildPushAction.outputs.imageid }}'. ${{ env.PUSH_IMAGE == true && '' || 'This was a dry run' }}"

.github/workflows/deployment-weekly-release.yml

@@ -37,7 +37,7 @@ jobs:
           token: ${{ github.token }}
           branch: dev
       - name: Create pull request
-        run: "gh pr create --title \"chore(release): automatic release ${{ steps.semver.outputs.next }}\" --body \"**This is an automatic release**.<br/>Manual action may be required for major bumps.<br/>Detected change to be ``${{ steps.semver.outputs.bump }}``<br/>Bump version from ``${{ steps.semver.outputs.current }}`` to ``${{ steps.semver.outputs.next }}``\" --base main --head dev --label automerge"
+        run: 'gh pr create --title "chore(release): automatic release ${{ steps.semver.outputs.next }}" --body "**This is an automatic release**.<br/>Manual action may be required for major bumps.<br/>Detected change to be ``${{ steps.semver.outputs.bump }}``<br/>Bump version from ``${{ steps.semver.outputs.current }}`` to ``${{ steps.semver.outputs.next }}``" --base beta --head dev --label automerge'
         env:
           GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
       - name: Discord notification

.releaserc.json

@@ -0,0 +1,51 @@
+{
+  "branches": [
+    "main",
+    {
+      "name": "beta",
+      "prerelease": true,
+      "channel": "beta"
+    }
+  ],
+  "plugins": [
+    [
+      "@semantic-release/commit-analyzer",
+      {
+        "preset": "conventionalcommits"
+      }
+    ],
+    [
+      "@semantic-release/release-notes-generator",
+      {
+        "preset": "conventionalcommits"
+      }
+    ],
+    [
+      "@semantic-release/changelog",
+      {
+        "changelogFile": "CHANGELOG.md"
+      }
+    ],
+    [
+      "@semantic-release/npm",
+      {
+        "npmPublish": false
+      }
+    ],
+    [
+      "@semantic-release/git",
+      {
+        "assets": ["package.json", "CHANGELOG.md"],
+        "message": "chore(release): ${nextRelease.version} [skip ci]"
+      }
+    ],
+    [
+      "@semantic-release/github",
+      {
+        "successComment": false,
+        "failComment": false,
+        "releaseBodyTemplate": "<%= _.truncate(nextRelease.notes, { 'length': 124000, 'omission': '' }) %>"
+      }
+    ]
+  ]
+}

Dockerfile

@@ -67,7 +67,7 @@ COPY --from=builder --chown=nextjs:nodejs /app/apps/nextjs/.next/standalone ./
 COPY --from=builder --chown=nextjs:nodejs /app/apps/nextjs/.next/static ./apps/nextjs/.next/static
 COPY --from=builder --chown=nextjs:nodejs /app/apps/nextjs/public ./apps/nextjs/public
 COPY --chown=nextjs:nodejs scripts/run.sh ./run.sh
-COPY --chown=nextjs:nodejs scripts/generateEncryptionKey.js ./generateEncryptionKey.js
+COPY --chown=nextjs:nodejs scripts/generateRandomSecureKey.js ./generateRandomSecureKey.js
 COPY --chown=nextjs:nodejs packages/redis/redis.conf /app/redis.conf
 COPY --chown=nextjs:nodejs nginx.conf /etc/nginx/templates/nginx.conf
 

LICENSE

@@ -1,21 +1,201 @@
-MIT License
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
 
-Copyright (c) 2023 Julius Marminge
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+   1. Definitions.
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright (c) 2024 Meier Lukas, Thomas Camlong and Homarr Labs
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

README.md

@@ -1,7 +0,0 @@
-# THIS PROJECT IS STILL UNSTABLE AND WE DO NOT PROVIDE ANY SUPPORT FOR ISSUES THAT OCCURE.
-
-## PLEASE DO NOT OPEN ANY ISSUES OR DISCUSSIONS
-
-### EVERYTHING IS SUBJECT TO CHANGE
-
-Please use [this](https://github.com/ajnart/homarr) version of Homarr when you want to use it

apps/nextjs/package.json

@@ -47,9 +47,9 @@
     "@million/lint": "1.0.14",
     "@t3-oss/env-nextjs": "^0.11.1",
     "@tabler/icons-react": "^3.26.0",
-    "@tanstack/react-query": "^5.62.7",
-    "@tanstack/react-query-devtools": "^5.62.7",
-    "@tanstack/react-query-next-experimental": "5.62.7",
+    "@tanstack/react-query": "^5.62.8",
+    "@tanstack/react-query-devtools": "^5.62.8",
+    "@tanstack/react-query-next-experimental": "5.62.8",
     "@trpc/client": "next",
     "@trpc/next": "next",
     "@trpc/react-query": "next",
@@ -81,7 +81,7 @@
     "@homarr/eslint-config": "workspace:^0.2.0",
     "@homarr/prettier-config": "workspace:^0.1.0",
     "@homarr/tsconfig": "workspace:^0.1.0",
-    "@types/chroma-js": "2.4.4",
+    "@types/chroma-js": "2.4.5",
     "@types/node": "^22.10.2",
     "@types/prismjs": "^1.26.5",
     "@types/react": "^19.0.1",

development/docker-run.cmd

@@ -1 +1 @@
-docker run -p 7575:7575 -e AUTH_SECRET='secrets' homarr:latest
+docker run -p 7575:7575 homarr:latest

docs/README.md

@@ -0,0 +1,130 @@
+<!-- Project Title -->
+![Banner](./banner.png)
+
+<!-- Badges -->
+<p align="center">
+<img src="https://img.shields.io/github/stars/homarr-labs/homarr?label=%E2%AD%90%20Stars&style=flat-square?branch=master&kill_cache=1%22">
+<a href="https://github.com/homarr-labs/homarr/releases/latest">
+  <img alt="Latest Release (Semver)" src="https://img.shields.io/github/v/release/homarr-labs/homarr?label=%F0%9F%9A%80%20Release">
+</a>
+<a href="https://github.com/homarr-labs/homarr/actions/workflows/deployment-docker-image.yml">
+  <img title="Docker CI Status" src="https://github.com/homarr-labs/homarr/actions/workflows/deployment-docker-image.yml/badge.svg" alt="CI Status">
+</a>
+<a href=https://translate.homarr.dev/>
+<img title="Translations" src="https://badges.crowdin.net/homarr/localized.svg" />
+</a>
+<a href="https://discord.gg/aCsmEV5RgA">
+  <img title="Discord" src="https://discordapp.com/api/guilds/972958686051962910/widget.png?style=shield">
+</a>
+</p>
+
+<!-- Links -->
+<p align="center">
+  <a href="https://demo.homarr.dev/">
+    <strong>Demo ✨</strong>
+  </a>
+  •
+  <a href="https://homarr.dev/docs/getting-started/installation/">
+    <strong>Install 💻</strong>
+  </a> •
+  <a href="https://translate.homarr.dev/">
+    <strong>Translations 🈺</strong>
+  </a> •
+  <a href="https://discord.com/invite/aCsmEV5RgA">
+    <strong>Discord 👋</strong>
+  </a>
+</p>
+
+> [!WARNING]
+> This is a beta version of Homarr. You can download the old but stable version at https://github.com/ajnart/homarr/. Running this version is at your own risk.
+
+Simplify the management of your server with Homarr - a sleek, modern dashboard that puts all of your apps and services at your fingertips. With Homarr, you can access and control everything in one location. Homarr seamlessly integrates with the apps you've added, providing you with valuable information and giving you complete control. Installation is a breeze, and Homarr supports a wide range of deployment methods.
+
+<br/>
+<br/>
+
+![Features Section](./section-features.png)
+
+- 🖌️ Highly customizable with an extensive drag and drop grid system
+- ✨ Integrates seamlessly with your favorite self-hosted applications
+- 📌 Easy and fast app management - no YAML involved
+- 👤 Detailed and easy to use user management with permissions and groups
+- 👥 Support for single sign on via OIDC / LDAP
+- 🙊 Safe encryption using BCrypt and AES-256-CBC for your valuable data
+- 🕔 Realtime widget updates using WebSockets, tRPC and Redis
+- 🔍 Search through thousands of data points in supported integrations or your data in Homarr using the fast built-in search
+- 🦞 Icon picker with over 11K icons
+- 🚀 Compatible with any major consumer hardware (x86, Raspberry Pi, old laptops, ...) and most OS (Windows, Linux, TrueNAS, Unraid)
+- 🖥️ Extensive Kubernetes support with Helm for efficient scaling & high reliability
+
+<br/>
+<br/>
+
+![Widgets & Integrations Section](./section-widgets-and-integrations.png)
+
+Homarr has a [built-in collection of widgets and integrations](https://homarr.dev/docs/category/integrations), that connect to your applications and enable you to control them directly from the dashboard.
+
+- 📥 **Torrent clients**
+    - [Deluge](https://homarr.dev/docs/integrations/torrent#deluge)
+    - [Transmission](https://homarr.dev/docs/integrations/torrent#transmission)
+    - [qBittorent](https://homarr.dev/docs/integrations/torrent#qbittorrent-integration)
+- 📥 **Usenet clients**
+    - [SABnzbd](https://homarr.dev/docs/integrations/usenet#sabnzbd)
+    - [NZBGet](https://homarr.dev/docs/integrations/usenet#nzbget)
+- 📺 **Media servers**
+    - [Plex](https://homarr.dev/docs/integrations/media-server/#plex)
+    - [Jellyfin](https://homarr.dev/docs/integrations/media-server#jellyfin-and-emby)
+- 📚 **Media collection managers**
+    - [Sonarr](https://homarr.dev/docs/integrations/servarr#sonarr)
+    - [Radarr](https://homarr.dev/docs/integrations/servarr#radarr)
+    - [Lidarr](https://homarr.dev/docs/integrations/servarr#lidarr)
+    - [Readarr](https://homarr.dev/docs/integrations/servarr#readarr)
+- 🎞️ **Media request managers**
+    - [Overseerr](https://homarr.dev/docs/integrations/media-requester)
+    - [Jellyseerr](https://homarr.dev/docs/integrations/media-requester)
+- 🚫 **DNS ad-blockers**
+    - [Pihole](https://homarr.dev/docs/integrations/dns#pihole)
+    - [AdGuard Home](https://homarr.dev/docs/integrations/dns#adguard-home)
+- 🖥️ **Monitoring**
+    - [Dash.](https://homarr.dev/docs/integrations/hardware)
+    - [OpenMediaVault.](https://homarr.dev/docs/integrations/hardware/#openmediavault)
+    - [Proxmox.](https://homarr.dev/docs/integrations/hardware/#proxmox)
+- 🐳 **Container management**:
+    - [Docker](https://homarr.dev/docs/integrations/containers)
+
+<br/>
+<br/>
+
+![Installation Section](./section-installation.png)
+
+Since we are updating Homarr very frequently, we recommend reading our official installation guides:
+
+<h2>
+<a href="https://homarr.dev/docs/getting-started/installation/">
+  Please click here for official installation instructions
+</a>
+</h2>
+
+<br/>
+<br/>
+
+![Contribute Section](./section-contribute.png)
+
+<br/>
+
+Homarr is a free to use open source project that is maintained by volunteers and developers from all over the world. We publish under the ``Apache License 2.0`` license which allows commercial usage. We invest multiple hours daily in to providing support, developing Homarr, integrating to third party software and more. We also pay for licensing and server hosting fees.
+Please consider to help us cover these costs to enable the future development of Homarr. Thank you!
+
+<h2>
+<a href="https://opencollective.com/homarr">
+  Please click here to sponsor us at OpenCollective
+</a>
+</h2>
+
+You can also support us by helping with [translating the entire project](https://homarr.dev/docs/community/translations) to as many languages as possible or contributing directly to the code or documentation. Please read our [Contribution Guidelines](/CONTRIBUTING.md). All contributions, regardless of their size or scope, are welcome and highly appreciated! Thank you ❤️
+
+## Sponsors
+Thanks to your generous sponsors we can continue to build Homarr. Check them out for high quality and easy to use development tools.
+Feel free to contact us at homarr-labs@proton.me if you wish to become a sponsor.
+
+[![Covered by Argos Visual Testing](https://argos-ci.com/badge-large.svg)](https://argos-ci.com?utm_source=%5Bhomarr%5D&utm_campaign=oss)

e2e/shared/create-homarr-container.ts

@@ -6,9 +6,6 @@ export const createHomarrContainer = () => {
   }
 
   return new GenericContainer("homarr-e2e")
-    .withEnvironment({
-      AUTH_SECRET: "secret",
-    })
     .withExposedPorts(7575)
     .withWaitStrategy(Wait.forHttp("/api/health/ready", 7575));
 };

package.json

@@ -1,7 +1,7 @@
 {
   "name": "homarr",
-  "private": true,
   "version": "1.0.0",
+  "private": true,
   "scripts": {
     "build": "cross-env CI=true turbo build",
     "clean": "git clean -xdf node_modules",
@@ -21,6 +21,7 @@
     "lint:fix": "turbo lint --continue -- --fix --cache --cache-location node_modules/.cache/.eslintcache",
     "lint:ws": "pnpm dlx sherif@latest",
     "package:new": "turbo gen init",
+    "release": "semantic-release",
     "test": "cross-env NODE_ENV=development vitest run --exclude e2e --coverage.enabled ",
     "test:e2e": "cross-env NODE_ENV=development vitest e2e",
     "test:ui": "cross-env NODE_ENV=development vitest --exclude e2e --ui --coverage.enabled",
@@ -30,13 +31,21 @@
   "prettier": "@homarr/prettier-config",
   "devDependencies": {
     "@homarr/prettier-config": "workspace:^0.1.0",
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/commit-analyzer": "^13.0.0",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/github": "^11.0.1",
+    "@semantic-release/npm": "^12.0.1",
+    "@semantic-release/release-notes-generator": "^14.0.1",
     "@turbo/gen": "^2.3.3",
     "@vitejs/plugin-react": "^4.3.4",
     "@vitest/coverage-v8": "^2.1.8",
     "@vitest/ui": "^2.1.8",
+    "conventional-changelog-conventionalcommits": "^8.0.0",
     "cross-env": "^7.0.3",
     "jsdom": "^25.0.1",
     "prettier": "^3.4.2",
+    "semantic-release": "^24.2.0",
     "testcontainers": "^10.16.0",
     "turbo": "^2.3.3",
     "typescript": "^5.7.2",
@@ -48,9 +57,9 @@
     "node": ">=22.12.0"
   },
   "pnpm": {
+    "allowNonAppliedPatches": true,
     "patchedDependencies": {
       "pretty-print-error": "patches/pretty-print-error.patch"
-    },
-    "allowNonAppliedPatches": true
+    }
   }
 }

packages/auth/configuration.ts

@@ -89,7 +89,6 @@ export const createConfiguration = (
       signIn: createSignInEventHandler(db),
     },
     redirectProxyUrl: createRedirectUri(headers, "/api/auth"),
-    secret: "secret-is-not-defined-yet", // TODO: This should be added later
     session: {
       strategy: "database",
       maxAge: env.AUTH_SESSION_EXPIRY_TIME,

scripts/generateRandomSecureKey.js

@@ -1,6 +1,6 @@
-// This script generates a random encryption key
-// This key is used to encrypt and decrypt the integration secrets
-// In production it is generated in run.sh and stored in the environment variable ENCRYPTION_KEY
+// This script generates a random secure key with a length of 64 characters
+// This key is used to encrypt and decrypt the integration secrets for auth.js
+// In production it is generated in run.sh and stored in the environment variables ENCRYPTION_KEY / AUTH_SECRET
 // during runtime, it's also stored in a file.
 
 const crypto = require("crypto");

scripts/run.sh

@@ -18,11 +18,24 @@ if [ -r /secrets/encryptionKey ]; then
     encryptionKey=$(cat /secrets/encryptionKey)
 else
     echo "Generating encryption key"
-    encryptionKey=$(node ./generateEncryptionKey.js)
+    encryptionKey=$(node ./generateRandomSecureKey.js)
     echo $encryptionKey > /secrets/encryptionKey
 fi
 export ENCRYPTION_KEY=$encryptionKey
 
+# Generates an auth secret if it doesn't exist and saves it to /secrets/authSecret
+# Also sets the AUTH_SECRET environment variable required for auth.js
+authSecret=""
+if [ -r /secrets/authSecret ]; then
+    echo "Auth secret already exists"
+    authSecret=$(cat /secrets/authSecret)
+else
+    echo "Generating auth secret"
+    authSecret=$(node ./generateRandomSecureKey.js)
+    echo $authSecret > /secrets/authSecret
+fi
+export AUTH_SECRET=$authSecret
+
 # Start nginx proxy
 # 1. Replace the HOSTNAME in the nginx template file
 # 2. Create the nginx configuration file from the template

tooling/semver/package.json

@@ -1,13 +0,0 @@
-{
-  "name": "@alparr/semver",
-  "private": true,
-  "version": "0.1.0",
-  "plugins": [
-    "@semantic-release/commit-analyzer",
-    "@semantic-release/release-notes-generator",
-    "@semantic-release/changelog",
-    "@semantic-release/github",
-    "@semantic-release/npm",
-    "@semantic-release/git"
-  ]
-}

tooling/semver/release.config.cjs

@@ -1,16 +0,0 @@
-/**
- * @type {import('semantic-release').GlobalConfig}
- */
-module.exports = {
-  branches: ["main"],
-  prepare: [
-    "@semantic-release/changelog",
-    "@semantic-release/npm",
-    {
-      path: "@semantic-release/git",
-      assets: ["package.json", "package-lock.json", "CHANGELOG.md"],
-      message:
-        "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}",
-    },
-  ],
-};