mirror of
https://github.com/juanfont/headscale.git
synced 2024-12-20 19:09:07 +01:00
Moved TLS config to another file
This commit is contained in:
parent
efe208fef5
commit
d1e8ac7ba5
@ -55,33 +55,15 @@ db_path: db.sqlite
|
|||||||
|
|
||||||
The fields starting with `db_` are used for the DB connection information.
|
The fields starting with `db_` are used for the DB connection information.
|
||||||
|
|
||||||
### Running the service via TLS (optional)
|
### TLS configuration
|
||||||
|
|
||||||
```yaml
|
Please check [`TLS.md`](TLS.md).
|
||||||
tls_cert_path: ''
|
|
||||||
tls_key_path: ''
|
|
||||||
```
|
|
||||||
|
|
||||||
Headscale can be configured to expose its web service via TLS. To configure the certificate and key file manually, set the `tls_cert_path` and `tls_cert_path` configuration parameters. If the path is relative, it will be interpreted as relative to the directory the configuration file was read from.
|
|
||||||
|
|
||||||
```yaml
|
### DNS configuration
|
||||||
tls_letsencrypt_hostname: ''
|
|
||||||
tls_letsencrypt_listen: ":http"
|
|
||||||
tls_letsencrypt_cache_dir: ".cache"
|
|
||||||
tls_letsencrypt_challenge_type: HTTP-01
|
|
||||||
```
|
|
||||||
|
|
||||||
To get a certificate automatically via [Let's Encrypt](https://letsencrypt.org/), set `tls_letsencrypt_hostname` to the desired certificate hostname. This name must resolve to the IP address(es) Headscale is reachable on (i.e., it must correspond to the `server_url` configuration parameter). The certificate and Let's Encrypt account credentials will be stored in the directory configured in `tls_letsencrypt_cache_dir`. If the path is relative, it will be interpreted as relative to the directory the configuration file was read from. The certificate will automatically be renewed as needed.
|
Please refer to [`DNS.md`](DNS.md).
|
||||||
|
|
||||||
#### Challenge type HTTP-01
|
|
||||||
|
|
||||||
The default challenge type `HTTP-01` requires that Headscale is reachable on port 80 for the Let's Encrypt automated validation, in addition to whatever port is configured in `listen_addr`. By default, Headscale listens on port 80 on all local IPs for Let's Encrypt automated validation.
|
|
||||||
|
|
||||||
If you need to change the ip and/or port used by Headscale for the Let's Encrypt validation process, set `tls_letsencrypt_listen` to the appropriate value. This can be handy if you are running Headscale as a non-root user (or can't run `setcap`). Keep in mind, however, that Let's Encrypt will _only_ connect to port 80 for the validation callback, so if you change `tls_letsencrypt_listen` you will also need to configure something else (e.g. a firewall rule) to forward the traffic from port 80 to the ip:port combination specified in `tls_letsencrypt_listen`.
|
|
||||||
|
|
||||||
#### Challenge type TLS-ALPN-01
|
|
||||||
|
|
||||||
Alternatively, `tls_letsencrypt_challenge_type` can be set to `TLS-ALPN-01`. In this configuration, Headscale listens on the ip:port combination defined in `listen_addr`. Let's Encrypt will _only_ connect to port 443 for the validation callback, so if `listen_addr` is not set to port 443, something else (e.g. a firewall rule) will be required to forward the traffic from port 443 to the ip:port combination specified in `listen_addr`.
|
|
||||||
|
|
||||||
### Policy ACLs
|
### Policy ACLs
|
||||||
|
|
||||||
@ -95,14 +77,3 @@ Please check https://tailscale.com/kb/1018/acls/, and `./tests/acls/` in this re
|
|||||||
### Apple devices
|
### Apple devices
|
||||||
|
|
||||||
An endpoint with information on how to connect your Apple devices (currently macOS only) is available at `/apple` on your running instance.
|
An endpoint with information on how to connect your Apple devices (currently macOS only) is available at `/apple` on your running instance.
|
||||||
|
|
||||||
## Disclaimer
|
|
||||||
|
|
||||||
1. We have nothing to do with Tailscale, or Tailscale Inc.
|
|
||||||
2. The purpose of writing this was to learn how Tailscale works.
|
|
||||||
|
|
||||||
## More on Tailscale
|
|
||||||
|
|
||||||
- https://tailscale.com/blog/how-tailscale-works/
|
|
||||||
- https://tailscale.com/blog/tailscale-key-management/
|
|
||||||
- https://tailscale.com/blog/an-unlikely-database-migration/
|
|
||||||
|
31
docs/TLS.md
Normal file
31
docs/TLS.md
Normal file
@ -0,0 +1,31 @@
|
|||||||
|
|
||||||
|
# Running the service via TLS (optional)
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
tls_letsencrypt_hostname: ''
|
||||||
|
tls_letsencrypt_listen: ":http"
|
||||||
|
tls_letsencrypt_cache_dir: ".cache"
|
||||||
|
tls_letsencrypt_challenge_type: HTTP-01
|
||||||
|
```
|
||||||
|
|
||||||
|
To get a certificate automatically via [Let's Encrypt](https://letsencrypt.org/), set `tls_letsencrypt_hostname` to the desired certificate hostname. This name must resolve to the IP address(es) Headscale is reachable on (i.e., it must correspond to the `server_url` configuration parameter). The certificate and Let's Encrypt account credentials will be stored in the directory configured in `tls_letsencrypt_cache_dir`. If the path is relative, it will be interpreted as relative to the directory the configuration file was read from. The certificate will automatically be renewed as needed.
|
||||||
|
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
tls_cert_path: ''
|
||||||
|
tls_key_path: ''
|
||||||
|
```
|
||||||
|
|
||||||
|
Headscale can also be configured to expose its web service via TLS. To configure the certificate and key file manually, set the `tls_cert_path` and `tls_cert_path` configuration parameters. If the path is relative, it will be interpreted as relative to the directory the configuration file was read from.
|
||||||
|
|
||||||
|
|
||||||
|
## Challenge type HTTP-01
|
||||||
|
|
||||||
|
The default challenge type `HTTP-01` requires that Headscale is reachable on port 80 for the Let's Encrypt automated validation, in addition to whatever port is configured in `listen_addr`. By default, Headscale listens on port 80 on all local IPs for Let's Encrypt automated validation.
|
||||||
|
|
||||||
|
If you need to change the ip and/or port used by Headscale for the Let's Encrypt validation process, set `tls_letsencrypt_listen` to the appropriate value. This can be handy if you are running Headscale as a non-root user (or can't run `setcap`). Keep in mind, however, that Let's Encrypt will _only_ connect to port 80 for the validation callback, so if you change `tls_letsencrypt_listen` you will also need to configure something else (e.g. a firewall rule) to forward the traffic from port 80 to the ip:port combination specified in `tls_letsencrypt_listen`.
|
||||||
|
|
||||||
|
## Challenge type TLS-ALPN-01
|
||||||
|
|
||||||
|
Alternatively, `tls_letsencrypt_challenge_type` can be set to `TLS-ALPN-01`. In this configuration, Headscale listens on the ip:port combination defined in `listen_addr`. Let's Encrypt will _only_ connect to port 443 for the validation callback, so if `listen_addr` is not set to port 443, something else (e.g. a firewall rule) will be required to forward the traffic from port 443 to the ip:port combination specified in `listen_addr`.
|
||||||
|
|
Loading…
Reference in New Issue
Block a user