custom-dockerfile/README.md

29 lines
2.4 KiB
Markdown
Raw Normal View History

2024-05-07 00:59:33 -04:00
# Environment Variables
2024-05-07 01:10:49 -04:00
| Name | Description | Default Value |
| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| DERP_HOSTNAME | Specifies the domain for the DERP server. | `example.com` |
| DERP_CERTMODE | Determines the SSL/TLS certificate management mode. Options: `manual`, `letsencrypt` | `letsencrypt` |
| DERP_ADDR | Sets the server address and port to bind to. | `:443` |
| DERP_VERIFY_CLIENTS | Whether to verify clients connecting to the DERP server. [reference](https://tailscale.com/kb/1118/custom-derp-servers#optional-restricting-client-access-to-your-derp-node) | `false` |
2024-05-07 01:52:58 -04:00
| DERP_HTTP_PORT | Sets the port for the HTTP server. | `80` |
| DERP_STUN_ENABLE | Whether to enable STUN. | `true` |
| DERP_STUN_PORT | Sets the port for the STUN server. | `3478` |
2024-05-07 00:59:33 -04:00
# Volumes
| Name | Description |
| ---------- | ------------------------------------------------ |
| /app/certs | Directory where SSL/TLS certificates are stored. |
# Usage
```shell
docker run -d --name derper \
2024-05-07 01:52:58 -04:00
-p 80:80 -p 443:443 -p 3478:3478 \
-e DERP_DOMAIN=example.com \
nite07/tailscale-derp-docker:latest
```
2024-05-07 01:52:58 -04:00
[Adding DERP servers to your tailnet](https://tailscale.com/kb/1118/custom-derp-servers#step-2-adding-derp-servers-to-your-tailnet)