Request management and media discovery tool for the Plex ecosystem
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.
 
 
 
 
Go to file
semantic-release-bot 0bd1bee1fa
chore(release): 1.6.0
4 years ago
.github docs: add invalid template workflow (#340) 4 years ago
.vscode chore(deps-dev): upgrade typescript to v4.1.2 and ts-node to v9.1.1 4 years ago
config feat(api): plex Sync (Movies) 4 years ago
public style: dark splash screen (#310) 4 years ago
server fix(api): set plex libraries to disabled if the name changes 4 years ago
src fix(frontend): adds a tip to plex setup to clarify that syncing runs in the background 4 years ago
.all-contributorsrc docs: add kieron as a contributor (#329) [skip ci] 4 years ago
.dockerignore build: further shrinkage for the docker build 4 years ago
.editorconfig feat(.editorconfig): add .editorconfig 4 years ago
.eslintrc.js build(deps): update dependencies and update relevant files 4 years ago
.gitignore feat(api): plex tv sync and recently added sync 4 years ago
.prettierignore feat: upgrade tailwindcss to 2.0.1 4 years ago
CHANGELOG.md chore(release): 1.6.0 4 years ago
CODE_OF_CONDUCT.md docs: update readme and add code of conduct/contribution guide 4 years ago
CONTRIBUTING.md docs: update contributing.md 4 years ago
Dockerfile feat: about page initial version 4 years ago
Dockerfile.local build(docker): added Dockerfiles for local/prod (prod untested) 4 years ago
LICENSE chore: add license file 4 years ago
README.md docs: update readme.md with emoji key for contributors 4 years ago
babel.config.js feat(frontend/api): i18n support 4 years ago
docker-compose.yml build(docker): added Dockerfiles for local/prod (prod untested) 4 years ago
next-env.d.ts Add tailwindcss 4 years ago
next.config.js style(frontend): login page styling touchup (#64) 4 years ago
ormconfig.js build: fix production build 4 years ago
overseerr-api.yml fix(api): accept the api key to perform actions on the api with X-API-Key header 4 years ago
package.json chore(release): 1.6.0 4 years ago
postcss.config.js chore: fixed some prettier formatting errors in postcss.config.js 4 years ago
stylelint.config.js build(deps): update dependencies and update relevant files 4 years ago
tailwind.config.js feat: upgrade tailwindcss to 2.0.1 4 years ago
tsconfig.json Request Model (#79) 4 years ago
yarn.lock build(deps): bump yup from 0.32.6 to 0.32.8 (#223) 4 years ago

README.md

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).
  • Version update notifications in-app.
  • 4K requests (Includes multi-radarr/sonarr management for media)

Planned Features

  • More notification types (Slack/Telegram/etc.).
  • Issues system. This will allow users to report issues with content on your media server.
  • Local user system (for those who don't use Plex).
  • Compatiblity APIs (to work with existing tools in your system).

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:3000 \
  -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:3000/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

💻