mirror of
https://github.com/pomerium/pomerium.git
synced 2025-05-09 15:17:39 +02:00
5332a752d0
* install VuePress Plugin Tabs https://www.npmjs.com/package/vuepress-plugin-tabs * init Enterprise documentation section * replace Vuepress tab plugin now using https://github.com/superbiger/vuepress-plugin-tabs * init Enterprise Quickstart * block of enterprise doc updates * Helm Quickstart Update (#2380) * removed/fixed redundant or incorrect config And some small copy edits * Update docs/docs/quick-start/helm.md Co-authored-by: Travis Groth <travisgroth@users.noreply.github.com> Co-authored-by: Travis Groth <travisgroth@users.noreply.github.com> * init console with helm doc * squash me * codeblock fix * init about page * updates to Enterprise section * consolidate on Postgres * WIP helm updates * update and align OS and Enterprise helm docs * Enterprise settings docs (#2397) * init console-specific reference docs files * remove shortdoc for name * init Enterprise Reference doc * expanding Enterprise Reference * init JS script for reference subpages When reviewing please remember that I'm not a developer, be kind * update script and apply * remove errant dep * document script and expand for CLI help output * import pomerium-console_serve.yaml In future iterations, this file should be sourced at build time as an artifact from the pomerium-console repo * init new output file * update script call and output * fix anchor links * BROKEN - import content from settings.yaml when dupe is true * filtering WiP * fix dupe script, more content * replace if dupe with if not docs * squash me * squash me! * add docs about PPL (#2404) * squash meeeeee * Update docs/enterprise/install/quickstart.md Co-authored-by: Travis Groth <travisgroth@users.noreply.github.com> * symlink img dir from docs/reference * squash mee * update install reqs * Fixed links throughout * Update docs/enterprise/install/quickstart.md Co-authored-by: Travis Groth <travisgroth@users.noreply.github.com> * Update docs/enterprise/install/quickstart.md Co-authored-by: Travis Groth <travisgroth@users.noreply.github.com> * remove internal note * - format python with black - format js with prettier Signed-off-by: Bobby DeSimone <bobbydesimone@gmail.com> * optimize images with imageOptim Signed-off-by: Bobby DeSimone <bobbydesimone@gmail.com> * run prettier on config.js Signed-off-by: Bobby DeSimone <bobbydesimone@gmail.com> * concepts.md Signed-off-by: Bobby DeSimone <bobbydesimone@gmail.com> * update concepts Signed-off-by: Bobby DeSimone <bobbydesimone@gmail.com> * copy edits * typo * symlink img dir from docs/reference * modify TLS section in quick-start * rm whitespace * add common links postamble * block of updates * block of updates * updates with @travisgroth * turtles all the way down * more content * import all the things * fill out reports * fill out reports * fix file extension * fix links * crosslink PPL ref * document embedded prometheus * expand example * update reqs * document non-directory users * typo fix * update metrics_address * fix broken links in example configs * update examples for route syntax * replaced required with deprecated Note that I didn't link to the route reference because I'm unsure what link formats are accepted when this file is used elsewhere. The warning block below includes a link. * update enterprise/about * Update docs/enterprise/console-settings.yaml Co-authored-by: bobby <1544881+desimone@users.noreply.github.com> * Update docs/enterprise/console-settings.yaml Co-authored-by: bobby <1544881+desimone@users.noreply.github.com> * Update docs/enterprise/concepts.md Co-authored-by: bobby <1544881+desimone@users.noreply.github.com> * Update docs/enterprise/concepts.md Co-authored-by: bobby <1544881+desimone@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: bobby <1544881+desimone@users.noreply.github.com> Co-authored-by: Travis Groth <travisgroth@users.noreply.github.com> * Update docs/enterprise/concepts.md Co-authored-by: bobby <1544881+desimone@users.noreply.github.com> * remove commented config lines * update non-domain user section in concepts * Update docs/enterprise/concepts.md Co-authored-by: bobby <1544881+desimone@users.noreply.github.com> * Update docs/enterprise/concepts.md Co-authored-by: bobby <1544881+desimone@users.noreply.github.com> * Update docs/enterprise/about.md Co-authored-by: Travis Groth <travisgroth@users.noreply.github.com> * Update docs/enterprise/concepts.md Co-authored-by: bobby <1544881+desimone@users.noreply.github.com> * Update docs/enterprise/concepts.md Co-authored-by: bobby <1544881+desimone@users.noreply.github.com> * add console route to OSS conf * update enterprise settings copy from source file * Update docs/enterprise/concepts.md * Update reports reference * merge conflict resolution * update sourced doc content, fix whitespace Co-authored-by: Travis Groth <travisgroth@users.noreply.github.com> Co-authored-by: Caleb Doxsey <cdoxsey@pomerium.com> Co-authored-by: Bobby DeSimone <bobbydesimone@gmail.com> Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>
82 lines
2.5 KiB
YAML
82 lines
2.5 KiB
YAML
name: pomerium-console serve
|
|
usage: pomerium-console serve [flags]
|
|
options:
|
|
- name: administrators
|
|
usage: |
|
|
a list of user ids, names or emails to make administrators, useful for bootstrapping
|
|
- name: bind-addr
|
|
default_value: :8701
|
|
usage: the address to listen on
|
|
- name: customer-id
|
|
usage: the customer id
|
|
- name: database-encryption-key
|
|
usage: |
|
|
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
|
|
- name: databroker-service-url
|
|
default_value: http://localhost:5443
|
|
usage: the databroker service url
|
|
- name: disable-validation
|
|
default_value: "false"
|
|
usage: disable config validation
|
|
- name: enable-remote-diagnostics
|
|
default_value: "false"
|
|
usage: enable remote diagnostics
|
|
- name: grpc-addr
|
|
default_value: :8702
|
|
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: override-certificate-name
|
|
usage: |
|
|
override the certificate name used for the databroker connection
|
|
- name: prometheus-data-dir
|
|
usage: path to prometheus data
|
|
- name: prometheus-listen-addr
|
|
default_value: 127.0.0.1:9090
|
|
usage: embedded prometheus listen address as host:port
|
|
- name: prometheus-scrape-interval
|
|
default_value: 10s
|
|
usage: prometheus scrape frequency
|
|
- name: prometheus-url
|
|
usage: url to access prometheus metrics server
|
|
- name: shared-secret
|
|
usage: base64-encoded shared secret for signing JWTs
|
|
- name: signing-key
|
|
usage: |
|
|
base64-encoded signing key (public or private) for verifying JWTs
|
|
- name: tls-ca
|
|
usage: base64-encoded string of tls-ca
|
|
- name: tls-ca-file
|
|
usage: file storing tls-ca
|
|
- name: tls-cert
|
|
usage: base64-encoded string of tls-cert
|
|
- name: tls-cert-file
|
|
usage: file storing tls-cert
|
|
- name: tls-insecure-skip-verify
|
|
default_value: "false"
|
|
usage: |
|
|
disable remote hosts TLS certificate chain and hostname check
|
|
- 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
|
|
inherited_options:
|
|
- name: config
|
|
usage: Set configuration file path
|
|
- name: version
|
|
default_value: "false"
|
|
usage: view the version information
|
|
see_also:
|
|
- 'pomerium-console - '
|
|
- migrate - migrate the dashboard database up or down
|