Skip to content

Commit

Permalink
Merge pull request #236 from Ombi-app/development
Browse files Browse the repository at this point in the history
Development
  • Loading branch information
Berserkir-Wolf committed Oct 15, 2023
2 parents d5e9389 + cb7e951 commit 8c07bcf
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/guides/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ For considerations when migrating an existing install rather than starting fresh
1. Install Ombi for your preferred OS using the steps provided below.
If you are migrating systems, rather than starting fresh, stop here and look at [Migrating Systems](#migrating-systems).
1. Configure your [install-specific settings](../../settings/customization) like the application url you'll be using externally.
1. Configure external access to Ombi. We recommend using SSL and a [reverse proxy](../../info/reverse-proxy).
1. Configure external access to Ombi. We strongly recommend using a [reverse proxy](../../info/reverse-proxy) for a friendly URL and providing SSL.
1. Configure notification methods and system connections (Sonarr, Radarr, etc).
Ensure you have systems to handle approved requests _before_ you give users access to the system.
1. [Import users](../../settings/usermanagement) and [assign permissions](../../info/user-roles).
Expand Down
18 changes: 18 additions & 0 deletions docs/info/reverse-proxy.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,24 @@
> Note: These examples assume you are using **_/ombi_** as your **Base URL**.
> If your **Base URL** differs, replace all instances of **_/ombi_** with **_/YourBaseURL_**.
> If you're using a **subdomain** (ombi.example.com), replace all instances of **_/ombi_** with **_/_**, and remove the first _location_ block.
## Why use a reverse proxy?

There are a few reasons to consider using a reverse proxy for providing access to Ombi.
These include:

- Providing a nice URL for users to access (instead of "http://your.external.ip.address:port").
- Providing a layer of SSL security for your Ombi users.

### A "nice URL"?

By default, the internet uses IP addresses to communicate. A service called DNS provides a way to alias these addresses with nice names (www.example.com, for example), rather than the direct IP address. Think of it like a phonebook for the internet, allowing you to look up a more complicated entry with an easy to remember name.
Setting up a reverse proxy allows you to use a nice url like "your.site.com", instead of just your external IP address.

### Providing SSL

Ombi doesn't do SSL in and of itself. We write a specific tool, for a specific purpose, and we're not going to be able to do SSL better than a dedicated web server software can.
As such, we recommend implementing a reverse proxy to handle that side of communication.

## Nginx

Expand Down
4 changes: 2 additions & 2 deletions docs/info/startup-parameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ Multiple parameters can be passed at once, and should be separated with a space,
For example, `--host http://localhost:123;http://ip.of.ombi.host:123`.
Use "\*" to indicate that the server should listen for requests on any IP held by the system it's installed on using the specified port and protocol.
For example, `--host http://*:5000` would listen on localhost, the machine IPv4 address, and the IPv6 address.
The protocol (http:// or https://) **must** be included with each URL.
Note: if behind a reverse proxy, Ombi should use `http://` as the proxy will handle the "s" part.
The protocol (http://) **must** be included with each URL.
Note: this must be `http://`, as Ombi itself does not handle the "s" part. For that, you need a proxy.
Default = `http://*:5000`

=== "Storage"
Expand Down

0 comments on commit 8c07bcf

Please sign in to comment.