Skip to content

Commit

Permalink
clarification of http-frontend.yml content
Browse files Browse the repository at this point in the history
  • Loading branch information
RobHumphris committed Nov 1, 2023
1 parent 913f3cf commit 55a3dc9
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions docs/guides/self-hosting/self_hosting_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit 55a3dc9

Please sign in to comment.