mirror of
https://github.com/sct/overseerr.git
synced 2025-12-26 16:27:17 +01:00
* 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
38 lines
2.1 KiB
Markdown
38 lines
2.1 KiB
Markdown
---
|
|
slug: /
|
|
sidebar_position: 1
|
|
---
|
|
|
|
# Introduction
|
|
|
|
Welcome to the Jellyseerr Documentation.
|
|
|
|
## Features
|
|
|
|
- **Full Jellyfin/Emby/Plex integration**. Login and manage user access with Jellyfin/Emby/Plex.
|
|
- **Syncs to your Jellyfin/Emby/Plex library** to show what titles you already have.
|
|
- **Integrates with Sonarr and Radarr**. With more services to come in the future.
|
|
- **Easy to use request system** allowing users to request individual seasons or movies in a friendly, clean UI.
|
|
- **Simple request management UI**. Don't dig through the app to approve recent requests.
|
|
- **Mobile-friendly design**, for when you need to approve requests on the go.
|
|
- Granular permission system.
|
|
- Localization into other languages.
|
|
- More features to come!
|
|
|
|
## Motivation
|
|
|
|
The primary motivation for starting this project was to add support for Jellyfin and Emby to Overseerr. As Overseerr is an incredibly performant and easy-to-use application, we wanted to bring that same experience to Jellyfin and Emby users. Thus, **Jellyseerr** was born.
|
|
|
|
This application is designed to be a **one-stop-shop** for all your media requests. It is designed to be a **simple, easy-to-use** application that allows users to request media to be added to your Jellyfin/Emby/Plex server.
|
|
|
|
## We need your help!
|
|
|
|
[Jellyseerr](https://github.com/Fallenbagel/jellyseerr) is a fork of Overseerr, with a heavy focus on Jellyfin and Emby integration.
|
|
[Overseerr](https://github.com/sct/overseerr) is an ambitious project where the original developers/contributors have already poured a lot of work into, and we wanted to build on top of that.
|
|
|
|
We also have poured a lot of work into this project, and we have a lot more to do as well. We need your valuable feedback and help to find and fix bugs. Also, with Jellyseerr being an open-source project, anyone is welcome to contribute. We also encourage you to contribute to Overseerr as well.
|
|
|
|
Contribution includes building new features, patching bugs, translating the application, or even just writing documentation.
|
|
|
|
If you would like to contribute, please be sure to review our [contribution guidelines](https://github.com/fallenbagel/jellyseerr/blob/develop/CONTRIBUTING.md).
|