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

14 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. Login and manage user access with Plex!
  • Integrates easily with your existing services. Currently Overseerr supports Sonarr and Radarr. More to come!
  • Syncs to your Plex library to know what titles you already have.
  • Complex request system allowing users to request individual seasons or movies in a friendly, easy to use UI.
  • Incredibly simple request management UI. Don't dig through the app to simply approve recent requests.
  • Granular permission system
  • Mobile friendly design, for when you need to approve requests on the go!

In Development

  • User profiles.
  • User settings page (to give users the ability to modify their Overseerr experience to their liking).
  • Local user system (for those who don't use Plex).

Planned Features

  • More 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 what features people have already requested.

Getting Started

Check out our documenation for steps on how to install and run Overseerr:

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

Running Overseerr

Currently, Overseerr is only distributed through Docker images. If you have Docker, you can run Overseerr as per:

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.

⚠️ 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 image sctx/overseerr:develop instead! ⚠️

Preview

Support

API Documentation

Full API documentation will soon be published automatically and available outside of running the app. Currently, you can access the API docs by running Overseerr locally and visiting http://localhost:5055/api-docs

Community

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

If you would like to chat with community members you can join the Overseerr Discord.

Our Code of Conduct applies to all Overseerr community channels.

Contributing

You can help build 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

💻 🌍