From 5469b0874c178b6ce6e6f4259251eb45c05c5da5 Mon Sep 17 00:00:00 2001 From: Kyle Robbertze Date: Tue, 7 Jan 2020 09:36:03 +0200 Subject: [PATCH] Document CORS configuration better Fixes #917 --- docs/manual/general/index.md | 4 +++- docs/manual/getting-started/index.md | 12 ++++++++++++ 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/docs/manual/general/index.md b/docs/manual/general/index.md index d30c706af..c4dca1e11 100644 --- a/docs/manual/general/index.md +++ b/docs/manual/general/index.md @@ -50,7 +50,9 @@ wish. (There is more about this feature in the *Advanced Configuration* section of this book). The **Allowed CORS URLs** is intended to deal with situations where you want a -remote site with a different domain to access the API. +remote site with a different domain to access the API. This is relevant when +there is a reverse proxy server in front of LibreTime. If you are using a +reverse proxy, the URLs that will be used to access it should be added here. The **Display login button on your Radio Page?** will determine whether visitors to your site see a link to login. If this is disabled DJs and admins will need diff --git a/docs/manual/getting-started/index.md b/docs/manual/getting-started/index.md index 7a80a6a52..dc6871b6c 100644 --- a/docs/manual/getting-started/index.md +++ b/docs/manual/getting-started/index.md @@ -94,3 +94,15 @@ your LibreTime server has made to this Icecast server. If you have only just installed LibreTime, there may not be any media playing out yet. ![](static/Screenshot293-Icecast_status_page.png) + +Reverse Proxy Connections +------------------------- +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**](/manual/general/). These origins should include any +domains that will be used externally to connect to your reverse proxy that you +want handled by LibreTime.