From 6bf336a39b3a06765cb2bd6d5678b31de43eae54 Mon Sep 17 00:00:00 2001 From: miloschwartz Date: Wed, 15 Oct 2025 18:14:45 -0700 Subject: [PATCH] update config for remote nodes --- docs.json | 3 +- manage/remote-node/config-file.mdx | 86 ++++++++++++++++++++++++++++++ self-host/advanced/config-file.mdx | 84 +++-------------------------- 3 files changed, 94 insertions(+), 79 deletions(-) create mode 100644 manage/remote-node/config-file.mdx diff --git a/docs.json b/docs.json index 2e300c7..1b9004d 100644 --- a/docs.json +++ b/docs.json @@ -79,7 +79,8 @@ "manage/remote-node/ha", "manage/remote-node/nodes", "manage/remote-node/quick-install-remote", - "manage/remote-node/convert-remote" + "manage/remote-node/convert-remote", + "manage/remote-node/config-file" ] }, "manage/domains", diff --git a/manage/remote-node/config-file.mdx b/manage/remote-node/config-file.mdx new file mode 100644 index 0000000..44c511e --- /dev/null +++ b/manage/remote-node/config-file.mdx @@ -0,0 +1,86 @@ +--- +title: "Configuration File" +description: "Configure your remote node using the config.yml file" +--- + +The `config.yml` file includes basic config variable for your remote node. This file is mounted at `config/config.yml` in your Docker container. + +Minimal configuration file: + +```yaml title="config.yml" +gerbil: + start_port: 51820 + base_endpoint: "154.123.45.67" # REPLACE WITH YOUR IP OR DOMAIN + +managed: + id: "he4g78wevj25msf" + secret: "n7sd18twfko0q0vrb7wyclqzbvvnx1fqt7ezv8xewhdb9s7d" +``` + +### Gerbil Tunnel Controller + + + Gerbil tunnel controller settings for WireGuard tunneling. + + + + Domain name included in WireGuard configuration for tunnel connections. + + **Example**: `pangolin.example.com` + + + + Starting port for WireGuard tunnels. + + **Example**: `51820` + + + + +### Managed Configuration + + + Managed deployment configuration for connecting self-hosted instances to managed services. + + + {/* + Display name for the managed deployment. + + **Example**: `My Self-Hosted Instance` + */} + + + Unique identifier for the managed deployment. Generated from the installer or the [Pangolin dashboard](https://pangolin.fossorial.io). + + **Example**: `he4g78wevj25msf` + + + + Secret key for authenticating with the managed service. Generated from the installer or the [Pangolin dashboard](https://pangolin.fossorial.io). + + **Example**: `n7sd18twfko0q0vrb7wyclqzbvvnx1fqt7ezv8xewhdb9s7d` + + + Keep this secret secure and do not share it publicly. + + + + + The managed service endpoint to connect to. This can only change with enterprise deployments. + + **Example**: `https://pangolin.fossorial.io` + + **Default**: `https://pangolin.fossorial.io` + + + + Custom redirect endpoint for authentication flows. This can only change for enterprise deployments. + + **Example**: `https://my-pangolin.example.com` + + + If not specified, the default dashboard URL will be used. + + + + diff --git a/self-host/advanced/config-file.mdx b/self-host/advanced/config-file.mdx index 434ee6b..8918028 100644 --- a/self-host/advanced/config-file.mdx +++ b/self-host/advanced/config-file.mdx @@ -31,20 +31,8 @@ flags: disable_signup_without_invite: true disable_user_create_org: true ``` - -In managed mode: - -```yaml title="config.yml" -gerbil: - start_port: 51820 - base_endpoint: "154.123.45.67" # REPLACE WITH YOUR IP OR DOMAIN - -managed: - id: "he4g78wevj25msf" - secret: "n7sd18twfko0q0vrb7wyclqzbvvnx1fqt7ezv8xewhdb9s7d" -``` - + Generate a strong secret for `server.secret`. Use at least 32 characters with a mix of letters, numbers, and special characters. @@ -618,72 +606,12 @@ This section contains the complete reference for all configuration options in `c -### Managed Configuration - - - Managed deployment configuration for connecting self-hosted instances to managed services. - - - {/* - Display name for the managed deployment. - - **Example**: `My Self-Hosted Instance` - */} - - - Unique identifier for the managed deployment. Generated from the installer or the [Pangolin dashboard](https://pangolin.fossorial.io). - - **Example**: `he4g78wevj25msf` - - - - Secret key for authenticating with the managed service. Generated from the installer or the [Pangolin dashboard](https://pangolin.fossorial.io). - - **Example**: `n7sd18twfko0q0vrb7wyclqzbvvnx1fqt7ezv8xewhdb9s7d` - - - Keep this secret secure and do not share it publicly. - - - - - The managed service endpoint to connect to. This can only change with enterprise deployments. - - **Example**: `https://pangolin.fossorial.io` - - **Default**: `https://pangolin.fossorial.io` - - - - Custom redirect endpoint for authentication flows. This can only change for enterprise deployments. - - **Example**: `https://my-pangolin.example.com` - - - If not specified, the default dashboard URL will be used. - - - - - ## Environment Variables Some configuration values can be set using environment variables for enhanced security: - - - **Variable**: `SERVER_SECRET` - - **Config**: `server.secret` - - Use this to avoid hardcoding secrets in your config file. - - - - **Variable**: `EMAIL_SMTP_PASS` - - **Config**: `email.smtp_pass` - - Keep SMTP passwords secure using environment variables. - - +| Name | Variable | Config | +|------|----------|--------| +| Server Secret | `SERVER_SECRET` | `server.secret` | +| Email Password | `EMAIL_SMTP_PASS` | `email.smtp_pass` | +| PostgreSQL Connection String | `POSTGRES_CONNECTION_STRING` | `postgres.connection_string` |