mirror of
https://github.com/sct/overseerr.git
synced 2025-12-29 09:06:08 +01:00
docs: setup docusaurus for documentation (#848)
* docs: setup docusaurus for documentation * docs: setup tailwind content for docusaurus * chore: ensure tailwindcss is installed so pages deploy works * docs: add cname to point to docs * ci: override format checking for pnpm-lock in gen-docs folder * docs(gen-docs): readme for docusaurus * chore(gen-docs): remove unnecessary image files * docs: remove installation instructions (moved to docs) * ci: rename docusaurus workflows to a more explicit name * style(gen-docs): custom color for links * docs: add more doc pages * style: gradient menu link bg, proper jellyseerr font & footer bg color * docs: fix proper link to relative pages * style: tab-items also now uses the proper jellyseerr colors * style: use prismTheme shadesOfPurple for codeblock/syntax highlighting * docs: fix broken links * docs: fix broken links * docs: fix broken anchors * chore(gen-docs): local search bar * style(gen-docs): tab colors * docs: reverse-proxy documentation * style(gen-docs): jellyseerr-like cards * docs: rename baremetal to build from source * docs: nixpkg version check component * docs: conditionally render override package derivation block and admonitions * docs: users section of the documentation
This commit is contained in:
9
docs/using-jellyseerr/_category_.json
Normal file
9
docs/using-jellyseerr/_category_.json
Normal file
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"label": "Using Jellyseerr",
|
||||
"position": 2,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"title": "Using Jellyseerr",
|
||||
"description": "Learn how to use Jellyseerr"
|
||||
}
|
||||
}
|
||||
27
docs/using-jellyseerr/notifications/discord.md
Normal file
27
docs/using-jellyseerr/notifications/discord.md
Normal file
@@ -0,0 +1,27 @@
|
||||
---
|
||||
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.
|
||||
|
||||
:::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.
|
||||
:::
|
||||
|
||||
## Configuration
|
||||
|
||||
### Webhook URL
|
||||
|
||||
You can find the webhook URL in the Discord application, at **Server Settings → Integrations → Webhooks**.
|
||||
|
||||
### Bot Username (optional)
|
||||
|
||||
If you would like to override the name you configured for your bot in Discord, you may set this value to whatever you like!
|
||||
|
||||
### Bot Avatar URL (optional)
|
||||
|
||||
Similar to the bot username, you can override the avatar for your bot.
|
||||
50
docs/using-jellyseerr/notifications/email.md
Normal file
50
docs/using-jellyseerr/notifications/email.md
Normal file
@@ -0,0 +1,50 @@
|
||||
---
|
||||
title: Email
|
||||
description: Configure email notifications for your users.
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Email
|
||||
|
||||
## Configuration
|
||||
|
||||
:::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., "Jellyseerr").
|
||||
|
||||
### Sender Address
|
||||
|
||||
Set this to the email address you would like to appear in the "from" field of the email message.
|
||||
|
||||
Depending on your email provider, this may need to be an address you own. For example, Gmail requires this to be your actual email address.
|
||||
|
||||
### SMTP Host
|
||||
|
||||
Set this to the hostname or IP address of your SMTP server.
|
||||
|
||||
### SMTP Port
|
||||
|
||||
Set this to a supported port number for your SMTP host. `465` and `587` are commonly used.
|
||||
|
||||
### Encryption Method
|
||||
|
||||
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
|
||||
|
||||
:::info
|
||||
If your account has two-factor authentication enabled, you may need to create an application password instead of using your account password.
|
||||
:::
|
||||
Configure these values as appropriate to authenticate with your SMTP host.
|
||||
|
||||
### PGP Private Key & Password (optional)
|
||||
|
||||
Configure these values to enable encrypting and signing of email messages using [OpenPGP](https://www.openpgp.org/). Note that individual users must also have their **PGP public keys** configured in their user settings in order for PGP encryption to be used in messages addressed to them.
|
||||
|
||||
When configuring the PGP keys, be sure to keep the entire contents of the key intact. For example, private keys always begin with `-----BEGIN PGP PRIVATE KEY BLOCK-----` and end with `-----END PGP PRIVATE KEY BLOCK-----`.
|
||||
25
docs/using-jellyseerr/notifications/index.mdx
Normal file
25
docs/using-jellyseerr/notifications/index.mdx
Normal file
@@ -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!
|
||||
23
docs/using-jellyseerr/notifications/webpush.md
Normal file
23
docs/using-jellyseerr/notifications/webpush.md
Normal file
@@ -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.
|
||||
:::
|
||||
9
docs/using-jellyseerr/settings/_category_.json
Normal file
9
docs/using-jellyseerr/settings/_category_.json
Normal file
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"label": "Settings",
|
||||
"position": 1,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"title": "Settings",
|
||||
"description": "Configure Jellyseerr to your liking"
|
||||
}
|
||||
}
|
||||
75
docs/using-jellyseerr/settings/general.md
Normal file
75
docs/using-jellyseerr/settings/general.md
Normal file
@@ -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.
|
||||
12
docs/using-jellyseerr/settings/jobs&cache.md
Normal file
12
docs/using-jellyseerr/settings/jobs&cache.md
Normal file
@@ -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.
|
||||
241
docs/using-jellyseerr/settings/mediaserver.mdx
Normal file
241
docs/using-jellyseerr/settings/mediaserver.mdx
Normal file
@@ -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>
|
||||
9
docs/using-jellyseerr/settings/notifications.mdx
Normal file
9
docs/using-jellyseerr/settings/notifications.mdx
Normal file
@@ -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.
|
||||
75
docs/using-jellyseerr/settings/services.md
Normal file
75
docs/using-jellyseerr/settings/services.md
Normal file
@@ -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.
|
||||
37
docs/using-jellyseerr/settings/users.md
Normal file
37
docs/using-jellyseerr/settings/users.md
Normal file
@@ -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.
|
||||
9
docs/using-jellyseerr/users/_category_.json
Normal file
9
docs/using-jellyseerr/users/_category_.json
Normal file
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"label": "Users",
|
||||
"position": 2,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"title": "Users",
|
||||
"description": "Configure your Jellyseerr users"
|
||||
}
|
||||
}
|
||||
64
docs/using-jellyseerr/users/adding-users.mdx
Normal file
64
docs/using-jellyseerr/users/adding-users.mdx
Normal file
@@ -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 → 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 → 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 → 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.
|
||||
9
docs/using-jellyseerr/users/deleting-users.md
Normal file
9
docs/using-jellyseerr/users/deleting-users.md
Normal file
@@ -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.
|
||||
62
docs/using-jellyseerr/users/editing-users.md
Normal file
62
docs/using-jellyseerr/users/editing-users.md
Normal file
@@ -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.
|
||||
17
docs/using-jellyseerr/users/owner.md
Normal file
17
docs/using-jellyseerr/users/owner.md
Normal file
@@ -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.
|
||||
:::
|
||||
Reference in New Issue
Block a user