diff --git a/docs/getting-started/docker.mdx b/docs/getting-started/docker.mdx index 2c5488e8..0a826ca8 100644 --- a/docs/getting-started/docker.mdx +++ b/docs/getting-started/docker.mdx @@ -38,6 +38,13 @@ For details on the Docker CLI, please [review the official `docker run` document #### 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 docker run -d \ --name seerr \ @@ -48,20 +55,16 @@ docker run -d \ -p 5055:5055 \ -v /path/to/appdata/config:/app/config \ --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-start-period 20s \ --health-timeout 3s \ --health-interval 15s \ --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. #### Updating: @@ -115,6 +118,13 @@ services: 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: ```bash docker compose up -d @@ -166,20 +176,16 @@ docker run -d \ -p 5055:5055 \ -v seerr-data:/app/config \ --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-start-period 20s \ --health-timeout 3s \ --health-interval 15s \ --health-retries 3 \ + ghcr.io/seerr-team/seerr:latest ``` +The argument `-e PORT=5055` is optional. + #### Updating: Pull the latest image: ```bash diff --git a/docs/getting-started/third-parties/index.mdx b/docs/getting-started/third-parties/index.mdx index d2d8e029..c729e01d 100644 --- a/docs/getting-started/third-parties/index.mdx +++ b/docs/getting-started/third-parties/index.mdx @@ -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. ::: +:::info +Want to add a third-party installation method? Contributions are welcome! Feel free to open a pull request. +::: + diff --git a/docs/getting-started/third-parties/nixpkg.mdx b/docs/getting-started/third-parties/nixpkg.mdx index c7cb14a3..224e7ad9 100644 --- a/docs/getting-started/third-parties/nixpkg.mdx +++ b/docs/getting-started/third-parties/nixpkg.mdx @@ -10,8 +10,21 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; # 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 +::: + + diff --git a/docs/getting-started/third-parties/truenas.mdx b/docs/getting-started/third-parties/truenas.mdx new file mode 100644 index 00000000..b0e261cc --- /dev/null +++ b/docs/getting-started/third-parties/truenas.mdx @@ -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. +::: + + diff --git a/docs/getting-started/third-parties/unraid.mdx b/docs/getting-started/third-parties/unraid.mdx index a8a3a252..73b14bf1 100644 --- a/docs/getting-started/third-parties/unraid.mdx +++ b/docs/getting-started/third-parties/unraid.mdx @@ -5,6 +5,12 @@ sidebar_position: 3 --- # 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. +::: + + diff --git a/docs/migration-guide.mdx b/docs/migration-guide.mdx index 67c76370..328374e5 100644 --- a/docs/migration-guide.mdx +++ b/docs/migration-guide.mdx @@ -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.). 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. 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 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 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 -**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: ```bash @@ -126,6 +136,12 @@ Summary of changes : + +## 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 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 : ``` + +### 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 diff --git a/gen-docs/README.md b/gen-docs/README.md index eb4a0515..5d739934 100644 --- a/gen-docs/README.md +++ b/gen-docs/README.md @@ -7,7 +7,7 @@ Seerr docs will be available at [docs.seerr.dev](https://docs.seerr.dev). ### Installation ``` -$ pnpm +$ pnpm install ``` ### Local Development