ByteSnap/channels-seerr
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: Overseerr to Jellyseerr migration (#2019)

Browse Source 
* feat: add Overseerr migration

* refactor: rename to Seerr

* refactor: more rename to Seerr

* feat: update the value of the MediaStatus.DELETED enum

* fix: add more details in migration logs

* fix: replace .update by .save for TypeORM hooks

* fix: add fake migration to skip the duplicated UpdateWebPush migration

* fix: rewrite the AddUserAvatarCacheFields migration for Overseerr merge

* fix: replace jellyseerr migrations with a dedicated one for overseerr

* fix: update overseerr migration

* fix: update overseerr migration

* fix: remove irrelevant changes

* fix: typos

* docs: update jsdoc comment

* docs: update seerr description

* docs: fix the contributing.md link

* fix: remove unwanterd change on postgres dev datasource

* docs: add latest tag to docker image

* fix: migrate old deleted status for 4k media

* fix: update Seerr version check
This commit is contained in:
Gauthier
2025-10-30 19:57:50 +01:00
committed by GitHub
parent 2e6e9ad657
commit 4e9c94c80f
60 changed files with 942 additions and 395 deletions
Download Patch File Download Diff File Expand all files Collapse all files

122
docs/getting-started/buildfromsource.mdx
View File

@@ -1,13 +1,13 @@
---
title: Build From Source (Advanced)
description: Install Jellyseerr by building from source
description: Install Seerr 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.
Refer to [Configuring Databases](/extending-jellyseerr/database-config#postgresql-options) for details on how to configure your database.
Refer to [Configuring Databases](/extending-seerr/database-config#postgresql-options) for details on how to configure your database.
:::
import Tabs from '@theme/Tabs';
@@ -20,11 +20,11 @@ import TabItem from '@theme/TabItem';
## Unix (Linux, macOS)
### Installation
1. Assuming you want the working directory to be `/opt/jellyseerr`, create the directory and navigate to it:
1. Assuming you want the working directory to be `/opt/seerr`, create the directory and navigate to it:
```bash
sudo mkdir -p /opt/jellyseerr && cd /opt/jellyseerr
sudo mkdir -p /opt/seerr && cd /opt/seerr
```
2. Clone the Jellyseerr repository and checkout the develop branch:
2. Clone the Seerr repository and checkout the develop branch:
```bash
git clone https://github.com/fallenbagel/jellyseerr.git
cd jellyseerr
@@ -38,26 +38,26 @@ CYPRESS_INSTALL_BINARY=0 pnpm install --frozen-lockfile
```bash
pnpm build
```
5. Start Jellyseerr:
5. Start Seerr:
```bash
pnpm start
```
:::info
You can now access Jellyseerr by visiting `http://localhost:5055` in your web browser.
You can now access Seerr by visiting `http://localhost:5055` in your web browser.
:::
#### Extending the installation
<Tabs groupId="unix-extensions" queryString>
<TabItem value="linux" label="Linux">
To run jellyseerr as a systemd service:
1. create the environment file at `/etc/jellyseerr/jellyseerr.conf`:
To run seerr as a systemd service:
1. create the environment file at `/etc/seerr/seerr.conf`:
```bash
## Jellyseerr's default port is 5055, if you want to use both, change this.
## Seerr'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
## specify on which interface to listen, by default seerr listens on all interfaces
#HOST=127.0.0.1
## Uncomment if you want to force Node.js to resolve IPv4 before IPv6 (advanced users only)
@@ -69,19 +69,19 @@ 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`:
3. Create the systemd service file at `/etc/systemd/system/seerr.service`, using either `sudo systemctl edit seerr` or `sudo nano /etc/systemd/system/seerr.service`:
```bash
[Unit]
Description=Jellyseerr Service
Description=Seerr Service
Wants=network-online.target
After=network-online.target
[Service]
EnvironmentFile=/etc/jellyseerr/jellyseerr.conf
EnvironmentFile=/etc/seerr/seerr.conf
Environment=NODE_ENV=production
Type=exec
Restart=on-failure
WorkingDirectory=/opt/jellyseerr
WorkingDirectory=/opt/seerr
ExecStart=/usr/bin/node dist/index.js
[Install]
@@ -93,33 +93,33 @@ If you are using a different path to node, replace `/usr/bin/node` with the path
4. Enable and start the service:
```bash
sudo systemctl enable jellyseerr
sudo systemctl start jellyseerr
sudo systemctl enable seerr
sudo systemctl start seerr
```
</TabItem>
<TabItem value="macos" label="macOS">
To run jellyseerr as a launchd service:
To run seerr 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`:
2. Create a launchd plist file at `~/Library/LaunchAgents/com.seerr.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>
<string>com.seerr</string>
<key>ProgramArguments</key>
<array>
<string>/usr/local/bin/node</string>
<string>/opt/jellyseerr/dist/index.js</string>
<string>/opt/seerr/dist/index.js</string>
</array>
<key>WorkingDirectory</key>
<string>/opt/jellyseerr</string>
<string>/opt/seerr</string>
<key>EnvironmentVariables</key>
<dict>
<key>NODE_ENV</key>
@@ -139,11 +139,11 @@ If you are using a different path to node, replace `/usr/local/bin/node` with th
:::
3. Load the service:
```bash
sudo launchctl load ~/Library/LaunchAgents/com.jellyseerr.plist
sudo launchctl load ~/Library/LaunchAgents/com.seerr.plist
```
3. Start the service:
```bash
sudo launchctl start com.jellyseerr
sudo launchctl start com.seerr
```
4. To ensure the service starts on boot, run the following command:
```bash
@@ -151,14 +151,14 @@ sudo lauchctl load
```
</TabItem>
<TabItem value="pm2" label="PM2">
To run jellyseerr as a PM2 service:
To run seerr as a PM2 service:
1. Install PM2:
```bash
npm install -g pm2
```
2. Start jellyseerr with PM2:
2. Start seerr with PM2:
```bash
pm2 start dist/index.js --name jellyseerr --node-args="--NODE_ENV=production"
pm2 start dist/index.js --name seerr --node-args="--NODE_ENV=production"
```
3. Save the process list:
```bash
@@ -171,35 +171,35 @@ pm2 startup
**Managing the service**
- To start the service:
```powershell
pm2 start jellyseerr
pm2 start seerr
```
- To stop the service:
```powershell
pm2 stop jellyseerr
pm2 stop seerr
```
- To restart the service:
```powershell
pm2 restart jellyseerr
pm2 restart seerr
```
- To view the logs:
```powershell
pm2 logs jellyseerr
pm2 logs seerr
```
- To view the status:
```powershell
pm2 status jellyseerr
pm2 status seerr
```
</TabItem>
</Tabs>
## Windows
### Installation
1. Assuming you want the working directory to be `C:\jellyseerr`, create the directory and navigate to it:
1. Assuming you want the working directory to be `C:\seerr`, create the directory and navigate to it:
```powershell
mkdir C:\jellyseerr
cd C:\jellyseerr
mkdir C:\seerr
cd C:\seerr
```
2. Clone the Jellyseerr repository and checkout the develop branch:
2. Clone the Seerr repository and checkout the develop branch:
```powershell
git clone https://github.com/fallenbagel/jellyseerr.git .
git checkout main
@@ -213,24 +213,24 @@ set CYPRESS_INSTALL_BINARY=0 && pnpm install --frozen-lockfile
```powershell
pnpm build
```
5. Start Jellyseerr:
5. Start Seerr:
```powershell
pnpm start
```
:::tip
You can add the environment variables to a `.env` file in the Jellyseerr directory.
You can add the environment variables to a `.env` file in the Seerr directory.
:::
:::info
You can now access Jellyseerr by visiting `http://localhost:5055` in your web browser.
You can now access Seerr by visiting `http://localhost:5055` in your web browser.
:::
#### Extending the installation
<Tabs groupId="windows-extensions" queryString>
<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:
To run seerr as a bat script:
1. Create a file named `start-seerr.bat` in the seerr directory:
```bat
@echo off
set PORT=5055
@@ -240,43 +240,43 @@ node dist/index.js
2. Create a task in Task Scheduler:
- Open Task Scheduler
- Click on "Create Basic Task"
- Name the task "Jellyseerr"
- Name the task "Seerr"
- 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
- Set the "Start in" to the jellyseerr directory.
- Set the program/script to the path of the `start-seerr.bat` file
- Set the "Start in" to the seerr directory.
- Click "Finish"
Now, Jellyseerr will start when the computer boots up in the background.
Now, Seerr will start when the computer boots up in the background.
</TabItem>
<TabItem value="nssm" label="NSSM">
To run jellyseerr as a service:
To run seerr 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 AppDirectory "C:\jellyseerr"
nssm set Jellyseerr AppEnvironmentExtra NODE_ENV=production
nssm install Seerr "C:\Program Files\nodejs\node.exe" "C:\seerr\dist\index.js"
nssm set Seerr AppDirectory "C:\seerr"
nssm set Seerr AppEnvironmentExtra NODE_ENV=production
```
3. Start the service:
```powershell
nssm start Jellyseerr
nssm start Seerr
```
4. To ensure the service starts on boot, run the following command:
```powershell
nssm set Jellyseerr Start SERVICE_AUTO_START
nssm set Seerr Start SERVICE_AUTO_START
```
</TabItem>
<TabItem value="pm2" label="PM2">
To run jellyseerr as a PM2 service:
To run seerr as a PM2 service:
1. Install PM2:
```powershell
npm install -g pm2
```
2. Start jellyseerr with PM2:
2. Start seerr with PM2:
```powershell
pm2 start dist/index.js --name jellyseerr --node-args="--NODE_ENV=production"
pm2 start dist/index.js --name seerr --node-args="--NODE_ENV=production"
```
3. Save the process list:
```powershell
@@ -289,31 +289,31 @@ pm2 startup
##### Managing the service
- To start the service:
```powershell
pm2 start jellyseerr
pm2 start seerr
```
- To stop the service:
```powershell
pm2 stop jellyseerr
pm2 stop seerr
```
- To restart the service:
```powershell
pm2 restart jellyseerr
pm2 restart seerr
```
- To view the logs:
```powershell
pm2 logs jellyseerr
pm2 logs seerr
```
- To view the status:
```powershell
pm2 status jellyseerr
pm2 status seerr
```
</TabItem>
</Tabs>
### Updating
To update Jellyseerr, navigate to the Jellyseerr directory and run the following commands:
To update Seerr, navigate to the Seerr directory and run the following commands:
```bash
git pull
```
Then, follow the steps in the installation section to rebuild and restart Jellyseerr.
Then, follow the steps in the installation section to rebuild and restart Seerr.

56
docs/getting-started/docker.mdx
View File

@@ -1,6 +1,6 @@
---
title: Docker (Recommended)
description: Install Jellyseerr using Docker
description: Install Seerr using Docker
sidebar_position: 1
---
# Docker
@@ -8,7 +8,7 @@ sidebar_position: 1
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/).
Refer to [Configuring Databases](/extending-jellyseerr/database-config#postgresql-options) for details on how to configure your database.
Refer to [Configuring Databases](/extending-seerr/database-config#postgresql-options) for details on how to configure your database.
:::
:::info
@@ -23,7 +23,7 @@ To confirm that the container image you are using is authentic and unmodified, p
## 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).
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 Seerr 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!
@@ -40,7 +40,7 @@ For details on the Docker CLI, please [review the official `docker run` document
```bash
docker run -d \
--name jellyseerr \
--name seerr \
--init \
-e LOG_LEVEL=debug \
-e TZ=Asia/Tashkent \
@@ -48,7 +48,7 @@ docker run -d \
-p 5055:5055 \
-v /path/to/appdata/config:/app/config \
--restart unless-stopped \
ghcr.io/fallenbagel/jellyseerr:latest
ghcr.io/seerr-team/seerr:latest
```
The argument `-e PORT=5055` is optional.
@@ -68,11 +68,11 @@ To run the container as a specific user/group, you may optionally add `--user=[
Stop and remove the existing container:
```bash
docker stop jellyseerr && docker rm jellyseerr
docker stop seerr && docker rm seerr
```
Pull the latest image:
```bash
docker pull ghcr.io/fallenbagel/jellyseerr:latest
docker pull ghcr.io/seerr-team/seerr:latest
```
Finally, run the container with the same parameters originally used to create the container:
```bash
@@ -80,7 +80,7 @@ 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 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 Seerr up-to-date automatically.
You could also use [diun](https://github.com/crazy-max/diun) to receive notifications when a new image is available.
:::
@@ -90,14 +90,14 @@ You could also use [diun](https://github.com/crazy-max/diun) to receive notifica
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 `compose.yaml` as follows:
Define the `seerr` service in your `compose.yaml` as follows:
```yaml
---
services:
jellyseerr:
image: ghcr.io/fallenbagel/jellyseerr:latest
seerr:
image: ghcr.io/seerr-team/seerr:latest
init: true
container_name: jellyseerr
container_name: seerr
environment:
- LOG_LEVEL=debug
- TZ=Asia/Tashkent
@@ -123,7 +123,7 @@ docker compose up -d
#### Updating:
Pull the latest image:
```bash
docker compose pull jellyseerr
docker compose pull seerr
```
Then, restart all services defined in the Compose file:
```bash
@@ -142,31 +142,31 @@ Please refer to the [Docker Desktop for Windows user manual](https://docs.docker
**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:
First, create a volume to store the configuration data for Seerr using using either the Docker CLI:
```bash
docker volume create jellyseerr-data
docker volume create seerr-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"
4. Enter a name for the volume (example: `seerr-data`) and hit "Create"
Then, create and start the Jellyseerr container:
Then, create and start the Seerr container:
<Tabs groupId="docker-methods" queryString>
<TabItem value="docker-cli" label="Docker CLI">
```bash
docker run -d \
--name jellyseerr \
--name seerr \
--init \
-e LOG_LEVEL=debug \
-e TZ=Asia/Tashkent \
-e PORT=5055 \
-p 5055:5055 \
-v jellyseerr-data:/app/config \
-v seerr-data:/app/config \
--restart unless-stopped \
ghcr.io/fallenbagel/jellyseerr:latest
ghcr.io/seerr-team/seerr:latest
```
The argument `-e PORT=5055` is optional.
@@ -183,7 +183,7 @@ If you want to add a healthcheck to the above command, you can add the following
#### Updating:
Pull the latest image:
```bash
docker compose pull jellyseerr
docker compose pull seerr
```
Then, restart all services defined in the Compose file:
```bash
@@ -195,17 +195,17 @@ docker compose up -d
```yaml
---
services:
jellyseerr:
image: ghcr.io/fallenbagel/jellyseerr:latest
seerr:
image: ghcr.io/seerr-team/seerr:latest
init: true
container_name: jellyseerr
container_name: seerr
environment:
- LOG_LEVEL=debug
- TZ=Asia/Tashkent
ports:
- 5055:5055
volumes:
- jellyseerr-data:/app/config
- seerr-data:/app/config
healthcheck:
test: wget --no-verbose --tries=1 --spider http://localhost:5055/api/v1/status || exit 1
start_period: 20s
@@ -215,14 +215,14 @@ services:
restart: unless-stopped
volumes:
jellyseerr-data:
seerr-data:
external: true
```
#### Updating:
Pull the latest image:
```bash
docker compose pull jellyseerr
docker compose pull seerr
```
Then, restart all services defined in the Compose file:
```bash
@@ -231,7 +231,7 @@ docker compose up -d
</TabItem>
</Tabs>
To access the files inside the volume created above, navigate to `\\wsl$\docker-desktop-data\version-pack-data\community\docker\volumes\jellyseerr-data\_data` using File Explorer.
To access the files inside the volume created above, navigate to `\\wsl$\docker-desktop-data\version-pack-data\community\docker\volumes\seerr-data\_data` using File Explorer.
:::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.

2
docs/getting-started/index.mdx
View File

@@ -4,7 +4,7 @@ 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.
After running Seerr for the first time, configure it by visiting the web UI at `http://[address]:5055` and completing the setup steps.
:::
<DocCardList />

4
docs/getting-started/kubernetes.mdx
View File

@@ -16,12 +16,12 @@ To confirm that the chart you are using is authentic and unmodified, please refe
## Installation
```console
helm install jellyseerr oci://ghcr.io/fallenbagel/jellyseerr/jellyseerr-chart
helm install seerr oci://ghcr.io/seerr-team/seerr/seerr-chart
```
Helm values can be found in the Jellyseerr repository under [charts/jellyseerr-chart/README.md](https://github.com/fallenbagel/jellyseerr/tree/develop/charts/jellyseerr-chart).
Verify the signature with [cosign](https://docs.sigstore.dev/cosign/system_config/installation/) (replace [tag], with the TAG you want to verify) :
```console
cosign verify ghcr.io/fallenbagel/jellyseerr/jellyseerr-chart:[tag] --certificate-identity=https://github.com/fallenbagel/jellyseerr/.github/workflows/helm.yml@refs/heads/main --certificate-oidc-issuer=https://token.ac
cosign verify ghcr.io/seerr-team/seerr/seerr-chart:[tag] --certificate-identity=https://github.com/fallenbagel/jellyseerr/.github/workflows/helm.yml@refs/heads/main --certificate-oidc-issuer=https://token.ac
tions.githubusercontent.com
```

12
docs/getting-started/third-parties/aur.mdx
View File

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

4
docs/getting-started/third-parties/nixpkg.mdx
View File

@@ -1,10 +1,10 @@
---
title: Nix Package Manager (Advanced)
description: Install Jellyseerr using Nixpkgs
description: Install Seerr using Nixpkgs
sidebar_position: 1
---
import { JellyseerrVersion, NixpkgVersion } from '@site/src/components/JellyseerrVersion';
import { SeerrVersion, NixpkgVersion } from '@site/src/components/SeerrVersion';
import Admonition from '@theme/Admonition';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

6
docs/getting-started/third-parties/unraid.mdx
View File

@@ -1,6 +1,6 @@
---
title: Unraid (Advanced)
description: Install Jellyseerr using Unraid
description: Install Seerr using Unraid
sidebar_position: 3
---
@@ -14,7 +14,7 @@ This method is not recommended for most users. It is intended for advanced users
:::
1. Ensure you have the **Community Applications** plugin installed.
2. Inside the **Community Applications** app store, search for **Jellyseerr**.
2. Inside the **Community Applications** app store, search for **Seerr**.
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 "Jellyseerr" at your `<ServerIP:HostPort>` in a web browser.
5. Click apply and access "Seerr" at your `<ServerIP:HostPort>` in a web browser.