chrisryn/requestarr
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: add querystring support & admonitions to docker page (#860)

Browse Source 
* docs: add querystring support to docker methods

* docs: add query string support to the rest of the tabs

* docs: add admonition for named volumes and emby variable
This commit is contained in:
Fallenbagel
2024-07-06 05:45:46 +05:00
committed by GitHub
parent 31ca32df99
commit 9dd175bb2e
6 changed files with 26 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/extending-jellyseerr/reverse-proxy.mdx
View File

@@ -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`:

2
docs/getting-started/aur.mdx
View File

@@ -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

10
docs/getting-started/buildfromsource.mdx
View File

@@ -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:

18
docs/getting-started/docker.mdx
View File

@@ -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,9 @@ docker run -d \
--restart unless-stopped \ --restart unless-stopped \
fallenbagel/jellyseerr fallenbagel/jellyseerr
``` ```
:::info
If you are using emby, make sure to set the `JELLYFIN_TYPE` environment variable to `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 +86,10 @@ services:
- /path/to/appdata/config:/app/config - /path/to/appdata/config:/app/config
restart: unless-stopped restart: unless-stopped
``` ```
:::info
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 +104,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 +139,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
@@ -179,6 +185,12 @@ volumes:
</TabItem> </TabItem>
</Tabs> </Tabs>
:::tip
If you are using a named volume, then you can safely **ignore** the warning about the `/app/config` folder being incorrectly mounted.
If you are using emby, make sure to set the `JELLYFIN_TYPE` environment variable to `emby`.
:::
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. 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.
:::info :::info

6
docs/using-jellyseerr/settings/mediaserver.mdx
View File

@@ -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

2
docs/using-jellyseerr/users/adding-users.mdx
View File

@@ -13,7 +13,7 @@ There are currently two methods to add users to Jellyseerr: importing Mediaserve
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.