Compare commits
13 Commits
gh-pages
...
preview-fi
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
cb25ad8457 | ||
|
|
ae955e9e7c | ||
|
|
7a826a1308 | ||
|
|
f201fee1ff | ||
|
|
316c31bd06 | ||
|
|
9dd175bb2e | ||
|
|
31ca32df99 | ||
|
|
df2f05f129 | ||
|
|
5428b19c62 | ||
|
|
8dde04396d | ||
|
|
3f7c01853c | ||
|
|
31472009ab | ||
|
|
73890ac802 |
4
.github/PULL_REQUEST_TEMPLATE.md
vendored
4
.github/PULL_REQUEST_TEMPLATE.md
vendored
@@ -4,8 +4,8 @@
|
|||||||
|
|
||||||
#### To-Dos
|
#### To-Dos
|
||||||
|
|
||||||
- [ ] Successful build `yarn build`
|
- [ ] Successful build `pnpm build`
|
||||||
- [ ] Translation keys `yarn i18n:extract`
|
- [ ] Translation keys `pnpm i18n:extract`
|
||||||
- [ ] Database migration (if required)
|
- [ ] Database migration (if required)
|
||||||
|
|
||||||
#### Issues Fixed or Closed
|
#### Issues Fixed or Closed
|
||||||
|
|||||||
1
.github/workflows/docs-deploy.yml
vendored
1
.github/workflows/docs-deploy.yml
vendored
@@ -58,6 +58,7 @@ jobs:
|
|||||||
deploy:
|
deploy:
|
||||||
name: Deploy to GitHub Pages
|
name: Deploy to GitHub Pages
|
||||||
needs: build
|
needs: build
|
||||||
|
concurrency: build-deploy-pages
|
||||||
|
|
||||||
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
|
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
|
||||||
permissions:
|
permissions:
|
||||||
|
|||||||
@@ -7,9 +7,9 @@ All help is welcome and greatly appreciated! If you would like to contribute to
|
|||||||
### Tools Required
|
### Tools Required
|
||||||
|
|
||||||
- HTML/Typescript/Javascript editor
|
- HTML/Typescript/Javascript editor
|
||||||
- [VSCode](https://code.visualstudio.com/) is recommended. Upon opening the project, a few extensions will be automatically recommended for install.
|
- [VSCode](https://code.visualstudio.com/) is recommended. Upon opening the project, a few extensions will be automatically recommended for install.
|
||||||
- [NodeJS](https://nodejs.org/en/download/) (Node 14.x or higher)
|
- [NodeJS](https://nodejs.org/en/download/) (Node 20.x)
|
||||||
- [Yarn](https://yarnpkg.com/)
|
- [Pnpm](https://pnpm.io/cli/install)
|
||||||
- [Git](https://git-scm.com/downloads)
|
- [Git](https://git-scm.com/downloads)
|
||||||
|
|
||||||
### Getting Started
|
### Getting Started
|
||||||
@@ -18,7 +18,7 @@ All help is welcome and greatly appreciated! If you would like to contribute to
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/YOUR_USERNAME/jellyseerr.git
|
git clone https://github.com/YOUR_USERNAME/jellyseerr.git
|
||||||
cd overseerr/
|
cd jellyseerr/
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Add the remote `upstream`:
|
2. Add the remote `upstream`:
|
||||||
@@ -48,8 +48,8 @@ All help is welcome and greatly appreciated! If you would like to contribute to
|
|||||||
4. Run the development environment:
|
4. Run the development environment:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
yarn
|
pnpm
|
||||||
yarn dev
|
pnpm dev
|
||||||
```
|
```
|
||||||
|
|
||||||
- Alternatively, you can use [Docker](https://www.docker.com/) with `docker-compose up -d`. This method does not require installing NodeJS or Yarn on your machine directly.
|
- Alternatively, you can use [Docker](https://www.docker.com/) with `docker-compose up -d`. This method does not require installing NodeJS or Yarn on your machine directly.
|
||||||
@@ -93,7 +93,7 @@ When adding new UI text, please try to adhere to the following guidelines:
|
|||||||
8. If an additional description or "tip" is required for a form field, it should be styled using the global CSS class `label-tip`.
|
8. If an additional description or "tip" is required for a form field, it should be styled using the global CSS class `label-tip`.
|
||||||
9. In full sentences, abbreviations like "info" or "auto" should not be used in place of full words, unless referencing the name/label of a specific setting or option which has an abbreviation in its name.
|
9. In full sentences, abbreviations like "info" or "auto" should not be used in place of full words, unless referencing the name/label of a specific setting or option which has an abbreviation in its name.
|
||||||
10. Do your best to check for spelling errors and grammatical mistakes.
|
10. Do your best to check for spelling errors and grammatical mistakes.
|
||||||
11. Do not misspell "Overseerr."
|
11. Do not misspell "Jellyseerr."
|
||||||
|
|
||||||
## Translation
|
## Translation
|
||||||
|
|
||||||
@@ -103,4 +103,4 @@ We use [Weblate](https://jellyseerr.borgcube.de/projects/jellyseerr/jellyseerr-f
|
|||||||
|
|
||||||
## Attribution
|
## Attribution
|
||||||
|
|
||||||
This contribution guide was inspired by the [Next.js](https://github.com/vercel/next.js) and [Radarr](https://github.com/Radarr/Radarr) contribution guides.
|
This contribution guide was inspired by the [Next.js](https://github.com/vercel/next.js), [Radarr](https://github.com/Radarr/Radarr), and [Overseerr](https://github.com/sct/Overseerr) contribution guides.
|
||||||
|
|||||||
@@ -37,6 +37,7 @@ With more features on the way! Check out our [issue tracker](https://github.com/
|
|||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
Check out our documentation for instructions on how to install and run Jellyseerr:
|
Check out our documentation for instructions on how to install and run Jellyseerr:
|
||||||
|
|
||||||
https://docs.jellyseerr.dev/getting-started/
|
https://docs.jellyseerr.dev/getting-started/
|
||||||
|
|
||||||
### Packages:
|
### Packages:
|
||||||
|
|||||||
@@ -1 +0,0 @@
|
|||||||
docs.seerr.dev
|
|
||||||
@@ -17,7 +17,7 @@ A Nginx subfolder workaround configuration is provided below, but it is not offi
|
|||||||
import Tabs from '@theme/Tabs';
|
import Tabs from '@theme/Tabs';
|
||||||
import TabItem from '@theme/TabItem';
|
import TabItem from '@theme/TabItem';
|
||||||
|
|
||||||
<Tabs groupId="nginx-reverse-proxy">
|
<Tabs groupId="nginx-reverse-proxy" queryString>
|
||||||
<TabItem value="subdomain" label="Subdomain">
|
<TabItem value="subdomain" label="Subdomain">
|
||||||
Add the following configuration to a new file `/etc/nginx/sites-available/jellyseerr.example.com.conf`:
|
Add the following configuration to a new file `/etc/nginx/sites-available/jellyseerr.example.com.conf`:
|
||||||
|
|
||||||
@@ -63,9 +63,9 @@ sudo ln -s /etc/nginx/sites-available/jellyseerr.example.com.conf /etc/nginx/sit
|
|||||||
<TabItem value="subfolder" label="Subfolder">
|
<TabItem value="subfolder" label="Subfolder">
|
||||||
|
|
||||||
:::warning
|
:::warning
|
||||||
This Nginx subfolder reverse proxy is an unsupported workaround, and only provided as an example. The filters may stop working when Overseerr is updated.
|
This Nginx subfolder reverse proxy is an unsupported workaround, and only provided as an example. The filters may stop working when Jellyseerr is updated.
|
||||||
|
|
||||||
If you encounter any issues with Overseerr while using this workaround, we may ask you to try to reproduce the problem without the Nginx proxy.
|
If you encounter any issues with Jellyseerr while using this workaround, we may ask you to try to reproduce the problem without the Nginx proxy.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
Add the following location block to your existing `nginx.conf` file.
|
Add the following location block to your existing `nginx.conf` file.
|
||||||
@@ -146,9 +146,9 @@ Add a new proxy host with the following settings:
|
|||||||
|
|
||||||
### Details
|
### Details
|
||||||
|
|
||||||
- **Domain Names:** Your desired external Overseerr hostname; e.g., `overseerr.example.com`
|
- **Domain Names:** Your desired external Jellyseerr hostname; e.g., `jellyseerr.example.com`
|
||||||
- **Scheme:** `http`
|
- **Scheme:** `http`
|
||||||
- **Forward Hostname / IP:** Internal Overseerr hostname or IP
|
- **Forward Hostname / IP:** Internal Jellyseerr hostname or IP
|
||||||
- **Forward Port:** `5055`
|
- **Forward Port:** `5055`
|
||||||
- **Cache Assets:** yes
|
- **Cache Assets:** yes
|
||||||
- **Block Common Exploits:** yes
|
- **Block Common Exploits:** yes
|
||||||
@@ -190,18 +190,18 @@ Caddy will automatically obtain and renew SSL certificates for your domain.
|
|||||||
|
|
||||||
## Traefik (v2)
|
## Traefik (v2)
|
||||||
|
|
||||||
Add the following labels to the Overseerr service in your `docker-compose.yml` file:
|
Add the following labels to the Jellyseerr service in your `docker-compose.yml` file:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
labels:
|
labels:
|
||||||
- 'traefik.enable=true'
|
- 'traefik.enable=true'
|
||||||
## HTTP Routers
|
## HTTP Routers
|
||||||
- 'traefik.http.routers.overseerr-rtr.entrypoints=https'
|
- 'traefik.http.routers.jellyseerr-rtr.entrypoints=https'
|
||||||
- 'traefik.http.routers.overseerr-rtr.rule=Host(`overseerr.domain.com`)'
|
- 'traefik.http.routers.jellyseerr-rtr.rule=Host(`jellyseerr.domain.com`)'
|
||||||
- 'traefik.http.routers.overseerr-rtr.tls=true'
|
- 'traefik.http.routers.jellyseerr-rtr.tls=true'
|
||||||
## HTTP Services
|
## HTTP Services
|
||||||
- 'traefik.http.routers.overseerr-rtr.service=overseerr-svc'
|
- 'traefik.http.routers.jellyseerr-rtr.service=jellyseerr-svc'
|
||||||
- 'traefik.http.services.overseerr-svc.loadbalancer.server.port=5055'
|
- 'traefik.http.services.jellyseerr-svc.loadbalancer.server.port=5055'
|
||||||
```
|
```
|
||||||
|
|
||||||
For more information, please refer to the [Traefik documentation](https://doc.traefik.io/traefik/user-guides/docker-compose/basic-example/).
|
For more information, please refer to the [Traefik documentation](https://doc.traefik.io/traefik/user-guides/docker-compose/basic-example/).
|
||||||
|
|||||||
@@ -17,7 +17,7 @@ To install Jellyseerr from the AUR, you can use an AUR helper like `yay` or `par
|
|||||||
import Tabs from '@theme/Tabs';
|
import Tabs from '@theme/Tabs';
|
||||||
import TabItem from '@theme/TabItem';
|
import TabItem from '@theme/TabItem';
|
||||||
|
|
||||||
<Tabs groupId="aur-methods">
|
<Tabs groupId="aur-methods" queryString>
|
||||||
<TabItem value="yay" label="yay">
|
<TabItem value="yay" label="yay">
|
||||||
```bash
|
```bash
|
||||||
yay -S jellyseerr
|
yay -S jellyseerr
|
||||||
|
|||||||
@@ -12,7 +12,7 @@ import Tabs from '@theme/Tabs';
|
|||||||
import TabItem from '@theme/TabItem';
|
import TabItem from '@theme/TabItem';
|
||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
<Tabs groupId="versions">
|
<Tabs groupId="versions" queryString>
|
||||||
<TabItem value="latest" label="Latest">
|
<TabItem value="latest" label="Latest">
|
||||||
- [Node.js 18.x](https://nodejs.org/en/download/)
|
- [Node.js 18.x](https://nodejs.org/en/download/)
|
||||||
- [Yarn 1.x](https://classic.yarnpkg.com/lang/en/docs/install)
|
- [Yarn 1.x](https://classic.yarnpkg.com/lang/en/docs/install)
|
||||||
@@ -29,7 +29,7 @@ import TabItem from '@theme/TabItem';
|
|||||||
|
|
||||||
## Unix (Linux, macOS)
|
## Unix (Linux, macOS)
|
||||||
### Installation
|
### Installation
|
||||||
<Tabs groupId="versions">
|
<Tabs groupId="versions" queryString>
|
||||||
<TabItem value="latest" label="latest">
|
<TabItem value="latest" label="latest">
|
||||||
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/jellyseerr`, create the directory and navigate to it:
|
||||||
```bash
|
```bash
|
||||||
@@ -85,7 +85,7 @@ You can now access Jellyseerr by visiting `http://localhost:5055` in your web br
|
|||||||
:::
|
:::
|
||||||
|
|
||||||
#### Extending the installation
|
#### Extending the installation
|
||||||
<Tabs groupId="unix-extensions">
|
<Tabs groupId="unix-extensions" queryString>
|
||||||
<TabItem value="linux" label="Linux">
|
<TabItem value="linux" label="Linux">
|
||||||
To run jellyseerr as a systemd service:
|
To run jellyseerr as a systemd service:
|
||||||
1. create the environment file at `/etc/jellyseerr/jellyseerr.conf`:
|
1. create the environment file at `/etc/jellyseerr/jellyseerr.conf`:
|
||||||
@@ -231,7 +231,7 @@ pm2 status jellyseerr
|
|||||||
|
|
||||||
## Windows
|
## Windows
|
||||||
### Installation
|
### Installation
|
||||||
<Tabs groupId="versions">
|
<Tabs groupId="versions" queryString>
|
||||||
<TabItem value="latest" label="latest">
|
<TabItem value="latest" label="latest">
|
||||||
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:\jellyseerr`, create the directory and navigate to it:
|
||||||
```powershell
|
```powershell
|
||||||
@@ -291,7 +291,7 @@ You can now access Jellyseerr by visiting `http://localhost:5055` in your web br
|
|||||||
:::
|
:::
|
||||||
|
|
||||||
#### Extending the installation
|
#### Extending the installation
|
||||||
<Tabs groupId="windows-extensions">
|
<Tabs groupId="windows-extensions" queryString>
|
||||||
<TabItem value="task-scheduler" label="Task Scheduler">
|
<TabItem value="task-scheduler" label="Task Scheduler">
|
||||||
To run jellyseerr as a bat script:
|
To run jellyseerr as a bat script:
|
||||||
1. Create a file named `start-jellyseerr.bat` in the jellyseerr directory:
|
1. Create a file named `start-jellyseerr.bat` in the jellyseerr directory:
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ Be sure to replace `/path/to/appdata/config` in the below examples with a valid
|
|||||||
import Tabs from '@theme/Tabs';
|
import Tabs from '@theme/Tabs';
|
||||||
import TabItem from '@theme/TabItem';
|
import TabItem from '@theme/TabItem';
|
||||||
|
|
||||||
<Tabs groupId="docker-methods">
|
<Tabs groupId="docker-methods" queryString>
|
||||||
<TabItem value="docker-cli" label="Docker CLI">
|
<TabItem value="docker-cli" label="Docker CLI">
|
||||||
For details on the Docker CLI, please [review the official `docker run` documentation](https://docs.docker.com/engine/reference/run/).
|
For details on the Docker CLI, please [review the official `docker run` documentation](https://docs.docker.com/engine/reference/run/).
|
||||||
|
|
||||||
@@ -37,6 +37,11 @@ docker run -d \
|
|||||||
--restart unless-stopped \
|
--restart unless-stopped \
|
||||||
fallenbagel/jellyseerr
|
fallenbagel/jellyseerr
|
||||||
```
|
```
|
||||||
|
:::tip
|
||||||
|
If you are using emby, make sure to set the `JELLYFIN_TYPE` environment variable to `emby`.
|
||||||
|
|
||||||
|
`-e JELLYFIN_TYPE=emby`
|
||||||
|
:::
|
||||||
|
|
||||||
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.
|
||||||
|
|
||||||
@@ -83,6 +88,10 @@ services:
|
|||||||
- /path/to/appdata/config:/app/config
|
- /path/to/appdata/config:/app/config
|
||||||
restart: unless-stopped
|
restart: unless-stopped
|
||||||
```
|
```
|
||||||
|
:::tip
|
||||||
|
If you are using emby, make sure to set the `JELLYFIN_TYPE` environment variable to `emby`.
|
||||||
|
:::
|
||||||
|
|
||||||
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
|
||||||
@@ -97,7 +106,6 @@ Then, restart all services defined in the Compose file:
|
|||||||
```bash
|
```bash
|
||||||
docker-compose up -d
|
docker-compose up -d
|
||||||
```
|
```
|
||||||
|
|
||||||
:::tip
|
:::tip
|
||||||
You may alternatively use a third-party mechanism like [dockge](https://github.com/louislam/dockge) to manage your docker compose files.
|
You may alternatively use a third-party mechanism like [dockge](https://github.com/louislam/dockge) to manage your docker compose files.
|
||||||
:::
|
:::
|
||||||
@@ -133,7 +141,7 @@ or the Docker Desktop app:
|
|||||||
4. Enter a name for the volume (example: `jellyseerr-data`) and hit "Create"
|
4. Enter a name for the volume (example: `jellyseerr-data`) and hit "Create"
|
||||||
|
|
||||||
Then, create and start the Jellyseerr container:
|
Then, create and start the Jellyseerr container:
|
||||||
<Tabs groupId="docker-methods">
|
<Tabs groupId="docker-methods" queryString>
|
||||||
<TabItem value="docker-cli" label="Docker CLI">
|
<TabItem value="docker-cli" label="Docker CLI">
|
||||||
```bash
|
```bash
|
||||||
docker run -d --name jellyseerr -e LOG_LEVEL=debug -e TZ=Asia/Tashkent -p 5055:5055 -v "jellyseerr-data:/app/config" --restart unless-stopped fallenbagel/jellyseerr:latest
|
docker run -d --name jellyseerr -e LOG_LEVEL=debug -e TZ=Asia/Tashkent -p 5055:5055 -v "jellyseerr-data:/app/config" --restart unless-stopped fallenbagel/jellyseerr:latest
|
||||||
@@ -161,32 +169,15 @@ volumes:
|
|||||||
external: true
|
external: true
|
||||||
```
|
```
|
||||||
</TabItem>
|
</TabItem>
|
||||||
|
|
||||||
<TabItem value="docker-desktop" label="Docker Desktop">
|
|
||||||
1. Open the Docker Desktop app
|
|
||||||
2. Head to the Containers/Apps tab
|
|
||||||
3. Click on the "Add Container/App" button near the top right
|
|
||||||
4. Fill in the container details:
|
|
||||||
- **Name**: `jellyseerr`
|
|
||||||
- **Image**: `fallenbagel/jellyseerr:latest`
|
|
||||||
- **Port**: `5055:5055`
|
|
||||||
- **Volume**: `jellyseerr-data:/app/config`
|
|
||||||
- **Environment Variables**:
|
|
||||||
- **LOG_LEVEL**: `debug`
|
|
||||||
- **TZ**: `Asia/Tashkent`
|
|
||||||
- **Restart Policy**: `unless-stopped`
|
|
||||||
5. Click on the "Run" button
|
|
||||||
</TabItem>
|
|
||||||
</Tabs>
|
</Tabs>
|
||||||
|
|
||||||
To access the files inside the volume created above, navigate to the following folder using File Explorer:
|
:::tip
|
||||||
|
If you are using a named volume, then you can safely **ignore** the warning about the `/app/config` folder being incorrectly mounted.
|
||||||
|
|
||||||
For Docker v26.1.4 or higher: `\\wsl$\docker-desktop\mnt\docker-desktop-disk\data\docker\volumes\jellyseerr-data\_data`
|
If you are using emby, make sure to set the `JELLYFIN_TYPE` environment variable to `emby`.
|
||||||
|
:::
|
||||||
|
|
||||||
For older versions of Docker:
|
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.
|
||||||
`\\wsl$\docker-desktop-data\data\docker\volumes\jellyseerr-data\_data`
|
|
||||||
or
|
|
||||||
`\\wsl$\docker-desktop-data\version-pack-data\community\docker\volumes\jellyseerr-data\_data`
|
|
||||||
|
|
||||||
:::info
|
:::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.
|
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.
|
||||||
|
|||||||
@@ -18,13 +18,13 @@ If you aren't a huge fan of the name "Jellyseerr" and would like to display some
|
|||||||
|
|
||||||
## Application URL
|
## Application URL
|
||||||
|
|
||||||
Set this to the externally-accessible URL of your Overseerr instance.
|
Set this to the externally-accessible URL of your Jellyseerr instance.
|
||||||
|
|
||||||
You must configure this setting in order to enable password reset and generation emails.
|
You must configure this setting in order to enable password reset and generation emails.
|
||||||
|
|
||||||
## Enable Proxy Support
|
## 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).
|
If you have Jellyseerr behind a reverse proxy, enable this setting to allow Jellyseerr 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.
|
This setting is **disabled** by default.
|
||||||
|
|
||||||
@@ -40,7 +40,7 @@ If you do not use Jellyseerr integrations with third-party applications to add/m
|
|||||||
|
|
||||||
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).
|
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`.
|
If you enable this setting and find yourself unable to access Jellyseerr, you can disable the setting by modifying `settings.json` in `/app/config`.
|
||||||
|
|
||||||
This setting is **disabled** by default.
|
This setting is **disabled** by default.
|
||||||
|
|
||||||
|
|||||||
@@ -9,7 +9,7 @@ sidebar_position: 3
|
|||||||
import Tabs from '@theme/Tabs';
|
import Tabs from '@theme/Tabs';
|
||||||
import TabItem from '@theme/TabItem';
|
import TabItem from '@theme/TabItem';
|
||||||
|
|
||||||
<Tabs groupId="media-server-type">
|
<Tabs groupId="media-server-type" queryString>
|
||||||
<TabItem value="jellyfin" label="Jellyfin">
|
<TabItem value="jellyfin" label="Jellyfin">
|
||||||
:::info
|
:::info
|
||||||
To set up Jellyfin, make sure you log in using an account with administrative privileges.
|
To set up Jellyfin, make sure you log in using an account with administrative privileges.
|
||||||
@@ -32,7 +32,7 @@ Jellyseerr will perform a full scan of your Jellyfin libraries once every 24 hou
|
|||||||
|
|
||||||
This section is where you configure the connection to your Jellyfin server.
|
This section is where you configure the connection to your Jellyfin server.
|
||||||
|
|
||||||
<Tabs groupId="versions">
|
<Tabs groupId="versions" queryString>
|
||||||
<TabItem value="latest" label="Latest">
|
<TabItem value="latest" label="Latest">
|
||||||
|
|
||||||
#### Internal URL
|
#### Internal URL
|
||||||
@@ -126,7 +126,7 @@ Jellyseerr will perform a full scan of your Emby libraries once every 24 hours (
|
|||||||
|
|
||||||
This section is where you configure the connection to your Emby server.
|
This section is where you configure the connection to your Emby server.
|
||||||
|
|
||||||
<Tabs groupId="versions">
|
<Tabs groupId="versions" queryString>
|
||||||
<TabItem value="latest" label="Latest">
|
<TabItem value="latest" label="Latest">
|
||||||
|
|
||||||
#### Internal URL
|
#### Internal URL
|
||||||
|
|||||||
@@ -16,7 +16,7 @@ This setting is **enabled** by default.
|
|||||||
|
|
||||||
## Enable New Jellyfin/Emby/Plex Sign-In
|
## 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.
|
When enabled, users with access to your media server will be able to sign in to Jellyseerr 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.
|
This setting is **enabled** by default.
|
||||||
|
|
||||||
|
|||||||
@@ -6,14 +6,14 @@ sidebar_position: 2
|
|||||||
|
|
||||||
# Adding Users
|
# 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**.
|
There are currently two methods to add users to Jellyseerr: importing Mediaserver 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
|
### Importing Mediaserver Users
|
||||||
|
|
||||||
import Tabs from '@theme/Tabs';
|
import Tabs from '@theme/Tabs';
|
||||||
import TabItem from '@theme/TabItem';
|
import TabItem from '@theme/TabItem';
|
||||||
|
|
||||||
<Tabs groupId="media-server-type">
|
<Tabs groupId="media-server-type" queryString>
|
||||||
<TabItem value="jellyfin" label="Jellyfin">
|
<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.
|
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.
|
||||||
|
|
||||||
@@ -25,9 +25,9 @@ To disable new Jellyfin sign-ins, navigate to **Settings → Users** and unch
|
|||||||
|
|
||||||
</TabItem>
|
</TabItem>
|
||||||
<TabItem value="emby" label="Emby">
|
<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.
|
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 Jellyseerr 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.
|
Importing Emby users is not required, however. Any user with access to the Emby 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
|
:::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.
|
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.
|
||||||
@@ -36,9 +36,9 @@ To disable new Emby sign-ins, navigate to **Settings → Users** and uncheck
|
|||||||
</TabItem>
|
</TabItem>
|
||||||
|
|
||||||
<TabItem value="plex" label="Plex">
|
<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.
|
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 Jellyseerr 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.
|
Importing Plex users is not required, however. Any user with access to the Plex 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
|
:::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.
|
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.
|
||||||
@@ -49,7 +49,7 @@ To disable new Plex sign-ins, navigate to **Settings → Users** and uncheck
|
|||||||
|
|
||||||
### Creating Local Users
|
### 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.
|
If you would like to grant Jellyseerr 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
|
#### Email Address
|
||||||
|
|
||||||
@@ -57,7 +57,7 @@ Enter a valid email address at which the user can receive messages pertaining to
|
|||||||
|
|
||||||
#### Automatically Generate Password
|
#### 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.
|
If an [application URL](/using-jellyseerr/settings/general#application-url) is set and [email notifications](/using-jellyseerr/notifications/email) have been configured and enabled, Jellyseerr can automatically generate a password for the new user.
|
||||||
|
|
||||||
#### Password
|
#### Password
|
||||||
|
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
Jellyseerr docs is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
|
Jellyseerr docs is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
|
||||||
|
|
||||||
Jellyseerr docs will be available at [docs.jellyseerr.com](https://docs.jellyseerr.dev).
|
Jellyseerr docs will be available at [docs.jellyseerr.dev](https://docs.jellyseerr.dev).
|
||||||
|
|
||||||
### Installation
|
### Installation
|
||||||
|
|
||||||
|
|||||||
@@ -13,6 +13,7 @@ const config: Config = {
|
|||||||
|
|
||||||
organizationName: 'Fallenbagel',
|
organizationName: 'Fallenbagel',
|
||||||
projectName: 'Jellyseerr',
|
projectName: 'Jellyseerr',
|
||||||
|
deploymentBranch: 'gh-pages',
|
||||||
|
|
||||||
onBrokenLinks: 'throw',
|
onBrokenLinks: 'throw',
|
||||||
onBrokenMarkdownLinks: 'warn',
|
onBrokenMarkdownLinks: 'warn',
|
||||||
@@ -57,7 +58,6 @@ const config: Config = {
|
|||||||
],
|
],
|
||||||
|
|
||||||
themeConfig: {
|
themeConfig: {
|
||||||
image: 'img/docusaurus-social-card.jpg',
|
|
||||||
colorMode: {
|
colorMode: {
|
||||||
defaultMode: 'dark',
|
defaultMode: 'dark',
|
||||||
disableSwitch: true,
|
disableSwitch: true,
|
||||||
|
|||||||
@@ -17,47 +17,45 @@ interface UserWarningsProps {
|
|||||||
const UserWarnings: React.FC<UserWarningsProps> = ({ onClick }) => {
|
const UserWarnings: React.FC<UserWarningsProps> = ({ onClick }) => {
|
||||||
const intl = useIntl();
|
const intl = useIntl();
|
||||||
const { user } = useUser();
|
const { user } = useUser();
|
||||||
if (!user) {
|
//check if a user has warnings
|
||||||
|
if (!user || !user.warnings || user.warnings.length === 0) {
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
let res = null;
|
let res = null;
|
||||||
|
|
||||||
//check if a user has warnings
|
user.warnings.forEach((warning) => {
|
||||||
if (user.warnings.length > 0) {
|
let link = '';
|
||||||
user.warnings.forEach((warning) => {
|
let warningText = '';
|
||||||
let link = '';
|
let warningTitle = '';
|
||||||
let warningText = '';
|
switch (warning) {
|
||||||
let warningTitle = '';
|
case 'userEmailRequired':
|
||||||
switch (warning) {
|
link = '/profile/settings/';
|
||||||
case 'userEmailRequired':
|
warningTitle = 'Profile is incomplete';
|
||||||
link = '/profile/settings/';
|
warningText = intl.formatMessage(messages.emailRequired);
|
||||||
warningTitle = 'Profile is incomplete';
|
}
|
||||||
warningText = intl.formatMessage(messages.emailRequired);
|
|
||||||
}
|
|
||||||
|
|
||||||
res = (
|
res = (
|
||||||
<Link
|
<Link
|
||||||
href={link}
|
href={link}
|
||||||
onClick={onClick}
|
onClick={onClick}
|
||||||
onKeyDown={(e) => {
|
onKeyDown={(e) => {
|
||||||
if (e.key === 'Enter' && onClick) {
|
if (e.key === 'Enter' && onClick) {
|
||||||
onClick();
|
onClick();
|
||||||
}
|
}
|
||||||
}}
|
}}
|
||||||
role="button"
|
role="button"
|
||||||
tabIndex={0}
|
tabIndex={0}
|
||||||
className="mx-2 mb-2 flex items-center rounded-lg bg-yellow-500 p-2 text-xs text-white ring-1 ring-gray-700 transition duration-300 hover:bg-yellow-400"
|
className="mx-2 mb-2 flex items-center rounded-lg bg-yellow-500 p-2 text-xs text-white ring-1 ring-gray-700 transition duration-300 hover:bg-yellow-400"
|
||||||
>
|
>
|
||||||
<ExclamationTriangleIcon className="h-6 w-6" />
|
<ExclamationTriangleIcon className="h-6 w-6" />
|
||||||
<div className="flex min-w-0 flex-1 flex-col truncate px-2 last:pr-0">
|
<div className="flex min-w-0 flex-1 flex-col truncate px-2 last:pr-0">
|
||||||
<span className="font-bold">{warningTitle}</span>
|
<span className="font-bold">{warningTitle}</span>
|
||||||
<span className="truncate">{warningText}</span>
|
<span className="truncate">{warningText}</span>
|
||||||
</div>
|
</div>
|
||||||
</Link>
|
</Link>
|
||||||
);
|
);
|
||||||
});
|
});
|
||||||
}
|
|
||||||
|
|
||||||
return res;
|
return res;
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -159,12 +159,12 @@ const SettingsAbout = () => {
|
|||||||
<List title={intl.formatMessage(messages.gettingsupport)}>
|
<List title={intl.formatMessage(messages.gettingsupport)}>
|
||||||
<List.Item title={intl.formatMessage(messages.documentation)}>
|
<List.Item title={intl.formatMessage(messages.documentation)}>
|
||||||
<a
|
<a
|
||||||
href="https://docs.overseerr.dev"
|
href="https://docs.jellyseerr.dev"
|
||||||
target="_blank"
|
target="_blank"
|
||||||
rel="noreferrer"
|
rel="noreferrer"
|
||||||
className="text-indigo-500 transition duration-300 hover:underline"
|
className="text-indigo-500 transition duration-300 hover:underline"
|
||||||
>
|
>
|
||||||
https://docs.overseerr.dev
|
https://docs.jellyseerr.dev
|
||||||
</a>
|
</a>
|
||||||
</List.Item>
|
</List.Item>
|
||||||
<List.Item title={intl.formatMessage(messages.githubdiscussions)}>
|
<List.Item title={intl.formatMessage(messages.githubdiscussions)}>
|
||||||
|
|||||||
Reference in New Issue
Block a user