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

125 lines
5.7 KiB

7 years ago
![](http://i.imgur.com/qQsN78U.png)
____
7 years ago
[![Discord](https://img.shields.io/discord/102860784329052160.svg)](https://discord.gg/KxYZ64w)
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
[![Crowdin](https://d322cqt584bo4o.cloudfront.net/ombi/localized.svg)](https://crowdin.com/project/ombi)
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
[![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
7 years ago
| Service | Master (Version 2.0 - Recommended) | Open Beta (Version 3.0) |
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/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/DotNetCore/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 and TV Shows (whether it being the entire series, an entire season, or even single episodes.)
8 years ago
* Easily manage your requests
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 so you don't have to worry about those script kiddies
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
7 years ago
* Ombi will automatically update itself :)
* Very fast system.
7 years ago
8 years ago
### Integration
We integrate with the following applications:
7 years ago
* Plex Media Server
* Emby
8 years ago
* Sonarr
7 years ago
* Radarr (beta)
* DogNzb
7 years ago
* Couch Potato
8 years ago
### Notifications
Supported notifications:
* SMTP Notifications (Email)
* Discord
* Slack
8 years ago
* Pushbullet
* Pushover
* Mattermost
### The difference between Version 3 and 2
7 years ago
Over the last 7 months, 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.
7 years ago
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 |
7 years ago
|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 Logo in Ombi and notifications | Yes | No |
| Sending newsletters | Planned | Yes |
| Send a Mass Email | Planned | Yes |
| SickRage | Planned (not supported yet)| Yes |
7 years ago
| CouchPotato | Yes | Yes |
7 years ago
| Watcher | Planned | Yes |
| DogNzb | Yes | No |
7 years ago
| Headphones | No (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
7 years ago
You may need to install libwind8.
```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)!
# 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/)
- [BrowserStack](https://www.browserstack.com) for allowing us to use their platform for testing