open-source-mirrors
/
overseerr
mirror of https://github.com/sct/overseerr
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'develop'
${ noResults }
overseerr/docs
History
Danshil Kokil Mungur d7bfc73727
docs(installation): add PORT env variable to example commands (#3254) [skip ci] 		1 year ago
..
extending-overseerr chore(docs): fix typo in fail2ban article (#3139) [skip ci] 1 year ago
getting-started docs(installation): add PORT env variable to example commands (#3254) [skip ci] 1 year ago
support fix(lang): correct capitalization of 'TMDB' (#2953) 2 years ago
using-overseerr feat: custom image proxy (#3056) 2 years ago
README.md docs: Various edits, and addition of UI style guide (#982) [skip ci] 3 years ago
SUMMARY.md docs(notif): add missing link for gotify (#2634) [skip ci] 2 years ago

README.md

Introduction

Welcome to the Overseerr Documentation.

Features

  • Full Plex integration. Login and manage user access with Plex.
  • Syncs to your 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.

Motivation

The primary motivation for starting this project was to have an incredibly performant and easy to use application. There is a heavy focus on the user experience for both the server owner and the users. We feel requesting should be effortless for the user. Find the media you want, click request, and branch off efficiently into other titles that interest you, all in one seamless flow. For the server owner, Overseerr takes all the hassle out of approving your users' requests.

We need your help!

Overseerr is an ambitious project. We have already poured a lot of work into this, and have a lot more to do. We need your valuable feedback and help to find and fix bugs. Also, with Overseerr being an open-source project, anyone is welcome to contribute. 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.