-
-
Notifications
You must be signed in to change notification settings - Fork 230
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: remove installation instructions (moved to docs)
- Loading branch information
1 parent
9e85590
commit ebfaed2
Showing
1 changed file
with
6 additions
and
107 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -17,12 +17,8 @@ | |
| **Jellyseerr** is a free and open source software application for managing requests for your media library. | ||
| It is a fork of [Overseerr](https://github.com/sct/overseerr) built to bring support for [Jellyfin](https://github.com/jellyfin/jellyfin) & [Emby](https://github.com/MediaBrowser/Emby) media servers! | ||
|
|
||
| _The original Overseerr team have been busy and Jellyfin/Emby support aren't on their roadmap, so we started this project as we wanted to bring the Overseerr experience to the Jellyfin/Emby Community!_ | ||
|
|
||
| ## Current Features | ||
|
|
||
| <!-- --> | ||
|
|
||
| - Full Jellyfin/Emby/Plex integration including authentication with user import & management | ||
| - Supports Movies, Shows and Mixed Libraries | ||
| - Ability to change email addresses for smtp purposes | ||
|
|
@@ -40,113 +36,15 @@ With more features on the way! Check out our [issue tracker](https://github.com/ | |
|
|
||
| ## Getting Started | ||
|
|
||
| ### Launching Jellyseerr using Docker (Recommended) | ||
|
|
||
| Check out our docker hub for instructions on how to install and run Jellyseerr: | ||
| https://hub.docker.com/r/fallenbagel/jellyseerr | ||
|
|
||
| ### Building from source (ADVANCED): | ||
|
|
||
| #### Windows | ||
|
|
||
| Pre-requisites: | ||
|
|
||
| - Nodejs [v20](https://nodejs.org/en/download) | ||
| - Pnpm [v9](https://pnpm.io/installation) | ||
| - Download/git clone the source code from the github (Either develop branch or main for stable) | ||
|
|
||
| ```cmd | ||
| npm i -g win-node-env | ||
| set CYPRESS_INSTALL_BINARY=0 | ||
| pnpm install --frozen-lockfile | ||
| pnpm add [email protected] | ||
| pnpm run build | ||
| pnpm start | ||
| ``` | ||
|
|
||
| (You can use task scheduler to run a bat script with `@echo off` and `pnpm start` to run jellyseerr in the background) | ||
| (You can also use nssm to run jellyseerr as a service, see [nssm](https://nssm.cc/usage) for more information) | ||
|
|
||
| _To set env variables such as `JELLYFIN_TYPE=emby` create a file called `.env` in the root directory of jellyseerr_ | ||
|
|
||
| #### Linux | ||
|
|
||
| **Pre-requisites:** | ||
|
|
||
| - Nodejs [v20](https://nodejs.org/en/download) | ||
| - Pnpm [v9](https://pnpm.io/installation) | ||
| - Git | ||
|
|
||
| **Steps:** | ||
|
|
||
| 1. Assuming you want the root folder for the jellyseerr source code to be cloned to `/opt` | ||
|
|
||
| ```bash | ||
| cd /opt | ||
| ``` | ||
|
|
||
| 2. Then execute the following commands to clone and checkout to the stable version | ||
|
|
||
| ```bash | ||
| git clone https://github.com/Fallenbagel/jellyseerr.git && cd jellyseerr | ||
| git checkout main | ||
| ``` | ||
|
|
||
| 3. Then install the dependencies and build the dist | ||
|
|
||
| ```bash | ||
| CYPRESS_INSTALL_BINARY=0 pnpm install --frozen-lockfile | ||
| pnpm build | ||
| ``` | ||
|
|
||
| 4. Now you can start jellyseerr using `pnpm start` and opening http://localhost:5055 in your browser. | ||
|
|
||
| 5. If you want to run jellyseerr as a _Systemd-service:_ | ||
|
|
||
| - assuming jellyseerr was cloned to `/opt/` | ||
| - first create the environment file at `/etc/jellyseerr/jellyseerr.conf` | ||
|
|
||
| Environment file: | ||
|
|
||
| ``` | ||
| # Jellyseerr's default port is 5055, if you want to use both, change this. | ||
| # specify on which port to listen | ||
| 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 | ||
| ``` | ||
|
|
||
| - Then run the command `which node` to find your node path (assuming it's at `/usr/bin/node`) | ||
| - Then create the service file using `sudo systemctl edit jellyseerr.service` or creating and editing a file at `/etc/systemd/system/jellyseerr.service` | ||
|
|
||
| Service file contents: | ||
|
|
||
| ``` | ||
| [Unit] | ||
| Description=Jellyseerr Service | ||
| Wants=network-online.target | ||
| After=network-online.target | ||
| [Service] | ||
| EnvironmentFile=/etc/jellyseerr/jellyseerr.conf | ||
| Environment=NODE_ENV=production | ||
| Type=exec | ||
| Restart=on-failure | ||
| WorkingDirectory=/opt/jellyseerr | ||
| ExecStart=/usr/bin/node dist/index.js | ||
| [Install] | ||
| WantedBy=multi-user.target | ||
| ``` | ||
| Check out our documentation for instructions on how to install and run Jellyseerr: | ||
| https://docs.jellyseerr.dev/getting-started/ | ||
|
|
||
| ### Packages: | ||
|
|
||
| Archlinux: [AUR](https://aur.archlinux.org/packages/jellyseerr) | ||
| Nixpkg: [Nixpkg](https://search.nixos.org/packages?channel=unstable&show=jellyseerr) | ||
|
|
||
| Nix: [Nixpkg](https://search.nixos.org/packages?channel=unstable&show=jellyseerr) | ||
|
|
||
| ~Snap: [Snap](https://snapcraft.io/jellyseerr)~(Deprecated) | ||
|
|
||
| ## Preview | ||
|
|
@@ -155,6 +53,7 @@ Nixpkg: [Nixpkg](https://search.nixos.org/packages?channel=unstable&show=jellyse | |
|
|
||
| ## Support | ||
|
|
||
| - Check out the [Jellyseerr Documentation](https://docs.jellyseerr.dev) before asking for help. Your question might already be in the docs! | ||
| - You can get support on [Discord](https://discord.gg/ckbvBtDJgC). | ||
| - You can ask questions in the Help category of our [GitHub Discussions](https://github.com/fallenbagel/jellyseerr/discussions). | ||
| - Bug reports and feature requests can be submitted via [GitHub Issues](https://github.com/fallenbagel/jellyseerr/issues). | ||
|
|
||