Merge pull request #437 from RobHumphris/issue-436

clarification of http-frontend.yml content
This commit is contained in:
Michael Quigley 2023-11-01 14:28:32 -04:00 committed by GitHub
commit 795b953845
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -192,14 +192,19 @@ 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.
Create an http frontend configuration file in `etc/http-frontend.yml`.
```yaml
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.
```yaml
host_match: zrok.quigley.com
address: 0.0.0.0:8080
```
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