From 55a3dc941a9e0be9006675c0edd46ed95d39c7af Mon Sep 17 00:00:00 2001 From: RobHumphris Date: Wed, 1 Nov 2023 09:52:08 +0000 Subject: [PATCH] clarification of http-frontend.yml content --- docs/guides/self-hosting/self_hosting_guide.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/docs/guides/self-hosting/self_hosting_guide.md b/docs/guides/self-hosting/self_hosting_guide.md index 814fab756..4fe1b0fdc 100644 --- a/docs/guides/self-hosting/self_hosting_guide.md +++ b/docs/guides/self-hosting/self_hosting_guide.md @@ -192,15 +192,20 @@ Nice work! The `zrok` controller is fully configured now that you have created t ## Configure the Public Frontend -Create `etc/http-frontend.yml`. This frontend config file has a `host_match` pattern that represents the DNS zone you're using with this instance of zrok. Incoming HTTP requests with a matching `Host` header will be handled by this frontend. You may also specify the interface address where the frontend will listen for public access requests. - -The frontend does not provide server TLS, but you may front the server with a reverse proxy. It is essential the reverse proxy forwards the `Host` header supplied by the viewer. This example will expose the non-TLS listener for the frontend. +Create an http frontend configuration file in `etc/http-frontend.yml`. ```yaml -host_match: zrok.quigley.com -address: 0.0.0.0:8080 +v: 3 +host_match: zrok.quigley.com +address: 0.0.0.0:8080 ``` +This frontend config file has a `host_match` pattern that represents the DNS zone you're using with this instance of zrok. Incoming HTTP requests with a matching `Host` header will be handled by this frontend. You may also specify the interface address where the frontend will listen for public access requests. + +The frontend does not provide server TLS, but you may front the server with a reverse proxy. It is essential the reverse proxy forwards the `Host` header supplied by the viewer. This example will expose the non-TLS listener for the frontend. + +You can also specify an `oauth` configuration in this file, full details of are found in [OAuth Public Frontend Configuration](oauth/configuring-oauth.md#configuring-your-public-frontend). + ## Start Public Frontend In another terminal window, run: