christianlight/tutor
6
0
Fork 0
mirror of https://github.com/ChristianLight/tutor.git synced 2024-11-15 01:34:14 +00:00
Code Issues Releases Activity
0e8f55798c
tutor/docs/tutorials/proxy.rst

16 lines
1.2 KiB
ReStructuredText
Raw Normal View History

docs: reorganize local guides in tutorials There is too much information in each of the local/k8s/dev docs pages. The "guides" that are listed in each one of those pages are moved either to "common tasks" or to a dedicated "tutorials" section. This paves the way for more comprehensive tutorials, where we describe how to run the latest master branches of Open edX. I am well aware that, as they stand, the tutorials are of poor quality and should be rewritten. This is a task for another day/commit. For now, we only move the contents to a separate part of the docs. Also, we should add a "reference" section to the docs, where we add the result of `tutor <subcommand> --help`.
2021-09-16 08:53:52 +00:00
.. _web_proxy:
Running Open edX behind a web proxy
===================================
The containerized web server (`Caddy <https://caddyserver.com/>`__) needs to listen to ports 80 and 443 on the host. If there is already a webserver running on the host, such as Apache or Nginx, the caddy container will not be able to start. Tutor supports running behind a web proxy. To do so, add the following configuration::
feat: get rid of the nginx container and services Nginx and Caddy performed duplicate tasks. It was decided to get rid of the nginx container, for simplification. This is a breaking change for plugin developers. Also, applications that collect nginx logs will have to be modified. See: - Corresponding TEP: https://discuss.overhang.io/t/tep-get-rid-of-the-nginx-container/2024 - the prior discussion: https://discuss.overhang.io/t/why-caddy-nginx/1952
2021-10-14 10:47:23 +00:00
tutor config save --set ENABLE_WEB_PROXY=false --set CADDY_HTTP_PORT=81
docs: reorganize local guides in tutorials There is too much information in each of the local/k8s/dev docs pages. The "guides" that are listed in each one of those pages are moved either to "common tasks" or to a dedicated "tutorials" section. This paves the way for more comprehensive tutorials, where we describe how to run the latest master branches of Open edX. I am well aware that, as they stand, the tutorials are of poor quality and should be rewritten. This is a task for another day/commit. For now, we only move the contents to a separate part of the docs. Also, we should add a "reference" section to the docs, where we add the result of `tutor <subcommand> --help`.
2021-09-16 08:53:52 +00:00
minor typos fixed
2022-03-27 10:36:55 +00:00
In this example, the caddy container port would be mapped to 81 instead of 80. You must then configure the web proxy on the host. As of v11.0.0, configuration files are no longer provided for the automatic configuration of your web proxy. You should set up a reverse proxy to `localhost:CADDY_HTTP_PORT` from the following hosts: LMS_HOST, PREVIEW_LMS_HOST, CMS_HOST, as well as any additional host exposed by your plugins.
docs: reorganize local guides in tutorials There is too much information in each of the local/k8s/dev docs pages. The "guides" that are listed in each one of those pages are moved either to "common tasks" or to a dedicated "tutorials" section. This paves the way for more comprehensive tutorials, where we describe how to run the latest master branches of Open edX. I am well aware that, as they stand, the tutorials are of poor quality and should be rewritten. This is a task for another day/commit. For now, we only move the contents to a separate part of the docs. Also, we should add a "reference" section to the docs, where we add the result of `tutor <subcommand> --help`.
2021-09-16 08:53:52 +00:00
.. warning::
feat: get rid of the nginx container and services Nginx and Caddy performed duplicate tasks. It was decided to get rid of the nginx container, for simplification. This is a breaking change for plugin developers. Also, applications that collect nginx logs will have to be modified. See: - Corresponding TEP: https://discuss.overhang.io/t/tep-get-rid-of-the-nginx-container/2024 - the prior discussion: https://discuss.overhang.io/t/why-caddy-nginx/1952
2021-10-14 10:47:23 +00:00
In this setup, the Caddy HTTP port will be exposed to the world. Make sure to configure your server firewall to block unwanted connections to your server's ``CADDY_HTTP_PORT``. Alternatively, you can configure the Caddy container to accept only local connections::
docs: reorganize local guides in tutorials There is too much information in each of the local/k8s/dev docs pages. The "guides" that are listed in each one of those pages are moved either to "common tasks" or to a dedicated "tutorials" section. This paves the way for more comprehensive tutorials, where we describe how to run the latest master branches of Open edX. I am well aware that, as they stand, the tutorials are of poor quality and should be rewritten. This is a task for another day/commit. For now, we only move the contents to a separate part of the docs. Also, we should add a "reference" section to the docs, where we add the result of `tutor <subcommand> --help`.
2021-09-16 08:53:52 +00:00
feat: get rid of the nginx container and services Nginx and Caddy performed duplicate tasks. It was decided to get rid of the nginx container, for simplification. This is a breaking change for plugin developers. Also, applications that collect nginx logs will have to be modified. See: - Corresponding TEP: https://discuss.overhang.io/t/tep-get-rid-of-the-nginx-container/2024 - the prior discussion: https://discuss.overhang.io/t/why-caddy-nginx/1952
2021-10-14 10:47:23 +00:00
tutor config save --set CADDY_HTTP_PORT=127.0.0.1:81
Copy Permalink