sct
79629645aa
|
4 years ago | |
|---|---|---|
| .github | 4 years ago | |
| .vscode | ||
| config | ||
| docs | 4 years ago | |
| public | 4 years ago | |
| server | 4 years ago | |
| src | 4 years ago | |
| .all-contributorsrc | 4 years ago | |
| .dockerignore | ||
| .editorconfig | ||
| .eslintrc.js | ||
| .gitbook.yaml | 4 years ago | |
| .gitignore | 4 years ago | |
| .prettierignore | ||
| CODE_OF_CONDUCT.md | ||
| CONTRIBUTING.md | 4 years ago | |
| Dockerfile | 4 years ago | |
| Dockerfile.local | ||
| LICENSE | ||
| README.md | 4 years ago | |
| babel.config.js | ||
| docker-compose.yml | ||
| next-env.d.ts | ||
| next.config.js | 4 years ago | |
| ormconfig.js | ||
| overseerr-api.yml | 4 years ago | |
| package.json | 4 years ago | |
| postcss.config.js | ||
| stylelint.config.js | ||
| tailwind.config.js | 4 years ago | |
| tsconfig.json | ||
| yarn.lock | 4 years ago | |
README.md
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).
- 4K requests (Includes multi-radarr/sonarr management for media)
Planned Features
- More notification types.
- 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).
- Compatibility APIs (to work with existing tools in your system).
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
- Check out the Overseerr Documentation before asking for help. Your question might already be in the FAQ.
- You can get support on Discord.
- You can ask questions in the Help category of our GitHub Discussions.
- Bugs/Feature Requests can be opened via a GitHub issue.
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):
