Skip to content

Commit

Permalink
chore(docs): update reference
Browse files Browse the repository at this point in the history
  • Loading branch information
jsiebens committed Mar 15, 2024
1 parent e7370d9 commit 48a2c78
Showing 1 changed file with 18 additions and 6 deletions.
24 changes: 18 additions & 6 deletions mkdocs/docs/configuration/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,20 @@ __ionscale__ uses the YAML file format for configuration.
A full configuration reference file is shown below, this provides comments and all available options.

```yaml
# The address to bind to for HTTP.
http_listen_addr: ":8080"
# The HTTP(S) listen address to serve the control plane.
listen_addr: ":8080"

# The address to bind to for HTTPS.
https_listen_addr: "8443"
# The STUN listen address when using the embedded DERP.
stun_listen_addr: ":3478"

# The address to bind to for the metrics.
metrics_listen_addr: ":9091"

# The public URL at which the ionscale server can be reached by clients and the CLI.
server_url: "https://ionscale.example.com"
# The DNS name of the server HTTP(S) endpoint as accessible by clients and the CLI.
public_addr: "ionscale.example.com:443"

# The DNS name of the STUN endpoint as accessible by clients.
stun_public_addr: "ionscale.example.com:3478"

tls:
# Disable TLS (not recommended)
Expand Down Expand Up @@ -46,6 +49,15 @@ database:
# url: "postgres://ionscale:ionscale@localhost/ionscale?sslmode=disable"
url: "./ionscale.db"

derp:
server:
disabled: false
region_id: 1000
region_code: "ionscale"
region_name: "ionscale Embedded DERP"
sources:
- https://controlplane.tailscale.com/derpmap/default

keys:
# A private, 32 bytes in hex, system admin key
# Use this key with the CLI when configuring system-wide resources like tailnets
Expand Down

0 comments on commit 48a2c78

Please sign in to comment.