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

130 lines
6.5 KiB

7 years ago
![](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)
7 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)
7 years ago
[![firsttimersonly](http://img.shields.io/badge/first--timers--only-friendly-blue.svg?style=flat-square)](http://www.firsttimersonly.com/)
7 years ago
[![Patreon](https://www.ombi.io/img/patreondonate.svg)](https://patreon.com/tidusjar/Ombi)
[![Paypal](https://www.ombi.io/img/paypaldonate.svg)](https://paypal.me/PlexRequestsNet)
7 years ago
[![Gratipay User](https://img.shields.io/gratipay/user/tidusjar.svg)](https://gratipay.com/Ombi/)
7 years ago
[![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)
7 years ago
| Service | Master (Recommend Version 3.0) | Early Access | Dev |
|----------|:---------------------------:|:----------------------------:|:----------------------------:|
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/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)
| Download |[![Download](http://i.imgur.com/odToka3.png)](https://ci.appveyor.com/project/tidusjar/requestplex/branch/DotNetCore/artifacts) | [![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) |
# Features
Here some of the features Ombi V3 has:
* Out of the box working on all OS Just download the zip and start Ombi!
* Let users request Movies and TV Shows (Whole series, whole seaons or even single episodes!)
8 years ago
* Easily manage your requests
7 years ago
* User management system (supports plex.tv accounts and local accounts)
* Allow your users to report issues and manage them separately
8 years ago
* 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 custom 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?!
7 years ago
* It automatically updates the status of requests when they are available on Plex
* Slick, responsive and mobile friendly UI
* Ombi wil automatically update here self :)
* Very fast system.
7 years ago
8 years ago
### Integration
We integrate with the following applications:
* Plex server
* Emby
8 years ago
* Sonarr
7 years ago
* Radarr (beta)
8 years ago
### Notifications
Supported notifications:
* SMTP Notifications (Email)
* Discord
* Slack
8 years ago
* Pushbullet
* Pushover
* Mattermost
### The difference between Version 3 and 2
Over the last 7 months, we focust on the main functions on Ombi.
Make it better, faster and more stable.
We did already a lot of work, but you will still miss some functions in the new version.
We are planning to bring this features back in Version 3. You can find a list below with the feature difference.
| Service | Version 3 | Version 2 |
|----------|:----------:|:----------:|
| Supported online | Yes | No |
| Emby & Plex support | Yes | Yes |
| Mono needed | 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 |
| Change bulk roles in user management | 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 | X (support dropped) | Yes |
8 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)
8 years ago
# Preview
8 years ago
![Preview](http://i.imgur.com/yrz2pzl.gif)
8 years ago
# Installation
Windows: Download the windows zip file above and run ombi.exe
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
Sometimes you need to install libwind8.
Pleas run the following command:
```apt-get install libunwind8```
# FAQ
7 years ago
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!
7 years ago
Please feel free to submit a pull request!
# Donation
7 years ago
If you feel like donating you can donate with the below buttons!
[![Patreon](https://www.ombi.io/img/patreondonate.svg)](https://patreon.com/tidusjar/Ombi)
[![Paypal](https://www.ombi.io/img/paypaldonate.svg)](https://paypal.me/PlexRequestsNet)
7 years ago
### A massive thanks to everyone for all their helps!
## Stats
7 years ago
[![Throughput Graph](https://graphs.waffle.io/tidusjar/PlexRequests.Net/throughput.svg)](https://waffle.io/tidusjar/PlexRequests.Net/metrics/throughput)
7 years ago
### Sponsors ###
- [JetBrains](http://www.jetbrains.com/) for providing us with free licenses to their great tools
- [ReSharper](http://www.jetbrains.com/resharper/)