Update CNAME

* docs: update docker volume location in windows

in newer versions of docker, the location of Docker volumes has now changed. See: https://stackoverflow.com/a/64418064

* add paths for older versions of Docker

* add newlines

Co-authored-by: Gauthier <mail@gauthierth.fr>

---------

Co-authored-by: Gauthier <mail@gauthierth.fr>

.all-contributorsrc

@@ -277,6 +277,132 @@
       "contributions": [
         "doc"
       ]
+    },
+    {
+      "login": "mdll23",
+      "name": "Michael Dallinger",
+      "avatar_url": "https://avatars.githubusercontent.com/u/142844478?v=4",
+      "profile": "https://github.com/mdll23",
+      "contributions": [
+        "translation"
+      ]
+    },
+    {
+      "login": "xeruf",
+      "name": "Janek",
+      "avatar_url": "https://avatars.githubusercontent.com/u/13354331?v=4",
+      "profile": "https://github.com/xeruf",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "aleksasiriski",
+      "name": "Aleksa Siriški",
+      "avatar_url": "https://avatars.githubusercontent.com/u/31509435?v=4",
+      "profile": "https://aleksasiriski.dev",
+      "contributions": [
+        "infra"
+      ]
+    },
+    {
+      "login": "Danish-H",
+      "name": "Danish Humair",
+      "avatar_url": "https://avatars.githubusercontent.com/u/121830048?v=4",
+      "profile": "http://danishhumair.com",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "trackmastersteve",
+      "name": "Stephen Harris",
+      "avatar_url": "https://avatars.githubusercontent.com/u/16858514?v=4",
+      "profile": "https://arm0.red",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "joshuaboniface",
+      "name": "Joshua M. Boniface",
+      "avatar_url": "https://avatars.githubusercontent.com/u/4031396?v=4",
+      "profile": "https://www.boniface.me",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "gauthier-th",
+      "name": "Gauthier",
+      "avatar_url": "https://avatars.githubusercontent.com/u/37781713?v=4",
+      "profile": "https://gauthierth.fr/",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "Kara-Zor-El",
+      "name": "Kara",
+      "avatar_url": "https://avatars.githubusercontent.com/u/69772087?v=4",
+      "profile": "https://github.com/Kara-Zor-El",
+      "contributions": [
+        "infra"
+      ]
+    },
+    {
+      "login": "JoaquinOlivero",
+      "name": "Joaquin Olivero",
+      "avatar_url": "https://avatars.githubusercontent.com/u/66050823?v=4",
+      "profile": "https://joaquinolivero.com",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "Bretterteig",
+      "name": "Julian Behr",
+      "avatar_url": "https://avatars.githubusercontent.com/u/47298401?v=4",
+      "profile": "https://github.com/Bretterteig",
+      "contributions": [
+        "translation"
+      ]
+    },
+    {
+      "login": "ThowZzy",
+      "name": "ThowZzy",
+      "avatar_url": "https://avatars.githubusercontent.com/u/61882536?v=4",
+      "profile": "https://github.com/ThowZzy",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "j0srisk",
+      "name": "Joseph Risk",
+      "avatar_url": "https://avatars.githubusercontent.com/u/18372584?v=4",
+      "profile": "http://josephrisk.com",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "Loetwiek",
+      "name": "Loetwiek",
+      "avatar_url": "https://avatars.githubusercontent.com/u/79059734?v=4",
+      "profile": "https://github.com/Loetwiek",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "Fuochi",
+      "name": "Fuochi",
+      "avatar_url": "https://avatars.githubusercontent.com/u/4720478?v=4",
+      "profile": "https://github.com/Fuochi",
+      "contributions": [
+        "doc"
+      ]
     }
   ]
 }

.eslintrc.js

@@ -5,9 +5,7 @@ module.exports = {
     'eslint:recommended',
     'plugin:@typescript-eslint/recommended', // Uses the recommended rules from the @typescript-eslint/eslint-plugin
     'plugin:jsx-a11y/recommended',
-    'plugin:react/recommended',
-    'plugin:react-hooks/recommended',
-    'plugin:react/jsx-runtime',
+    'plugin:@next/next/recommended',
     'prettier',
   ],
   parserOptions: {

.github/FUNDING.yml

@@ -1 +1 @@
-github: [Fallenbagel]
+buy_me_a_coffee: fallen.bagel

.github/workflows/ci.yml

@@ -13,20 +13,35 @@ jobs:
     name: Lint & Test Build
     if: github.event_name == 'pull_request'
     runs-on: ubuntu-22.04
-    container: node:18.18-alpine
+    container: node:20-alpine
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
+      - name: Pnpm Setup
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9
+      - name: Get pnpm store directory
+        shell: sh
+        run: |
+          echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
+      - name: Setup pnpm cache
+        uses: actions/cache@v4
+        with:
+          path: ${{ env.STORE_PATH }}
+          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-pnpm-store-
       - name: Install dependencies
         env:
           HUSKY: 0
-        run: yarn
+        run: pnpm install
       - name: Lint
-        run: yarn lint
+        run: pnpm lint
       - name: Formatting
-        run: yarn format:check
+        run: pnpm format:check
       - name: Build
-        run: yarn build
+        run: pnpm build
 
   build_and_push:
     name: Build & Publish Docker Images
@@ -34,18 +49,18 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
+        uses: docker/setup-qemu-action@v3
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
+        uses: docker/setup-buildx-action@v3
       - name: Log in to Docker Hub
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         with:
           username: ${{ secrets.DOCKER_USERNAME }}
           password: ${{ secrets.DOCKER_TOKEN }}
       - name: Log in to GitHub Container Registry
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         with:
           registry: ghcr.io
           username: ${{ github.repository_owner }}
@@ -56,11 +71,11 @@ jobs:
         env:
           OWNER: ${{ github.repository_owner }}
       - name: Build and push
-        uses: docker/build-push-action@v3
+        uses: docker/build-push-action@v5
         with:
           context: .
           file: ./Dockerfile
-          platforms: linux/amd64,linux/arm64,linux/arm/v7
+          platforms: linux/amd64,linux/arm64
           push: true
           build-args: |
             COMMIT_TAG=${{ github.sha }}

.github/workflows/codeql.yml

@@ -24,7 +24,7 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Initialize CodeQL
         uses: github/codeql-action/init@v2

.github/workflows/conflict_labeler.yml

@@ -0,0 +1,26 @@
+name: Merge Conflict Labeler
+
+on:
+  push:
+    branches:
+      - develop
+  pull_request_target:
+    branches:
+      - develop
+    types: [synchronize]
+
+jobs:
+  label:
+    name: Labeling
+    runs-on: ubuntu-latest
+    if: ${{ github.repository == 'Fallenbagel/jellyseerr' }}
+    permissions:
+      contents: read
+      pull-requests: write
+    steps:
+      - name: Apply label
+        uses: eps1lon/actions-label-merge-conflict@v3
+        with:
+          dirtyLabel: 'merge conflict'
+          commentOnDirty: 'This pull request has merge conflicts. Please resolve the conflicts so the PR can be successfully reviewed and merged.'
+          repoToken: '${{ secrets.GITHUB_TOKEN }}'

.github/workflows/cypress.yml

@@ -13,12 +13,20 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
-      - name: Cypress run
-        uses: cypress-io/github-action@v4
+        uses: actions/checkout@v4
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
         with:
-          build: yarn cypress:build
-          start: yarn start
+          node-version: 20
+      - name: Pnpm Setup
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9
+      - name: Cypress run
+        uses: cypress-io/github-action@v6
+        with:
+          build: pnpm cypress:build
+          start: pnpm start
           wait-on: 'http://localhost:5055'
           record: true
         env:

.github/workflows/docs-deploy.yml

@@ -0,0 +1,82 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches:
+      - develop
+    paths:
+      - 'docs/**'
+      - 'gen-docs/**'
+
+jobs:
+  build:
+    name: Build Docusaurus
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - name: Pnpm Setup
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9
+
+      - name: Get pnpm store directory
+        shell: sh
+        run: |
+          echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
+
+      - name: Setup pnpm cache
+        uses: actions/cache@v4
+        with:
+          path: ${{ env.STORE_PATH }}
+          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-pnpm-store-
+
+      - name: Install dependencies
+        run: |
+          cd gen-docs
+          pnpm install --frozen-lockfile
+
+      - name: Build website
+        run: |
+          cd gen-docs
+          pnpm build
+
+      - name: Upload Build Artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: gen-docs/build
+
+  deploy:
+    name: Deploy to GitHub Pages
+    needs: build
+
+    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
+    permissions:
+      pages: write # to deploy to Pages
+      id-token: write # to verify the deployment originates from an appropriate source
+
+    # Deploy to the github-pages environment
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    runs-on: ubuntu-latest
+    steps:
+      # - name: Download Build Artifact
+      #   uses: actions/download-artifact@v4
+      #   with:
+      #     name: docusaurus-build
+      #     path: gen-docs/build
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/preview.yml

@@ -11,25 +11,25 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Get the version
         id: get_version
         run: echo "VERSION=${GITHUB_REF#refs/tags/}" >> $GITHUB_OUTPUT
       - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
+        uses: docker/setup-qemu-action@v3
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
+        uses: docker/setup-buildx-action@v3
       - name: Log in to Docker Hub
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         with:
           username: ${{ secrets.DOCKER_USERNAME }}
           password: ${{ secrets.DOCKER_TOKEN }}
       - name: Build and push
-        uses: docker/build-push-action@v3
+        uses: docker/build-push-action@v5
         with:
           context: .
           file: ./Dockerfile
-          platforms: linux/amd64
+          platforms: linux/amd64,linux/arm64
           push: true
           build-args: |
             COMMIT_TAG=${{ github.sha }}

.github/workflows/release.yml

@@ -10,24 +10,39 @@ jobs:
       HUSKY: 0
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - name: Set up Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version: 16
+          node-version: 20
       - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
+        uses: docker/setup-qemu-action@v3
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
+        uses: docker/setup-buildx-action@v3
       - name: Log in to Docker Hub
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         with:
           username: ${{ secrets.DOCKER_USERNAME }}
           password: ${{ secrets.DOCKER_TOKEN }}
+      - name: Pnpm Setup
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9
+      - name: Get pnpm store directory
+        shell: sh
+        run: |
+          echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
+      - name: Setup pnpm cache
+        uses: actions/cache@v4
+        with:
+          path: ${{ env.STORE_PATH }}
+          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-pnpm-store-
       - name: Install dependencies
-        run: yarn
+        run: pnpm install
       - name: Release
         env:
           GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
@@ -35,60 +50,59 @@ jobs:
           DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }}
         run: npx semantic-release
 
-  build-snap:
-    name: Build Snap Package (${{ matrix.architecture }})
-    needs: semantic-release
-    runs-on: ubuntu-22.04
-    strategy:
-      fail-fast: false
-      matrix:
-        architecture:
-          - amd64
-          - arm64
-          - armhf
-    steps:
-      - name: Checkout Code
-        uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-      - name: Switch to main branch
-        run: git checkout main
-      - name: Pull latest changes
-        run: git pull
-      - name: Prepare
-        id: prepare
-        run: |
-          git fetch --prune --tags
-          if [[ $GITHUB_REF == refs/tags/* || $GITHUB_REF == refs/heads/master ]]; then
-            echo "RELEASE=stable" >> $GITHUB_OUTPUT
-          else
-            echo "RELEASE=edge" >> $GITHUB_OUTPUT
-          fi
-      - name: Set Up QEMU
-        uses: docker/setup-qemu-action@v1
-        with:
-          image: tonistiigi/binfmt@sha256:df15403e06a03c2f461c1f7938b171fda34a5849eb63a70e2a2109ed5a778bde
-      - name: Build Snap Package
-        uses: diddlesnaps/snapcraft-multiarch-action@v1
-        id: build
-        with:
-          architecture: ${{ matrix.architecture }}
-      - name: Upload Snap Package
-        uses: actions/upload-artifact@v2
-        with:
-          name: jellyseerr-snap-package-${{ matrix.architecture }}
-          path: ${{ steps.build.outputs.snap }}
-      - name: Review Snap Package
-        uses: diddlesnaps/snapcraft-review-tools-action@v1
-        with:
-          snap: ${{ steps.build.outputs.snap }}
-      - name: Publish Snap Package
-        uses: snapcore/action-publish@v1
-        env:
-          SNAPCRAFT_STORE_CREDENTIALS: ${{ secrets.SNAP_LOGIN }}
-        with:
-          snap: ${{ steps.build.outputs.snap }}
-          release: ${{ steps.prepare.outputs.RELEASE }}
+  # build-snap:
+  #   name: Build Snap Package (${{ matrix.architecture }})
+  #   needs: semantic-release
+  #   runs-on: ubuntu-22.04
+  #   strategy:
+  #     fail-fast: false
+  #     matrix:
+  #       architecture:
+  #         - amd64
+  #         - arm64
+  #   steps:
+  #     - name: Checkout Code
+  #       uses: actions/checkout@v4
+  #       with:
+  #         fetch-depth: 0
+  #     - name: Switch to main branch
+  #       run: git checkout main
+  #     - name: Pull latest changes
+  #       run: git pull
+  #     - name: Prepare
+  #       id: prepare
+  #       run: |
+  #         git fetch --prune --tags
+  #         if [[ $GITHUB_REF == refs/tags/* || $GITHUB_REF == refs/heads/master ]]; then
+  #           echo "RELEASE=stable" >> $GITHUB_OUTPUT
+  #         else
+  #           echo "RELEASE=edge" >> $GITHUB_OUTPUT
+  #         fi
+  #     - name: Set Up QEMU
+  #       uses: docker/setup-qemu-action@v3
+  #       with:
+  #         image: tonistiigi/binfmt@sha256:df15403e06a03c2f461c1f7938b171fda34a5849eb63a70e2a2109ed5a778bde
+  #     - name: Build Snap Package
+  #       uses: diddlesnaps/snapcraft-multiarch-action@v1
+  #       id: build
+  #       with:
+  #         architecture: ${{ matrix.architecture }}
+  #     - name: Upload Snap Package
+  #       uses: actions/upload-artifact@v4
+  #       with:
+  #         name: jellyseerr-snap-package-${{ matrix.architecture }}
+  #         path: ${{ steps.build.outputs.snap }}
+  #     - name: Review Snap Package
+  #       uses: diddlesnaps/snapcraft-review-tools-action@v1
+  #       with:
+  #         snap: ${{ steps.build.outputs.snap }}
+  #     - name: Publish Snap Package
+  #       uses: snapcore/action-publish@v1
+  #       env:
+  #         SNAPCRAFT_STORE_CREDENTIALS: ${{ secrets.SNAP_LOGIN }}
+  #       with:
+  #         snap: ${{ steps.build.outputs.snap }}
+  #         release: ${{ steps.prepare.outputs.RELEASE }}
 
   discord:
     name: Send Discord Notification

.github/workflows/snap.yaml

@@ -1,9 +1,13 @@
 name: Publish Snap
 
-on:
-  push:
-    branches:
-      - develop
+# turn off edge snap builds temporarily and make it manual
+
+# on:
+#  push:
+#    branches:
+#      - develop
+
+on: workflow_dispatch
 
 jobs:
   jobs:
@@ -12,7 +16,7 @@ jobs:
     if: "!contains(github.event.head_commit.message, '[skip ci]')"
     steps:
       - name: Cancel Previous Runs
-        uses: styfle/cancel-workflow-action@0.10.0
+        uses: styfle/cancel-workflow-action@0.12.1
         with:
           access_token: ${{ secrets.GITHUB_TOKEN }}
 
@@ -26,10 +30,9 @@ jobs:
         architecture:
           - amd64
           - arm64
-          - armhf
     steps:
       - name: Checkout Code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Prepare
         id: prepare
         run: |
@@ -40,7 +43,7 @@ jobs:
             echo "RELEASE=edge" >> $GITHUB_OUTPUT
           fi
       - name: Set Up QEMU
-        uses: docker/setup-qemu-action@v2
+        uses: docker/setup-qemu-action@v3
       - name: Configure Git
         run: git config --add safe.directory /data/parts/jellyseerr/src
       - name: Build Snap Package
@@ -49,7 +52,7 @@ jobs:
         with:
           architecture: ${{ matrix.architecture }}
       - name: Upload Snap Package
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: jellyseerr-snap-package-${{ matrix.architecture }}
           path: ${{ steps.build.outputs.snap }}

.github/workflows/support.yml

@@ -6,9 +6,9 @@ on:
 
 jobs:
   support:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     steps:
-      - uses: dessant/support-requests@v2
+      - uses: dessant/support-requests@v4
         with:
           github-token: ${{ github.token }}
           support-label: 'support'

.github/workflows/test-docs-deploy.yml

@@ -0,0 +1,51 @@
+name: Test Docs deployment
+
+on:
+  pull_request:
+    branches:
+      - develop
+    path:
+      - 'docs/**'
+      - 'gen-docs/**'
+
+jobs:
+  test-deploy:
+    name: Test deployment
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - name: Pnpm Setup
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9
+
+      - name: Get pnpm store directory
+        shell: sh
+        run: |
+          echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
+
+      - name: Setup pnpm cache
+        uses: actions/cache@v4
+        with:
+          path: ${{ env.STORE_PATH }}
+          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-pnpm-store-
+
+      - name: Install dependencies
+        run: |
+          cd gen-docs 
+          pnpm install --frozen-lockfile
+
+      - name: Build website
+        run: |
+          cd gen-docs
+          pnpm build

.npmrc

@@ -0,0 +1 @@
+engine-strict=true

.prettierignore

@@ -3,6 +3,7 @@
 dist/
 config/
 CHANGELOG.md
+pnpm-lock.yaml
 
 # assets
 src/assets/

.prettierrc.js

@@ -2,4 +2,12 @@ module.exports = {
   plugins: [require('./merged-prettier-plugin.js')],
   singleQuote: true,
   trailingComma: 'es5',
+  overrides: [
+    {
+      files: 'gen-docs/pnpm-lock.yaml',
+      options: {
+        rangeEnd: 0, // default: Infinity
+      },
+    },
+  ],
 };

CNAME

@@ -0,0 +1 @@
+docs.jellyseerr.dev

CONTRIBUTING.md

@@ -1,4 +1,4 @@
-# Contributing to Overseerr
+# Contributing to Jellyseerr
 
 All help is welcome and greatly appreciated! If you would like to contribute to the project, the following instructions should get you started...
 
@@ -17,7 +17,7 @@ All help is welcome and greatly appreciated! If you would like to contribute to
 1. [Fork](https://help.github.com/articles/fork-a-repo/) the repository to your own GitHub account and [clone](https://help.github.com/articles/cloning-a-repository/) it to your local device:
 
    ```bash
-   git clone https://github.com/YOUR_USERNAME/overseerr.git
+   git clone https://github.com/YOUR_USERNAME/jellyseerr.git
    cd overseerr/
    ```
 
@@ -97,9 +97,9 @@ When adding new UI text, please try to adhere to the following guidelines:
 
 ## Translation
 
-We use [Weblate](https://hosted.weblate.org/engage/overseerr/) for our translations, and your help with localizing Overseerr would be greatly appreciated! If your language is not listed below, please [open a feature request](https://github.com/fallenbagel/jellyseerr/issues/new/choose).
+We use [Weblate](https://jellyseerr.borgcube.de/projects/jellyseerr/jellyseerr-frontend/) for our translations, and your help with localizing Overseerr would be greatly appreciated! If your language is not listed below, please [open a feature request](https://github.com/fallenbagel/jellyseerr/issues/new/choose).
 
-<a href="https://hosted.weblate.org/engage/overseerr/"><img src="https://hosted.weblate.org/widgets/overseerr/-/overseerr-frontend/multi-auto.svg" alt="Translation status" /></a>
+<a href="https://jellyseerr.borgcube.de/engage/jellysseerr/"><img src="https://jellyseerr.borgcube.de/widget/jellyseerr/multi-auto.svg" alt="Translation status" /></a>
 
 ## Attribution
 

Dockerfile

@@ -1,4 +1,4 @@
-FROM node:18.18-alpine AS BUILD_IMAGE
+FROM node:20-alpine AS BUILD_IMAGE
 
 WORKDIR /app
 
@@ -10,22 +10,24 @@ RUN \
   'linux/arm64' | 'linux/arm/v7') \
   apk update && \
   apk add --no-cache python3 make g++ gcc libc6-compat bash && \
-  yarn global add node-gyp \
+  npm install --global node-gyp \
   ;; \
   esac
 
-COPY package.json yarn.lock ./
-RUN CYPRESS_INSTALL_BINARY=0 yarn install --frozen-lockfile --network-timeout 1000000
+RUN npm install --global pnpm
+
+COPY package.json pnpm-lock.yaml postinstall-win.js ./
+RUN CYPRESS_INSTALL_BINARY=0 pnpm install --frozen-lockfile
 
 COPY . ./
 
 ARG COMMIT_TAG
 ENV COMMIT_TAG=${COMMIT_TAG}
 
-RUN yarn build
+RUN pnpm build
 
 # remove development dependencies
-RUN yarn install --production --ignore-scripts --prefer-offline
+RUN pnpm prune --prod --ignore-scripts
 
 RUN rm -rf src server .next/cache
 
@@ -34,7 +36,7 @@ RUN touch config/DOCKER
 RUN echo "{\"commitTag\": \"${COMMIT_TAG}\"}" > committag.json
 
 
-FROM node:18.18-alpine
+FROM node:20-alpine
 
 # Metadata for Github Package Registry
 LABEL org.opencontainers.image.source="https://github.com/Fallenbagel/jellyseerr"
@@ -43,10 +45,12 @@ WORKDIR /app
 
 RUN apk add --no-cache tzdata tini && rm -rf /tmp/*
 
+RUN npm install -g pnpm
+
 # copy from build image
 COPY --from=BUILD_IMAGE /app ./
 
 ENTRYPOINT [ "/sbin/tini", "--" ]
-CMD [ "yarn", "start" ]
+CMD [ "pnpm", "start" ]
 
 EXPOSE 5055

Dockerfile.local

@@ -1,8 +1,10 @@
-FROM node:18.18-alpine
+FROM node:20-alpine
 
 COPY . /app
 WORKDIR /app
 
-RUN yarn
+Run npm install --global pnpm
 
-CMD yarn dev
+RUN pnpm install
+
+CMD pnpm dev

README.md

@@ -2,23 +2,26 @@
 <img src="./public/logo_full.svg" alt="Jellyseerr" style="margin: 20px 0;">
 </p>
 <p align="center">
-<a href="https://discord.gg/ckbvBtDJgC"><img src="https://img.shields.io/badge/Discord-Chat-lightgrey" alt="Discord"></a>
+<img src="https://github.com/Fallenbagel/jellyseerr/actions/workflows/release.yml/badge.svg" alt="Jellyseerr Release" />
+<img src="https://github.com/Fallenbagel/jellyseerr/actions/workflows/ci.yml/badge.svg" alt="Jellyseerr CI">
+</p>
+<p align="center">
+<a href="https://discord.gg/ckbvBtDJgC"><img src="https://img.shields.io/discord/952656177924300932" alt="Discord"></a>
 <a href="https://hub.docker.com/r/fallenbagel/jellyseerr"><img src="https://img.shields.io/docker/pulls/fallenbagel/jellyseerr" alt="Docker pulls"></a>
+<a href="http://jellyseerr.borgcube.de/engage/jellyseerr/"><img src="http://jellyseerr.borgcube.de/widget/jellyseerr/jellyseerr-frontend/svg-badge.svg" alt="Translation status" /></a>
 <a href="https://github.com/fallenbagel/jellyseerr/blob/develop/LICENSE"><img alt="GitHub" src="https://img.shields.io/github/license/fallenbagel/jellyseerr"></a>
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-<a href="#contributors-"><img alt="All Contributors" src="https://img.shields.io/badge/all_contributors-29-orange.svg"/></a>
+<a href="#contributors-"><img alt="All Contributors" src="https://img.shields.io/badge/all_contributors-40-orange.svg"/></a>
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
-**Jellyseerr** is a free and open source software application for managing requests for your media library. It is a a fork of Overseerr built to bring support for Jellyfin & Emby media servers!
-
-_The original Overseerr team have been busy and Jellyfin/Emby support aren't on their roadmap, so we started this project as we wanted to bring the Overseerr experience to the Jellyfin/Emby Community!_
+**Jellyseerr** is a free and open source software application for managing requests for your media library.
+It is a fork of [Overseerr](https://github.com/sct/overseerr) built to bring support for [Jellyfin](https://github.com/jellyfin/jellyfin) & [Emby](https://github.com/MediaBrowser/Emby) media servers!
 
 ## Current Features
 
-- Full Jellyfin/Emby/Plex integration. Authenticate and manage user access with Jellyfin/Emby/Plex!
-- Supports Movies, Shows, Mixed Libraries!
+- Full Jellyfin/Emby/Plex integration including authentication with user import & management
+- Supports Movies, Shows and Mixed Libraries
 - Ability to change email addresses for smtp purposes
-- Ability to import all jellyfin/emby users
 - Easy integration with your existing services. Currently, Jellyseerr supports Sonarr and Radarr. More to come!
 - Jellyfin/Emby/Plex library scan, to keep track of the titles which are already available.
 - Customizable request system, which allows users to request individual seasons or movies in a friendly, easy-to-use interface.
@@ -33,114 +36,16 @@ With more features on the way! Check out our [issue tracker](https://github.com/
 
 ## Getting Started
 
-#### Pre-requisite (Important)
+Check out our documentation for instructions on how to install and run Jellyseerr:
+https://docs.jellyseerr.dev/getting-started/
 
-_*On Jellyfin/Emby, ensure the `settings > Home > Automatically group content from the following folders into views such as 'Movies', 'Music' and 'TV'` is turned off*_
-
-### Launching Jellyseerr using Docker (Recommended)
-
-Check out our dockerhub for instructions on how to install and run Jellyseerr:
-https://hub.docker.com/r/fallenbagel/jellyseerr
-
-### Building from source (ADVANCED):
-
-#### Windows
-
-Pre-requisites:
-
-- Nodejs [v18](https://nodejs.org/download/release/v18.18.2)
-- [Yarn](https://classic.yarnpkg.com/lang/en/docs/install) 
-- Download/git clone the source code from the github (Either develop branch or main for stable)
-
-```cmd
-npm i -g win-node-env
-set CYPRESS_INSTALL_BINARY=0
-yarn install --frozen-lockfile --network-timeout 1000000
-yarn run build
-yarn start
-```
-(you can use task scheduler to run a bat script with `@echo off` and `yarn start` to run jellyseerr in the background)
-
-_to set env variables such as `JELLYFIN_TYPE=emby` create a file called `.env` in the root directory of jellyseerr_
-
-#### Linux
-
-**Pre-requisites:**
-
-- Nodejs [v18](https://nodejs.org/en/download/package-manager)
-- [Yarn](https://classic.yarnpkg.com/lang/en/docs/install) (on debian based distros, the package manager provided `yarn` is different and is a package called cmdlet. You can remove that using `apt-remove cmdlet` then install yarn using `npm install -g yarn`)
-- Git
-
-**Steps:**
-
-1. Assuming you want the root folder for the jellyseerr source code to be cloned to `/opt`
-
-```bash
-cd /opt
-```
-
-2. Then clone the follow commands to clone and checkout to the stable version
-
-```bash
-git clone https://github.com/Fallenbagel/jellyseerr.git && cd jellyseerr
-git checkout main
-```
-
-3. Then install the dependencies and build the dist
-
-```bash
-CYPRESS_INSTALL_BINARY=0 yarn install --frozen-lockfile --network-timeout 1000000
-yarn run build
-```
-
-4. Now you can start jellyseerr using `yarn start` and opening http://localhost:5055 in your browser.
-
-5. If you want to run jellyseerr as a _Systemd-service:_
-
-- assuming jellyseerr was cloned to `/opt/`
-- first create the environmentfile at `/etc/jellyseerr/jellyseerr.conf`
-
-Environmentfile:
-
-```
-# Jellyseerr's default port is 5055, if you want to use both, change this.
-# specify on which port to listen
-PORT=5055
-
-# specify on which interface to listen, by default jellyseerr listens on all interfaces
-#HOST=127.0.0.1
-
-# Uncomment if your media server is emby instead of jellyfin.
-# JELLYFIN_TYPE=emby
-```
-
-- Then run the command `which node` to find your node path (assuming it's at `/usr/bin/node`)
-- Then create the service file using `sudo systemctl edit jellyseerr.service` or creating and editing a file at `/etc/systemd/system/jellyseerr.service`
-
-Service file contents:
-
-```
-[Unit]
-Description=Jellyseerr Service
-Wants=network-online.target
-After=network-online.target
-
-[Service]
-EnvironmentFile=/etc/jellyseerr/jellyseerr.conf
-Environment=NODE_ENV=production
-Type=exec
-Restart=on-failure
-WorkingDirectory=/opt/jellyseerr
-ExecStart=/usr/bin/node dist/index.js
-
-[Install]
-WantedBy=multi-user.target
-```
 ### Packages:
 
 Archlinux: [AUR](https://aur.archlinux.org/packages/jellyseerr)
-Nixpkg: [Nixpkg](https://search.nixos.org/packages?channel=unstable&show=jellyseerr)
-Snap: [Snap](https://snapcraft.io/jellyseerr)
+
+Nix: [Nixpkg](https://search.nixos.org/packages?channel=unstable&show=jellyseerr)
+
+~Snap: [Snap](https://snapcraft.io/jellyseerr)~(Deprecated)
 
 ## Preview
 
@@ -148,6 +53,7 @@ Snap: [Snap](https://snapcraft.io/jellyseerr)
 
 ## Support
 
+- Check out the [Jellyseerr Documentation](https://docs.jellyseerr.dev) before asking for help. Your question might already be in the docs!
 - You can get support on [Discord](https://discord.gg/ckbvBtDJgC).
 - You can ask questions in the Help category of our [GitHub Discussions](https://github.com/fallenbagel/jellyseerr/discussions).
 - Bug reports and feature requests can be submitted via [GitHub Issues](https://github.com/fallenbagel/jellyseerr/issues).
@@ -217,6 +123,19 @@ Thanks goes to these wonderful people from Overseerr ([emoji key](https://allcon
     </tr>
     <tr>
       <td align="center" valign="top" width="14.28%"><a href="https://athfan.com"><img src="https://avatars.githubusercontent.com/u/13810742?v=4?s=100" width="100px;" alt="Athfan Khaleel"/><br /><sub><b>Athfan Khaleel</b></sub></a><br /><a href="https://github.com/Fallenbagel/jellyseerr/commits?author=athphane" title="Documentation">📖</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/mdll23"><img src="https://avatars.githubusercontent.com/u/142844478?v=4?s=100" width="100px;" alt="Michael Dallinger"/><br /><sub><b>Michael Dallinger</b></sub></a><br /><a href="#translation-mdll23" title="Translation">🌍</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/xeruf"><img src="https://avatars.githubusercontent.com/u/13354331?v=4?s=100" width="100px;" alt="Janek"/><br /><sub><b>Janek</b></sub></a><br /><a href="https://github.com/Fallenbagel/jellyseerr/commits?author=xeruf" title="Documentation">📖</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://aleksasiriski.dev"><img src="https://avatars.githubusercontent.com/u/31509435?v=4?s=100" width="100px;" alt="Aleksa Siriški"/><br /><sub><b>Aleksa Siriški</b></sub></a><br /><a href="#infra-aleksasiriski" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="http://danishhumair.com"><img src="https://avatars.githubusercontent.com/u/121830048?v=4?s=100" width="100px;" alt="Danish Humair"/><br /><sub><b>Danish Humair</b></sub></a><br /><a href="https://github.com/Fallenbagel/jellyseerr/commits?author=Danish-H" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://arm0.red"><img src="https://avatars.githubusercontent.com/u/16858514?v=4?s=100" width="100px;" alt="Stephen Harris"/><br /><sub><b>Stephen Harris</b></sub></a><br /><a href="https://github.com/Fallenbagel/jellyseerr/commits?author=trackmastersteve" title="Documentation">📖</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://www.boniface.me"><img src="https://avatars.githubusercontent.com/u/4031396?v=4?s=100" width="100px;" alt="Joshua M. Boniface"/><br /><sub><b>Joshua M. Boniface</b></sub></a><br /><a href="https://github.com/Fallenbagel/jellyseerr/commits?author=joshuaboniface" title="Code">💻</a></td>
+    </tr>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://gauthierth.fr/"><img src="https://avatars.githubusercontent.com/u/37781713?v=4?s=100" width="100px;" alt="Gauthier"/><br /><sub><b>Gauthier</b></sub></a><br /><a href="https://github.com/Fallenbagel/jellyseerr/commits?author=gauthier-th" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Kara-Zor-El"><img src="https://avatars.githubusercontent.com/u/69772087?v=4?s=100" width="100px;" alt="Kara"/><br /><sub><b>Kara</b></sub></a><br /><a href="#infra-Kara-Zor-El" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://joaquinolivero.com"><img src="https://avatars.githubusercontent.com/u/66050823?v=4?s=100" width="100px;" alt="Joaquin Olivero"/><br /><sub><b>Joaquin Olivero</b></sub></a><br /><a href="https://github.com/Fallenbagel/jellyseerr/commits?author=JoaquinOlivero" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Bretterteig"><img src="https://avatars.githubusercontent.com/u/47298401?v=4?s=100" width="100px;" alt="Julian Behr"/><br /><sub><b>Julian Behr</b></sub></a><br /><a href="#translation-Bretterteig" title="Translation">🌍</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/ThowZzy"><img src="https://avatars.githubusercontent.com/u/61882536?v=4?s=100" width="100px;" alt="ThowZzy"/><br /><sub><b>ThowZzy</b></sub></a><br /><a href="https://github.com/Fallenbagel/jellyseerr/commits?author=ThowZzy" title="Code">💻</a></td>
     </tr>
   </tbody>
 </table>
@@ -358,6 +277,9 @@ Thanks goes to these wonderful people from Overseerr ([emoji key](https://allcon
     </tr>
     <tr>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/RemiRigal"><img src="https://avatars.githubusercontent.com/u/19256051?v=4?s=100" width="100px;" alt="RemiRigal"/><br /><sub><b>RemiRigal</b></sub></a><br /><a href="https://github.com/sct/overseerr/commits?author=RemiRigal" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="http://josephrisk.com"><img src="https://avatars.githubusercontent.com/u/18372584?v=4?s=100" width="100px;" alt="Joseph Risk"/><br /><sub><b>Joseph Risk</b></sub></a><br /><a href="https://github.com/sct/overseerr/commits?author=j0srisk" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Loetwiek"><img src="https://avatars.githubusercontent.com/u/79059734?v=4?s=100" width="100px;" alt="Loetwiek"/><br /><sub><b>Loetwiek</b></sub></a><br /><a href="https://github.com/sct/overseerr/commits?author=Loetwiek" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Fuochi"><img src="https://avatars.githubusercontent.com/u/4720478?v=4?s=100" width="100px;" alt="Fuochi"/><br /><sub><b>Fuochi</b></sub></a><br /><a href="https://github.com/sct/overseerr/commits?author=Fuochi" title="Documentation">📖</a></td>
     </tr>
   </tbody>
 </table>

babel.config.js

@@ -1,25 +0,0 @@
-module.exports = function (api) {
-  api.cache(true);
-
-  return {
-    presets: [
-      [
-        'next/babel',
-        {
-          'preset-env': {
-            useBuiltIns: 'entry',
-            corejs: '3',
-          },
-        },
-      ],
-    ],
-    plugins: [
-      [
-        'react-intl-auto',
-        {
-          removePrefix: 'src/',
-        },
-      ],
-    ],
-  };
-};

cypress/config/settings.cypress.json

@@ -19,6 +19,7 @@
     "region": "",
     "originalLanguage": "",
     "trustProxy": false,
+    "mediaServerType": 1,
     "partialRequestsEnabled": true,
     "locale": "en"
   },
@@ -37,6 +38,17 @@
     ],
     "machineId": "test"
   },
+  "jellyfin": {
+    "name": "",
+    "ip": "",
+    "port": 8096,
+    "useSsl": false,
+    "urlBase": "",
+    "externalHostname": "",
+    "jellyfinForgotPasswordUrl": "",
+    "libraries": [],
+    "serverId": ""
+  },
   "tautulli": {},
   "radarr": [],
   "sonarr": [],
@@ -139,11 +151,26 @@
     "sonarr-scan": {
       "schedule": "0 30 4 * * *"
     },
+    "plex-watchlist-sync": {
+      "schedule": "0 */10 * * * *"
+    },
+    "availability-sync": {
+      "schedule": "0 0 5 * * *"
+    },
     "download-sync": {
       "schedule": "0 * * * * *"
     },
     "download-sync-reset": {
       "schedule": "0 0 1 * * *"
+    },
+    "jellyfin-recently-added-scan": {
+      "schedule": "0 */5 * * * *"
+    },
+    "jellyfin-full-scan": {
+      "schedule": "0 0 3 * * *"
+    },
+    "image-cache-cleanup": {
+      "schedule": "0 0 5 * * *"
     }
   }
 }

cypress/support/e2e.ts

@@ -2,6 +2,6 @@ import './commands';
 
 before(() => {
   if (Cypress.env('SEED_DATABASE')) {
-    cy.exec('yarn cypress:prepare');
+    cy.exec('pnpm cypress:prepare');
   }
 });

docs/CNAME

@@ -0,0 +1 @@
+docs.seerr.dev

docs/README.md

@@ -1,24 +1,37 @@
+---
+slug: /
+sidebar_position: 1
+---
+
 # Introduction
 
-Welcome to the Overseerr Documentation.
+Welcome to the Jellyseerr Documentation.
 
 ## Features
 
-- **Full Plex integration**. Login and manage user access with Plex.
-- **Syncs to your Plex library** to show what titles you already have.
+- **Full Jellyfin/Emby/Plex integration**. Login and manage user access with Jellyfin/Emby/Plex.
+- **Syncs to your Jellyfin/Emby/Plex library** to show what titles you already have.
 - **Integrates with Sonarr and Radarr**. With more services to come in the future.
 - **Easy to use request system** allowing users to request individual seasons or movies in a friendly, clean UI.
 - **Simple request management UI**. Don't dig through the app to approve recent requests.
 - **Mobile-friendly design**, for when you need to approve requests on the go.
 - Granular permission system.
 - Localization into other languages.
+- More features to come!
 
 ## Motivation
 
-The primary motivation for starting this project was to have an incredibly performant and easy to use application. There is a heavy focus on the user experience for both the server owner and the users. We feel requesting should be **effortless for the user**. Find the media you want, click request, and branch off efficiently into other titles that interest you, all in one seamless flow. For the server owner, Overseerr takes all the hassle out of approving your users' requests.
+The primary motivation for starting this project was to add support for Jellyfin and Emby to Overseerr. As Overseerr is an incredibly performant and easy-to-use application, we wanted to bring that same experience to Jellyfin and Emby users. Thus, **Jellyseerr** was born.
+
+This application is designed to be a **one-stop-shop** for all your media requests. It is designed to be a **simple, easy-to-use** application that allows users to request media to be added to your Jellyfin/Emby/Plex server.
 
 ## We need your help!
 
-Overseerr is an ambitious project. We have already poured a lot of work into this, and have a lot more to do. We need your valuable feedback and help to find and fix bugs. Also, with Overseerr being an open-source project, anyone is welcome to contribute. Contribution includes building new features, patching bugs, translating the application, or even just writing documentation.
+[Jellyseerr](https://github.com/Fallenbagel/jellyseerr) is a fork of Overseerr, with a heavy focus on Jellyfin and Emby integration.
+[Overseerr](https://github.com/sct/overseerr) is an ambitious project where the original developers/contributors have already poured a lot of work into, and we wanted to build on top of that.
+
+We also have poured a lot of work into this project, and we have a lot more to do as well. We need your valuable feedback and help to find and fix bugs. Also, with Jellyseerr being an open-source project, anyone is welcome to contribute. We also encourage you to contribute to Overseerr as well.
+
+Contribution includes building new features, patching bugs, translating the application, or even just writing documentation.
 
 If you would like to contribute, please be sure to review our [contribution guidelines](https://github.com/fallenbagel/jellyseerr/blob/develop/CONTRIBUTING.md).

docs/SUMMARY.md

@@ -1,34 +0,0 @@
-# Table of Contents
-
-- [Introduction](README.md)
-
-## Getting Started
-
-- [Installation](getting-started/installation.md)
-
-## Using Overseerr
-
-- [Settings](using-overseerr/settings/README.md)
-- [Users](using-overseerr/users/README.md)
-- [Notifications](using-overseerr/notifications/README.md)
-  - [Email](using-overseerr/notifications/email.md)
-  - [Web Push](using-overseerr/notifications/webpush.md)
-  - [Discord](using-overseerr/notifications/discord.md)
-  - [Gotify](using-overseerr/notifications/gotify.md)
-  - [LunaSea](using-overseerr/notifications/lunasea.md)
-  - [Pushbullet](using-overseerr/notifications/pushbullet.md)
-  - [Pushover](using-overseerr/notifications/pushover.md)
-  - [Slack](using-overseerr/notifications/slack.md)
-  - [Telegram](using-overseerr/notifications/telegram.md)
-  - [Webhook](using-overseerr/notifications/webhooks.md)
-
-## Support
-
-- [Frequently Asked Questions (FAQ)](support/faq.md)
-- [Need Help?](support/need-help.md)
-
-## Extending Overseerr
-
-- [Reverse Proxy](extending-overseerr/reverse-proxy.md)
-- [Fail2ban](extending-overseerr/fail2ban.md)
-- [Third-Party Integrations](extending-overseerr/third-party.md)

docs/extending-jellyseerr/_category_.json

@@ -0,0 +1,9 @@
+{
+  "label": "Extending Jellyseerr",
+  "position": 3,
+  "link": {
+    "type": "generated-index",
+    "title": "Extending Jellyseerr",
+    "description": "Extend Jellyseerr to your liking"
+  }
+}

docs/extending-jellyseerr/reverse-proxy.mdx

@@ -1,87 +1,39 @@
+---
+title: Reverse Proxy
+description: Configure a reverse proxy for Jellyseerr.
+sidebar_position: 1
+---
+
 # Reverse Proxy
 
-{% hint style="warning" %}
-Base URLs cannot be configured in Overseerr. With this limitation, only subdomain configurations are supported.
+:::warning
+Base URLs cannot be configured in Jellyseerr. With this limitation, only subdomain configurations are supported.
 
 A Nginx subfolder workaround configuration is provided below, but it is not officially supported.
-{% endhint %}
+:::
 
 ## Nginx
 
-{% tabs %}
-{% tab title="SWAG" %}
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
 
-A sample proxy configuration is included in [SWAG (Secure Web Application Gateway)](https://github.com/linuxserver/docker-swag).
-
-However, this page is still the only source of truth, so the SWAG sample configuration is not guaranteed to be up-to-date. If you find an inconsistency, please [report it to the LinuxServer team](https://github.com/linuxserver/reverse-proxy-confs/issues/new) or [submit a pull request to update it](https://github.com/linuxserver/reverse-proxy-confs/pulls).
-
-To use the bundled configuration file, simply rename `overseerr.subdomain.conf.sample` in the `proxy-confs` folder to `overseerr.subdomain.conf`.
-
-Alternatively, you can create a new file `overseerr.subdomain.conf` in `proxy-confs` with the following configuration:
-
-```nginx
-server {
-    listen 443 ssl http2;
-    listen [::]:443 ssl http2;
-
-    server_name overseerr.*;
-
-    include /config/nginx/ssl.conf;
-
-    client_max_body_size 0;
-
-    location / {
-        include /config/nginx/proxy.conf;
-        resolver 127.0.0.11 valid=30s;
-        set $upstream_app overseerr;
-        set $upstream_port 5055;
-        set $upstream_proto http;
-        proxy_pass $upstream_proto://$upstream_app:$upstream_port;
-    }
-
-}
-```
-
-{% endtab %}
-
-{% tab title="Nginx Proxy Manager" %}
-
-Add a new proxy host with the following settings:
-
-### Details
-
-- **Domain Names:** Your desired external Overseerr hostname; e.g., `overseerr.example.com`
-- **Scheme:** `http`
-- **Forward Hostname / IP:** Internal Overseerr hostname or IP
-- **Forward Port:** `5055`
-- **Cache Assets:** yes
-- **Block Common Exploits:** yes
-
-### SSL
-
-- **SSL Certificate:** Select one of the options; if you are not sure, pick “Request a new SSL Certificate”
-- **Force SSL:** yes
-- **HTTP/2 Support:** yes
-
-{% endtab %}
-
-{% tab title="Subdomain" %}
-
-Add the following configuration to a new file `/etc/nginx/sites-available/overseerr.example.com.conf`:
+<Tabs groupId="nginx-reverse-proxy">
+    <TabItem value="subdomain" label="Subdomain">
+Add the following configuration to a new file `/etc/nginx/sites-available/jellyseerr.example.com.conf`:
 
 ```nginx
 server {
     listen 80;
-    server_name overseerr.example.com;
+    server_name jellyseerr.example.com;
     return 301 https://$server_name$request_uri;
 }
 
 server {
     listen 443 ssl http2;
-    server_name overseerr.example.com;
+    server_name jellyseerr.example.com;
 
-    ssl_certificate /etc/letsencrypt/live/overseerr.example.com/fullchain.pem;
-    ssl_certificate_key /etc/letsencrypt/live/overseerr.example.com/privkey.pem;
+    ssl_certificate /etc/letsencrypt/live/jellyseerr.example.com/fullchain.pem;
+    ssl_certificate_key /etc/letsencrypt/live/jellyseerr.example.com/privkey.pem;
 
     proxy_set_header Referer $http_referer;
     proxy_set_header Host $host;
@@ -103,27 +55,27 @@ server {
 Then, create a symlink to `/etc/nginx/sites-enabled`:
 
 ```bash
-sudo ln -s /etc/nginx/sites-available/overseerr.example.com.conf /etc/nginx/sites-enabled/overseerr.example.com.conf
+sudo ln -s /etc/nginx/sites-available/jellyseerr.example.com.conf /etc/nginx/sites-enabled/jellyseerr.example.com.conf
 ```
 
-{% endtab %}
+    </TabItem>
 
-{% tab title="Subfolder" %}
+    <TabItem value="subfolder" label="Subfolder">
 
-{% hint style="warning" %}
+:::warning
 This Nginx subfolder reverse proxy is an unsupported workaround, and only provided as an example. The filters may stop working when Overseerr is updated.
 
 If you encounter any issues with Overseerr while using this workaround, we may ask you to try to reproduce the problem without the Nginx proxy.
-{% endhint %}
+:::
 
 Add the following location block to your existing `nginx.conf` file.
 
 ```nginx
-location ^~ /overseerr {
-    set $app 'overseerr';
+location ^~ /jellyseerr {
+    set $app 'jellyseerr';
 
-    # Remove /overseerr path to pass to the app
-    rewrite ^/overseerr/?(.*)$ /$1 break;
+    # Remove /jellyseerr path to pass to the app
+    rewrite ^/jellyseerr/?(.*)$ /$1 break;
     proxy_pass http://127.0.0.1:5055; # NO TRAILING SLASH
 
     # Redirect location headers
@@ -151,23 +103,105 @@ location ^~ /overseerr {
 }
 ```
 
-{% endtab %}
-{% endtabs %}
+    </TabItem>
+
+    <TabItem value="swag" label="SWAG">
+
+A sample proxy configuration is included in [SWAG (Secure Web Application Gateway)](https://github.com/linuxserver/docker-swag).
+
+However, this page is still the only source of truth, so the SWAG sample configuration is not guaranteed to be up-to-date. If you find an inconsistency, please [report it to the LinuxServer team](https://github.com/linuxserver/reverse-proxy-confs/issues/new) or [submit a pull request to update it](https://github.com/linuxserver/reverse-proxy-confs/pulls).
+
+To use the bundled configuration file, simply rename `jellyseerr.subdomain.conf.sample` in the `proxy-confs` folder to `jellyseerr.subdomain.conf`.
+
+Alternatively, you can create a new file `jellyseerr.subdomain.conf` in `proxy-confs` with the following configuration:
+
+```nginx
+server {
+    listen 443 ssl http2;
+    listen [::]:443 ssl http2;
+
+    server_name jellyseerr.*;
+
+    include /config/nginx/ssl.conf;
+
+    client_max_body_size 0;
+
+    location / {
+        include /config/nginx/proxy.conf;
+        resolver 127.0.0.11 valid=30s;
+        set $upstream_app jellyseerr;
+        set $upstream_port 5055;
+        set $upstream_proto http;
+        proxy_pass $upstream_proto://$upstream_app:$upstream_port;
+    }
+
+}
+```
+
+</TabItem>
+
+    <TabItem value="nginx-proxy-manager" label="Nginx Proxy Manager">
+
+Add a new proxy host with the following settings:
+
+### Details
+
+- **Domain Names:** Your desired external Overseerr hostname; e.g., `overseerr.example.com`
+- **Scheme:** `http`
+- **Forward Hostname / IP:** Internal Overseerr hostname or IP
+- **Forward Port:** `5055`
+- **Cache Assets:** yes
+- **Block Common Exploits:** yes
+
+### SSL
+
+- **SSL Certificate:** Select one of the options; if you are not sure, pick “Request a new SSL Certificate”
+- **Force SSL:** yes
+- **HTTP/2 Support:** yes
+
+Then, click “Save” and “Apply Changes”.
+
+      </TabItem>
+
+  </Tabs>
+
+## Caddy (v2)
+
+Create a Caddyfile with the following content:
+
+```caddyfile
+jellyseerr.example.com {
+    reverse_proxy http://127.0.0.1:5055
+}
+```
+
+Deploy the Caddyfile by running:
+
+```bash
+
+sudo caddy run --config /path/to/Caddyfile
+```
+
+Verify by visiting https://jellyseerr.example.com in your browser.
+
+:::note
+Caddy will automatically obtain and renew SSL certificates for your domain.
+:::
 
 ## Traefik (v2)
 
 Add the following labels to the Overseerr service in your `docker-compose.yml` file:
 
-```text
+```yaml
 labels:
-  - "traefik.enable=true"
+  - 'traefik.enable=true'
   ## HTTP Routers
-  - "traefik.http.routers.overseerr-rtr.entrypoints=https"
-  - "traefik.http.routers.overseerr-rtr.rule=Host(`overseerr.domain.com`)"
-  - "traefik.http.routers.overseerr-rtr.tls=true"
+  - 'traefik.http.routers.overseerr-rtr.entrypoints=https'
+  - 'traefik.http.routers.overseerr-rtr.rule=Host(`overseerr.domain.com`)'
+  - 'traefik.http.routers.overseerr-rtr.tls=true'
   ## HTTP Services
-  - "traefik.http.routers.overseerr-rtr.service=overseerr-svc"
-  - "traefik.http.services.overseerr-svc.loadbalancer.server.port=5055"
+  - 'traefik.http.routers.overseerr-rtr.service=overseerr-svc'
+  - 'traefik.http.services.overseerr-svc.loadbalancer.server.port=5055'
 ```
 
 For more information, please refer to the [Traefik documentation](https://doc.traefik.io/traefik/user-guides/docker-compose/basic-example/).

docs/extending-overseerr/fail2ban.md

@@ -1,14 +0,0 @@
-# Fail2ban Filter
-
-{% hint style="warning" %}
-If you are running Overseerr behind a reverse proxy, make sure that the **Enable Proxy Support** setting is **enabled**.
-{% endhint %}
-
-To use Fail2ban with Overseerr, create a new file named `overseerr.local` in your Fail2ban `filter.d` directory with the following filter definition:
-
-```
-[Definition]
-failregex = .*\[warn\]\[API\]\: Failed sign-in attempt.*"ip":"<HOST>"
-```
-
-You can then add a jail using this filter in `jail.local`. Please see the [Fail2ban documentation](https://www.fail2ban.org/wiki/index.php/MANUAL_0_8#Jails) for details on how to configure the jail.

docs/extending-overseerr/third-party.md

@@ -1,15 +0,0 @@
-# Third-Party Integrations
-
-{% hint style="warning" %}
-**We do not officially support these third-party integrations.** If you run into any issues, please seek help on the appropriate support channels for the integration itself!
-{% endhint %}
-
-- [Organizr](https://organizr.app/), a HTPC/homelab services organizer
-- [Heimdall](https://github.com/linuxserver/Heimdall), an application dashboard and launcher
-- [LunaSea](https://docs.lunasea.app/modules/overseerr), a self-hosted controller for mobile and macOS
-- [Requestrr](https://github.com/darkalfx/requestrr/wiki/Configuring-Overseerr), a Discord chatbot
-- [Doplarr](https://github.com/kiranshila/Doplarr), a Discord request bot
-- [Overseerr Assistant](https://github.com/RemiRigal/Overseerr-Assistant), a browser extension for requesting directly from TMDB and IMDb
-- [ha-overseerr](https://github.com/vaparr/ha-overseerr), a custom Home Assistant component
-- [OverCLIrr](https://github.com/WillFantom/OverCLIrr), a command-line tool
-- [Overseerr Exporter](https://github.com/WillFantom/overseerr-exporter), a Prometheus exporter

docs/getting-started/_category_.json

@@ -0,0 +1,4 @@
+{
+  "label": "Getting Started",
+  "position": 2
+}

docs/getting-started/aur.mdx

@@ -0,0 +1,39 @@
+---
+title: AUR (Arch User Repository)
+description: Install Jellyseerr using the Arch User Repository
+sidebar_position: 4
+---
+
+# AUR (Arch User Repository)
+
+:::info
+This method is not recommended for most users. It is intended for advanced users who are using Arch Linux or an Arch-based distribution.
+:::
+
+## Installation
+
+To install Jellyseerr from the AUR, you can use an AUR helper like `yay` or `paru`:
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+<Tabs groupId="aur-methods">
+  <TabItem value="yay" label="yay">
+    ```bash
+    yay -S jellyseerr
+    ```
+  </TabItem>
+  <TabItem value="paru" label="paru">
+    ```bash
+    paru -S jellyseerr
+    ```
+  </TabItem>
+</Tabs>
+
+:::info
+After installing Jellyseerr, configure it by visiting the web UI at `http://[address]:5055` and completing the setup steps.
+:::
+
+:::tip
+You can find the environment file at `/etc/conf.d/jellyseerr` and the service file at `/etc/systemd/system/jellyseerr.service`.
+:::

docs/getting-started/buildfromsource.mdx

@@ -0,0 +1,381 @@
+---
+title: Build From Source (Advanced)
+description: Install Jellyseerr by building from source
+sidebar_position: 2
+---
+# Build from Source (Advanced)
+:::warning
+This method is not recommended for most users. It is intended for advanced users who are familiar with managing their own server infrastructure.
+:::
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+### Prerequisites
+<Tabs groupId="versions">
+  <TabItem value="latest" label="Latest">
+    - [Node.js 18.x](https://nodejs.org/en/download/)
+    - [Yarn 1.x](https://classic.yarnpkg.com/lang/en/docs/install)
+    - [Git](https://git-scm.com/downloads)
+  </TabItem>
+
+  <TabItem value="develop" label="Develop">
+    - [Node.js 20.x](https://nodejs.org/en/download/)
+    - [Pnpm 9.x](https://pnpm.io/installation)
+    - [Git](https://git-scm.com/downloads)
+  </TabItem>
+</Tabs>
+
+
+## Unix (Linux, macOS)
+### Installation
+<Tabs groupId="versions">
+  <TabItem value="latest" label="latest">
+1. Assuming you want the working directory to be `/opt/jellyseerr`, create the directory and navigate to it:
+```bash
+sudo mkdir -p /opt/jellyseerr && cd /opt/jellyseerr
+```
+2. Clone the Jellyseerr repository and checkout the latest release:
+```bash
+git clone https://github.com/Fallenbagel/jellyseerr.git
+cd jellyseerr
+git checkout main
+```
+3. Install the dependencies:
+```bash
+CYPRESS_INSTALL_BINARY=0 yarn install --frozen-lockfile --network-timeout 1000000
+```
+4. Build the project:
+```bash
+yarn build
+```
+5. Start Jellyseerr:
+```bash
+yarn start
+```
+  </TabItem>
+  <TabItem value="develop" label="develop">
+1. Assuming you want the working directory to be `/opt/jellyseerr`, create the directory and navigate to it:
+```bash
+sudo mkdir -p /opt/jellyseerr && cd /opt/jellyseerr
+```
+2. Clone the Jellyseerr repository and checkout the develop branch:
+```bash
+git clone https://github.com/Fallenbagel/jellyseerr.git
+cd jellyseerr
+git checkout develop # by default, you are on the develop branch so this step is not necessary
+```
+3. Install the dependencies:
+```bash
+CYPRESS_INSTALL_BINARY=0 pnpm install --frozen-lockfile
+```
+4. Build the project:
+```bash
+pnpm build
+```
+5. Start Jellyseerr:
+```bash
+pnpm start
+```
+  </TabItem>
+</Tabs>
+  
+:::info
+You can now access Jellyseerr by visiting `http://localhost:5055` in your web browser.
+:::
+
+#### Extending the installation
+<Tabs groupId="unix-extensions">
+  <TabItem value="linux" label="Linux">
+To run jellyseerr as a systemd service:
+1. create the environment file at `/etc/jellyseerr/jellyseerr.conf`:
+```bash
+## Jellyseerr's default port is 5055, if you want to use both, change this.
+## specify on which port to listen
+PORT=5055
+
+## specify on which interface to listen, by default jellyseerr listens on all interfaces
+#HOST=127.0.0.1
+
+## Uncomment if your media server is emby instead of jellyfin.
+# JELLYFIN_TYPE=emby
+```
+2. Then run the following commands:
+```bash
+which node
+```
+Copy the path to node, it should be something like `/usr/bin/node`.
+
+3. Create the systemd service file at `/etc/systemd/system/jellyseerr.service`, using either `sudo systemctl edit jellyseerr` or `sudo nano /etc/systemd/system/jellyseerr.service`:
+```bash
+[Unit]
+Description=Jellyseerr Service
+Wants=network-online.target
+After=network-online.target
+
+[Service]
+EnvironmentFile=/etc/jellyseerr/jellyseerr.conf
+Environment=NODE_ENV=production
+Type=exec
+Restart=on-failure
+WorkingDirectory=/opt/jellyseerr
+ExecStart=/usr/bin/node dist/index.js
+
+[Install]
+WantedBy=multi-user.target
+```
+:::note
+If you are using a different path to node, replace `/usr/bin/node` with the path to node.
+:::
+
+4. Enable and start the service:
+```bash
+sudo systemctl enable jellyseerr
+sudo systemctl start jellyseerr
+```
+  </TabItem>
+  <TabItem value="macos" label="macOS">
+To run jellyseerr as a launchd service:
+1. Find the path to node:
+```bash
+which node
+```
+Copy the path to node, it should be something like `/usr/local/bin/node`.
+
+2. Create a launchd plist file at `~/Library/LaunchAgents/com.jellyseerr.plist`:
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+  <key>Label</key>
+  <string>com.jellyseerr</string>
+  <key>ProgramArguments</key>
+  <array>
+    <string>/usr/local/bin/node</string>
+    <string>/opt/jellyseerr/dist/index.js</string>
+  </array>
+  <key>WorkingDirectory</key>
+  <string>/opt/jellyseerr</string>
+  <key>EnvironmentVariables</key>
+  <dict>
+    <key>NODE_ENV</key>
+    <string>production</string>
+    <key>PORT</key>
+    <string>5055</string>
+  </dict>
+  <key>RunAtLoad</key>
+  <true/>
+  <key>KeepAlive</key>
+  <true/>
+</dict>
+</plist>
+```
+:::note
+If you are using a different path to node, replace `/usr/local/bin/node` with the path to node.
+:::
+3. Load the service:
+```bash
+sudo launchctl load ~/Library/LaunchAgents/com.jellyseerr.plist
+```
+3. Start the service:
+```bash
+sudo launchctl start com.jellyseerr
+```
+4. To ensure the service starts on boot, run the following command:
+```bash
+sudo lauchctl load
+```
+  </TabItem>
+  <TabItem value="pm2" label="PM2">
+To run jellyseerr as a PM2 service:
+1. Install PM2:
+```bash
+npm install -g pm2
+```
+2. Start jellyseerr with PM2:
+```bash
+pm2 start dist/index.js --name jellyseerr --node-args="--NODE_ENV=production"
+```
+3. Save the process list:
+```bash
+pm2 save
+```
+4. Ensure PM2 starts on boot:
+```bash
+pm2 startup
+```
+**Managing the service**
+- To start the service:
+```powershell
+pm2 start jellyseerr
+```
+- To stop the service:
+```powershell
+pm2 stop jellyseerr
+```
+- To restart the service:
+```powershell
+pm2 restart jellyseerr
+```
+- To view the logs:
+```powershell
+pm2 logs jellyseerr
+```
+- To view the status:
+```powershell
+pm2 status jellyseerr
+```
+  </TabItem>
+</Tabs>
+
+## Windows
+### Installation
+<Tabs groupId="versions">
+  <TabItem value="latest" label="latest">
+1. Assuming you want the working directory to be `C:\jellyseerr`, create the directory and navigate to it:
+```powershell
+mkdir C:\jellyseerr
+cd C:\jellyseerr
+```
+2. Clone the Jellyseerr repository and checkout the latest release:
+```powershell
+git clone https://github.com/Fallenbagel/jellyseerr.git .
+git checkout main
+```
+3. Install the dependencies:
+```powershell
+set CYPRESS_INSTALL_BINARY=0 && yarn install --frozen-lockfile --network-timeout 1000000
+```
+4. Build the project:
+```powershell
+yarn build
+```
+5. Start Jellyseerr:
+```powershell
+yarn start
+```
+  </TabItem>
+  <TabItem value="develop" label="develop">
+1. Assuming you want the working directory to be `C:\jellyseerr`, create the directory and navigate to it:
+```powershell
+mkdir C:\jellyseerr
+cd C:\jellyseerr
+```
+2. Clone the Jellyseerr repository and checkout the develop branch:
+```powershell
+git clone https://github.com/Fallenbagel/jellyseerr.git .
+git checkout develop # by default, you are on the develop branch so this step is not necessary
+```
+3. Install the dependencies:
+```powershell
+set CYPRESS_INSTALL_BINARY=0 && pnpm install --frozen-lockfile
+```
+4. Build the project:
+```powershell
+pnpm build
+```
+5. Start Jellyseerr:
+```powershell
+pnpm start
+```
+  </TabItem>
+</Tabs>
+
+:::tip
+You can add the environment variables to a `.env` file in the Jellyseerr directory.
+:::
+
+:::info
+You can now access Jellyseerr by visiting `http://localhost:5055` in your web browser.
+:::
+
+#### Extending the installation
+<Tabs groupId="windows-extensions">
+  <TabItem value="task-scheduler" label="Task Scheduler">
+To run jellyseerr as a bat script:
+1. Create a file named `start-jellyseerr.bat` in the jellyseerr directory:
+```bat
+@echo off
+set PORT=5055
+set NODE_ENV=production
+node dist/index.js
+```
+2. Create a task in Task Scheduler:
+- Open Task Scheduler
+- Click on "Create Basic Task"
+- Name the task "Jellyseerr"
+- Set the trigger to "When the computer starts"
+- Set the action to "Start a program"
+- Set the program/script to the path of the `start-jellyseerr.bat` file
+- Click "Finish"
+
+Now, Jellyseerr will start when the computer boots up in the background.
+  </TabItem>
+  
+  <TabItem value="nssm" label="NSSM">
+To run jellyseerr as a service:
+1. Download the [Non-Sucking Service Manager](https://nssm.cc/download)
+2. Install NSSM:
+```powershell
+nssm install Jellyseerr "C:\Program Files\nodejs\node.exe" ["C:\jellyseerr\dist\index.js"]
+nssm set Jellyseerr AppEnvironmentExtra NODE_ENV=production
+```
+3. Start the service:
+```powershell
+nssm start Jellyseerr
+```
+4. To ensure the service starts on boot, run the following command:
+```powershell
+nssm set Jellyseerr Start SERVICE_AUTO_START
+```
+  </TabItem>
+  <TabItem value="pm2" label="PM2">
+To run jellyseerr as a PM2 service:
+1. Install PM2:
+```powershell
+npm install -g pm2
+```
+2. Start jellyseerr with PM2:
+```powershell
+pm2 start dist/index.js --name jellyseerr  --node-args="--NODE_ENV=production"
+```
+3. Save the process list:
+```powershell
+pm2 save
+```
+4. Ensure PM2 starts on boot:
+```powershell
+pm2 startup
+```
+##### Managing the service
+- To start the service:
+```powershell
+pm2 start jellyseerr
+```
+- To stop the service:
+```powershell
+pm2 stop jellyseerr
+```
+- To restart the service:
+```powershell
+pm2 restart jellyseerr
+```
+- To view the logs:
+```powershell
+pm2 logs jellyseerr
+```
+- To view the status:
+```powershell
+pm2 status jellyseerr
+```
+  </TabItem>
+</Tabs>
+
+### Updating
+To update Jellyseerr, navigate to the Jellyseerr directory and run the following commands:
+```bash
+git pull
+```
+Then, follow the steps in the installation section to rebuild and restart Jellyseerr.
+

docs/getting-started/docker.mdx

@@ -0,0 +1,196 @@
+---
+title: Docker (Recommended)
+description: Install Jellyseerr using Docker
+sidebar_position: 1
+---
+# Docker
+:::info
+This is the recommended method for most users.
+Details on how to install Docker can be found on the [official Docker website](https://docs.docker.com/get-docker/).
+:::
+
+## Unix (Linux, macOS)
+:::warning
+Be sure to replace `/path/to/appdata/config` in the below examples with a valid host directory path. If this volume mount is not configured correctly, your Jellyseerr settings/data will not be persisted when the container is recreated (e.g., when updating the image or rebooting your machine).
+
+    The `TZ` environment variable value should also be set to the [TZ database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) of your time zone!
+
+:::
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+<Tabs groupId="docker-methods">
+  <TabItem value="docker-cli" label="Docker CLI">
+For details on the Docker CLI, please [review the official `docker run` documentation](https://docs.docker.com/engine/reference/run/).
+
+#### Installation:
+
+```bash
+docker run -d \
+  --name jellyseerr \
+  -e LOG_LEVEL=debug \
+  -e TZ=Asia/Tashkent \
+  -e PORT=5055 `#optional` \
+  -p 5055:5055 \
+  -v /path/to/appdata/config:/app/config \
+  --restart unless-stopped \
+  fallenbagel/jellyseerr
+```
+
+To run the container as a specific user/group, you may optionally add `--user=[ user | user:group | uid | uid:gid | user:gid | uid:group ]` to the above command.
+
+#### Updating:
+
+Stop and remove the existing container:
+```bash
+docker stop jellyseerr && docker rm Jellyseerr
+```
+Pull the latest image:
+```bash
+docker pull fallenbagel/jellyseerr
+```
+Finally, run the container with the same parameters originally used to create the container:
+```bash
+docker run -d ...
+```
+
+:::tip
+You may alternatively use a third-party updating mechanism, such as [Watchtower](https://github.com/containrrr/watchtower) or [Ouroboros](https://github.com/pyouroboros/ouroboros), to keep Jellyseerr up-to-date automatically.
+
+You could also use [diun](https://github.com/crazy-max/diun) to receive notifications when a new image is available.
+:::
+  </TabItem>
+
+  <TabItem value="docker-compose" label="Docker Compose">
+For details on how to use Docker Compose, please [review the official Compose documentation](https://docs.docker.com/compose/reference/).
+
+#### Installation:
+Define the `jellyseerr` service in your `docker-compose.yml` as follows:
+```yaml
+---
+services:
+  jellyseerr:
+    image: fallenbagel/jellyseerr:latest
+    container_name: jellyseerr
+    environment:
+      - LOG_LEVEL=debug
+      - TZ=Asia/Tashkent
+      - PORT=5055 #optional
+    ports:
+      - 5055:5055
+    volumes:
+      - /path/to/appdata/config:/app/config
+    restart: unless-stopped
+```
+Then, start all services defined in the Compose file:
+```bash
+docker-compose up -d
+```
+
+#### Updating:
+Pull the latest image:
+```bash
+docker-compose pull jellyseerr
+```
+Then, restart all services defined in the Compose file:
+```bash
+docker-compose up -d
+```
+
+:::tip
+You may alternatively use a third-party mechanism like [dockge](https://github.com/louislam/dockge) to manage your docker compose files.
+:::
+  </TabItem>
+</Tabs>
+
+
+## Unraid
+
+1. Ensure you have the **Community Applications** plugin installed.
+2. Inside the **Community Applications** app store, search for **Jellyseerr**.
+3. Click the **Install Button**.
+4. On the following **Add Container** screen, make changes to the **Host Port** and **Host Path 1** \(Appdata\) as needed.
+5. If you want to use emby, make sure to set the `JELLYFIN_TYPE` environment variable to `emby`. Otherwise, remove the variable.
+6. Click apply and access "Jellyseerr" at your `<ServerIP:HostPort>` in a web browser.
+
+## Windows
+
+Please refer to the [Docker Desktop for Windows user manual](https://docs.docker.com/docker-for-windows/) for details on how to install Docker on Windows. There is no need to install a Linux distro if using named volumes like in the example below.
+:::warning
+**WSL2 will need to be installed to prevent DB corruption!** Please see the [Docker Desktop WSL 2 backend documentation](https://docs.docker.com/docker-for-windows/wsl/) for instructions on how to enable WSL2. The commands below will only work with WSL2 installed!
+:::
+
+First, create a volume to store the configuration data for Jellyseerr using using either the Docker CLI:
+```bash
+docker volume create jellyseerr-data
+```
+
+or the Docker Desktop app:
+1. Open the Docker Desktop app
+2. Head to the Volumes tab
+3. Click on the "New Volume" button near the top right
+4. Enter a name for the volume (example: `jellyseerr-data`) and hit "Create"
+
+Then, create and start the Jellyseerr container:
+<Tabs groupId="docker-methods">
+  <TabItem value="docker-cli" label="Docker CLI">
+```bash
+docker run -d --name jellyseerr -e LOG_LEVEL=debug -e TZ=Asia/Tashkent -p 5055:5055 -v "jellyseerr-data:/app/config" --restart unless-stopped fallenbagel/jellyseerr:latest
+```
+  </TabItem>
+
+  <TabItem value="docker-compose" label="Docker Compose">
+```yaml
+---
+services:
+  jellyseerr:
+    image: fallenbagel/jellyseerr:latest
+    container_name: jellyseerr
+    environment:
+      - LOG_LEVEL=debug
+      - TZ=Asia/Tashkent
+    ports:
+      - 5055:5055
+    volumes:
+      - jellyseerr-data:/app/config
+    restart: unless-stopped
+
+volumes:
+  jellyseerr-data:
+    external: true
+```
+  </TabItem>
+
+  <TabItem value="docker-desktop" label="Docker Desktop">
+1. Open the Docker Desktop app
+2. Head to the Containers/Apps tab
+3. Click on the "Add Container/App" button near the top right
+4. Fill in the container details:
+   - **Name**: `jellyseerr`
+   - **Image**: `fallenbagel/jellyseerr:latest`
+   - **Port**: `5055:5055`
+   - **Volume**: `jellyseerr-data:/app/config`
+   - **Environment Variables**:
+     - **LOG_LEVEL**: `debug`
+     - **TZ**: `Asia/Tashkent`
+   - **Restart Policy**: `unless-stopped`
+5. Click on the "Run" button
+  </TabItem>
+</Tabs>
+
+To access the files inside the volume created above, navigate to the following folder using File Explorer:
+
+For Docker v26.1.4 or higher: `\\wsl$\docker-desktop\mnt\docker-desktop-disk\data\docker\volumes\jellyseerr-data\_data`
+
+For older versions of Docker:
+`\\wsl$\docker-desktop-data\data\docker\volumes\jellyseerr-data\_data`
+or
+`\\wsl$\docker-desktop-data\version-pack-data\community\docker\volumes\jellyseerr-data\_data`
+
+:::info
+Docker on Windows works differently than it does on Linux; it runs Docker inside of a stripped-down Linux VM. Volume mounts are exposed to Docker inside this VM via SMB mounts. While this is fine for media, it is unacceptable for the `/app/config` directory because SMB does not support file locking. This will eventually corrupt your database, which can lead to slow behavior and crashes.
+
+**If you must run Docker on Windows, you should put the `/app/config` directory mount inside the VM and not on the Windows host.** (This also applies to other containers with SQLite databases.)
+
+Named volumes, like in the example commands above, are automatically mounted inside the VM. Therefore the warning on the setup about the `/app/config` folder being incorrectly mounted page should be ignored.

docs/getting-started/index.mdx

@@ -0,0 +1,10 @@
+---
+title: Getting Started
+---
+import DocCardList from '@theme/DocCardList';
+
+:::info
+After running Jellyseerr for the first time, configure it by visiting the web UI at `http://[address]:5055` and completing the setup steps.
+:::
+
+<DocCardList />

docs/getting-started/installation.md

@@ -1,256 +0,0 @@
-# Installation
-
-{% hint style="danger" %}
-**Overseerr is currently in BETA.** If you would like to help test the bleeding edge, please use the image **`fallenbagel/jellyseerr:develop`**!
-{% endhint %}
-
-{% hint style="info" %}
-After running Overseerr for the first time, configure it by visiting the web UI at `http://[address]:5055` and completing the setup steps.
-{% endhint %}
-
-## Docker
-
-{% hint style="warning" %}
-Be sure to replace `/path/to/appdata/config` in the below examples with a valid host directory path. If this volume mount is not configured correctly, your Overseerr settings/data will not be persisted when the container is recreated (e.g., when updating the image or rebooting your machine).
-
-The `TZ` environment variable value should also be set to the [TZ database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) of your time zone!
-{% endhint %}
-
-{% tabs %}
-{% tab title="Docker CLI" %}
-
-For details on the Docker CLI, please [review the official `docker run` documentation](https://docs.docker.com/engine/reference/run/).
-
-**Installation:**
-
-```bash
-docker run -d \
-  --name overseerr \
-  -e LOG_LEVEL=debug \
-  -e TZ=Asia/Tokyo \
-  -e PORT=5055 `#optional` \
-  -p 5055:5055 \
-  -v /path/to/appdata/config:/app/config \
-  --restart unless-stopped \
-  fallenbagel/jellyseerr
-```
-
-To run the container as a specific user/group, you may optionally add `--user=[ user | user:group | uid | uid:gid | user:gid | uid:group ]` to the above command.
-
-**Updating:**
-
-Stop and remove the existing container:
-
-```bash
-docker stop overseerr && docker rm overseerr
-```
-
-Pull the latest image:
-
-```bash
-docker pull fallenbagel/jellyseerr
-```
-
-Finally, run the container with the same parameters originally used to create the container:
-
-```bash
-docker run -d ...
-```
-
-{% hint style="info" %}
-You may alternatively use a third-party updating mechanism, such as [Watchtower](https://github.com/containrrr/watchtower) or [Ouroboros](https://github.com/pyouroboros/ouroboros), to keep Overseerr up-to-date automatically.
-{% endhint %}
-
-{% endtab %}
-
-{% tab title="Docker Compose" %}
-
-For details on how to use Docker Compose, please [review the official Compose documentation](https://docs.docker.com/compose/reference/).
-
-**Installation:**
-
-Define the `overseerr` service in your `docker-compose.yml` as follows:
-
-```yaml
----
-version: '3'
-
-services:
-  overseerr:
-    image: fallenbagel/jellyseerr:latest
-    container_name: overseerr
-    environment:
-      - LOG_LEVEL=debug
-      - TZ=Asia/Tokyo
-      - PORT=5055 #optional
-    ports:
-      - 5055:5055
-    volumes:
-      - /path/to/appdata/config:/app/config
-    restart: unless-stopped
-```
-
-Then, start all services defined in the Compose file:
-
-```bash
-docker-compose up -d
-```
-
-**Updating:**
-
-Pull the latest image:
-
-```bash
-docker-compose pull overseerr
-```
-
-Then, restart all services defined in the Compose file:
-
-```bash
-docker-compose up -d
-```
-
-{% endtab %}
-{% endtabs %}
-
-## Unraid
-
-1. Ensure you have the **Community Applications** plugin installed.
-2. Inside the **Community Applications** app store, search for **Overseerr**.
-3. Click the **Install Button**.
-4. On the following **Add Container** screen, make changes to the **Host Port** and **Host Path 1**\(Appdata\) as needed.
-5. Click apply and access "Overseerr" at your `<ServerIP:HostPort>` in a web browser.
-
-## Windows
-
-Please refer to the [Docker Desktop for Windows user manual](https://docs.docker.com/docker-for-windows/) for details on how to install Docker on Windows. There is no need to install a Linux distro if using named volumes like in the example below.
-
-{% hint style="danger" %}
-**WSL2 will need to be installed to prevent DB corruption!** Please see the [Docker Desktop WSL 2 backend documentation](https://docs.docker.com/docker-for-windows/wsl/) for instructions on how to enable WSL2. The commands below will only work with WSL2 installed!
-{% endhint %}
-
-First, create a volume to store the configuration data for Overseerr using using either the Docker CLI:
-
-```bash
-docker volume create overseerr-data
-```
-
-or the Docker Desktop app:
-
-1. Open the Docker Desktop app
-2. Head to the Volumes tab
-3. Click on the "New Volume" button near the top right
-4. Enter a name for the volume (example: `overseerr-data`) and hit "Create"
-
-Then, create and start the Overseerr container:
-
-```bash
-docker run -d --name overseerr -e LOG_LEVEL=debug -e TZ=Asia/Tokyo -p 5055:5055 -v "overseerr-data:/app/config" --restart unless-stopped fallenbagel/jellyseerr:latest
-```
-
-To access the files inside the volume created above, navigate to `\\wsl$\docker-desktop-data\version-pack-data\community\docker\volumes\overseerr-data\_data` using File Explorer.
-
-{% hint style="info" %}
-Docker on Windows works differently than it does on Linux; it runs Docker inside of a stripped-down Linux VM. Volume mounts are exposed to Docker inside this VM via SMB mounts. While this is fine for media, it is unacceptable for the `/app/config` directory because SMB does not support file locking. This will eventually corrupt your database, which can lead to slow behavior and crashes.
-
-**If you must run Docker on Windows, you should put the `/app/config` directory mount inside the VM and not on the Windows host.** (This also applies to other containers with SQLite databases.)
-
-Named volumes, like in the example commands above, are automatically mounted inside the VM. Therefore the warning on the setup about the `/app/config` folder being incorrectly mounted page should be ignored.
-{% endhint %}
-
-## Linux
-
-{% hint style="info" %}
-The [Overseerr snap](https://snapcraft.io/overseerr) is the only officially supported Linux install method aside from [Docker](#docker).
-
-Currently, the listening port cannot be changed, so port `5055` will need to be available on your host. To install `snapd`, please refer to the [Snapcraft documentation](https://snapcraft.io/docs/installing-snapd).
-{% endhint %}
-
-**Installation:**
-
-```
-sudo snap install overseerr
-```
-
-{% hint style="danger" %}
-To install the development build, add the `--edge` argument to the above command (i.e., `sudo snap install overseerr --edge`). However, note that this version can break any moment. Be prepared to troubleshoot any issues that arise!
-{% endhint %}
-
-**Updating:**
-
-Snap will keep Overseerr up-to-date automatically. You can force a refresh by using the following command.
-
-```bash
-sudo snap refresh
-```
-
-## Third-Party
-
-{% tabs %}
-
-{% tab title="Gentoo" %}
-Portage overlay [GitHub Repository](https://github.com/chriscpritchard/overseerr-overlay).
-
-This is now included in the list of [Gentoo repositories](https://overlays.gentoo.org/), so can be easily enabled with `eselect repository`
-
-Efforts will be made to keep up-to-date with the latest releases; however, this cannot be guaranteed.
-
-**To enable:**
-To enable using `eselect repository`, run:
-
-```bash
-eselect repository enable overseerr-overlay
-```
-
-**To install:**
-Once complete, you can just run:
-
-```bash
-emerge www-apps/overseerr
-```
-
-**To install the development build:**
-A live ebuild (`=www-apps/overseerr-9999`) is also available. To use this, you will need to modify accept_keywords for this package:
-
-```bash
-emerge --autounmask --autounmask-write "=www-apps/overseerr-9999"
-```
-
-Once installed, you will not be notified of updates, so you can update with:
-
-```bash
-emerge @live-rebuild
-```
-
-or use `app-portage/smart-live-rebuild`
-
-{% hint style="danger" %}
-This version can break any moment. Be prepared to troubleshoot any issues that arise!
-{% endhint %}
-
-{% endtab %}
-
-{% tab title="Swizzin" %}
-
-{% hint style="danger" %}
-This implementation is not yet merged to master due to missing functionality. You can beta test the limited implementation or follow the status on [the pull request](https://github.com/swizzin/swizzin/pull/567).
-{% endhint %}
-
-The installation is not implemented via Docker, but barebones. The latest release version of Overseerr will be used.
-Please see the [swizzin documentation](https://swizzin.ltd/applications/overseerr) for more information.
-
-To install, run the following:
-
-```bash
-box install overseerr
-```
-
-To upgrade, run the following:
-
-```bash
-box upgrade overseerr
-```
-
-{% endtab %}
-
-{% endtabs %}

docs/getting-started/nixpkg.mdx

@@ -0,0 +1,225 @@
+---
+title: Nix Package Manager (Advanced)
+description: Install Jellyseerr using Nix
+sidebar_position: 3
+---
+
+import { JellyseerrVersion, NixpkgVersion } from '@site/src/components/JellyseerrVersion';
+import Admonition from '@theme/Admonition';
+
+# Nix Package Manager (Advanced)
+:::info
+This method is not recommended for most users. It is intended for advanced users who are using Nix as their package manager.
+:::
+
+export const VersionMismatchWarning = () => {
+  const jellyseerrVersion = JellyseerrVersion();
+  const nixpkgVersion = NixpkgVersion();
+
+  const isUpToDate = jellyseerrVersion === nixpkgVersion;
+
+  return (
+    <>
+      {!isUpToDate ? (
+        <Admonition type="warning">
+          The <a href="https://github.com/NixOS/nixpkgs/blob/nixos-unstable/pkgs/servers/jellyseerr/default.nix#L14">upstream Jellyseerr Nix Package (v{nixpkgVersion})</a> is not <b>up-to-date</b>. If you want to use <b>Jellyseerr v{jellyseerrVersion}</b>, you will need to <a href="#overriding-the-package">override the package derivation</a>.
+        </Admonition>
+      ) : (
+        <Admonition type="success">
+          The <a href="https://github.com/NixOS/nixpkgs/blob/nixos-unstable/pkgs/servers/jellyseerr/default.nix#L14">upstream Jellyseerr Nix Package (v{nixpkgVersion})</a> is <b>up-to-date</b> with <b>Jellyseerr v{jellyseerrVersion}</b>.
+        </Admonition>
+      )}
+    </>
+  );
+};
+
+<VersionMismatchWarning />
+
+## Installation
+To get up and running with jellyseerr using Nix, you can add the following to your `configuration.nix`:
+
+```nix
+{ config, pkgs, ... }:
+
+{
+  services.jellyseerr.enable = true;
+}
+```
+
+If you want more advanced configuration options, you can use the following:
+
+```nix
+{ config, pkgs, ... }:
+
+{
+  services.jellyseerr = {
+    enable = true;
+    port = 5055;
+    openFirewall = true;
+  };
+}
+```
+
+After adding the configuration to your `configuration.nix`, you can run the following command to install jellyseerr:
+
+```bash
+nixos-rebuild switch
+```
+After rebuild is complete jellyseerr should be running, verify that it is with the following command.
+```bash
+systemctl status jellyseerr
+```
+
+:::info
+You can now access Jellyseerr by visiting `http://localhost:5055` in your web browser.
+:::
+
+
+
+import CodeBlock from '@theme/CodeBlock';
+
+## Overriding the package derivation
+export const VersionMatch = () => {
+  const jellyseerrVersion = JellyseerrVersion();
+  const nixpkgVersion = NixpkgVersion();
+
+  const code = `{ config, pkgs, ... }:
+{
+  nixpkgs.config.packageOverrides = pkgs: {
+    jellyseerr = pkgs.jellyseerr.overrideAttrs (oldAttrs: rec {
+      version = "${jellyseerrVersion}";
+
+      src = pkgs.fetchFromGitHub {
+        rev = "v\${version}";
+        sha256 = pkgs.lib.fakeSha256;
+      };
+
+      offlineCache = pkgs.fetchYarnDeps {
+        sha256 = pkgs.lib.fakeSha256; 
+      };
+    }); 
+  };
+}`;
+ 
+  const module = `{ config, pkgs, lib, ... }:
+
+with lib;
+let
+  cfg = config.services.jellyseerr;
+in
+{
+  meta.maintainers = [ maintainers.camillemndn ];
+
+  disabledModules = [ "services/misc/jellyseerr.nix" ];
+
+  options.services.jellyseerr = {
+    enable = mkEnableOption (mdDoc ''Jellyseerr, a requests manager for Jellyfin'');
+
+    openFirewall = mkOption {
+      type = types.bool;
+      default = false;
+      description = mdDoc ''Open port in the firewall for the Jellyseerr web interface.'';
+    };
+
+    port = mkOption {
+      type = types.port;
+      default = 5055;
+      description = mdDoc ''The port which the Jellyseerr web UI should listen to.'';
+    };
+
+    package = mkOption {
+        type = types.package;
+        default = pkgs.jellyseerr;
+        defaultText = literalExpression "pkgs.jellyseerr";
+        description = lib.mdDoc ''
+          Jellyseerr package to use.
+        '';
+      };
+  };
+
+  config = mkIf cfg.enable {
+    systemd.services.jellyseerr = {
+      description = "Jellyseerr, a requests manager for Jellyfin";
+      after = [ "network.target" ];
+      wantedBy = [ "multi-user.target" ];
+      environment.PORT = toString cfg.port;
+      serviceConfig = {
+        Type = "exec";
+        StateDirectory = "jellyseerr";
+        WorkingDirectory = "\${cfg.package}/libexec/jellyseerr/deps/jellyseerr";
+        DynamicUser = true;
+        ExecStart = "\${cfg.package}/bin/jellyseerr";
+        BindPaths = [ "/var/lib/jellyseerr/:\${cfg.package}/libexec/jellyseerr/deps/jellyseerr/config/" ];
+        Restart = "on-failure";
+        ProtectHome = true;
+        ProtectSystem = "strict";
+        PrivateTmp = true;
+        PrivateDevices = true;
+        ProtectHostname = true;
+        ProtectClock = true;
+        ProtectKernelTunables = true;
+        ProtectKernelModules = true;
+        ProtectKernelLogs = true;
+        ProtectControlGroups = true;
+        NoNewPrivileges = true;
+        RestrictRealtime = true;
+        RestrictSUIDSGID = true;
+        RemoveIPC = true;
+        PrivateMounts = true;
+      };
+    };
+
+    networking.firewall = mkIf cfg.openFirewall {
+      allowedTCPPorts = [ cfg.port ];
+    };
+  };
+}`;
+
+  const configuration = `{ config, pkgs, ... }:
+{
+    imports = [ ./jellyseerr-module.nix ]
+
+    services.jellyseerr = {
+        enable = true;
+        port = 5055;
+        openFirewall = true;
+        package = (pkgs.callPackage (import ../../../pkgs/jellyseerr) { });
+    };
+}`;
+
+  const isUpToDate = jellyseerrVersion === nixpkgVersion;
+
+  return (
+    <>
+      {isUpToDate ? (
+        <>
+          <p>The latest version of Jellyseerr <strong>({jellyseerrVersion})</strong> and the Jellyseerr nixpkg package version <strong>({nixpkgVersion})</strong> is <strong>up-to-date</strong>.</p>
+          <p>There is no need to override the package derivation.</p>
+        </>
+      ) : (
+        <>
+          <p>The latest version of Jellyseerr <strong>({jellyseerrVersion})</strong> and the Jellyseerr nixpkg version <strong>(v{nixpkgVersion})</strong> is <strong>out-of-date</strong>.
+          If you want to use <b>Jellyseerr v{jellyseerrVersion}</b>, you will need to override the package derivation.</p>
+          <p>In order to override the package derivation:</p>
+          <ol>
+            <li style={{ marginBottom: '1rem' }}>Grab the <a href="https://raw.githubusercontent.com/NixOS/nixpkgs/nixos-unstable/pkgs/servers/jellyseerr/default.nix">latest nixpkg derivation for Jellyseerr</a></li>
+            <li style={{ marginBottom: '1rem' }}>Grab the latest <a href="https://raw.githubusercontent.com/Fallenbagel/jellyseerr/main/package.json">package.json</a> for Jellyseerr</li>
+            <li style={{ marginBottom: '1rem' }}>Add it to the same directory as the nixpkg derivation</li>
+            <li style={{ marginBottom: '1rem' }}>Update the `src` and `offlineCache` attributes in the nixpkg derivation:</li>
+            <CodeBlock className="language-nix" style={{ marginBottom: '1rem' }}>{code}</CodeBlock>
+            <Admonition type="tip" style={{ marginBottom: '1rem' }}>You can replace the <b>sha256</b> with the actual hash that <b>nixos-rebuild</b> outputs when you run the command.</Admonition>
+            <li style={{ marginBottom: '1rem' }}>Grab this module and import it in your `configuration.nix`</li>
+            <CodeBlock className="language-nix" style={{ marginBottom: '1rem' }}>{module}</CodeBlock>
+            <Admonition type="tip" style={{ marginBottom: '1rem' }}>We are using a custom module because the upstream module does not have a package option.</Admonition>
+            <li style={{ marginBottom: '1rem' }}>Call the new package in your `configuration.nix`</li>
+            <CodeBlock className="language-nix" style={{ marginBottom: '1rem' }}>{configuration}</CodeBlock>
+          </ol>
+        </>
+      )}
+    </>
+  );
+
+};
+
+<VersionMatch />
+

docs/support/faq.md

@@ -1,133 +0,0 @@
-# Frequently Asked Questions (FAQ)
-
-{% hint style="info" %}
-If you can't find the solution to your problem here, please read [Need Help?](./need-help.md) and reach out to us on [Discord](https://discord.gg/ckbvBtDJgC).
-
-_Please do not post questions or support requests on the GitHub issue tracker!_
-{% endhint %}
-
-## General
-
-### How do I keep Overseerr up-to-date?
-
-Use a third-party update mechanism (such as [Watchtower](https://github.com/containrrr/watchtower), [Ouroboros](https://github.com/pyouroboros/ouroboros), or [Pullio](https://hotio.dev/pullio)) to keep Overseerr up-to-date automatically.
-
-### How can I access Overseerr outside of my home network?
-
-The easiest but least secure method is to simply forward an external port (e.g., `5055`) on your router to the internal port used by Overseerr (default is TCP `5055`). Visit [Port Forward](http://portforward.com/) for instructions for your particular router. You would then be able to access Overseerr via `http://EXTERNAL-IP-ADDRESS:5055`.
-
-A more advanced, user-friendly, and secure (if using SSL) method is to set up a web server and use a reverse proxy to access Overseerr. Please refer to our [reverse proxy examples](../extending-overseerr/reverse-proxy.md) for more information.
-
-The most secure method (but also the most inconvenient method) is to set up a VPN tunnel to your home server. You would then be able to access Overseerr as if you were on your local network, via `http://LOCAL-IP-ADDRESS:5055`.
-
-### Are there mobile apps for Overseerr?
-
-Since Overseerr has an almost native app experience when installed as a Progressive Web App (PWA), there are no plans to develop mobile apps for Overseerr.
-
-Out of the box, Overseerr already fulfills most of the [PWA install criteria](https://web.dev/install-criteria/). You simply need to make sure that your Overseerr instance is being served over HTTPS (e.g., via a [reverse proxy](../extending-overseerr/reverse-proxy.md)).
-
-### Overseerr is amazing! But it is not translated in my language yet! Can I help with translations?
-
-You sure can! We are using [Weblate](https://hosted.weblate.org/engage/overseerr/) for translations. If your language is not listed, please [open a feature request on GitHub](https://github.com/sct/overseerr/issues/new/choose).
-
-### Where can I find the changelog?
-
-You can find the changelog for your version (stable/`latest`,s or `develop`) in the **Settings → About** page in your Overseerr instance.
-
-You can alternatively review the [stable release history](https://github.com/fallenbagel/jellyseerr/releases) and [`develop` branch commit history](https://github.com/fallenbagel/jellyseerr/commits/develop) on GitHub.
-
-### Some media is missing from Overseerr that I know is in Plex!
-
-Overseerr currently supports the following agents:
-
-- New Plex Movie
-- Legacy Plex Movie
-- New Plex TV
-- Legacy Plex TV
-- TheTVDB
-- TMDB
-- [HAMA](https://github.com/ZeroQI/Hama.bundle)
-
-Please verify that your library is using one of the agents previously listed.
-
-When changing agents, a full metadata refresh of your Plex library is required. (Caution: This can take a long time depending on the size of your library.)
-
-#### Troubleshooting Steps
-
-First, check the Overseerr logs for media items that are missing. The logs will contain an error as to why that item could not be matched.
-
-1. Verify that you are using one of the agents mentioned above.
-2. Refresh the metadata for just that item.
-3. Run a full scan in Overseerr to see if that item is now matched properly.
-4. If the item is now seen by Overseerr then repeat step 2 for each missing item. If you have a large amount of items missing then a full metadata refresh is recommended for that library.
-5. Run a full scan on Overseerr after refreshing all unmatched items.
-
-You can also perform the following to verify the media item has a GUID Overseerr can match:
-
-1. Go to the media item in Plex and **"Get info"** and click on **"View XML"**.
-2. Verify that the media item's GUID follows one of the below formats:
-
-   1. TMDB agent `guid="com.plexapp.agents.themoviedb://1705"`
-   2. New Plex Movie agent `<Guid id="tmdb://464052"/>`
-   3. TheTVDB agent `guid="com.plexapp.agents.thetvdb://78874/1/1"`
-   4. Legacy Plex Movie agent `guid="com.plexapp.agents.imdb://tt0765446"`
-
-### Where can I find the log files?
-
-Please see [these instructions on how to locate and share your logs](./need-help.md#how-can-i-share-my-logs).
-
-## Users
-
-### Why can't I see all of my Plex users?
-
-Please see the [documentation for importing users from Plex](../using-overseerr/users/README.md#importing-users-from-plex).
-
-### Can I create local users in Overseerr?
-
-Yes! Please see the [documentation for creating local users](../using-overseerr/users/README.md#creating-local-users).
-
-### Is is possible to set user roles in Overseerr?
-
-Permissions can be configured for each user via the **User List** or their **User Settings** page. The list of assignable permissions is still growing, so if you have any suggestions, [submit a feature request](https://github.com/fallenbagel/jellyseerr/issues/new/choose)!
-
-## Requests
-
-### I receive 409 or 400 errors when requesting a movie or TV series!
-
-Verify you are running v3 of both Radarr and Sonarr. Overseerr is not backwards-compatible with previous versions.
-
-### Can I allow users to submit 4K requests?
-
-Yes! If you keep both non-4K and 4K content in your media libraries, you can link separate 4K Radarr/Sonarr servers to allow users to submit 4K requests. (You must configure default non-4K **and** default 4K Radarr/Sonarr servers.)
-
-Please see the [Services documentation](../using-overseerr/settings/README.md#services) for details on how to configure your Radarr and/or Sonarr servers.
-
-Note that users must also have the **Request 4K**, **Request 4K Movies**, and/or **Request 4K Series** permissions in order to submit requests for 4K content.
-
-### I approved a requested movie and Radarr didn't search for it!
-
-Check the minimum availability setting in your Radarr server. If a movie does not meet the minimum availability requirement, no search will be performed. Also verify that Radarr did not perform a search, by checking the Radarr logs. Lastly, verify that the item was not already being monitored by Radarr prior to approving the request.
-
-### Help! My request still shows "requested" even though it is in Plex!
-
-See "[Some media is missing from Overseerr that I know is in Plex!](#some-media-is-missing-from-overseerr-that-i-know-is-in-plex)" for troubleshooting steps.
-
-### Series requests keep failing!
-
-If you configured a URL base in Sonarr, make sure you have also configured the [URL Base](../using-overseerr/settings/README.md#url-base) setting for your Sonarr server in Overseerr.
-
-Also, check that you are using Sonarr v3 and that you have configured a default language profile in Overseerr.
-
-Language profile support for Sonarr was added in [v1.20.0](https://github.com/fallenbagel/jellyseerr/releases/tag/v1.20.0) along with a new, _required_ **Language Profile** setting. If series requests are failing, make sure that you have a default language profile configured for each of your Sonarr servers in **Settings &rarr; Services**.
-
-## Notifications
-
-### I am getting "Username and Password not accepted" when attempting to send email notifications via Gmail!
-
-If you have 2-Step Verification enabled on your account, you will need to create an [app password](https://support.google.com/mail/answer/185833).
-
-### The logo image in email notifications is broken!
-
-This may be an issue with how you are proxying your Overseerr instance. A good first troubleshooting step is to verify that the [`Content-Security-Policy` HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP) being set by your proxy (if any) is configured appropriately to allow external embedding of the image.
-
-For Gmail users, another possible issue is that Google's image URL proxy is being blocked from fetching the image. If using Cloudflare, overzealous firewall rules could be the culprit.

docs/support/need-help.md

@@ -1,45 +0,0 @@
-# Need Help?
-
-Before seeking assistance, please make sure you have first tried these following:
-
-- **Updating** Overseerr to the latest version.
-- **Stopping and restarting** Overseerr.
-- **Restarting** your machine.
-- **Clearing** your browser cache.
-- **Analyzing** your logs, you just might find the solution yourself!
-- **Searching** the [documentation](../README.md), [installation guide](../getting-started/installation.md), and [FAQs](./faq.md).
-
-If you still have questions after troubleshooting on your own, feel free to ask on [Discord](https://discord.gg/ckbvBtDJgC)! (Please review our [Code of Conduct](https://github.com/fallenbagel/jellyseerr/blob/develop/CODE_OF_CONDUCT.md) before posting.)
-
-Be sure to also include a link to your logs. (Please see [How can I share my logs?](#how-can-i-share-my-logs) below.)
-
-## What should I include when requesting support?
-
-Please try to include as much information as possible. A vague statement like "it doesn't work" provides very little to go on, and makes it difficult for us to help you.
-
-Try to answer the following questions:
-
-- What version of Overseerr are you running? (You can find this in Settings → About → Version.)
-- How did you install Overseerr? Are you using the official Docker or snap images, or images published by a third-party?
-- How are you accessing Overseerr?
-  - Are you accessing Overseerr through your reverse proxy or via a local IP address?
-  - What browser are you using? What browser extensions are enabled?
-- What were you trying to do, and how did you attempt it?
-  - What command did you enter?
-  - What did you click on?
-  - What settings did you change?
-  - Did you follow official instructions, or a third-party guide?
-  - Provide a step-by-step list of what you tried.
-  - Provide a brief description of your setup.
-- What exactly do you see?
-  - Did something happen?
-  - Did something not happen?
-  - Are there any error messages showing?
-  - Provide screenshots to help us see what you are seeing.
-  - Share your Overseerr logs, which show exactly what happened and are often critical for identifying issues (see [How can I share my logs?](#how-can-i-share-my-logs) below).
-
-## How can I share my logs?
-
-1. Locate the current log file at `<your Overseerr config directory>/logs/overseerr.log`.
-2. Open the log file and **copy its contents** into a [**secret gist** on GitHub](https://gist.github.com/). If you upload your logs elsewhere, we may ask you to share them again via GitHub Gist.
-3. **Share the link/URL to your secret gist** in the [`#support` channel in our Discord server](https://discord.gg/ckbvBtDJgC).

docs/using-jellyseerr/_category_.json

@@ -0,0 +1,9 @@
+{
+  "label": "Using Jellyseerr",
+  "position": 2,
+  "link": {
+    "type": "generated-index",
+    "title": "Using Jellyseerr",
+    "description": "Learn how to use Jellyseerr"
+  }
+}

docs/using-jellyseerr/notifications/discord.md

@@ -1,10 +1,16 @@
+---
+title: Discord
+description: Configure Discord notifications.
+sidebar_position: 3
+---
+
 # Discord
 
 The Discord notification agent enables you to post notifications to a channel in a server you manage.
 
-{% hint style="info" %}
+:::info
 Users can optionally opt-in to being mentioned in Discord notifications by configuring their [Discord user ID](https://support.discord.com/hc/en-us/articles/206346498-Where-can-I-find-my-User-Server-Message-ID-) in their user settings.
-{% endhint %}
+:::
 
 ## Configuration
 

docs/using-jellyseerr/notifications/email.md

@@ -1,14 +1,20 @@
+---
+title: Email
+description: Configure email notifications for your users.
+sidebar_position: 1
+---
+
 # Email
 
 ## Configuration
 
-{% hint style="info" %}
-If the [Application URL](../settings/README.md#application-url) setting is configured in **Settings → General**, Overseerr will explicitly set the origin server hostname when connecting to the SMTP host.
-{% endhint %}
+:::info
+If the [Application URL](/using-jellyseerr/settings/general#application-title) setting is configured in **Settings → General**, Jellyseerr will explicitly set the origin server hostname when connecting to the SMTP host.
+:::
 
 ### Sender Name (optional)
 
-Configure a friendly name for the email sender (e.g., "Overseerr").
+Configure a friendly name for the email sender (e.g., "Jellyseerr").
 
 ### Sender Address
 
@@ -18,7 +24,7 @@ Depending on your email provider, this may need to be an address you own. For ex
 
 ### SMTP Host
 
-Set this to the hostname or IP address of your SMTP host/server.
+Set this to the hostname or IP address of your SMTP server.
 
 ### SMTP Port
 
@@ -26,16 +32,15 @@ Set this to a supported port number for your SMTP host. `465` and `587` are comm
 
 ### Encryption Method
 
-In most cases, [Use Implicit TLS](https://tools.ietf.org/html/rfc8314) should be selected for port 465, and [Use STARTTLS if available](https://en.wikipedia.org/wiki/Opportunistic_TLS) for port 587. Please refer to your email provider's documentations for details on how to configure this setting.
+In most cases, [Use Implicit TLS](https://tools.ietf.org/html/rfc8314) should be selected for port 465, and [Use STARTTLS](https://en.wikipedia.org/wiki/Opportunistic_TLS) if available for port 587. Please refer to your email provider's documentations for details on how to configure this setting.
 
 The default value for this setting is **Use STARTTLS if available**.
 
 ### SMTP Username & Password
 
-{% hint style="info" %}
+:::info
 If your account has two-factor authentication enabled, you may need to create an application password instead of using your account password.
-{% endhint %}
-
+:::
 Configure these values as appropriate to authenticate with your SMTP host.
 
 ### PGP Private Key & Password (optional)

docs/using-jellyseerr/notifications/index.mdx

@@ -0,0 +1,25 @@
+---
+title: Notifications
+description: Configure notifications for your users.
+sidebar_position: 3
+---
+
+# Notifications
+
+## Supported Notification Agents
+
+Jellyseerr currently supports the following notification agents:
+
+import DocCardList from '@theme/DocCardList';
+
+<DocCardList />
+
+## Setting Up Notifications
+
+Simply configure your desired notification agents in **Settings -> Notifications** in the Jellyseerr web UI.
+
+Users can customize their notification preferences in their own user notification settings.
+
+## Requesting New Notification Agents
+
+If we do not currently support your preferred notification agent, feel free to [submit a feature request on GitHub](https://github.com/Fallenbagel/jellyseerr/issues). However, please be sure to search first and confirm that there is not already an existing request for the agent!

docs/using-jellyseerr/notifications/webpush.md

@@ -0,0 +1,23 @@
+---
+title: Web Push
+description: Configure web push notifications for your users.
+sidebar_position: 2
+---
+
+# Web Push
+
+The web push notification agent enables you and your users to receive Jellyseerr notifications in a supported browser.
+
+This notification agent does not require any configuration, but is not enabled in Jellyseerr by default.
+
+:::warning
+Web push notifications require a secure connection to your Jellyseerr instance. Refer to the [Reverse Proxy](/extending-jellyseerr/reverse-proxy) documentation for more information.
+:::
+
+To set up web push notifications, simply enable the agent in **Settings → Notifications → Web Push**. You and your users will then be prompted to allow notifications in your web browser.
+
+Users can opt out of these notifications, or customize the notification types they would like to subscribe to, in their user settings.
+
+:::info
+Web push notifications offer a native notification experience without the need to install an app.
+:::

docs/using-jellyseerr/settings/_category_.json

@@ -0,0 +1,9 @@
+{
+  "label": "Settings",
+  "position": 1,
+  "link": {
+    "type": "generated-index",
+    "title": "Settings",
+    "description": "Configure Jellyseerr to your liking"
+  }
+}

docs/using-jellyseerr/settings/general.md

@@ -0,0 +1,75 @@
+---
+title: General
+description: Configure global and default settings for Jellyseerr.
+sidebar_position: 1
+---
+
+# General
+
+## API Key
+
+This is your Jellyseerr API key, which can be used to integrate Jellyseerr with third-party applications. Do **not** share this key publicly, as it can be used to gain administrator access!
+
+If you need to generate a new API key for any reason, simply click the button to the right of the text box.
+
+## Application Title
+
+If you aren't a huge fan of the name "Jellyseerr" and would like to display something different to your users, you can customize the application title!
+
+## Application URL
+
+Set this to the externally-accessible URL of your Overseerr instance.
+
+You must configure this setting in order to enable password reset and generation emails.
+
+## Enable Proxy Support
+
+If you have Overseerr behind a reverse proxy, enable this setting to allow Overseerr to correctly register client IP addresses. For details, please see the [Express Documentation](https://expressjs.com/en/guide/behind-proxies.html).
+
+This setting is **disabled** by default.
+
+## Enable CSRF Protection
+
+:::warning
+**This is an advanced setting.** Please only enable this setting if you are familiar with CSRF protection and how it works.
+:::
+
+CSRF stands for [cross-site request forgery](https://en.wikipedia.org/wiki/Cross-site_request_forgery). When this setting is enabled, all external API access that alters Jellyseerr application data is blocked.
+
+If you do not use Jellyseerr integrations with third-party applications to add/modify/delete requests or users, you can consider enabling this setting to protect against malicious attacks.
+
+One caveat, however, is that HTTPS is required, meaning that once this setting is enabled, you will no longer be able to access your Jellyseerr instance over _HTTP_ (including using an IP address and port number).
+
+If you enable this setting and find yourself unable to access Overseerr, you can disable the setting by modifying `settings.json` in `/app/config`.
+
+This setting is **disabled** by default.
+
+## Enable Image Caching
+
+When enabled, Jellseerr will proxy and cache images from pre-configured sources (such as TMDB). This can use a significant amount of disk space.
+
+Images are saved in the `config/cache/images` and stale images are cleared out every 24 hours.
+
+You should enable this if you are having issues with loading images directly from TMDB in your browser.
+
+## Display Language
+
+Set the default display language for Jellyseerr. Users can override this setting in their user settings.
+
+## Discover Region & Discover Language
+
+These settings filter content shown on the "Discover" home page based on regional availability and original language, respectively. Users can override these global settings by configuring these same options in their user settings.
+
+## Hide Available Media
+
+When enabled, media which is already available will not appear on the "Discover" home page, or in the "Recommended" or "Similar" categories or other links on media detail pages.
+
+Available media will still appear in search results, however, so it is possible to locate and view hidden items by searching for them by title.
+
+This setting is **disabled** by default.
+
+## Allow Partial Series Requests
+
+When enabled, users will be able to submit requests for specific seasons of TV series. If disabled, users will only be able to submit requests for all unavailable seasons.
+
+This setting is **enabled** by default.

docs/using-jellyseerr/settings/jobs&cache.md

@@ -0,0 +1,12 @@
+---
+title: Jobs & Cache
+description: Configure jobs and cache settings.
+---
+
+# Jobs & Cache
+
+Jellyseerr performs certain maintenance tasks as regularly-scheduled jobs, but they can also be manually triggered on this page.
+
+Jellyseerr also caches requests to external API endpoints to optimize performance and avoid making unnecessary API calls. If necessary, the cache for any particular endpoint can be cleared by clicking the "Flush Cache" button.
+
+You can also view the current image cache size as well as the total number of cached images.

docs/using-jellyseerr/settings/mediaserver.mdx

@@ -0,0 +1,241 @@
+---
+title: Mediaserver Settings
+description: Configure your Jellyfin, Emby, or Plex server settings.
+sidebar_position: 3
+---
+
+# Media Server
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+<Tabs groupId="media-server-type">
+    <TabItem value="jellyfin" label="Jellyfin">
+:::info
+To set up Jellyfin, make sure you log in using an account with administrative privileges.
+
+The email address can be any email address and is only used for notifications, password resets, and local sign-in.
+It is **not** tied to your Jellyfin account.
+:::
+
+### Jellyfin Libraries
+
+In this section, simply select the libraries you would like Jellyseerr to scan. Jellyseerr will periodically check the selected libraries for available content to update the media status that is displayed to users.
+
+If you do not see your Jellyfin library listed, verify your Jellyfin settings are correct and click the Sync Libraries button.
+
+### Manual Library Scan
+
+Jellyseerr will perform a full scan of your Jellyfin libraries once every 24 hours (recently added items are fetched more frequently). If this is your first time configuring Jellyfin, a one-time full manual library scan is recommended!
+
+### Jellyfin Settings
+
+This section is where you configure the connection to your Jellyfin server.
+
+    <Tabs groupId="versions">
+        <TabItem value="latest" label="Latest">
+
+#### Internal URL
+
+The internal URL is the URL that Jellyseerr will use to communicate with your Jellyfin server. This URL should be accessible from the machine running Jellyseerr.
+
+In most cases, this will be the hostname or IP address of the machine running Jellyfin, followed by the port number Jellyfin is running on (usually 8096).
+
+:::note
+When running Jellyseerr in a docker container with a bridged network (default), the container's network will be separate from the host network. Therefore, you cannot use `localhost` or `127.0.0.1` as the internal URL as it will resolve to the container itself.
+:::
+:::tip
+If you are running Jellyfin in a docker container, you can put both Jellyseerr and Jellyfin on the same docker network by using a custom [docker network](https://docs.docker.com/reference/cli/docker/network/). This will allow you to use the container name as the internal URL.
+:::
+
+#### External URL
+
+The external URL is the URL that your users will use to access Jellyfin. This URL is used to generate links in `Play on Jellyfin` buttons, Jellyfin avatars and other places where users need to access Jellyfin directly.
+
+In most cases, the external URL will be different from the internal URL. This is especially true if you are connecting to Jellyfin using docker container names or local IP addresses.
+
+#### Forgot Password URL
+
+The forgot password URL is the URL that users will be directed to when they click the "Forgot Password" button on the login page. This URL should be accessible from the machine running Jellyseerr.
+
+By default, this field is empty and the "Forgot Password" button on the login page will redirect to the Jellyfin internal URL with the path `/web/index.html#!/forgotpassword`.
+
+You can customize this URL to point to a custom password reset page if you have one.
+
+        </TabItem>
+        <TabItem value="develop" label="develop">
+
+#### Hostname or IP Address
+
+If you have Jellyseerr installed on the same network as Jellyfin, you can set this to the local IP address of your Jellyfin server. Otherwise, this should be set to a valid hostname (e.g., jellyfin.myawesomeserver.com).
+
+In most cases, this will be the hostname or IP address of the machine running Jellyfin.
+
+:::note
+When running Jellyseerr in a docker container with a bridged network (default), the container's network will be separate from the host network. Therefore, you cannot use `localhost` or `127.0.0.1` as the internal URL as it will resolve to the container itself.
+:::
+:::tip
+If you are running Jellyfin in a docker container, you can put both Jellyseerr and Jellyfin on the same docker network by using a custom [docker network](https://docs.docker.com/reference/cli/docker/network/). This will allow you to use the container name as the internal URL.
+:::
+
+#### Port
+
+This value should be set to the port that your Jellyfin server listens on. The default port that Jellyfin uses is 8096, but you may need to set this to 443 or some other value if your Jellyfin server is hosted on a VPS or a different machine and is behind a reverse proxy.
+
+#### Use SSL
+
+Enable this setting to connect to Jellyfin via HTTPS rather than HTTP. Note that self-signed certificates are **not** officially supported.
+
+#### External URL
+
+The external URL is the URL that your users will use to access Jellyfin. This URL is used to generate links in `Play on Jellyfin` buttons, Jellyfin avatars and other places where users need to access Jellyfin directly.
+
+In most cases, the external URL will be different from the internal URL. This is especially true if you are connecting to Jellyfin using docker container names or local IP addresses.
+
+#### Forgot Password URL
+
+The forgot password URL is the URL that users will be directed to when they click the "Forgot Password" button on the login page. This URL should be accessible from the machine running Jellyseerr.
+
+By default, this field is empty and the "Forgot Password" button on the login page will redirect to the Jellyfin internal URL with the path `/web/index.html#!/forgotpassword`.
+
+You can customize this URL to point to a custom password reset page if you have one.
+
+            </TabItem>
+        </Tabs>
+    </TabItem>
+
+   <TabItem value="emby" label="Emby">
+:::info
+To set up Emby, make sure you log in using an account with administrative privileges.
+
+The email address can be any email address and is only used for notifications, password resets, and local sign-in.
+It is **not** tied to your Emby account.
+:::
+
+### Emby Libraries
+
+In this section, simply select the libraries you would like Jellyseerr to scan. Jellyseerr will periodically check the selected libraries for available content to update the media status that is displayed to users.
+
+If you do not see your Emby library listed, verify your Emby settings are correct and click the Sync Libraries button.
+
+### Manual Library Scan
+
+Jellyseerr will perform a full scan of your Emby libraries once every 24 hours (recently added items are fetched more frequently). If this is your first time configuring Emby, a one-time full manual library scan is recommended!
+
+### Emby Settings
+
+This section is where you configure the connection to your Emby server.
+
+        <Tabs groupId="versions">
+            <TabItem value="latest" label="Latest">
+
+#### Internal URL
+
+The internal URL is the URL that Jellyseerr will use to communicate with your Emby server. This URL should be accessible from the machine running Jellyseerr.
+
+In most cases, this will be the hostname or IP address of the machine running Emby, followed by the port number Emby is running on (usually 8096).
+
+:::note
+When running Jellyseerr in a docker container with a bridged network (default), the container's network will be separate from the host network. Therefore, you cannot use `localhost` or `127.0.0.1` as the internal URL as it will resolve to the container itself.
+:::
+:::tip
+If you are running Emby in a docker container, you can put both Jellyseerr and Emby on the same docker network by using a custom [docker network](https://docs.docker.com/reference/cli/docker/network/). This will allow you to use the container name as the internal URL.
+:::
+
+#### External URL
+
+The external URL is the URL that your users will use to access Emby. This URL is used to generate links in `Play on Emby` buttons, Emby avatars and other places where users need to access Emby directly.
+
+In most cases, the external URL will be different from the internal URL. This is especially true if you are connecting to Emby using docker container names or local IP addresses.
+
+#### Forgot Password URL
+
+The forgot password URL is the URL that users will be directed to when they click the "Forgot Password" button on the login page. This URL should be accessible from the machine running Jellyseerr.
+
+By default, this field is empty and the "Forgot Password" button on the login page will redirect to the Emby internal URL with the path `/web/index.html#!/forgotpassword.html`.
+
+You can customize this URL to point to a custom password reset page if you have one.
+
+            </TabItem>
+            <TabItem value="develop" label="develop">
+
+#### Hostname or IP Address
+
+If you have Jellyseerr installed on the same network as Emby, you can set this to the local IP address of your Emby server. Otherwise, this should be set to a valid hostname (e.g., jellyfin.myawesomeserver.com).
+
+In most cases, this will be the hostname or IP address of the machine running Emby.
+
+:::note
+When running Jellyseerr in a docker container with a bridged network (default), the container's network will be separate from the host network. Therefore, you cannot use `localhost` or `127.0.0.1` as the internal URL as it will resolve to the container itself.
+:::
+:::tip
+If you are running Emby in a docker container, you can put both Jellyseerr and Emby on the same docker network by using a custom [docker network](https://docs.docker.com/reference/cli/docker/network/). This will allow you to use the container name as the internal URL.
+:::
+
+#### Port
+
+This value should be set to the port that your Emby server listens on. The default port that Emby uses is 8096, but you may need to set this to 443 or some other value if your Emby server is hosted on a VPS or a different machine and is behind a reverse proxy.
+
+#### Use SSL
+
+Enable this setting to connect to Emby via HTTPS rather than HTTP. Note that self-signed certificates are **not** officially supported.
+
+#### External URL
+
+The external URL is the URL that your users will use to access Emby. This URL is used to generate links in `Play on Emby` buttons, Emby avatars and other places where users need to access Emby directly.
+
+In most cases, the external URL will be different from the internal URL. This is especially true if you are connecting to Emby using docker container names or local IP addresses.
+
+#### Forgot Password URL
+
+The forgot password URL is the URL that users will be directed to when they click the "Forgot Password" button on the login page. This URL should be accessible from the machine running Jellyseerr.
+
+By default, this field is empty and the "Forgot Password" button on the login page will redirect to the Emby internal URL with the path `/web/index.html#!/startup/forgotpassword.html`.
+
+You can customize this URL to point to a custom password reset page if you have one.
+
+            </TabItem>
+        </Tabs>
+    </TabItem>
+
+    <TabItem value="plex" label="Plex">
+
+### Plex Settings
+
+:::info
+To set up Plex, you can either enter your details manually or select a server retrieved from [plex.tv](https://plex.tv/). Press the button to the right of the "Server" dropdown to retrieve available servers.
+
+Depending on your setup/configuration, you may need to enter your Plex server details manually in order to establish a connection from Jellyseerr.
+:::
+
+#### Hostname or IP Address
+
+If you have Jellyseerr installed on the same network as Plex, you can set this to the local IP address of your Plex server. Otherwise, this should be set to a valid hostname (e.g., `plex.myawesomeserver.com`).
+
+#### Port
+
+This value should be set to the port that your Plex server listens on. The default port that Plex uses is `32400`, but you may need to set this to `443` or some other value if your Plex server is hosted on a VPS or cloud provider.
+
+#### Use SSL
+
+Enable this setting to connect to Plex via HTTPS rather than HTTP. Note that self-signed certificates are _not_ supported.
+
+#### Web App URL (optional)
+
+The **Play on Plex** buttons on media pages link to items on your Plex server. By default, these links use the [Plex Web App](https://support.plex.tv/articles/200288666-opening-plex-web-app/) hosted from plex.tv, but you can provide the URL to the web app on your Plex server and we'll use that instead!
+
+Note that you will need to enter the full path to the web app (e.g., `https://plex.myawesomeserver.com/web`).
+
+### Plex Libraries
+
+In this section, simply select the libraries you would like Jellyseerr to scan. Jellyseerr will periodically check the selected libraries for available content to update the media status that is displayed to users.
+
+If you do not see your Plex libraries listed, verify your Plex settings are correct and click the **Sync Libraries** button.
+
+### Manual Library Scan
+
+Jellyseerr will perform a full scan of your Plex libraries once every 24 hours (recently added items are fetched more frequently). If this is your first time configuring Plex, a one-time full manual library scan is recommended!
+
+</TabItem>
+
+</Tabs>

docs/using-jellyseerr/settings/notifications.mdx

@@ -0,0 +1,9 @@
+---
+title: Notifications
+description: Configure notifications for your users.
+sidebar_position: 5
+---
+
+# Notifications
+
+Please see the [Notifications](/using-jellyseerr/notifications) page for more information.

docs/using-jellyseerr/settings/services.md

@@ -0,0 +1,75 @@
+---
+title: Services
+description: Configure your default services.
+sidebar_position: 4
+---
+
+# Services
+
+:::info
+**If you keep separate copies of non-4K and 4K content in your media libraries, you will need to set up multiple Radarr/Sonarr instances and link each of them to Jellyseerr.**
+
+Jellyseerr checks these linked servers to determine whether or not media has already been requested or is available, so two servers of each type are required _if you keep separate non-4K and 4K copies of media._
+
+**If you only maintain one copy of media, you can instead simply set up one server and set the "Quality Profile" setting on a per-request basis.**
+:::
+
+### Radarr/Sonarr Settings
+
+:::warning
+**Only v3 & V4 Radarr/Sonarr servers are supported!** If your Radarr/Sonarr server is still running v2, you will need to upgrade in order to add it to Jellyseerr.
+::::
+
+#### Default Server
+
+At least one server needs to be marked as "Default" in order for requests to be sent successfully to Radarr/Sonarr.
+
+If you have separate 4K Radarr/Sonarr servers, you need to designate default 4K servers _in addition to_ default non-4K servers.
+
+#### 4K Server
+
+Only select this option if you have separate non-4K and 4K servers. If you only have a single Radarr/Sonarr server, do _not_ check this box!
+
+#### Server Name
+
+Enter a friendly name for the Radarr/Sonarr server.
+
+#### Hostname or IP Address
+
+If you have Jellyseerr installed on the same network as Radarr/Sonarr, you can set this to the local IP address of your Radarr/Sonarr server. Otherwise, this should be set to a valid hostname (e.g., `radarr.myawesomeserver.com`).
+
+#### Port
+
+This value should be set to the port that your Radarr/Sonarr server listens on. By default, Radarr uses port `7878` and Sonarr uses port `8989`, but you may need to set this to `443` or some other value if your Radarr/Sonarr server is hosted on a VPS or cloud provider.
+
+#### Use SSL
+
+Enable this setting to connect to Radarr/Sonarr via HTTPS rather than HTTP. Note that self-signed certificates are _not_ supported.
+
+#### API Key
+
+Enter your Radarr/Sonarr API key here. Do _not_ share these key publicly, as they can be used to gain administrator access to your Radarr/Sonarr servers!
+
+You can locate the required API keys in Radarr/Sonarr in **Settings → General → Security**.
+
+#### URL Base
+
+If you have configured a URL base for your Radarr/Sonarr server, you _must_ enter it here in order for Jellyeerr to connect to those services!
+
+You can verify whether or not you have a URL base configured in your Radarr/Sonarr server at **Settings → General → Host**. (Note that a restart of your Radarr/Sonarr server is required if you modify this setting!)
+
+#### Profiles, Root Folder, Minimum Availability
+
+Select the default settings you would like to use for all new requests. Note that all of these options are required, and that requests will fail if any of these are not configured!
+
+#### External URL (optional)
+
+If the hostname or IP address you configured above is not accessible outside your network, you can set a different URL here. This "external" URL is used to add clickable links to your Radarr/Sonarr servers on media detail pages.
+
+#### Enable Scan (optional)
+
+Enable this setting if you would like to scan your Radarr/Sonarr server for existing media/request status. It is recommended that you enable this setting, so that users cannot submit requests for media which has already been requested or is already available.
+
+#### Enable Automatic Search (optional)
+
+Enable this setting to have Radarr/Sonarr to automatically search for media upon approval of a request.

docs/using-jellyseerr/settings/users.md

@@ -0,0 +1,37 @@
+---
+title: User Settings
+description: Configure global and default user settings.
+sidebar_position: 2
+---
+
+# Users
+
+## Enable Local Sign-In
+
+When enabled, users who have configured passwords will be allowed to sign in using their email address.
+
+When disabled, your mediaserver OAuth becomes the only sign-in option, and any "local users" you have created will not be able to sign in to Jellyseerr.
+
+This setting is **enabled** by default.
+
+## Enable New Jellyfin/Emby/Plex Sign-In
+
+When enabled, users with access to your media server will be able to sign in to Overseerr even if they have not yet been imported. Users will be automatically assigned the permissions configured in the [Default Permissions](#default-permissions) setting upon first sign-in.
+
+This setting is **enabled** by default.
+
+## Global Movie Request Limit & Global Series Request Limit
+
+Select the request limits you would like granted to users.
+
+Unless an override is configured, users are granted these global request limits.
+
+Note that users with the **Manage Users** permission are exempt from request limits, since that permission also grants the ability to submit requests on behalf of other users.
+
+## Default Permissions
+
+Select the permissions you would like assigned to new users to have by default upon account creation.
+
+If [Enable New Jellyfin/Emby/Plex Sign-In](#enable-new-jellyfinembyplex-sign-in) is enabled, any user with access to your media server will be able to sign in to Jellyseerr, and they will be granted the permissions you select here upon first sign-in.
+
+This setting only affects new users, and has no impact on existing users. In order to modify permissions for existing users, you will need to edit the users.

docs/using-jellyseerr/users/_category_.json

@@ -0,0 +1,9 @@
+{
+  "label": "Users",
+  "position": 2,
+  "link": {
+    "type": "generated-index",
+    "title": "Users",
+    "description": "Configure your Jellyseerr users"
+  }
+}

docs/using-jellyseerr/users/adding-users.mdx

@@ -0,0 +1,64 @@
+---
+title: Adding Users
+description: Add users to your Jellyseerr instance.
+sidebar_position: 2
+---
+
+# Adding Users
+
+There are currently two methods to add users to Overseerr: importing Plex users and creating "local users." All new users are created with the [default permissions](/using-jellyseerr/settings/users#default-permissions) defined in **Settings → Users**.
+
+### Importing Mediaserver Users
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+<Tabs groupId="media-server-type">
+  <TabItem value="jellyfin" label="Jellyfin">
+    Clicking the **Import Jellyfin Users** button on the **User List** page will fetch the list of users with access to the Jellyfin server and add them to Jellyseerr automatically.
+
+    Importing Jellyfin users is not required, however. Any user with access to the Jellyfin server can log in to Jellyseerr even if they have not been imported, and will be assigned the configured [default permissions](/using-jellyseerr/settings/users#default-permissions) upon their first login.
+
+:::tip
+To disable new Jellyfin sign-ins, navigate to **Settings &rarr; Users** and uncheck the [**Enable New Jellyfin Sign-In**](/using-jellyseerr/settings/users#enable-new-jellyfinembyplex-sign-in) box.
+:::
+
+  </TabItem>
+  <TabItem value="emby" label="Emby">
+    Clicking the **Import Emby Users** button on the **User List** page will fetch the list of users with access to the Emby server and add them to Overseerr automatically.
+
+    Importing Emby users is not required, however. Any user with access to the Emby server can log in to Overseerr even if they have not been imported, and will be assigned the configured [default permissions](/using-jellyseerr/settings/users#default-permissions) upon their first login.
+
+:::tip
+To disable new Emby sign-ins, navigate to **Settings &rarr; Users** and uncheck the [**Enable New Emby Sign-In**](/using-jellyseerr/settings/users#enable-new-jellyfinembyplex-sign-in) box.
+:::
+
+  </TabItem>
+  
+  <TabItem value="plex" label="Plex">
+    Clicking the **Import Plex Users** button on the **User List** page will fetch the list of users with access to the Plex server from [plex.tv](https://www.plex.tv/), and add them to Overseerr automatically.
+
+    Importing Plex users is not required, however. Any user with access to the Plex server can log in to Overseerr even if they have not been imported, and will be assigned the configured [default permissions](/using-jellyseerr/settings/users#default-permissions) upon their first login.
+
+:::tip
+To disable new Plex sign-ins, navigate to **Settings &rarr; Users** and uncheck the [**Enable New Plex Sign-In**](/using-jellyseerr/settings/users#enable-new-jellyfinembyplex-sign-in) box.
+:::
+
+  </TabItem>
+</Tabs>
+
+### Creating Local Users
+
+If you would like to grant Overseerr access to a user who doesn't have their own Plex account and/or access to the Plex server, you can manually add them by clicking the **Create Local User** button.
+
+#### Email Address
+
+Enter a valid email address at which the user can receive messages pertaining to their account and other notifications. The email address currently cannot be modified after the account is created.
+
+#### Automatically Generate Password
+
+If an [application URL](/using-jellyseerr/settings/general#application-url) is set and [email notifications](/using-jellyseerr/notifications/email) have been configured and enabled, Overseerr can automatically generate a password for the new user.
+
+#### Password
+
+If you would prefer to manually configure a password, enter a password here that is a minimum of 8 characters.

docs/using-jellyseerr/users/deleting-users.md

@@ -0,0 +1,9 @@
+---
+title: Deleting Users
+description: Delete users from Jellyseerr.
+sidebar_position: 4
+---
+
+# Deleting Users
+
+When users are deleted, all of their data and request history is also cleared from the database.

docs/using-jellyseerr/users/editing-users.md

@@ -0,0 +1,62 @@
+---
+title: Editing Users
+description: Edit user settings and permissions.
+sidebar_position: 3
+---
+
+# Editing Users
+
+From the **User List**, you can click the **Edit** button to modify a particular user's settings.
+
+You can also click the check boxes and click the **Bulk Edit** button to set user permissions for multiple users at once.
+
+## General
+
+### Display Name
+
+You can optionally set a "friendly name" for any user. This name will be used in lieu of their media server (Jellyfin/Emby/Plex) username (for users imported from the media server) or their email address (for manually-created local users).
+
+### Email
+
+:::note
+This field is read-only for users imported from Plex.
+:::
+You can optionally set a proper email address for any user. This email address will be used for notifications, local sign-in and password resets.
+
+By default, users imported from Jellyfin/Emby will use their media server username as their email address.
+
+:::warning
+You cannot leave this field blank.
+:::
+
+### Display Language
+
+Users can override the [global display language](/using-jellyseerr/settings/general#display-language) to use Jellyseerr in their preferred language.
+
+### Discover Region & Discover Language
+
+Users can override the [global filter settings](/using-jellyseerr/settings/general#discover-region-and-discover-language) to suit their own preferences.
+
+### Movie Request Limit & Series Request Limit
+
+You can override the default settings and assign different request limits for specific users by checking the **Enable Override** box and selecting the desired request limit and time period.
+
+Unless an override is configured, users are granted the global request limits.
+
+Note that users with the **Manage Users** permission are exempt from request limits, since that permission also grants the ability to submit requests on behalf of other users.
+
+Users are also unable to modify their own request limits.
+
+## Password
+
+All "local users" are assigned passwords upon creation, but users imported from Plex can also optionally configure passwords to enable sign-in using their email address.
+
+Passwords must be a minimum of 8 characters long.
+
+## Notifications
+
+Users can configure their personal notification settings here. Please see [Notifications](/using-jellyseerr/notifications/) for details on configuring and enabling notifications.
+
+## Permissions
+
+Users cannot modify their own permissions. Users with the **Manage Users** permission can manage permissions of other users, except those of users with the **Admin** permission.

docs/using-jellyseerr/users/owner.md

@@ -0,0 +1,17 @@
+---
+title: Owner Account
+description: Your owner account is the primary account for managing Jellyseerr.
+sidebar_position: 1
+---
+
+# Owner Account
+
+The user account created during Jellyseerr setup is the "Owner" account, which cannot be deleted or modified by other users. This account's credentials are used to authenticate with your media server and configure Jellyseerr settings.
+
+:::note
+In case of Jellyfin/Emby, the owner account is also used for API access to your media server. This account should have a valid authentication token for your media server.
+:::
+
+:::tip
+If your authentication token is ever invalidated or changed, you can refresh it by re-authenticating with your media server.
+:::

docs/using-overseerr/notifications/README.md

@@ -1,26 +0,0 @@
-# Notifications
-
-## Supported Notification Agents
-
-Overseerr currently supports the following notification agents:
-
-- [Email](./email.md)
-- [Web Push](./webpush.md)
-- [Discord](./discord.md)
-- [Gotify](./gotify.md)
-- [LunaSea](./lunasea.md)
-- [Pushbullet](./pushbullet.md)
-- [Pushover](./pushover.md)
-- [Slack](./slack.md)
-- [Telegram](./telegram.md)
-- [Webhooks](./webhooks.md)
-
-## Setting Up Notifications
-
-Simply configure your desired notification agents in **Settings → Notifications**.
-
-Users can customize their personal notification preferences in their own user notification settings.
-
-## Requesting New Notification Agents
-
-If we do not currently support your preferred notification agent, feel free to [submit a feature request on GitHub](https://github.com/sct/overseerr/issues). However, please be sure to search first and confirm that there is not already an existing request for the agent!

docs/using-overseerr/notifications/gotify.md

@@ -1,15 +0,0 @@
-# Gotify
-
-## Configuration
-
-### Server URL
-
-Set this to the URL of your Gotify server.
-
-### Application Token
-
-Add an application to your Gotify server, and set this field to the generated application token.
-
-{% hint style="info" %}
-Please refer to the [Gotify API documentation](https://gotify.net/docs) for more details on configuring these notifications.
-{% endhint %}

docs/using-overseerr/notifications/lunasea.md

@@ -1,17 +0,0 @@
-# LunaSea
-
-## Configuration
-
-### Webhook URL
-
-Copy either a device- or user-based webhook URL from the LunaSea app into this field.
-
-### Profile Name (optional)
-
-If not using the `default` profile in the LunaSea app, specify the name of the profile here.
-
-Note that the entered profile name **_must_** match the name in LunaSea exactly (including any capitalization, punctuation, and/or whitespace).
-
-{% hint style="info" %}
-Please refer to the [LunaSea documentation](https://docs.lunasea.app/lunasea/notifications/overseerr) for more details on configuring these notifications.
-{% endhint %}

docs/using-overseerr/notifications/pushbullet.md

@@ -1,17 +0,0 @@
-# Pushbullet
-
-{% hint style="info" %}
-Users can optionally configure personal notifications in their user settings.
-
-User notifications are separate from system notifications, and the available notification types are dependent on user permissions.
-{% endhint %}
-
-## Configuration
-
-### Access Token
-
-[Create an access token](https://www.pushbullet.com/#settings) and set it here to grant Overseerr access to the Pushbullet API.
-
-### Channel Tag (optional)
-
-Optionally, [create a channel](https://www.pushbullet.com/my-channel) to allow other users to follow the notification feed using the specified channel tag.

docs/using-overseerr/notifications/pushover.md

@@ -1,21 +0,0 @@
-# Pushover
-
-{% hint style="info" %}
-Users can optionally configure personal notifications in their user settings.
-
-User notifications are separate from system notifications, and the available notification types are dependent on user permissions.
-{% endhint %}
-
-## Configuration
-
-### Application/API Token
-
-[Register an application](https://pushover.net/apps/build) and enter the API token in this field. (You can use one of the [official icons in our GitHub repository](https://github.com/fallenbagel/jellyseerr/tree/develop/public) when configuring the application.)
-
-For more details on registering applications or the API token, please see the [Pushover API documentation](https://pushover.net/api#registration).
-
-### User Key
-
-Set this to the user key for your Pushover account. Alternatively, you can set this to a group key to deliver notifications to multiple users.
-
-For more details, please see the [Pushover API documentation](https://pushover.net/api#identifiers).

docs/using-overseerr/notifications/slack.md

@@ -1,11 +0,0 @@
-# Slack
-
-## Configuration
-
-### Webhook URL
-
-Simply [create a webhook](https://my.slack.com/services/new/incoming-webhook/) and enter the URL in this field.
-
-{% hint style="info" %}
-Please refer to the [Slack API documentation](https://api.slack.com/messaging/webhooks) for more details on configuring these notifications.
-{% endhint %}

docs/using-overseerr/notifications/telegram.md

@@ -1,33 +0,0 @@
-# Telegram
-
-{% hint style="info" %}
-Users can optionally configure personal notifications in their user settings.
-
-User notifications are separate from system notifications, and the available notification types are dependent on user permissions.
-{% endhint %}
-
-## Configuration
-
-{% hint style="info" %}
-In order to configure Telegram notifications, you first need to [create a bot](https://telegram.me/BotFather).
-
-Bots **cannot** initiate conversations with users, so users must have your bot added to a conversation in order to receive notifications.
-{% endhint %}
-
-### Bot Username (optional)
-
-If this value is configured, users will be able to click a link to start a chat with your bot and configure their own personal notifications.
-
-The bot username should end with `_bot`, and the `@` prefix should be omitted.
-
-### Bot Authentication Token
-
-At the end of the bot creation process, [@BotFather](https://telegram.me/botfather) will provide an authentication token.
-
-### Chat ID
-
-To obtain your chat ID, simply create a new group chat, add [@get_id_bot](https://telegram.me/get_id_bot), and issue the `/my_id` command.
-
-### Send Silently (optional)
-
-Optionally, notifications can be sent silently. Silent notifications send messages without notification sounds.

docs/using-overseerr/notifications/webhooks.md

@@ -1,132 +0,0 @@
-# Webhook
-
-The webhook notification agent enables you to send a custom JSON payload to any endpoint for specific notification events.
-
-## Configuration
-
-### Webhook URL
-
-The URL you would like to post notifications to. Your JSON will be sent as the body of the request.
-
-### Authorization Header (optional)
-
-{% hint style="info" %}
-This is typically not needed. Please refer to your webhook provider's documentation for details.
-{% endhint %}
-
-This value will be sent as an `Authorization` HTTP header.
-
-### JSON Payload
-
-Customize the JSON payload to suit your needs. Overseerr provides several [template variables](#template-variables) for use in the payload, which will be replaced with the relevant data when the notifications are triggered.
-
-## Template Variables
-
-### General
-
-| Variable                | Value                                                                                                                               |
-| ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
-| `{{notification_type}}` | The type of notification (e.g. `MEDIA_PENDING` or `ISSUE_COMMENT`)                                                                  |
-| `{{event}}`             | A friendly description of the notification event                                                                                    |
-| `{{subject}}`           | The notification subject (typically the media title)                                                                                |
-| `{{message}}`           | The notification message body (the media overview/synopsis for request notifications; the issue description for issue notificatons) |
-| `{{image}}`             | The notification image (typically the media poster)                                                                                 |
-
-### Notify User
-
-These variables are for the target recipient of the notification.
-
-| Variable                                 | Value                                                         |
-| ---------------------------------------- | ------------------------------------------------------------- |
-| `{{notifyuser_username}}`                | The target notification recipient's username                  |
-| `{{notifyuser_email}}`                   | The target notification recipient's email address             |
-| `{{notifyuser_avatar}}`                  | The target notification recipient's avatar URL                |
-| `{{notifyuser_settings_discordId}}`      | The target notification recipient's Discord ID (if set)       |
-| `{{notifyuser_settings_telegramChatId}}` | The target notification recipient's Telegram Chat ID (if set) |
-
-{% hint style="info" %}
-The `notifyuser` variables are not defined for the following request notification types, as they are intended for application administrators rather than end users:
-
-- Request Pending Approval
-- Request Automatically Approved
-- Request Processing Failed
-
-On the other hand, the `notifyuser` variables _will_ be replaced with the requesting user's information for the below notification types:
-
-- Request Approved
-- Request Declined
-- Request Available
-
-If you would like to use the requesting user's information in your webhook, please instead include the relevant variables from the [Request](#request) section below.
-{% endhint %}
-
-### Special
-
-The following variables must be used as a key in the JSON payload (e.g., `"{{extra}}": []`).
-
-| Variable      | Value                                                                                                                          |
-| ------------- | ------------------------------------------------------------------------------------------------------------------------------ |
-| `{{media}}`   | The relevant media object                                                                                                      |
-| `{{request}}` | The relevant request object                                                                                                    |
-| `{{issue}}`   | The relevant issue object                                                                                                      |
-| `{{comment}}` | The relevant issue comment object                                                                                              |
-| `{{extra}}`   | The "extra" array of additional data for certain notifications (e.g., season/episode numbers for series-related notifications) |
-
-#### Media
-
-The `{{media}}` will be `null` if there is no relevant media object for the notification.
-
-These following special variables are only included in media-related notifications, such as requests.
-
-| Variable             | Value                                                                                                          |
-| -------------------- | -------------------------------------------------------------------------------------------------------------- |
-| `{{media_type}}`     | The media type (`movie` or `tv`)                                                                               |
-| `{{media_tmdbid}}`   | The media's TMDB ID                                                                                            |
-| `{{media_tvdbid}}`   | The media's TheTVDB ID                                                                                         |
-| `{{media_status}}`   | The media's availability status (`UNKNOWN`, `PENDING`, `PROCESSING`, `PARTIALLY_AVAILABLE`, or `AVAILABLE`)    |
-| `{{media_status4k}}` | The media's 4K availability status (`UNKNOWN`, `PENDING`, `PROCESSING`, `PARTIALLY_AVAILABLE`, or `AVAILABLE`) |
-
-#### Request
-
-The `{{request}}` will be `null` if there is no relevant media object for the notification.
-
-The following special variables are only included in request-related notifications.
-
-| Variable                                  | Value                                           |
-| ----------------------------------------- | ----------------------------------------------- |
-| `{{request_id}}`                          | The request ID                                  |
-| `{{requestedBy_username}}`                | The requesting user's username                  |
-| `{{requestedBy_email}}`                   | The requesting user's email address             |
-| `{{requestedBy_avatar}}`                  | The requesting user's avatar URL                |
-| `{{requestedBy_settings_discordId}}`      | The requesting user's Discord ID (if set)       |
-| `{{requestedBy_settings_telegramChatId}}` | The requesting user's Telegram Chat ID (if set) |
-
-#### Issue
-
-The `{{issue}}` will be `null` if there is no relevant media object for the notification.
-
-The following special variables are only included in issue-related notifications.
-
-| Variable                                 | Value                                           |
-| ---------------------------------------- | ----------------------------------------------- |
-| `{{issue_id}}`                           | The issue ID                                    |
-| `{{reportedBy_username}}`                | The requesting user's username                  |
-| `{{reportedBy_email}}`                   | The requesting user's email address             |
-| `{{reportedBy_avatar}}`                  | The requesting user's avatar URL                |
-| `{{reportedBy_settings_discordId}}`      | The requesting user's Discord ID (if set)       |
-| `{{reportedBy_settings_telegramChatId}}` | The requesting user's Telegram Chat ID (if set) |
-
-#### Comment
-
-The `{{comment}}` will be `null` if there is no relevant media object for the notification.
-
-The following special variables are only included in issue comment-related notifications.
-
-| Variable                                  | Value                                           |
-| ----------------------------------------- | ----------------------------------------------- |
-| `{{comment_message}}`                     | The comment message                             |
-| `{{commentedBy_username}}`                | The commenting user's username                  |
-| `{{commentedBy_email}}`                   | The commenting user's email address             |
-| `{{commentedBy_avatar}}`                  | The commenting user's avatar URL                |
-| `{{commentedBy_settings_discordId}}`      | The commenting user's Discord ID (if set)       |
-| `{{commentedBy_settings_telegramChatId}}` | The commenting user's Telegram Chat ID (if set) |

docs/using-overseerr/notifications/webpush.md

@@ -1,17 +0,0 @@
-# Web Push
-
-The web push notification agent enables you and your users to receive Overseerr notifications in a supported browser.
-
-This notification agent does not require any configuration, but is not enabled in Overseerr by default.
-
-{% hint style="warning" %}
-**The web push agent only works via HTTPS.** Refer to our [reverse proxy examples](../../extending-overseerr/reverse-proxy.md) for help on proxying Overseerr traffic via HTTPS.
-{% endhint %}
-
-To set up web push notifications, simply enable the agent in **Settings → Notifications → Web Push**. You and your users will then be prompted to allow notifications in your web browser.
-
-Users can opt out of these notifications, or customize the notification types they would like to subscribe to, in their user settings.
-
-{% hint style="info" %}
-Web push notifications offer a native notification experience without the need to install an app. iOS devices do not have support for these notifications at this time, however.
-{% endhint %}

docs/using-overseerr/settings/README.md

@@ -1,221 +0,0 @@
-# Settings
-
-## General
-
-### API Key
-
-This is your Overseerr API key, which can be used to integrate Overseerr with third-party applications. Do **not** share this key publicly, as it can be used to gain administrator access!
-
-If you need to generate a new API key for any reason, simply click the button to the right of the text box.
-
-### Application Title
-
-If you aren't a huge fan of the name "Overseerr" and would like to display something different to your users, you can customize the application title!
-
-### Application URL
-
-Set this to the externally-accessible URL of your Overseerr instance.
-
-You must configure this setting in order to enable password reset and [generation](../users/README.md#automatically-generate-password) emails.
-
-### Enable Proxy Support
-
-If you have Overseerr behind a [reverse proxy](../../extending-overseerr/reverse-proxy.md), enable this setting to allow Overseerr to correctly register client IP addresses. For details, please see the [Express documentation](http://expressjs.com/en/guide/behind-proxies.html).
-
-This setting is **disabled** by default.
-
-### Enable CSRF Protection
-
-{% hint style="danger" %}
-**This is an advanced setting.** We do not recommend enabling it unless you understand the implications of doing so.
-{% endhint %}
-
-CSRF stands for [cross-site request forgery](https://en.wikipedia.org/wiki/Cross-site_request_forgery). When this setting is enabled, all external API access that alters Overseerr application data is blocked.
-
-If you do not use Overseerr integrations with third-party applications to add/modify/delete requests or users, you can consider enabling this setting to protect against malicious attacks.
-
-One caveat, however, is that _HTTPS is required_, meaning that once this setting is enabled, you will no longer be able to access your Overseerr instance over HTTP (including using an IP address and port number).
-
-If you enable this setting and find yourself unable to access Overseerr, you can disable the setting by modifying `settings.json` in `/app/config`.
-
-This setting is **disabled** by default.
-
-### Enable Image Caching
-
-When enabled, Overseerr will proxy and cache images from pre-configured sources (such as TMDB). This can use a significant amount of disk space.
-
-Images are saved in the `config/cache/images` and stale images are cleared out every 24 hours.
-
-You should enable this if you are having issues with loading images directly from TMDB in your browser.
-
-### Display Language
-
-Set the default display language for Overseerr. Users can override this setting in their user settings.
-
-### Discover Region & Discover Language
-
-These settings filter content shown on the "Discover" home page based on regional availability and original language, respectively. Users can override these global settings by configuring these same options in their user settings.
-
-### Hide Available Media
-
-When enabled, media which is already available will not appear on the "Discover" home page, or in the "Recommended" or "Similar" categories or other links on media detail pages.
-
-Available media will still appear in search results, however, so it is possible to locate and view hidden items by searching for them by title.
-
-This setting is **disabled** by default.
-
-### Allow Partial Series Requests
-
-When enabled, users will be able to submit requests for specific seasons of TV series. If disabled, users will only be able to submit requests for all unavailable seasons.
-
-This setting is **enabled** by default.
-
-## Users
-
-### Enable Local Sign-In
-
-When enabled, users who have configured passwords will be allowed to sign in using their email address.
-
-When disabled, Plex OAuth becomes the only sign-in option, and any "local users" you have created will not be able to sign in to Overseerr.
-
-This setting is **enabled** by default.
-
-### Enable New Plex Sign-In
-
-When enabled, users with access to your Plex server will be able to sign in to Overseerr even if they have not yet been imported. Users will be automatically assigned the permissions configured in the [Default Permissions](#default-permissions) setting upon first sign-in.
-
-This setting is **enabled** by default.
-
-### Global Movie Request Limit & Global Series Request Limit
-
-Select the request limits you would like granted to users.
-
-Unless an [override](../users/README.md#movie-request-limit-and-series-request-limit) is configured, users are granted these global request limits.
-
-Note that users with the **Manage Users** permission are exempt from request limits, since that permission also grants the ability to submit requests on behalf of other users.
-
-### Default Permissions
-
-Select the permissions you would like assigned to new users to have by default upon account creation.
-
-If [Enable New Plex Sign-In](#enable-new-plex-sign-in) is enabled, any user with access to your Plex server will be able to sign in to Overseerr, and they will be granted the permissions you select here upon first sign-in.
-
-This setting only affects new users, and has no impact on existing users. In order to modify permissions for existing users, you will need to [edit the users](../users/README.md#editing-users).
-
-## Plex
-
-### Plex Settings
-
-{% hint style="info" %}
-To set up Plex, you can either enter your details manually or select a server retrieved from [plex.tv](https://plex.tv/). Press the button to the right of the "Server" dropdown to retrieve available servers.
-
-Depending on your setup/configuration, you may need to enter your Plex server details manually in order to establish a connection from Overseerr.
-{% endhint %}
-
-#### Hostname or IP Address
-
-If you have Overseerr installed on the same network as Plex, you can set this to the local IP address of your Plex server. Otherwise, this should be set to a valid hostname (e.g., `plex.myawesomeserver.com`).
-
-#### Port
-
-This value should be set to the port that your Plex server listens on. The default port that Plex uses is `32400`, but you may need to set this to `443` or some other value if your Plex server is hosted on a VPS or cloud provider.
-
-#### Use SSL
-
-Enable this setting to connect to Plex via HTTPS rather than HTTP. Note that self-signed certificates are _not_ supported.
-
-#### Web App URL (optional)
-
-The **Play on Plex** buttons on media pages link to items on your Plex server. By default, these links use the [Plex Web App](https://support.plex.tv/articles/200288666-opening-plex-web-app/) hosted from plex.tv, but you can provide the URL to the web app on your Plex server and we'll use that instead!
-
-Note that you will need to enter the full path to the web app (e.g., `https://plex.myawesomeserver.com/web`).
-
-### Plex Libraries
-
-In this section, simply select the libraries you would like Overseerr to scan. Overseerr will periodically check the selected libraries for available content to update the media status that is displayed to users.
-
-If you do not see your Plex libraries listed, verify your Plex settings are correct and click the **Sync Libraries** button.
-
-### Manual Library Scan
-
-Overseerr will perform a full scan of your Plex libraries once every 24 hours (recently added items are fetched more frequently). If this is your first time configuring Plex, a one-time full manual library scan is recommended!
-
-## Services
-
-{% hint style="info" %}
-**If you keep separate copies of non-4K and 4K content in your media libraries, you will need to set up multiple Radarr/Sonarr instances and link each of them to Overseerr.**
-
-Overseerr checks these linked servers to determine whether or not media has already been requested or is available, so two servers of each type are required _if you keep separate non-4K and 4K copies of media_.
-
-**If you only maintain one copy of media, you can instead simply set up one server and set the "Quality Profile" setting on a per-request basis.**
-{% endhint %}
-
-### Radarr/Sonarr Settings
-
-{% hint style="warning" %}
-**Only v3 Radarr/Sonarr servers are supported!** If your Radarr/Sonarr server is still running v2, you will need to upgrade in order to add it to Overseerr.
-{% endhint %}
-
-#### Default Server
-
-At least one server needs to be marked as "Default" in order for requests to be sent successfully to Radarr/Sonarr.
-
-If you have separate 4K Radarr/Sonarr servers, you need to designate default 4K servers _in addition to_ default non-4K servers.
-
-#### 4K Server
-
-Only select this option if you have separate non-4K and 4K servers. If you only have a single Radarr/Sonarr server, do _not_ check this box!
-
-#### Server Name
-
-Enter a friendly name for the Radarr/Sonarr server.
-
-#### Hostname or IP Address
-
-If you have Overseerr installed on the same network as Radarr/Sonarr, you can set this to the local IP address of your Radarr/Sonarr server. Otherwise, this should be set to a valid hostname (e.g., `radarr.myawesomeserver.com`).
-
-#### Port
-
-This value should be set to the port that your Radarr/Sonarr server listens on. By default, Radarr uses port `7878` and Sonarr uses port `8989`, but you may need to set this to `443` or some other value if your Radarr/Sonarr server is hosted on a VPS or cloud provider.
-
-#### Use SSL
-
-Enable this setting to connect to Radarr/Sonarr via HTTPS rather than HTTP. Note that self-signed certificates are _not_ supported.
-
-#### API Key
-
-Enter your Radarr/Sonarr API key here. Do _not_ share these key publicly, as they can be used to gain administrator access to your Radarr/Sonarr servers!
-
-You can locate the required API keys in Radarr/Sonarr in **Settings → General → Security**.
-
-#### URL Base
-
-If you have configured a URL base for your Radarr/Sonarr server, you _must_ enter it here in order for Overseerr to connect to those services!
-
-You can verify whether or not you have a URL base configured in your Radarr/Sonarr server at **Settings → General → Host**. (Note that a restart of your Radarr/Sonarr server is required if you modify this setting!)
-
-#### Profiles, Root Folder, Minimum Availability
-
-Select the default settings you would like to use for all new requests. Note that all of these options are required, and that requests will fail if any of these are not configured!
-
-#### External URL (optional)
-
-If the hostname or IP address you configured above is not accessible outside your network, you can set a different URL here. This "external" URL is used to add clickable links to your Radarr/Sonarr servers on media detail pages.
-
-#### Enable Scan (optional)
-
-Enable this setting if you would like to scan your Radarr/Sonarr server for existing media/request status. It is recommended that you enable this setting, so that users cannot submit requests for media which has already been requested or is already available.
-
-#### Enable Automatic Search (optional)
-
-Enable this setting to have Radarr/Sonarr to automatically search for media upon approval of a request.
-
-## Notifications
-
-Please see [Notifications](../notifications/README.md) for details on configuring and enabling notifications.
-
-## Jobs & Cache
-
-Overseerr performs certain maintenance tasks as regularly-scheduled jobs, but they can also be manually triggered on this page.
-
-Overseerr also caches requests to external API endpoints to optimize performance and avoid making unnecessary API calls. If necessary, the cache for any particular endpoint can be cleared by clicking the "Flush Cache" button.

docs/using-overseerr/users/README.md

@@ -1,79 +0,0 @@
-# Users
-
-## Owner Account
-
-The user account created during Overseerr setup is the "Owner" account, which cannot be deleted or modified by other users. This account's credentials are used to authenticate with Plex.
-
-## Adding Users
-
-There are currently two methods to add users to Overseerr: importing Plex users and creating "local users." All new users are created with the [default permissions](../settings/README.md#default-permissions) defined in **Settings → Users**.
-
-### Importing Plex Users
-
-Clicking the **Import Plex Users** button on the **User List** page will fetch the list of users with access to the Plex server from [plex.tv](https://www.plex.tv/), and add them to Overseerr automatically.
-
-Importing Plex users is not required, however. Any user with access to the Plex server can log in to Overseerr even if they have not been imported, and will be assigned the configured [default permissions](../settings/README.md#default-permissions) upon their first login.
-
-### Creating Local Users
-
-If you would like to grant Overseerr access to a user who doesn't have their own Plex account and/or access to the Plex server, you can manually add them by clicking the **Create Local User** button.
-
-#### Email Address
-
-Enter a valid email address at which the user can receive messages pertaining to their account and other notifications. The email address currently cannot be modified after the account is created.
-
-#### Automatically Generate Password
-
-If an [application URL](../settings/README.md#application-url) is set and [email notifications](../notifications/email.md) have been configured and enabled, Overseerr can automatically generate a password for the new user.
-
-#### Password
-
-If you would prefer to manually configure a password, enter a password here that is a minimum of 8 characters.
-
-## Editing Users
-
-From the **User List**, you can click the **Edit** button to modify a particular user's settings.
-
-You can also click the check boxes and click the **Bulk Edit** button to set user permissions for multiple users at once.
-
-### General
-
-#### Display Name
-
-You can optionally set a "friendly name" for any user. This name will be used in lieu of their Plex username (for users imported from Plex) or their email address (for manually-created local users).
-
-#### Display Language
-
-Users can override the [global display language](../settings/README.md#display-language) to use Overseerr in their preferred language.
-
-#### Discover Region & Discover Language
-
-Users can override the [global filter settings](../settings/README.md#discover-region-and-discover-language) to suit their own preferences.
-
-#### Movie Request Limit & Series Request Limit
-
-You can override the default settings and assign different request limits for specific users by checking the **Enable Override** box and selecting the desired request limit and time period.
-
-Unless an override is configured, users are granted the global request limits.
-
-Note that users with the **Manage Users** permission are exempt from request limits, since that permission also grants the ability to submit requests on behalf of other users.
-
-Users are also unable to modify their own request limits.
-
-### Password
-
-All "local users" are assigned passwords upon creation, but users imported from Plex can also optionally configure passwords to enable sign-in using their email address.
-
-Passwords must be a minimum of 8 characters long.
-
-### Notifications
-
-Users can configure their personal notification settings here. Please see [Notifications](../notifications/README.md) for details on configuring and enabling notifications.
-
-### Permissions
-
-Users cannot modify their own permissions. Users with the **Manage Users** permission can manage permissions of other users, except those of users with the **Admin** permission.
-
-## Deleting Users
-
-When users are deleted, all of their data and request history is also cleared from the database.

gen-docs/.gitignore

@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

gen-docs/README.md

@@ -0,0 +1,27 @@
+# Jellyseerr Documentation
+
+Jellyseerr docs is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
+
+Jellyseerr docs will be available at [docs.jellyseerr.com](https://docs.jellyseerr.dev).
+
+### Installation
+
+```
+$ pnpm
+```
+
+### Local Development
+
+```
+$ pnpm start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+### Build
+
+```
+$ pnpm build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.

gen-docs/babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};

gen-docs/docusaurus.config.ts

@@ -0,0 +1,115 @@
+import type * as Preset from '@docusaurus/preset-classic';
+import type { Config } from '@docusaurus/types';
+import { themes as prismThemes } from 'prism-react-renderer';
+
+const config: Config = {
+  title: 'Jellyseerr',
+  tagline: 'One Stop Solution for all your media request needs',
+  favicon: 'img/favicon.ico',
+
+  url: 'https://docs.jellyseerr.dev',
+  baseUrl: '/',
+  trailingSlash: false,
+
+  organizationName: 'Fallenbagel',
+  projectName: 'Jellyseerr',
+
+  onBrokenLinks: 'throw',
+  onBrokenMarkdownLinks: 'warn',
+
+  i18n: {
+    defaultLocale: 'en',
+    locales: ['en'],
+  },
+
+  presets: [
+    [
+      'classic',
+      {
+        docs: {
+          sidebarPath: './sidebars.ts',
+          routeBasePath: '/',
+          path: '../docs',
+          editUrl:
+            'https://github.com/Fallenbagel/jellyseerr/edit/develop/docs/',
+        },
+        blog: false,
+        pages: false,
+        theme: {
+          customCss: './src/css/custom.css',
+        },
+      } satisfies Preset.Options,
+    ],
+  ],
+
+  themes: [
+    [
+      '@easyops-cn/docusaurus-search-local',
+      /**  @type {import("@easyops-cn/docusaurus-search-local").PluginOptions}  */
+      {
+        hashed: true,
+        indexBlog: false,
+        docsDir: '../docs',
+        docsRouteBasePath: '/',
+        explicitSearchResultPath: true,
+      },
+    ],
+  ],
+
+  themeConfig: {
+    image: 'img/docusaurus-social-card.jpg',
+    colorMode: {
+      defaultMode: 'dark',
+      disableSwitch: true,
+      respectPrefersColorScheme: false,
+    },
+    navbar: {
+      logo: {
+        alt: 'Jellyseerr',
+        src: 'img/logo.svg',
+      },
+      items: [
+        {
+          href: 'https://github.com/Fallenbagel/jellyseerr',
+          label: 'GitHub',
+          position: 'right',
+        },
+      ],
+    },
+    footer: {
+      style: 'dark',
+      links: [
+        {
+          title: 'Docs',
+          items: [
+            {
+              label: 'Documentation',
+              to: '/',
+            },
+          ],
+        },
+        {
+          title: 'Community',
+          items: [
+            {
+              label: 'Discord',
+              href: 'https://discord.gg/ckbvBtDJgC',
+            },
+            {
+              label: 'Github Discussions',
+              href: 'https://github.com/fallenbagel/jellyseerr/discussions',
+            },
+          ],
+        },
+      ],
+      copyright: `Copyright © ${new Date().getFullYear()} Jellyseerr. Built with Docusaurus.`,
+    },
+    prism: {
+      theme: prismThemes.shadesOfPurple,
+      darkTheme: prismThemes.shadesOfPurple,
+      additionalLanguages: ['bash', 'powershell', 'yaml', 'nix', 'nginx'],
+    },
+  } satisfies Preset.ThemeConfig,
+};
+
+export default config;

gen-docs/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "gen-docs",
+  "version": "0.0.0",
+  "private": true,
+  "scripts": {
+    "docusaurus": "docusaurus",
+    "start": "docusaurus start",
+    "build": "docusaurus build",
+    "swizzle": "docusaurus swizzle",
+    "deploy": "docusaurus deploy",
+    "clear": "docusaurus clear",
+    "serve": "docusaurus serve",
+    "write-translations": "docusaurus write-translations",
+    "write-heading-ids": "docusaurus write-heading-ids",
+    "typecheck": "tsc"
+  },
+  "dependencies": {
+    "@docusaurus/core": "3.4.0",
+    "@docusaurus/preset-classic": "3.4.0",
+    "@easyops-cn/docusaurus-search-local": "^0.44.2",
+    "@mdx-js/react": "^3.0.0",
+    "clsx": "^2.0.0",
+    "prism-react-renderer": "^2.3.0",
+    "react": "^18.0.0",
+    "react-dom": "^18.0.0",
+    "tailwindcss": "^3.4.4"
+  },
+  "devDependencies": {
+    "@docusaurus/module-type-aliases": "3.4.0",
+    "@docusaurus/tsconfig": "3.4.0",
+    "@docusaurus/types": "3.4.0",
+    "typescript": "~5.2.2"
+  },
+  "resolutions": {
+    "prismjs": "PrismJS/prism"
+  },
+  "browserslist": {
+    "production": [
+      ">0.5%",
+      "not dead",
+      "not op_mini all"
+    ],
+    "development": [
+      "last 3 chrome version",
+      "last 3 firefox version",
+      "last 5 safari version"
+    ]
+  },
+  "engines": {
+    "node": ">=18.0"
+  }
+}

gen-docs/sidebars.ts

@@ -0,0 +1,31 @@
+import type { SidebarsConfig } from '@docusaurus/plugin-content-docs';
+
+/**
+ * Creating a sidebar enables you to:
+ - create an ordered group of docs
+ - render a sidebar for each doc of that group
+ - provide next/previous navigation
+
+ The sidebars can be generated from the filesystem, or explicitly defined here.
+
+ Create as many sidebars as you want.
+ */
+const sidebars: SidebarsConfig = {
+  // By default, Docusaurus generates a sidebar from the docs folder structure
+  documentationSidebar: [{ type: 'autogenerated', dirName: '.' }],
+
+  // But you can create a sidebar manually
+  /*
+  tutorialSidebar: [
+    'intro',
+    'hello',
+    {
+      type: 'category',
+      label: 'Tutorial',
+      items: ['tutorial-basics/create-a-document'],
+    },
+  ],
+   */
+};
+
+export default sidebars;

gen-docs/src/components/JellyseerrVersion/index.tsx

@@ -0,0 +1,67 @@
+import { useEffect, useState } from 'react';
+
+export const JellyseerrVersion = () => {
+  const [version, setVersion] = useState<string | null>('0.0.0');
+
+  useEffect(() => {
+    async function fetchVersion() {
+      try {
+        const response = await fetch(
+          'https://raw.githubusercontent.com/Fallenbagel/jellyseerr/main/package.json'
+        );
+
+        const data = await response.json();
+
+        setVersion(data.version);
+        console.log(data.version);
+      } catch (error) {
+        console.error('Failed to fetch version', error);
+        setVersion('Error fetching version');
+      }
+    }
+    fetchVersion();
+  }, []);
+
+  return version;
+};
+
+export const NixpkgVersion = () => {
+  const [version, setVersion] = useState(null);
+  const [loading, setLoading] = useState(true);
+  const [error, setError] = useState(null);
+
+  useEffect(() => {
+    const fetchVersion = async () => {
+      try {
+        const url =
+          'https://raw.githubusercontent.com/NixOS/nixpkgs/nixos-unstable/pkgs/servers/jellyseerr/default.nix';
+        const response = await fetch(url);
+        const data = await response.text();
+
+        const versionRegex = /version\s*=\s*"([^"]+)"/;
+        const match = data.match(versionRegex);
+        if (match && match[1]) {
+          setVersion(match[1]);
+        } else {
+          setError('0.0.0');
+        }
+        setLoading(false);
+      } catch (err) {
+        setError(err.message);
+        setLoading(false);
+      }
+    };
+
+    fetchVersion();
+  }, []);
+
+  if (loading) {
+    return 'Loading...';
+  }
+
+  if (error) {
+    return { error };
+  }
+
+  return version;
+};

gen-docs/src/css/custom.css

@@ -0,0 +1,106 @@
+/**
+ * Any CSS included here will be global. The classic template
+ * bundles Infima by default. Infima is a CSS framework designed to
+ * work well for content-centric websites.
+ */
+
+/* You can override the default Infima variables here. */
+/* :root {
+  --ifm-color-scheme: dark;
+  --ifm-background-color: #151d2c;
+  --ifm-navbar-background-color: #151d2c;
+  --ifm-color-content: #fff;
+  --ifm-color-content-secondary: #888f9b;
+  --ifm-color-primary: var(--ifm-color-content);
+  --ifm-hover-overlay: #374151;
+  --ifm-menu-color-background-active: #793ae8;
+  --ifm-color-primary-dark: #1f2b7f;
+  --ifm-color-primary-darker: #16206b;
+  --ifm-color-primary-darkest: #0d1456;
+  --ifm-color-primary-light: #9066e3;
+  --ifm-color-primary-lighter: #a37ff0;
+  --ifm-color-primary-lightest: #b8a3f9;
+  --ifm-code-font-size: 95%;
+  --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
+} */
+
+/* For readability concerns, you should choose a lighter palette in dark mode. */
+[data-theme='dark'] {
+  --ifm-color-scheme: dark;
+  --ifm-background-color: #151d2c !important;
+  --ifm-navbar-background-color: #151d2c;
+  --ifm-color-content: #fff;
+  --ifm-color-content-secondary: #888f9b;
+  --ifm-color-primary: var(--ifm-color-content);
+  --ifm-hover-overlay: #374151;
+  /* --ifm-menu-color-background-active: #793ae8; */
+  /* --ifm-menu-color-background-active: linear-gradient(
+    90deg,
+    #793ae8 0%,
+    #ff8c00 100%
+  ); */
+  --ifm-color-primary-dark: #1f2b7f;
+  --ifm-color-primary-darker: #16206b;
+  --ifm-color-primary-darkest: #0d1456;
+  --ifm-color-primary-light: #9066e3;
+  --ifm-color-primary-lighter: #a37ff0;
+  --ifm-color-primary-lightest: #b8a3f9;
+  --ifm-code-font-size: 95%;
+  --search-local-modal-background: #121a29;
+  /* --search-local-highlight-color: var(--ifm-hover-overlay); */
+  --search-local-highlight-color: #6366f1;
+  --search-local-hit-color: #fff;
+  --search-local-hit-background: #2d3748;
+  --search-local-hit-active-color: var(--ifm-color-primary);
+  --ifm-input-border-color: #ccc; /* Default border color */
+  --ifm-input-border-focus-color: red; /* Border color when focused */
+  --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
+  --ifm-navbar-search-input-icon: url('data:image/svg+xml;utf8,<svg fill="%23fff" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16" height="16px" width="16px"><path d="M6.02945,10.20327a4.17382,4.17382,0,1,1,4.17382-4.17382A4.15609,4.15609,0,0,1,6.02945,10.20327Zm9.69195,4.2199L10.8989,9.59979A5.88021,5.88021,0,0,0,12.058,6.02856,6.00467,6.00467,0,1,0,9.59979,10.8989l4.82338,4.82338a.89729.89729,0,0,0,1.29912,0,.89749.89749,0,0,0-.00087-1.29909Z" /></svg>');
+}
+
+.table-of-contents__link--active,
+a:not(
+    .card,
+    .menu__link,
+    .menu__link--sublist,
+    .menu__link--sublist-item,
+    .table-of-contents__link
+  ) {
+  /* color: #793ae8; */
+  color: #6366f1;
+}
+
+.card {
+  background-color: rgb(31 41 55/0.9);
+}
+
+.theme-admonition a {
+  color: #fff;
+}
+
+.menu__link--active,
+.menu__list-item-collapsible--active {
+  background: linear-gradient(0deg, #8238e9 0%, #5d42e6 100%);
+}
+
+/* .tabs__item--active {
+  background: linear-gradient(0deg, #8238e9 0%, #5d42e6 100%);
+} */
+
+.tabs__item {
+  border-bottom: 1px solid #fff;
+  border-bottom-left-radius: 0;
+  border-bottom-right-radius: 0;
+  padding: 0.5rem 1rem;
+}
+
+.tabs__item--active {
+  /* background: rgba(255, 255, 255, 0.1); */
+  color: #a37ff0;
+  border-bottom: 3px solid #a37ff0;
+}
+
+.footer {
+  background: var(--ifm-navbar-background-color);
+  border-top: 1px solid #2d3748;
+}

gen-docs/static/CNAME

@@ -0,0 +1 @@
+docs.jellyseerr.dev

gen-docs/tailwind.config.js

@@ -0,0 +1,7 @@
+module.exports = {
+  content: ['./src/components/**/*.{ts,tsx}'],
+  theme: {
+    extend: {},
+  },
+  plugins: [],
+};

gen-docs/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  // This file is not used in compilation. It is here just for a nice editor experience.
+  "extends": "@docusaurus/tsconfig",
+  "compilerOptions": {
+    "baseUrl": "."
+  }
+}

next.config.js

@@ -10,7 +10,11 @@ module.exports = {
     JELLYFIN_TYPE: process.env.JELLYFIN_TYPE,
   },
   images: {
-    domains: ['image.tmdb.org'],
+    remotePatterns: [
+      { hostname: 'gravatar.com' },
+      { hostname: 'image.tmdb.org' },
+      { hostname: '*', protocol: 'https' },
+    ],
   },
   webpack(config) {
     config.module.rules.push({

overseerr-api.yml

@@ -368,6 +368,9 @@ components:
         externalHostname:
           type: string
           example: 'http://my.jellyfin.host'
+        jellyfinForgotPasswordUrl:
+          type: string
+          example: 'http://my.jellyfin.host/web/index.html#!/forgotpassword.html'
         adminUser:
           type: string
           example: 'admin'
@@ -2089,6 +2092,13 @@ paths:
             application/json:
               schema:
                 type: array
+                items:
+                  type: object
+                  properties:
+                    username:
+                      type: string
+                    userId:
+                      type: integer
   /settings/jellyfin/sync:
     get:
       summary: Get status of full Jellyfin library sync
@@ -3392,6 +3402,12 @@ paths:
         Updates a single slider and return the newly updated slider. Requires the `ADMIN` permission.
       tags:
         - settings
+      parameters:
+        - in: path
+          name: sliderId
+          required: true
+          schema:
+            type: number
       requestBody:
         required: true
         content:
@@ -3721,7 +3737,7 @@ paths:
                   results:
                     type: array
                     items:
-                    $ref: '#/components/schemas/User'
+                      $ref: '#/components/schemas/User'
     post:
       summary: Create new user
       description: |

package.json

@@ -3,26 +3,28 @@
   "version": "0.1.0",
   "private": true,
   "scripts": {
+    "preinstall": "npx only-allow pnpm",
+    "postinstall": "node postinstall-win.js",
     "dev": "nodemon -e ts --watch server --watch overseerr-api.yml -e .json,.ts,.yml -x ts-node -r tsconfig-paths/register --files --project server/tsconfig.json server/index.ts",
     "build:server": "tsc --project server/tsconfig.json && copyfiles -u 2 server/templates/**/*.{html,pug} dist/templates && tsc-alias -p server/tsconfig.json",
     "build:next": "next build",
-    "build": "yarn build:next && yarn build:server",
+    "build": "pnpm build:next && pnpm build:server",
     "lint": "eslint \"./server/**/*.{ts,tsx}\" \"./src/**/*.{ts,tsx}\" --cache",
     "lintfix": "eslint \"./server/**/*.{ts,tsx}\" \"./src/**/*.{ts,tsx}\" --fix",
     "start": "NODE_ENV=production node dist/index.js",
-    "i18n:extract": "extract-messages -l=en -o src/i18n/locale -d en --flat true --overwriteDefault true \"./src/**/!(*.test).{ts,tsx}\"",
+    "i18n:extract": "ts-node --project server/tsconfig.json src/i18n/extractMessages.ts",
     "migration:generate": "ts-node -r tsconfig-paths/register --project server/tsconfig.json ./node_modules/typeorm/cli.js migration:generate -d server/datasource.ts",
     "migration:create": "ts-node -r tsconfig-paths/register --project server/tsconfig.json ./node_modules/typeorm/cli.js migration:create -d server/datasource.ts",
     "migration:run": "ts-node -r tsconfig-paths/register --project server/tsconfig.json ./node_modules/typeorm/cli.js migration:run -d server/datasource.ts",
     "format": "prettier --loglevel warn --write --cache .",
     "format:check": "prettier --check --cache .",
-    "typecheck": "yarn typecheck:server && yarn typecheck:client",
+    "typecheck": "pnpm typecheck:server && pnpm typecheck:client",
     "typecheck:server": "tsc --project server/tsconfig.json --noEmit",
     "typecheck:client": "tsc --noEmit",
     "prepare": "husky install",
     "cypress:open": "cypress open",
     "cypress:prepare": "ts-node -r tsconfig-paths/register --files --project server/tsconfig.json server/scripts/prepareTestDb.ts",
-    "cypress:build": "yarn build && yarn cypress:prepare"
+    "cypress:build": "pnpm build && pnpm cypress:prepare"
   },
   "repository": {
     "type": "git",
@@ -34,6 +36,7 @@
     "@formatjs/intl-locale": "3.1.1",
     "@formatjs/intl-pluralrules": "5.1.10",
     "@formatjs/intl-utils": "3.8.4",
+    "@formatjs/swc-plugin-experimental": "^0.4.0",
     "@headlessui/react": "1.7.12",
     "@heroicons/react": "2.0.16",
     "@supercharge/request-ip": "1.2.0",
@@ -58,11 +61,10 @@
     "express-openapi-validator": "4.13.8",
     "express-rate-limit": "6.7.0",
     "express-session": "1.17.3",
-    "formik": "2.2.9",
+    "formik": "^2.4.6",
     "gravatar-url": "3.1.0",
-    "intl": "1.2.5",
     "lodash": "4.17.21",
-    "next": "12.3.4",
+    "next": "^14.2.4",
     "node-cache": "5.1.2",
     "node-gyp": "9.3.1",
     "node-schedule": "2.1.1",
@@ -70,13 +72,13 @@
     "openpgp": "5.7.0",
     "plex-api": "5.3.2",
     "pug": "3.0.2",
-    "react": "18.2.0",
+    "react": "^18.3.1",
     "react-ace": "10.1.0",
     "react-animate-height": "2.1.2",
     "react-aria": "3.23.0",
-    "react-dom": "18.2.0",
+    "react-dom": "^18.3.1",
     "react-intersection-observer": "9.4.3",
-    "react-intl": "6.2.10",
+    "react-intl": "^6.6.8",
     "react-markdown": "8.0.5",
     "react-popper-tooltip": "4.4.2",
     "react-select": "5.7.0",
@@ -88,9 +90,10 @@
     "reflect-metadata": "0.1.13",
     "secure-random-password": "0.2.3",
     "semver": "7.3.8",
+    "sharp": "^0.33.4",
     "sqlite3": "5.1.4",
     "swagger-ui-express": "4.6.2",
-    "swr": "2.0.4",
+    "swr": "2.2.5",
     "typeorm": "0.3.12",
     "web-push": "3.5.0",
     "winston": "3.8.2",
@@ -101,7 +104,6 @@
     "zod": "3.20.6"
   },
   "devDependencies": {
-    "@babel/cli": "7.21.0",
     "@commitlint/cli": "17.4.4",
     "@commitlint/config-conventional": "17.4.4",
     "@semantic-release/changelog": "6.0.2",
@@ -122,8 +124,8 @@
     "@types/node": "17.0.36",
     "@types/node-schedule": "2.1.0",
     "@types/nodemailer": "6.4.7",
-    "@types/react": "18.0.28",
-    "@types/react-dom": "18.0.11",
+    "@types/react": "^18.3.3",
+    "@types/react-dom": "^18.3.0",
     "@types/react-transition-group": "4.4.5",
     "@types/secure-random-password": "0.2.1",
     "@types/semver": "7.3.13",
@@ -135,15 +137,13 @@
     "@typescript-eslint/eslint-plugin": "5.54.0",
     "@typescript-eslint/parser": "5.54.0",
     "autoprefixer": "10.4.13",
-    "babel-plugin-react-intl": "8.2.25",
-    "babel-plugin-react-intl-auto": "3.3.0",
     "commitizen": "4.3.0",
     "copyfiles": "2.4.1",
     "cy-mobile-commands": "0.3.0",
     "cypress": "12.7.0",
     "cz-conventional-changelog": "3.3.0",
     "eslint": "8.35.0",
-    "eslint-config-next": "12.3.4",
+    "eslint-config-next": "^14.2.4",
     "eslint-config-prettier": "8.6.0",
     "eslint-plugin-formatjs": "4.9.0",
     "eslint-plugin-jsx-a11y": "6.7.1",
@@ -151,7 +151,6 @@
     "eslint-plugin-prettier": "4.2.1",
     "eslint-plugin-react": "7.32.2",
     "eslint-plugin-react-hooks": "4.6.0",
-    "extract-react-intl-messages": "4.1.1",
     "husky": "8.0.3",
     "lint-staged": "13.1.2",
     "nodemon": "2.0.20",
@@ -167,10 +166,12 @@
     "tsconfig-paths": "4.1.2",
     "typescript": "4.9.5"
   },
-  "resolutions": {
+  "engines": {
+    "node": "^20.0.0",
+    "pnpm": "^9.0.0"
+  },
+  "overrides": {
     "sqlite3/node-gyp": "8.4.1",
-    "@types/react": "18.0.28",
-    "@types/react-dom": "18.0.11",
     "@types/express-session": "1.17.6"
   },
   "config": {
@@ -236,8 +237,7 @@
         ],
         "platforms": [
           "linux/amd64",
-          "linux/arm64",
-          "linux/arm/v7"
+          "linux/arm64"
         ]
       },
       "@semantic-release/github"

postinstall-win.js

@@ -0,0 +1,13 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
+const fs = require('fs');
+const path = require('path');
+const { execSync } = require('child_process');
+
+if (process.platform === 'win32') {
+  const typeormPath = path.resolve('node_modules/typeorm');
+
+  if (fs.existsSync(typeormPath)) {
+    process.stdout.write('> Installing typeorm@0.3.11 for Windows\n');
+    execSync('pnpm add typeorm@0.3.11', { stdio: 'inherit' });
+  }
+}