-
-
Notifications
You must be signed in to change notification settings - Fork 477
docs: add migration guide #2069
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
M0NsTeRRR
wants to merge
10
commits into
develop
Choose a base branch
from
docs/migration-guide
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+188
−14
Open
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
3286528
docs: add migration guide
M0NsTeRRR 4a1a64a
Update docs/migration-guide.mdx
M0NsTeRRR 89fa7e7
Apply suggestion from @gauthier-th
M0NsTeRRR b96d15c
docs: update migration-guide intro
M0NsTeRRR 18ef5a0
docs: update documentation with code block
M0NsTeRRR 6eb84c6
chore: gitignore compose override file
M0NsTeRRR edb222a
docs: fix typo
M0NsTeRRR a140077
Update docs/migration-guide.mdx
M0NsTeRRR fe24cce
docs: clarify when the migration happens
M0NsTeRRR 46ca52b
Merge branch 'develop' into docs/migration-guide
M0NsTeRRR File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -71,3 +71,6 @@ tsconfig.tsbuildinfo | |
|
|
||
| # Config Cache Directory | ||
| config/cache | ||
|
|
||
| # Docker compose | ||
| compose.override.yaml | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,157 @@ | ||
| --- | ||
| title: Migration guide | ||
| --- | ||
|
|
||
| import Tabs from '@theme/Tabs'; | ||
| import TabItem from '@theme/TabItem'; | ||
|
|
||
| Whether you come from Overseerr or Jellyseerr, you don't need to perform any manual migration steps, your instance will automatically be migrated to Seerr. | ||
| This migration will run automatically the first time you start your instance using the Seerr codebase (Docker image or source build or Kubernetes, etc.). | ||
| An additional migration will happen for Overseerr users, to migrate their configuration to the new codebase. | ||
|
|
||
| :::warning | ||
| Before doing anything you should backup your existing instance so that you can rollback in case something goes wrong. | ||
| See [Backups](/using-seerr/backups) for details on how to properly backup your instance. | ||
| ::: | ||
|
|
||
| ## Docker | ||
| Refer to [Seerr Docker Documentation](/getting-started/docker), all of our example have been updated to reflect the below change. | ||
|
|
||
| Changes : | ||
| - Renamed all references from `overseerr` or `jellyseerr` to `seerr`. | ||
| - The container image reference has been updated. | ||
| - The container can now be run as a non-root user (`node` user); remove the `user` directive if you have configured it. | ||
| - The container no longer provides an init process, so you must configure it by adding `init: true` for Docker Compose or `--init` for the Docker CLI. | ||
|
|
||
| ### Unix | ||
|
|
||
| Summary of changes : | ||
| <Tabs groupId="docker-methods" queryString> | ||
| <TabItem value="docker-compose" label="Docker compose"> | ||
| ```yaml {3-6} | ||
| --- | ||
| services: | ||
| seerr: | ||
| image: ghcr.io/seerr-team/seerr:latest | ||
| init: true | ||
| container_name: seerr | ||
| environment: | ||
| - LOG_LEVEL=debug | ||
| - TZ=Asia/Tashkent | ||
| - PORT=5055 #optional | ||
| ports: | ||
| - 5055:5055 | ||
| volumes: | ||
| - /path/to/appdata/config:/app/config | ||
| healthcheck: | ||
| test: wget --no-verbose --tries=1 --spider http://localhost:5055/api/v1/status || exit 1 | ||
| start_period: 20s | ||
| timeout: 3s | ||
| interval: 15s | ||
| retries: 3 | ||
| restart: unless-stopped | ||
| ``` | ||
| </TabItem> | ||
| <TabItem value="docker-cli" label="Docker CLI"> | ||
| ```bash {2-3,10} | ||
| docker run -d \ | ||
| --name seerr \ | ||
| --init \ | ||
| -e LOG_LEVEL=debug \ | ||
| -e TZ=Asia/Tashkent \ | ||
| -e PORT=5055 \ | ||
| -p 5055:5055 \ | ||
| -v /path/to/appdata/config:/app/config \ | ||
| --restart unless-stopped \ | ||
| ghcr.io/seerr-team/seerr:latest | ||
| ``` | ||
| </TabItem> | ||
| </Tabs> | ||
|
|
||
| ### Windows | ||
| Summary of changes : | ||
| <Tabs groupId="docker-methods" queryString> | ||
| <TabItem value="docker-compose" label="Docker compose"> | ||
| ```yaml {3-6,13,23} | ||
| --- | ||
| services: | ||
| seerr: | ||
| image: ghcr.io/seerr-team/seerr:latest | ||
| init: true | ||
| container_name: seerr | ||
| environment: | ||
| - LOG_LEVEL=debug | ||
| - TZ=Asia/Tashkent | ||
| ports: | ||
| - 5055:5055 | ||
| volumes: | ||
| - seerr-data:/app/config | ||
| healthcheck: | ||
| test: wget --no-verbose --tries=1 --spider http://localhost:5055/api/v1/status || exit 1 | ||
| start_period: 20s | ||
| timeout: 3s | ||
| interval: 15s | ||
| retries: 3 | ||
| restart: unless-stopped | ||
|
|
||
| volumes: | ||
| seerr-data: | ||
| external: true | ||
| ``` | ||
| </TabItem> | ||
| <TabItem value="docker-cli" label="Docker CLI"> | ||
| ```bash {2-3,8,10} | ||
| docker run -d \ | ||
| --name seerr \ | ||
| --init \ | ||
| -e LOG_LEVEL=debug \ | ||
| -e TZ=Asia/Tashkent \ | ||
| -e PORT=5055 \ | ||
| -p 5055:5055 \ | ||
| -v seerr-data:/app/config \ | ||
| --restart unless-stopped \ | ||
| ghcr.io/seerr-team/seerr:latest | ||
| ``` | ||
| </TabItem> | ||
| </Tabs> | ||
|
|
||
| ## Kubernetes | ||
| Refer to [Seerr Kubernetes Documentation](/getting-started/kubernetes), all of our example have been updated to reflect the below change. | ||
|
|
||
| Changes : | ||
| - All references to `jellyseerr` have been renamed to `seerr` in the manifests. | ||
| - The container image reference has been updated. | ||
| - The default `securityContext` and `podSecurityContext` have been updated to support running the container without root permissions. | ||
|
|
||
| Summary of changes : | ||
| <Tabs groupId="kubernetes-values" queryString> | ||
| <TabItem value="old" label="Old values"> | ||
| ```yaml | ||
| image: | ||
| repository: fallenbagel/jellyseerr | ||
| podSecurityContext: {} | ||
| securityContext: {} | ||
| ``` | ||
| </TabItem> | ||
| <TabItem value="new" label="New values"> | ||
| ```yaml | ||
| image: | ||
| repository: seerr-team/seerr | ||
| podSecurityContext: | ||
| fsGroup: 1000 | ||
| fsGroupChangePolicy: OnRootMismatch | ||
| securityContext: | ||
| allowPrivilegeEscalation: false | ||
| capabilities: | ||
| drop: | ||
| - ALL | ||
| readOnlyRootFilesystem: false | ||
| runAsNonRoot: true | ||
| privileged: false | ||
| runAsUser: 1000 | ||
| runAsGroup: 1000 | ||
| seccompProfile: | ||
| type: RuntimeDefault | ||
| ``` | ||
| </TabItem> | ||
| </Tabs> | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.