diff --git a/docs/.vuepress/styles/palette.styl b/docs/.vuepress/styles/palette.styl index f119015b6..f462ce066 100644 --- a/docs/.vuepress/styles/palette.styl +++ b/docs/.vuepress/styles/palette.styl @@ -50,6 +50,11 @@ $MQMobileNarrow = 419px &:hover, &.router-link-active color lighten($textColor, 8%) !important +a.entRef-anchor + visibility: hidden + display: block + position: relative + top: -4.25rem .dropdown-wrapper .dropdown-title diff --git a/docs/enterprise/pomerium-console_serve.yaml b/docs/enterprise/pomerium-console_serve.yaml index b2f117c74..6b4aef275 100644 --- a/docs/enterprise/pomerium-console_serve.yaml +++ b/docs/enterprise/pomerium-console_serve.yaml @@ -3,63 +3,67 @@ usage: pomerium-console serve [flags] options: - name: administrators usage: | - a list of user ids, names or emails to make administrators, useful for bootstrapping + A list of user ids, names or emails to make administrators. Useful for bootstrapping. - name: audience default_value: '[]' - usage: A list of audiences for verifying signing key + usage: A list of audiences for verifying the signing key. - name: authenticate-service-url - usage: URL for the authenticate service + usage: | + URL for the Authenticate Service. Required for Device Registration. - name: bind-addr default_value: :8701 - usage: the address to listen on + usage: The address the Pomerium Console will listen on. - name: customer-id - usage: the customer id + usage: The customer ID - name: database-encryption-key usage: | - base64-encoded encryption key for encrypting sensitive data in the database + The base64-encoded encryption key for encrypting sensitive data in the database. - name: database-url default_value: | postgresql://pomerium:pomerium@localhost:5432/dashboard?sslmode=disable - usage: the database to connect to + usage: The database Pomerium Enterprise Console will use. - name: databroker-service-url default_value: http://localhost:5443 - usage: the databroker service url + usage: The databroker service URL. - name: debug-config-dump default_value: "false" - usage: dump databroker configuration + usage: | + Dumps the Databroker configuration. This is a debug option to be used only when specified by Pomerium Support. +- name: disable-remote-diagnostics + default_value: "true" + usage: Disable remote diagnostics. - name: disable-validation default_value: "false" - usage: disable config validation -- name: enable-remote-diagnostics - default_value: "false" - usage: enable remote diagnostics + usage: Disable config validation. - name: grpc-addr default_value: :8702 - usage: the address to listen for gRPC on + usage: The address to listen for gRPC on. - name: help shorthand: h default_value: "false" usage: help for serve -- name: license - usage: license JWT +- name: license-key + usage: 'Required: Provide the license key issued by your account team.' - name: override-certificate-name usage: | - override the certificate name used for the databroker connection + Overrides the certificate name used for the databroker connection. - name: prometheus-data-dir - usage: path to prometheus data + usage: The path to Prometheus data - name: prometheus-listen-addr default_value: 127.0.0.1:9090 - usage: embedded prometheus listen address as host:port + usage: | + When set, embedded Prometheus listens at this address. Set as `host:port` - name: prometheus-scrape-interval default_value: 10s - usage: prometheus scrape frequency + usage: The Prometheus scrape frequency - name: prometheus-url - usage: url to access prometheus metrics server + usage: The URL to access the Prometheus metrics server. - name: shared-secret - usage: base64-encoded shared secret for signing JWTs + usage: | + The base64-encoded secret for signing JWTs, shared with OSS Pomerium. - name: signing-key usage: | - base64-encoded signing key (public or private) for verifying JWTs + base64-encoded signing key (public or private) for verifying JWTs. This option is deprecated in favor of `authenticate-service-url`. - name: tls-ca usage: base64-encoded string of tls-ca - name: tls-ca-file @@ -71,14 +75,14 @@ options: - name: tls-insecure-skip-verify default_value: "false" usage: | - disable remote hosts TLS certificate chain and hostname check + Disable remote hosts TLS certificate chain and hostname checks. - name: tls-key usage: base64-encoded string of tls-key - name: tls-key-file usage: file storing tls-key - name: use-static-assets default_value: "true" - usage: when false, forward static requests to localhost:3000 + usage: When false, forward static requests to `localhost:3000`. inherited_options: - name: config usage: Set configuration file path diff --git a/docs/enterprise/reference/config.md b/docs/enterprise/reference/config.md index e1335a9bb..34fbf40db 100644 --- a/docs/enterprise/reference/config.md +++ b/docs/enterprise/reference/config.md @@ -10,182 +10,34 @@ meta: The keys listed below can be applied in Pomerium Console's `config.yaml` file, or applied as environment variables (in uppercase, replacing `-` with `_`). -## administrators - -a list of user ids, names or emails to make administrators, useful for bootstrapping - - -**Default value:** `none` - -## audience - -A list of audiences for verifying signing key - -**Default value:** `[]` - -## authenticate-service-url - -URL for the authenticate service - -**Default value:** `none` - -## bind-addr - -the address to listen on - -**Default value:** `:8701` - -## customer-id - -the customer id - -**Default value:** `none` - -## database-encryption-key - -base64-encoded encryption key for encrypting sensitive data in the database - - -**Default value:** `none` - -## database-url - -the database to connect to - -**Default value:** `postgresql://pomerium:pomerium@localhost:5432/dashboard?sslmode=disable -` - -## databroker-service-url - -the databroker service url - -**Default value:** `http://localhost:5443` - -## debug-config-dump - -dump databroker configuration - -**Default value:** `false` - -## disable-validation - -disable config validation - -**Default value:** `false` - -## enable-remote-diagnostics - -enable remote diagnostics - -**Default value:** `false` - -## grpc-addr - -the address to listen for gRPC on - -**Default value:** `:8702` - -## help - -help for serve - -**Default value:** `false` - -## license - -license JWT - -**Default value:** `none` - -## override-certificate-name - -override the certificate name used for the databroker connection - - -**Default value:** `none` - -## prometheus-data-dir - -path to prometheus data - -**Default value:** `none` - -## prometheus-listen-addr - -embedded prometheus listen address as host:port - -**Default value:** `127.0.0.1:9090` - -## prometheus-scrape-interval - -prometheus scrape frequency - -**Default value:** `10s` - -## prometheus-url - -url to access prometheus metrics server - -**Default value:** `none` - -## shared-secret - -base64-encoded shared secret for signing JWTs - -**Default value:** `none` - -## signing-key - -base64-encoded signing key (public or private) for verifying JWTs - - -**Default value:** `none` - -## tls-ca - -base64-encoded string of tls-ca - -**Default value:** `none` - -## tls-ca-file - -file storing tls-ca - -**Default value:** `none` - -## tls-cert - -base64-encoded string of tls-cert - -**Default value:** `none` - -## tls-cert-file - -file storing tls-cert - -**Default value:** `none` - -## tls-insecure-skip-verify - -disable remote hosts TLS certificate chain and hostname check - - -**Default value:** `false` - -## tls-key - -base64-encoded string of tls-key - -**Default value:** `none` - -## tls-key-file - -file storing tls-key - -**Default value:** `none` - -## use-static-assets - -when false, forward static requests to localhost:3000 - -**Default value:** `true` +| Name | Description | Default Value | +|:--------|:-------------|---------------| +| #administrators | A list of user ids, names or emails to make administrators. Useful for bootstrapping. | none | +| #audience | A list of audiences for verifying the signing key. | `[]` | +| #authenticate-service-url | URL for the Authenticate Service. Required for Device Registration. | none | +| #bind-addr | The address the Pomerium Console will listen on. | `:8701` | +| #customer-id | The customer ID | none | +| #database-encryption-key | The base64-encoded encryption key for encrypting sensitive data in the database. | none | +| #database-url | The database Pomerium Enterprise Console will use. | `postgresql://pomerium:pomerium@localhost:5432/dashboard?sslmode=disable` | +| #databroker-service-url | The databroker service URL. | `http://localhost:5443` | +| #debug-config-dump | Dumps the Databroker configuration. This is a debug option to be used only when specified by Pomerium Support. | `false` | +| #disable-remote-diagnostics | Disable remote diagnostics. | `true` | +| #disable-validation | Disable config validation. | `false` | +| #grpc-addr | The address to listen for gRPC on. | `:8702` | +| #help | help for serve | `false` | +| #license-key | Required: Provide the license key issued by your account team. | none | +| #override-certificate-name | Overrides the certificate name used for the databroker connection. | none | +| #prometheus-data-dir | The path to Prometheus data | none | +| #prometheus-listen-addr | When set, embedded Prometheus listens at this address. Set as `host:port` | `127.0.0.1:9090` | +| #prometheus-scrape-interval | The Prometheus scrape frequency | `10s` | +| #prometheus-url | The URL to access the Prometheus metrics server. | none | +| #shared-secret | The base64-encoded secret for signing JWTs, shared with OSS Pomerium. | none | +| #signing-key | base64-encoded signing key (public or private) for verifying JWTs. This option is deprecated in favor of `authenticate-service-url`. | none | +| #tls-ca | base64-encoded string of tls-ca | none | +| #tls-ca-file | file storing tls-ca | none | +| #tls-cert | base64-encoded string of tls-cert | none | +| #tls-cert-file | file storing tls-cert | none | +| #tls-insecure-skip-verify | Disable remote hosts TLS certificate chain and hostname checks. | `false` | +| #tls-key | base64-encoded string of tls-key | none | +| #tls-key-file | file storing tls-key | none | +| #use-static-assets | When false, forward static requests to `localhost:3000`. | `true` | \ No newline at end of file diff --git a/scripts/generate-console-pages.js b/scripts/generate-console-pages.js index 51893d09e..13cc112bc 100755 --- a/scripts/generate-console-pages.js +++ b/scripts/generate-console-pages.js @@ -69,15 +69,14 @@ meta: The keys listed below can be applied in Pomerium Console's \`config.yaml\` file, or applied as environment variables (in uppercase, replacing \`-\` with \`_\`). +| Name | Description | Default Value | +|:--------|:-------------|---------------| `; const keySection = (obj) => { //console.log(JSON.stringify(obj.name)) // For Debugging - let header = `## ` + obj.name + "\n\n"; - let body = `${obj.usage} - -**Default value:** \`${obj.default_value ? obj.default_value : `none`}\` -`; - return header + body; + let name = `| #` + obj.name + ` |`; + let body = ` ${(obj.usage).replace(/\n/g, '')} | ${obj.default_value ? `\`${obj.default_value.replace(/\n/g, '')}\`` : `none`} |`; + return name + body; }; let content =