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

92 lines
5.0 KiB

![](http://i.imgur.com/qQsN78U.png)
____
[![Gitter](https://badges.gitter.im/tidusjar/Ombi.svg)](https://gitter.im/tidusjar/Ombi?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
[![Build status](https://ci.appveyor.com/api/projects/status/hgj8j6lcea7j0yhn?svg=true)](https://ci.appveyor.com/project/tidusjar/requestplex)
[![Linux Status](https://travis-ci.org/tidusjar/Ombi.svg)](https://travis-ci.org/tidusjar/Ombi)
[![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/tidusjar/Ombi.svg)](http://isitmaintained.com/project/tidusjar/Ombi "Average time to resolve an issue")
[![Percentage of issues still open](http://isitmaintained.com/badge/open/tidusjar/Ombi.svg)](http://isitmaintained.com/project/tidusjar/Ombi "Percentage of issues still open")
[![Github All Releases](https://img.shields.io/github/downloads/tidusjar/Ombi/total.svg)](https://github.com/tidusjar/Ombi)
[![Stories in Progress](https://badge.waffle.io/tidusjar/Ombi.svg?label=in progress&title=In Progress)](http://waffle.io/tidusjar/Ombi)
| Service | Master | Early Access | Dev |
|----------|:---------------------------:|:----------------------------:|:----------------------------:|
| 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)
| Travis | [![Travis](https://img.shields.io/travis/tidusjar/Ombi/master.svg)](https://travis-ci.org/tidusjar/Ombi) | [![Travis](https://img.shields.io/travis/tidusjar/Ombi/EAP.svg)](https://travis-ci.org/tidusjar/Ombi) | [![Travis](https://img.shields.io/travis/tidusjar/Ombi/dev.svg)](https://travis-ci.org/tidusjar/Ombi)
# Features
Here some of the features Ombi has:
* All your users to Request Movies, TV Shows (Whole series, whole seaons or even single episodes!) and Albums
* Easily manage your requests
* User management system (supports plex.tv accounts and local accounts) [NEW]
* Sending newsletters [NEW]
* Fault Queue for requests (Buffer requests if Sonar/Couchpotato/SickRage is offline) [NEW]
* 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
* We check to see if the request is already in Plex, if it's already in Plex then why you requesting it?!
* We have allowed the ability for a user to add a custom note on a request
* It automatically updates the status of requests when they are available on Plex
* Slick, responsive and mobile friendly UI
### Integration
We integrate with the following applications:
* Plex server 1.2 (and higher)
* Sonarr
* SickRage
* CouchPotato
* Headphones
### Notifications
Supported notifications:
* SMTP Notifications (Email)
* Pushbullet
* Pushover
* Slack
* Weekly Recently Added email notification to all of your Plex Users!
# Feature Requests
Feature requests are handled on FeatHub.
Search the existing requests to see if your suggestion has already been submitted.
(If a similar request exists, give it a thumbs up (+1), or add additional comments to the request)
#### [![Feature Requests](https://cloud.githubusercontent.com/assets/390379/10127973/045b3a96-6560-11e5-9b20-31a2032956b2.png)](http://feathub.com/tidusjar/Ombi)
# Preview
![Preview](http://i.imgur.com/yrz2pzl.gif)
# Installation
[Windows Guide!](http://www.htpcguides.com/install-plex-requests-net-windows-system-service/)
[Ubuntu Guide!](http://www.htpcguides.com/install-plex-requests-net-ubuntu-14-x/)
# FAQ
Do you have an issue or a question? if so check out our [FAQ](https://github.com/tidusjar/Ombi/wiki/FAQ)!
# Docker
Looking for a Docker Image? Well [rogueosb](https://github.com/rogueosb/) has created a docker image for us, You can find it [here](https://github.com/rogueosb/docker-plexrequestsnet) :smile:
# 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!
Please feel free to submit a pull request!
# Donation
If you feel like donating you can donate [here](https://paypal.me/PlexRequestsNet)!
### A massive thanks to everyone for all their helps!
## Stats
[![Throughput Graph](https://graphs.waffle.io/tidusjar/PlexRequests.Net/throughput.svg)](https://waffle.io/tidusjar/PlexRequests.Net/metrics/throughput)
### Sponsors ###
- [JetBrains](http://www.jetbrains.com/) for providing us with free licenses to their great tools
- [ReSharper](http://www.jetbrains.com/resharper/)