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

141 lines
6.1 KiB

7 years ago
![](http://i.imgur.com/qQsN78U.png)
7 years ago
____
[![Discord](https://img.shields.io/discord/270828201473736705.svg)](https://discord.gg/Sa7wNWb)
8 years ago
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/ombi.svg)](https://hub.docker.com/r/linuxserver/ombi/)
[![Github All Releases](https://img.shields.io/github/downloads/tidusjar/Ombi/total.svg)](https://github.com/tidusjar/Ombi)
[![firsttimersonly](http://img.shields.io/badge/first--timers--only-friendly-blue.svg)](http://www.firsttimersonly.com/)
7 years ago
[![Crowdin](https://d322cqt584bo4o.cloudfront.net/ombi/localized.svg)](https://crowdin.com/project/ombi)
8 years ago
[![Patreon](https://img.shields.io/badge/patreon-donate-yellow.svg)](https://patreon.com/tidusjar/Ombi)
[![Paypal](https://img.shields.io/badge/paypal-donate-yellow.svg)](https://paypal.me/PlexRequestsNet)
6 years ago
___
6 years ago
[![Twitter](https://img.shields.io/twitter/follow/tidusjar.svg?style=social)](https://twitter.com/intent/follow?screen_name=tidusjar)
6 years ago
Follow me developing Ombi!
[![Twitch](https://img.shields.io/badge/Twitch-Watch-blue.svg?style=flat-square&logo=twitch)](https://www.twitch.tv/tidusjar)
6 years ago
7 years ago
___
<a href='https://play.google.com/store/apps/details?id=com.tidusjar.Ombi&pcampaignid=MKT-Other-global-all-co-prtnr-py-PartBadge-Mar2515-1'><img width="150" alt='Get it on Google Play' src='https://play.google.com/intl/en_gb/badges/images/generic/en_badge_web_generic.png'/></a>
<br>
_**Note:** There is no longer an iOS app due to complications outside of our control._
7 years ago
8 years ago
___
8 years ago
We also now have merch up on Teespring!
[EU Store](https://teespring.com/stores/ombi-eu)
[US Store](https://teespring.com/stores/ombi-us)
___
8 years ago
7 years ago
| Service | Stable | Develop |
7 years ago
|----------|:---------------------------:|:----------------------------:|
| AppVeyor | [![Build status](https://ci.appveyor.com/api/projects/status/hgj8j6lcea7j0yhn/branch/master?svg=true)](https://ci.appveyor.com/project/tidusjar/requestplex/branch/master) | [![Build status](https://ci.appveyor.com/api/projects/status/hgj8j6lcea7j0yhn/branch/develop?svg=true)](https://ci.appveyor.com/project/tidusjar/requestplex/branch/develop) |
| Download |[![Download](http://i.imgur.com/odToka3.png)](https://github.com/tidusjar/Ombi/releases) | [![Download](http://i.imgur.com/odToka3.png)](https://ci.appveyor.com/project/tidusjar/requestplex/branch/develop/artifacts) |
# Features
7 years ago
Here are some of the features Ombi V3 has:
7 years ago
* Now working without crashes on Linux.
* Lets users request Movies, Music, and TV Shows (whether it being the entire series, an entire season, or even single episodes.)
9 years ago
* Easily manage your requests
* Allows you to set specific users to automatically have requests approved and added to the relevant service (Sonarr/Radarr/Lidarr/Couchpotato etc)
7 years ago
* User management system (supports plex.tv, Emby and local accounts)
* A landing page that will give you the availability of your Plex/Emby server and also add custom notification text to inform your users of downtime.
7 years ago
* Allows your users to get custom notifications!
* Secure authentication using best practises
7 years ago
* Will show if the request is already on plex or even if it's already monitored.
* Automatically updates the status of requests when they are available on Plex/Emby
* Slick, responsive and mobile friendly UI
* Ombi will automatically update itself :) (YMMV)
* Very fast!
8 years ago
9 years ago
### Integration
We integrate with the following applications:
7 years ago
* Plex Media Server
* Emby
9 years ago
* Sonarr
* Radarr
* Lidarr
* DogNzb
7 years ago
* Couch Potato
9 years ago
### Notifications
Supported notifications:
* SMTP Notifications (Email)
* Discord
* Gotify
* Slack
9 years ago
* Pushbullet
* Pushover
* Mattermost
* Telegram
### The difference between Version 3 and 2
Over the last year, we focused on the main functions on Ombi, a complete rewrite while making it better, faster and more stable.
7 years ago
We have already done most of the work, but some features are still be missing in this first version.
We are planning to bring back these features in V3 but for now you can find a list below with a quick comparison of features between v2 and v3.
| Service | Version 3 | Version 2 |
|----------|:----------:|:----------:|
| Multiple Plex/Emby Servers| Yes | No |
| Emby & Plex support | Yes | Yes |
7 years ago
| Mono dependency | No | Yes |
| Notifications support | Yes| Yes |
| Landing page | Yes (brand new) | Yes |
| Login page | Yes (brand new) | Yes |
| Custom Notification Messages | Yes | No |
| Sending newsletters | Yes | Yes |
| Send a Mass Email | Yes | Yes |
7 years ago
| SickRage | Yes | Yes |
7 years ago
| CouchPotato | Yes | Yes |
| DogNzb | Yes | No |
7 years ago
| Issues | Yes | Yes |
| Headphones | No | Yes |
| Lidarr | Yes | No |
9 years ago
8 years ago
# Feature Requests
Feature requests are handled on FeatHub.
Search the existing requests to see if your suggestion has already been submitted.
8 years ago
(If a similar request exists, give it a thumbs up (+1), or add additional comments to the request)
8 years ago
#### [![Feature Requests](https://cloud.githubusercontent.com/assets/390379/10127973/045b3a96-6560-11e5-9b20-31a2032956b2.png)](http://feathub.com/tidusjar/Ombi)
9 years ago
# Preview
![Preview](http://i.imgur.com/Nn1BwAM.gif)
9 years ago
# Installation
7 years ago
[Installation Guide](https://github.com/tidusjar/Ombi/wiki/Installation)
[Here for Reverse Proxy Config Examples](https://github.com/tidusjar/Ombi/wiki/Reverse-Proxy-Examples)
[PlexGuide.com - Ombi Deployment & 101 Demonstration!](https://www.youtube.com/watch?v=QPNlqqkjNJw&feature=youtu.be)
# Contributors
We are looking for any contributions to the project! Just pick up a task, if you have any questions ask and i'll get straight on it!
8 years ago
Please feel free to submit a pull request!
# Donation
8 years ago
If you feel like donating you can donate with the below buttons!
6 years ago
[![Patreon](https://img.shields.io/badge/patreon-donate-yellow.svg)](https://patreon.com/tidusjar/Ombi)
[![Paypal](https://img.shields.io/badge/paypal-donate-yellow.svg)](https://paypal.me/PlexRequestsNet)
### A massive thanks to everyone for all their help!
8 years ago
8 years ago
### Sponsors ###
- [JetBrains](http://www.jetbrains.com/) for providing us with free licenses to their great tools
- [ReSharper](http://www.jetbrains.com/resharper/)
- [BrowserStack](https://www.browserstack.com) for allowing us to use their platform for testing