leviathonbeast/ionscale
1
0
Fork 0
mirror of https://github.com/jsiebens/ionscale.git synced 2026-03-31 15:07:49 +01:00
Code Issues Packages Projects Releases Wiki Activity

chore(docs): update reference

Browse Source
This commit is contained in:
Johan Siebens
2024-03-15 09:24:09 +01:00
parent e7370d98a3
commit 48a2c78c05
1 changed files with 18 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
mkdocs/docs/configuration/reference.md
+18 -6
View File
@@ -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. A full configuration reference file is shown below, this provides comments and all available options.
```yaml ```yaml
# The address to bind to for HTTP. # The HTTP(S) listen address to serve the control plane.
http_listen_addr: ":8080" listen_addr: ":8080"
# The address to bind to for HTTPS. # The STUN listen address when using the embedded DERP.
https_listen_addr: "8443" stun_listen_addr: ":3478"
# The address to bind to for the metrics. # The address to bind to for the metrics.
metrics_listen_addr: ":9091" metrics_listen_addr: ":9091"
# The public URL at which the ionscale server can be reached by clients and the CLI. # The DNS name of the server HTTP(S) endpoint as accessible by clients and the CLI.
server_url: "https://ionscale.example.com" 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: tls:
# Disable TLS (not recommended) # Disable TLS (not recommended)
@@ -46,6 +49,15 @@ database:
# url: "postgres://ionscale:ionscale@localhost/ionscale?sslmode=disable" # url: "postgres://ionscale:ionscale@localhost/ionscale?sslmode=disable"
url: "./ionscale.db" 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: keys:
# A private, 32 bytes in hex, system admin key # A private, 32 bytes in hex, system admin key
# Use this key with the CLI when configuring system-wide resources like tailnets # Use this key with the CLI when configuring system-wide resources like tailnets