libretime/docs/getting-started/reverse-proxy.md

111 lines
4.2 KiB
Markdown
Raw Normal View History

2020-11-02 19:20:34 +01:00
---
title: Reverse Proxy
sidebar_position: 5
2020-11-02 19:20:34 +01:00
---
In some deployments, the LibreTime server is deployed behind a reverse proxy,
for example in containerization use-cases such as Docker and LXC. LibreTime
makes extensive use of its API for some site functionality, which causes
[Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS)
to occur. By default, CORS requests are blocked by your browser and the origins
need to be added to the **Allowed CORS URLs** block in
[**General Settings**](/docs/guides/settings). These origins should include any
2020-11-02 19:20:34 +01:00
domains that will be used externally to connect to your reverse proxy that you
want handled by LibreTime. These URLS can also be set during the first run configuration
that is displayed when you first install LibreTime
### Reverse proxy basics
2020-11-02 19:20:34 +01:00
A reverse proxy allows the LibreTime server to not be connected to the open internet. In
this configuration, it is rather behind another server that proxies traffic to it from
users. This provides some advantages in the containerization space, as this means that
the containers can be on their own internal network, protected from outside access.
A reverse proxy also allows SSL to be terminated in a single location for multiple sites.
This means that all your traffic to the proxy from clients is encrypted, but the reverse
proxy's traffic to the containers on the internal network is not. All the SSL certificates
live on the reverse proxy and can be renewed there instead of on the individual
containers.
### Setup
For SSL redirection to work, you need two domains: one for LibreTime and one for Icecast.
Here, these will be `libretime.example.com` and `icecast.example.com`.
2020-11-02 19:20:34 +01:00
You will also require two VMs, servers or containers. Alternatively the reverse proxy can
be located on the server, proxying connections to containers also on the host. Setting up
a containerization environment is beyond the scope of this guide. It assumes that you have
Nginx set up on `localhost` and LibreTime will be installed on `192.168.1.10`. You will need root
access on both. `192.168.1.10` also needs to be able to be accessed from `localhost`
(`ping 192.168.1.10` on `localhost`).
2020-11-02 19:20:34 +01:00
On `192.168.1.10`, install LibreTime as described in the [install guide](/docs/getting-started/install). Once it has installed, replace `<hostname>localhost</hostname>` in
2020-11-02 19:20:34 +01:00
`/etc/icecast2/icecast.xml` with the following:
```xml
2020-11-02 19:20:34 +01:00
<hostname>icecast.example.com</hostname>
```
This is the hostname that people listening to your stream will connect to and what
LibreTime will use to stream out to them. You will then need to restart Icecast using `sudo systemctl restart icecast2`.
2020-11-02 19:20:34 +01:00
On `localhost`, run the following:
2020-11-02 19:20:34 +01:00
```bash
2020-11-02 19:20:34 +01:00
cat << EOF | sudo tee /etc/nginx/sites-available/libretime.conf
server {
listen 80;
server_name libretime.example.com;
location / {
rewrite ^ https://$server_name$request_uri? permanent;
}
}
server {
listen 443 ssl;
server_name libretime.example.com;
ssl_certificate /etc/letsencrypt/live/libretime.example.com/fullchain.pem;
ssl_certificate_key /etc/letsencrypt/live/libretime.example.com/privkey.pem;
add_header Strict-Transport-Security "max-age=15552000;";
add_header X-Frame-Options "SAMEORIGIN";
client_max_body_size 512M;
location / {
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
2022-02-16 09:48:01 +01:00
proxy_pass http://192.168.1.10/;
2020-11-02 19:20:34 +01:00
}
}
EOF
```
This Nginx configuration ensures that all traffic uses SSL to the reverse proxy, and
2022-02-16 09:48:01 +01:00
traffic is proxied to `192.168.1.10`.
2020-11-02 19:20:34 +01:00
Next, the SSL certificate needs to be generated and the site activated.
```
sudo apt install certbot
sudo systemctl stop nginx
sudo certbot certonly -d libretime.example.com -a standalone
sudo systemctl start nginx
```
2022-02-16 09:48:01 +01:00
You can now go to `https://libretime.example.com` and go
2020-11-02 19:20:34 +01:00
through the installer. On `General Settings`, you need to change the Webserver Port to
`443` and add the following CORS URLs:
```
https://libretime.example.com
http://libretime.example.com
https://localhost
http://localhost
2020-11-17 01:59:30 +01:00
```
Finally, the configuration file needs updating. Under `[general]`, `force_ssl`
needs to be set to true:
```ini
2020-11-17 01:59:30 +01:00
[general]
...
force_ssl = true
```