docs: add missing migration steps (#2376)
This commit is contained in:
@@ -38,6 +38,13 @@ For details on the Docker CLI, please [review the official `docker run` document
|
|||||||
|
|
||||||
#### Installation:
|
#### Installation:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Create the appdata folder
|
||||||
|
mkdir /path/to/appdata/config
|
||||||
|
# Chown the folder as the container runs as the `node` user (UID 1000).
|
||||||
|
chown -R 1000:1000 /path/to/appdata/config
|
||||||
|
```
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker run -d \
|
docker run -d \
|
||||||
--name seerr \
|
--name seerr \
|
||||||
@@ -48,20 +55,16 @@ docker run -d \
|
|||||||
-p 5055:5055 \
|
-p 5055:5055 \
|
||||||
-v /path/to/appdata/config:/app/config \
|
-v /path/to/appdata/config:/app/config \
|
||||||
--restart unless-stopped \
|
--restart unless-stopped \
|
||||||
ghcr.io/seerr-team/seerr:latest
|
|
||||||
```
|
|
||||||
|
|
||||||
The argument `-e PORT=5055` is optional.
|
|
||||||
|
|
||||||
If you want to add a healthcheck to the above command, you can add the following flags :
|
|
||||||
```
|
|
||||||
--health-cmd "wget --no-verbose --tries=1 --spider http://localhost:5055/api/v1/status || exit 1" \
|
--health-cmd "wget --no-verbose --tries=1 --spider http://localhost:5055/api/v1/status || exit 1" \
|
||||||
--health-start-period 20s \
|
--health-start-period 20s \
|
||||||
--health-timeout 3s \
|
--health-timeout 3s \
|
||||||
--health-interval 15s \
|
--health-interval 15s \
|
||||||
--health-retries 3 \
|
--health-retries 3 \
|
||||||
|
ghcr.io/seerr-team/seerr:latest
|
||||||
```
|
```
|
||||||
|
|
||||||
|
The argument `-e PORT=5055` is optional.
|
||||||
|
|
||||||
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.
|
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:
|
#### Updating:
|
||||||
@@ -115,6 +118,13 @@ services:
|
|||||||
restart: unless-stopped
|
restart: unless-stopped
|
||||||
```
|
```
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Create the appdata folder
|
||||||
|
mkdir /path/to/appdata/config
|
||||||
|
# Chown the folder as the container runs as the `node` user (UID 1000).
|
||||||
|
chown -R 1000:1000 /path/to/appdata/config
|
||||||
|
```
|
||||||
|
|
||||||
Then, start all services defined in the Compose file:
|
Then, start all services defined in the Compose file:
|
||||||
```bash
|
```bash
|
||||||
docker compose up -d
|
docker compose up -d
|
||||||
@@ -166,20 +176,16 @@ docker run -d \
|
|||||||
-p 5055:5055 \
|
-p 5055:5055 \
|
||||||
-v seerr-data:/app/config \
|
-v seerr-data:/app/config \
|
||||||
--restart unless-stopped \
|
--restart unless-stopped \
|
||||||
ghcr.io/seerr-team/seerr:latest
|
|
||||||
```
|
|
||||||
|
|
||||||
The argument `-e PORT=5055` is optional.
|
|
||||||
|
|
||||||
If you want to add a healthcheck to the above command, you can add the following flags :
|
|
||||||
```
|
|
||||||
--health-cmd "wget --no-verbose --tries=1 --spider http://localhost:5055/api/v1/status || exit 1" \
|
--health-cmd "wget --no-verbose --tries=1 --spider http://localhost:5055/api/v1/status || exit 1" \
|
||||||
--health-start-period 20s \
|
--health-start-period 20s \
|
||||||
--health-timeout 3s \
|
--health-timeout 3s \
|
||||||
--health-interval 15s \
|
--health-interval 15s \
|
||||||
--health-retries 3 \
|
--health-retries 3 \
|
||||||
|
ghcr.io/seerr-team/seerr:latest
|
||||||
```
|
```
|
||||||
|
|
||||||
|
The argument `-e PORT=5055` is optional.
|
||||||
|
|
||||||
#### Updating:
|
#### Updating:
|
||||||
Pull the latest image:
|
Pull the latest image:
|
||||||
```bash
|
```bash
|
||||||
|
|||||||
@@ -7,5 +7,9 @@ import DocCardList from '@theme/DocCardList';
|
|||||||
Third-party installation methods are maintained by the community. The Seerr team is not responsible for these packages.
|
Third-party installation methods are maintained by the community. The Seerr team is not responsible for these packages.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
|
:::info
|
||||||
|
Want to add a third-party installation method? Contributions are welcome! Feel free to open a pull request.
|
||||||
|
:::
|
||||||
|
|
||||||
|
|
||||||
<DocCardList />
|
<DocCardList />
|
||||||
|
|||||||
@@ -10,8 +10,21 @@ import Tabs from '@theme/Tabs';
|
|||||||
import TabItem from '@theme/TabItem';
|
import TabItem from '@theme/TabItem';
|
||||||
|
|
||||||
# Nix Package Manager
|
# Nix Package Manager
|
||||||
|
:::danger
|
||||||
|
This method has not yet been updated for Seerr and is currently a work in progress.
|
||||||
|
You can follow the ongoing work on these pull requests:
|
||||||
|
- https://github.com/NixOS/nixpkgs/pull/450096
|
||||||
|
- https://github.com/NixOS/nixpkgs/pull/450093
|
||||||
|
:::
|
||||||
|
|
||||||
|
<!--
|
||||||
:::warning
|
:::warning
|
||||||
Third-party installation methods are maintained by the community. The Seerr team is not responsible for these packages.
|
Third-party installation methods are maintained by the community. The Seerr team is not responsible for these packages.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
|
:::warning
|
||||||
|
This method is not recommended for most users. It is intended for advanced users who are using NixOS distribution.
|
||||||
|
:::
|
||||||
|
|
||||||
Refer to [NixOS documentation](https://search.nixos.org/options?channel=25.05&query=seerr)
|
Refer to [NixOS documentation](https://search.nixos.org/options?channel=25.05&query=seerr)
|
||||||
|
-->
|
||||||
|
|||||||
20
docs/getting-started/third-parties/truenas.mdx
Normal file
20
docs/getting-started/third-parties/truenas.mdx
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
---
|
||||||
|
title: TrueNAS (Advanced)
|
||||||
|
description: Install Seerr using TrueNAS
|
||||||
|
sidebar_position: 4
|
||||||
|
---
|
||||||
|
# TrueNAS
|
||||||
|
:::danger
|
||||||
|
This method has not yet been updated for Seerr and is currently a work in progress.
|
||||||
|
You can follow the ongoing work on this issue https://github.com/truenas/apps/issues/3374.
|
||||||
|
:::
|
||||||
|
|
||||||
|
<!--
|
||||||
|
:::warning
|
||||||
|
Third-party installation methods are maintained by the community. The Seerr team is not responsible for these packages.
|
||||||
|
:::
|
||||||
|
|
||||||
|
:::warning
|
||||||
|
This method is not recommended for most users. It is intended for advanced users who are using TrueNAS distribution.
|
||||||
|
:::
|
||||||
|
-->
|
||||||
@@ -5,6 +5,12 @@ sidebar_position: 3
|
|||||||
---
|
---
|
||||||
|
|
||||||
# Unraid
|
# Unraid
|
||||||
|
:::danger
|
||||||
|
This method has not yet been updated for Seerr and is awaiting a community contribution.
|
||||||
|
Feel free to open a pull request on GitHub to update this installation method.
|
||||||
|
:::
|
||||||
|
|
||||||
|
<!--
|
||||||
:::warning
|
:::warning
|
||||||
Third-party installation methods are maintained by the community. The Seerr team is not responsible for these packages.
|
Third-party installation methods are maintained by the community. The Seerr team is not responsible for these packages.
|
||||||
:::
|
:::
|
||||||
@@ -18,3 +24,4 @@ This method is not recommended for most users. It is intended for advanced users
|
|||||||
3. Click the **Install Button**.
|
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.
|
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 "Seerr" at your `<ServerIP:HostPort>` in a web browser.
|
5. Click apply and access "Seerr" at your `<ServerIP:HostPort>` in a web browser.
|
||||||
|
-->
|
||||||
|
|||||||
@@ -9,11 +9,20 @@ Whether you come from Overseerr or Jellyseerr, you don't need to perform any man
|
|||||||
This migration will run automatically the first time you start your instance using the Seerr codebase (Docker image or source build or Kubernetes, etc.).
|
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.
|
An additional migration will happen for Overseerr users, to migrate their configuration to the new codebase.
|
||||||
|
|
||||||
:::warning
|
:::danger
|
||||||
Before doing anything you should backup your existing instance so that you can rollback in case something goes wrong.
|
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.
|
See [Backups](/using-seerr/backups) for details on how to properly backup your instance.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
|
:::warning
|
||||||
|
Installation methods are now divided into two categories: official and third-party methods.
|
||||||
|
The Seerr team is only responsible for official installation methods, while third-party methods are maintained by the community.
|
||||||
|
Some methods are currently not maintained, but this does not mean they are permanently discontinued. The community may restore and support them if they choose to do so.
|
||||||
|
|
||||||
|
- **Unraid app:** Not maintained
|
||||||
|
- **Snap package:** Not maintained
|
||||||
|
:::
|
||||||
|
|
||||||
## Docker
|
## Docker
|
||||||
Refer to [Seerr Docker Documentation](/getting-started/docker), all of our examples have been updated to reflect the below change.
|
Refer to [Seerr Docker Documentation](/getting-started/docker), all of our examples have been updated to reflect the below change.
|
||||||
|
|
||||||
@@ -23,8 +32,9 @@ Changes :
|
|||||||
- The container can now be run as a non-root user (`node` user); remove the `user` directive if you have configured it.
|
- 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.
|
- 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.
|
||||||
|
|
||||||
|
#### Config folder permissions
|
||||||
:::info
|
:::info
|
||||||
**Config folder permissions**: Since the container now runs as the `node` user (UID 1000), you must ensure your config folder has the correct permissions. The `node` user must have read and write access to the `/app/config` directory.
|
Since the container now runs as the `node` user (UID 1000), you must ensure your config folder has the correct permissions. The `node` user must have read and write access to the `/app/config` directory.
|
||||||
|
|
||||||
If you're migrating from a previous installation, you may need to update the ownership of your config folder:
|
If you're migrating from a previous installation, you may need to update the ownership of your config folder:
|
||||||
```bash
|
```bash
|
||||||
@@ -126,6 +136,12 @@ Summary of changes :
|
|||||||
</TabItem>
|
</TabItem>
|
||||||
</Tabs>
|
</Tabs>
|
||||||
|
|
||||||
|
|
||||||
|
## Build From Source
|
||||||
|
Refer to [Seerr Build From Source Documentation](/getting-started/buildfromsource), all of our examples have been updated to reflect the below change.
|
||||||
|
|
||||||
|
Install from scratch by following the documentation, restore your data as described in [Backups](/using-seerr/backups), and then start Seerr. No additional steps are required.
|
||||||
|
|
||||||
## Kubernetes
|
## Kubernetes
|
||||||
Refer to [Seerr Kubernetes Documentation](/getting-started/kubernetes), all of our examples have been updated to reflect the below change.
|
Refer to [Seerr Kubernetes Documentation](/getting-started/kubernetes), all of our examples have been updated to reflect the below change.
|
||||||
|
|
||||||
@@ -166,3 +182,15 @@ Summary of changes :
|
|||||||
```
|
```
|
||||||
</TabItem>
|
</TabItem>
|
||||||
</Tabs>
|
</Tabs>
|
||||||
|
|
||||||
|
### Nix (Third-party installation methods)
|
||||||
|
|
||||||
|
Waiting for https://github.com/NixOS/nixpkgs/pull/450096 and https://github.com/NixOS/nixpkgs/pull/450093
|
||||||
|
|
||||||
|
### AUR (Third-party installation methods)
|
||||||
|
|
||||||
|
See https://aur.archlinux.org/packages/seerr
|
||||||
|
|
||||||
|
### TrueNAS (Third-party installation methods)
|
||||||
|
|
||||||
|
Waiting for https://github.com/truenas/apps/issues/3374
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ Seerr docs will be available at [docs.seerr.dev](https://docs.seerr.dev).
|
|||||||
### Installation
|
### Installation
|
||||||
|
|
||||||
```
|
```
|
||||||
$ pnpm
|
$ pnpm install
|
||||||
```
|
```
|
||||||
|
|
||||||
### Local Development
|
### Local Development
|
||||||
|
|||||||
Reference in New Issue
Block a user