Skip to content

Commit

Permalink
style: fix code lint to the required standards
Browse files Browse the repository at this point in the history
  • Loading branch information
JoaquinOlivero committed Jul 10, 2024
1 parent 77a9a24 commit dd11a2d
Show file tree
Hide file tree
Showing 7 changed files with 387 additions and 384 deletions.
8 changes: 2 additions & 6 deletions docs/getting-started/aur.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,10 @@ import TabItem from '@theme/TabItem';

<Tabs groupId="aur-methods" queryString>
<TabItem value="yay" label="yay">
```bash
yay -S jellyseerr
```
```bash yay -S jellyseerr ```
</TabItem>
<TabItem value="paru" label="paru">
```bash
paru -S jellyseerr
```
```bash paru -S jellyseerr ```
</TabItem>
</Tabs>

Expand Down
167 changes: 69 additions & 98 deletions docs/getting-started/buildfromsource.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@ title: Build From Source (Advanced)
description: Install Jellyseerr by building from source
sidebar_position: 2
---

# Build from Source (Advanced)

:::warning
This method is not recommended for most users. It is intended for advanced users who are familiar with managing their own server infrastructure.
:::
Expand All @@ -12,6 +14,7 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

### Prerequisites

<Tabs groupId="versions" queryString>
<TabItem value="latest" label="Latest">
- [Node.js 18.x](https://nodejs.org/en/download/)
Expand All @@ -26,65 +29,38 @@ import TabItem from '@theme/TabItem';
</TabItem>
</Tabs>


## Unix (Linux, macOS)

### Installation

<Tabs groupId="versions" queryString>
<TabItem value="latest" label="latest">
1. Assuming you want the working directory to be `/opt/jellyseerr`, create the directory and navigate to it:
```bash
sudo mkdir -p /opt/jellyseerr && cd /opt/jellyseerr
```
2. Clone the Jellyseerr repository and checkout the latest release:
```bash
git clone https://github.com/Fallenbagel/jellyseerr.git
cd jellyseerr
git checkout main
```
3. Install the dependencies:
```bash
CYPRESS_INSTALL_BINARY=0 yarn install --frozen-lockfile --network-timeout 1000000
```
4. Build the project:
```bash
yarn build
```
5. Start Jellyseerr:
```bash
yarn start
```
1. Assuming you want the working directory to be `/opt/jellyseerr`, create
the directory and navigate to it: ```bash sudo mkdir -p /opt/jellyseerr &&
cd /opt/jellyseerr ``` 2. Clone the Jellyseerr repository and checkout the
latest release: ```bash git clone
https://github.com/Fallenbagel/jellyseerr.git cd jellyseerr git checkout
main ``` 3. Install the dependencies: ```bash CYPRESS_INSTALL_BINARY=0 yarn
install --frozen-lockfile --network-timeout 1000000 ``` 4. Build the
project: ```bash yarn build ``` 5. Start Jellyseerr: ```bash yarn start ```
</TabItem>
<TabItem value="develop" label="develop">
1. Assuming you want the working directory to be `/opt/jellyseerr`, create the directory and navigate to it:
```bash
sudo mkdir -p /opt/jellyseerr && cd /opt/jellyseerr
```
2. Clone the Jellyseerr repository and checkout the develop branch:
```bash
git clone https://github.com/Fallenbagel/jellyseerr.git
cd jellyseerr
git checkout develop # by default, you are on the develop branch so this step is not necessary
```
3. Install the dependencies:
```bash
CYPRESS_INSTALL_BINARY=0 pnpm install --frozen-lockfile
```
4. Build the project:
```bash
pnpm build
```
5. Start Jellyseerr:
```bash
pnpm start
```
1. Assuming you want the working directory to be `/opt/jellyseerr`, create
the directory and navigate to it: ```bash sudo mkdir -p /opt/jellyseerr &&
cd /opt/jellyseerr ``` 2. Clone the Jellyseerr repository and checkout the
develop branch: ```bash git clone
https://github.com/Fallenbagel/jellyseerr.git cd jellyseerr git checkout
develop # by default, you are on the develop branch so this step is not
necessary ``` 3. Install the dependencies: ```bash CYPRESS_INSTALL_BINARY=0
pnpm install --frozen-lockfile ``` 4. Build the project: ```bash pnpm build
``` 5. Start Jellyseerr: ```bash pnpm start ```
</TabItem>
</Tabs>

:::info
You can now access Jellyseerr by visiting `http://localhost:5055` in your web browser.
:::
:::info You can now access Jellyseerr by visiting `http://localhost:5055` in your
web browser. :::

#### Extending the installation

<Tabs groupId="unix-extensions" queryString>
<TabItem value="linux" label="Linux">
To run jellyseerr as a systemd service:
Expand All @@ -95,18 +71,23 @@ To run jellyseerr as a systemd service:
PORT=5055

## specify on which interface to listen, by default jellyseerr listens on all interfaces

#HOST=127.0.0.1

## Uncomment if your media server is emby instead of jellyfin.

# JELLYFIN_TYPE=emby
```

````
2. Then run the following commands:
```bash
which node
```
````
Copy the path to node, it should be something like `/usr/bin/node`.
3. Create the systemd service file at `/etc/systemd/system/jellyseerr.service`, using either `sudo systemctl edit jellyseerr` or `sudo nano /etc/systemd/system/jellyseerr.service`:
```bash
[Unit]
Description=Jellyseerr Service
Expand All @@ -124,15 +105,18 @@ ExecStart=/usr/bin/node dist/index.js
[Install]
WantedBy=multi-user.target
```

:::note
If you are using a different path to node, replace `/usr/bin/node` with the path to node.
:::

4. Enable and start the service:

```bash
sudo systemctl enable jellyseerr
sudo systemctl start jellyseerr
```

</TabItem>
<TabItem value="macos" label="macOS">
To run jellyseerr as a launchd service:
Expand All @@ -143,6 +127,7 @@ which node
Copy the path to node, it should be something like `/usr/local/bin/node`.

2. Create a launchd plist file at `~/Library/LaunchAgents/com.jellyseerr.plist`:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
Expand Down Expand Up @@ -171,21 +156,27 @@ Copy the path to node, it should be something like `/usr/local/bin/node`.
</dict>
</plist>
```

:::note
If you are using a different path to node, replace `/usr/local/bin/node` with the path to node.
:::
3. Load the service:
::: 3. Load the service:

```bash
sudo launchctl load ~/Library/LaunchAgents/com.jellyseerr.plist
```

3. Start the service:

```bash
sudo launchctl start com.jellyseerr
```

4. To ensure the service starts on boot, run the following command:

```bash
sudo lauchctl load
```

</TabItem>
<TabItem value="pm2" label="PM2">
To run jellyseerr as a PM2 service:
Expand Down Expand Up @@ -230,55 +221,31 @@ pm2 status jellyseerr
</Tabs>

## Windows

### Installation

<Tabs groupId="versions" queryString>
<TabItem value="latest" label="latest">
1. Assuming you want the working directory to be `C:\jellyseerr`, create the directory and navigate to it:
```powershell
mkdir C:\jellyseerr
cd C:\jellyseerr
```
2. Clone the Jellyseerr repository and checkout the latest release:
```powershell
git clone https://github.com/Fallenbagel/jellyseerr.git .
git checkout main
```
3. Install the dependencies:
```powershell
set CYPRESS_INSTALL_BINARY=0 && yarn install --frozen-lockfile --network-timeout 1000000
```
4. Build the project:
```powershell
yarn build
```
5. Start Jellyseerr:
```powershell
yarn start
```
1. Assuming you want the working directory to be `C:\jellyseerr`, create the
directory and navigate to it: ```powershell mkdir C:\jellyseerr cd
C:\jellyseerr ``` 2. Clone the Jellyseerr repository and checkout the latest
release: ```powershell git clone
https://github.com/Fallenbagel/jellyseerr.git . git checkout main ``` 3.
Install the dependencies: ```powershell set CYPRESS_INSTALL_BINARY=0 && yarn
install --frozen-lockfile --network-timeout 1000000 ``` 4. Build the
project: ```powershell yarn build ``` 5. Start Jellyseerr: ```powershell
yarn start ```
</TabItem>
<TabItem value="develop" label="develop">
1. Assuming you want the working directory to be `C:\jellyseerr`, create the directory and navigate to it:
```powershell
mkdir C:\jellyseerr
cd C:\jellyseerr
```
2. Clone the Jellyseerr repository and checkout the develop branch:
```powershell
git clone https://github.com/Fallenbagel/jellyseerr.git .
git checkout develop # by default, you are on the develop branch so this step is not necessary
```
3. Install the dependencies:
```powershell
set CYPRESS_INSTALL_BINARY=0 && pnpm install --frozen-lockfile
```
4. Build the project:
```powershell
pnpm build
```
5. Start Jellyseerr:
```powershell
pnpm start
```
1. Assuming you want the working directory to be `C:\jellyseerr`, create the
directory and navigate to it: ```powershell mkdir C:\jellyseerr cd
C:\jellyseerr ``` 2. Clone the Jellyseerr repository and checkout the
develop branch: ```powershell git clone
https://github.com/Fallenbagel/jellyseerr.git . git checkout develop # by
default, you are on the develop branch so this step is not necessary ``` 3.
Install the dependencies: ```powershell set CYPRESS_INSTALL_BINARY=0 && pnpm
install --frozen-lockfile ``` 4. Build the project: ```powershell pnpm build
``` 5. Start Jellyseerr: ```powershell pnpm start ```
</TabItem>
</Tabs>

Expand All @@ -291,6 +258,7 @@ You can now access Jellyseerr by visiting `http://localhost:5055` in your web br
:::

#### Extending the installation

<Tabs groupId="windows-extensions" queryString>
<TabItem value="task-scheduler" label="Task Scheduler">
To run jellyseerr as a bat script:
Expand All @@ -311,6 +279,7 @@ node dist/index.js
- Click "Finish"

Now, Jellyseerr will start when the computer boots up in the background.

</TabItem>

<TabItem value="nssm" label="NSSM">
Expand Down Expand Up @@ -373,9 +342,11 @@ pm2 status jellyseerr
</Tabs>

### Updating

To update Jellyseerr, navigate to the Jellyseerr directory and run the following commands:

```bash
git pull
```
Then, follow the steps in the installation section to rebuild and restart Jellyseerr.

Then, follow the steps in the installation section to rebuild and restart Jellyseerr.
Loading

0 comments on commit dd11a2d

Please sign in to comment.