github/Ombi
1
0
Fork 0
mirror of https://github.com/Ombi-app/Ombi.git synced 2025-07-14 09:12:57 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #1515 from tidusjar/PotatoQuality-patch-1

Browse source 
Prepare readme for upcoming beta
This commit is contained in:
PotatoQuality 2017-09-30 18:20:39 +02:00 • committed by GitHub
commit a269d16bc4
1 changed files with 52 additions and 27 deletions
Download patch file Download diff file Expand all files Collapse all files

79
README.md
View file

@ -14,46 +14,65 @@ ____
[![Report a bug](http://i.imgur.com/xSpw482.png)](https://github.com/tidusjar/Ombi/issues/new) [![Feature request](http://i.imgur.com/mFO0OuX.png)](http://feathub.com/tidusjar/Ombi) [![Report a bug](http://i.imgur.com/xSpw482.png)](https://github.com/tidusjar/Ombi/issues/new) [![Feature request](http://i.imgur.com/mFO0OuX.png)](http://feathub.com/tidusjar/Ombi)
| Service | Master (Recommend) | Early Access | Dev | V3 (Not ready for use!) | | Service | Master (Version 2.0 - Recommended) | Open Beta (Version 3.0) |
|----------|:---------------------------:|:----------------------------:|:----------------------------:|:----------------------------:| |----------|:---------------------------:|:----------------------------:|
| 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/eap?svg=true)](https://ci.appveyor.com/project/tidusjar/requestplex/branch/eap) | [![Build status](https://ci.appveyor.com/api/projects/status/hgj8j6lcea7j0yhn/branch/dev?svg=true)](https://ci.appveyor.com/project/tidusjar/requestplex/branch/dev)| [![Build status](https://ci.appveyor.com/api/projects/status/hgj8j6lcea7j0yhn/branch/DotNetCore?svg=true)](https://ci.appveyor.com/project/tidusjar/requestplex/branch/DotNetCore) | 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/DotNetCore?svg=true)](https://ci.appveyor.com/project/tidusjar/requestplex/branch/DotNetCore) |
| 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/eap/artifacts) | [![Download](http://i.imgur.com/odToka3.png)](https://ci.appveyor.com/project/tidusjar/requestplex/branch/dev/artifacts) |[![Download](http://i.imgur.com/odToka3.png)](https://ci.appveyor.com/project/tidusjar/requestplex/branch/DotNetCore/artifacts) | | 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/DotNetCore/artifacts) |
# Features # Features
Here some of the features Ombi has: Here are some of the features Ombi V3 has:
* All your users to Request Movies, TV Shows (Whole series, whole seaons or even single episodes!) and Albums * Now working without crashes on Linux.
* Lets users request Movies and TV Shows (whether it being the entire series, an entire season, or even single episodes.)
* Easily manage your requests * Easily manage your requests
* User management system (supports plex.tv accounts and local accounts) * User management system (supports plex.tv, Emby and local accounts)
* Sending newsletters * 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.
* Fault Queue for requests (Buffer requests if Sonar/Couchpotato/SickRage is offline) * Allows your users to get custom notifications!
* Allow your users to report issues and manage them separately
* A landing page that will give you the availability of your Plex server and also add custom notification text to inform your users of downtime.
* Allow your users to get notifications!
* Secure authentication so you don't have to worry about those script kiddies * Secure authentication so you don't have to worry about those script kiddies
* We check to see if the request is already in Plex, if it's already in Plex then why you requesting it?! * Will show if the request is already on plex or even if it's already monitored.
* We have allowed the ability for a user to add a custom note on a request * Automatically updates the status of requests when they are available on Plex/Emby
* It automatically updates the status of requests when they are available on Plex
* Slick, responsive and mobile friendly UI * Slick, responsive and mobile friendly UI
* Ombi will automatically update itself :)
* Very fast system.
### Integration ### Integration
We integrate with the following applications: We integrate with the following applications:
* Plex server 1.2 (and higher) * Plex Media Server
* Emby (beta) * Emby
* Sonarr * Sonarr
* SickRage
* CouchPotato
* Radarr (beta) * Radarr (beta)
* Watcher (beta)
* Headphones
### Notifications ### Notifications
Supported notifications: Supported notifications:
* SMTP Notifications (Email) * SMTP Notifications (Email)
* Discord
* Slack
* Pushbullet * Pushbullet
* Pushover * Pushover
* Slack * Mattermost
* Discord
* Weekly Recently Added email notification to all of your Plex Users! ### The difference between Version 3 and 2
Over the last 7 months, we focused on the main functions on Ombi, a complete rewrite while making it better, faster and more stable.
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 Version 3 but for now you can find a list below with a comparison of features between v2 and v3.
| Service | Version 3 | Version 2 |
|----------|:----------:|:----------:|
| Supported online | Yes | No |
|Multiple Plex/Emby Servers| Yes | No |
| Emby & Plex support | Yes | Yes |
| Mono dependency | No | Yes |
| Notifications support | Yes| Yes |
| Landing page | Yes (brand new) | Yes |
| Login page | Yes (brand new) | Yes |
| Custom Logo in Ombi and notifications | Yes | No |
| Sending newsletters | Planned | Yes |
| Send a Mass Email | Planned | Yes |
| SickRage | Planned (not supported yet)| Yes |
| CouchPotato | Planned | Yes |
| Watcher | Planned | Yes |
| Headphones | No (support dropped) | Yes |
# Feature Requests # Feature Requests
Feature requests are handled on FeatHub. Feature requests are handled on FeatHub.
@ -69,8 +88,14 @@ Search the existing requests to see if your suggestion has already been submitte
# Installation # Installation
[Windows Guide!](http://www.htpcguides.com/install-plex-requests-net-windows-system-service/) Windows: Download the windows zip file above and run ombi.exe
[Ubuntu Guide!](http://www.htpcguides.com/install-plex-requests-net-ubuntu-14-x/)
Linux: Download the linux zip file, run chmod +x Ombi to make the Ombi file an executable.
Get the following error?
libunwind.so.8: cannot open shared object file
You may need to install libwind8.
```apt-get install libunwind8```
# FAQ # FAQ
Do you have an issue or a question? if so check out our [FAQ](https://github.com/tidusjar/Ombi/wiki/FAQ)! Do you have an issue or a question? if so check out our [FAQ](https://github.com/tidusjar/Ombi/wiki/FAQ)!