robin/haze
1
0
Fork 0
mirror of https://codeberg.org/icewind/haze.git synced 2026-10-01 08:44:09 +02:00
Code Issues Projects Releases Wiki Activity

spelling fixes in changelog and book

Browse source
This commit is contained in:
Robin Appelman 2026-09-23 15:10:49 +02:00
commit 51d0279c41
14 changed files with 110 additions and 102 deletions
Download patch file Download diff file Expand all files Collapse all files

16
book/src/proxy/README.md
View file

@ -1,7 +1,7 @@
# Proxy
By default, instances can be accessed by their IP. In order to get more
memorable URLs and allow supporting https. haze comes with a builtin reverse
memorable URLs and allow supporting HTTPS. haze comes with a builtin reverse
proxy to allow using a wildcard domain.
## Setup
@ -10,17 +10,17 @@ proxy to allow using a wildcard domain.
`haze.example.com` pointing to your development machine.
- Set the `proxy` configuration with your domain and desired listen endpoint.
- Set up a service to run `haze proxy` in the background as your own user. A
systemd user service is recommended (see
SystemD user service is recommended (see
[haze.service](<[./haze.service](https://codeberg.org/icewind/haze/src/branch/main/haze.service)>)
for an example).
- If you're already running a reverse proxy, configure your reverse proxy of
choice to proxy `*.haze.example.com` and `haze.example.com` to the proxy's
listen endpoint.
- (Optionally) [setup https](./https.html) for the proxy.
- (Optionally) [setup HTTPS](./https.html) for the proxy.
### Configuration
Add the following configuration to the `haze.toml` config file:
Add the following configuration to the `haze.toml` configuration file:
```toml
[proxy]
@ -34,13 +34,13 @@ listen = "127.0.0.1:8080" # the port+ip to listen on
If you have no other http(s) servers on your development machine, you can setup
things without a reverse proxy.
Simply configure the proxy to listen on port `80` (or `443` when using http).
Simply configure the proxy to listen on port `80` (or `443` when using HTTPS).
Binding to port 80 or443 as a regular user requires either giving the haze
binary the `net_bind_service` capability with
`sudo setcap cap_net_bind_service=+ep $(which haze)` (this will have to be done
every time your upgrade haze) or configure your system to allow unpriviled users
to bind on the low port numbers. Using
every time your upgrade haze) or configure your system to allow unprivileged
users to bind on the low port numbers. Using
`sysctl net.ipv4.ip_unprivileged_port_start=80` and writing
```
@ -56,7 +56,7 @@ probably want to setup a reverse proxy to allow them to all be served on your
machine.
The setup for this will depend on your reverse proxy of the choice, the
following example config is for `nginx`.
following example configuration is for `nginx`.
```nginx
upstream haze-handler {