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.
overseerr/README.md

15 KiB

Overseerr

Overseerr Release Overseerr CI

Discord Docker pulls Translation status Language grade: JavaScript GitHub All Contributors

Overseerr is a free and open source software application for managing requests for your media library. It integrates with your existing services, such as Sonarr, Radarr, and Plex!

Current Features

  • Full Plex integration. Authenticate and manage user access with Plex!
  • Easy integration with your existing services. Currently, Overseerr supports Sonarr and Radarr. More to come!
  • Plex library sync, to keep track of the titles which are already available.
  • Customizable request system, which allows users to request individual seasons or movies in a friendly, easy-to-use interface.
  • Incredibly simple request management UI. Don't dig through the app to simply approve recent requests!
  • Granular permission system.
  • Support for various notification agents.
  • Mobile-friendly design, for when you need to approve requests on the go!

Planned Features

  • Additional notification types.
  • Issues system. This will allow users to report issues with content on your media server.
  • And a ton more! Check out our issue tracker to see the features which have already been requested.

Getting Started

Check out our documentation for instructions on how to install and run Overseerr:

https://docs.overseerr.dev/getting-started/installation

Running Overseerr

Currently, Overseerr is primarily distributed as Docker images. If you have Docker installed, you can simply run Overseerr with:

docker run -d \
  -e LOG_LEVEL=info \
  -e TZ=Asia/Tokyo \
  -p 5055:5055 \
  -v /path/to/appdata/config:/app/config \
  --restart unless-stopped \
  sctx/overseerr

After running Overseerr for the first time, configure it by visiting the web UI at http://[address]:5055 and completing the setup steps

For more information or alternative installation methods, please see the Overseerr documentation.

⚠️ Overseerr is currently under very heavy, rapid development and things are likely to break often. We need all the help we can get to find bugs and get them fixed to hit a more stable release. If you would like to help test the bleeding edge, please use the sctx/overseerr:develop image instead! ⚠️

Preview

Support

API Documentation

Our documentation is built on every commit and hosted at https://api-docs.overseerr.dev

You can also access the API documentation from your local Overseerr install at http://localhost:5055/api-docs

Community

You can ask questions, share ideas, and more in GitHub Discussions.

If you would like to chat with other members of our growing community, join the Overseerr Discord server!

Our Code of Conduct applies to all Overseerr community channels.

Contributing

You can help improve Overseerr too! Check out our Contribution Guide to get started.

Contributors

Thanks goes to these wonderful people (emoji key):


sct

💻 🎨 🤔

Alex Zoitos

💻

Brandon Cohen

💻 📖

Ahreluth

🌍

KovalevArtem

🌍

GiyomuWeb

🌍

Angry Cuban

📖

jvennik

🌍

darknessgp

💻

salty

🚇

Shutruk

🌍

Krystian Charubin

🎨

Kieron Boswell

💻

samwiseg0

💬 🚇

ecelebi29

💻 📖

Mārtiņš Možeiko

💻

mazzetta86

🌍

Paul Hagedorn

🌍

Shagon94

🌍

sebstrgg

🌍

Danshil Mungur

💻 📖

doob187

🚇

johnpyp

💻

Jakob Ankarhem

📖 💻 🌍

Jayesh

💻

flying-sausages

📖

hirenshah

📖

TheCatLady

💻 🌍 📖

Chris Pritchard

💻 📖

Tamberlox

🌍

David

💻

Douglas Parker

📖

Daniel Carter

💻