pomerium/docs/guides
Alex Fornuto 5332a752d0
Enterprise Docs (#2390)
* 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>
2021-08-04 13:55:04 -05:00
..
img Installation Docs Restructuring (#2406) 2021-07-29 15:40:15 -05:00
ad-guard.md Enterprise Docs (#2390) 2021-08-04 13:55:04 -05:00
argo.md Enterprise Docs (#2390) 2021-08-04 13:55:04 -05:00
cloud-run.md docs: replace httpbin with verify (#1702) 2020-12-22 09:53:08 -08:00
code-server.md Enterprise Docs (#2390) 2021-08-04 13:55:04 -05:00
istio.md docs: refactor sections, consolidate examples (#1164) 2020-07-30 11:02:14 -07:00
jwt-verification.md docs: add JWT Verification w/Envoy guide (#1974) 2021-03-10 15:45:37 -07:00
kubernetes-dashboard.md Enterprise Docs (#2390) 2021-08-04 13:55:04 -05:00
kubernetes.md docs: fix minor errors (#1214) 2020-08-05 15:04:31 -04:00
local-oidc.md Enterprise Docs (#2390) 2021-08-04 13:55:04 -05:00
mtls.md docs: replace httpbin with verify (#1702) 2020-12-22 09:53:08 -08:00
nginx.md docs: replace httpbin with verify (#1702) 2020-12-22 09:53:08 -08:00
readme.md Installation Docs Restructuring (#2406) 2021-07-29 15:40:15 -05:00
synology.md Enterprise Docs (#2390) 2021-08-04 13:55:04 -05:00
tcp.md Enterprise Docs (#2390) 2021-08-04 13:55:04 -05:00
tiddlywiki.md Enterprise Docs (#2390) 2021-08-04 13:55:04 -05:00
traefik-ingress.md docs: Add Traefik + Kubernetes example (#1411) 2020-09-19 13:33:32 -04:00
transmission.md Enterprise Docs (#2390) 2021-08-04 13:55:04 -05:00

Overview

This section contains applications, and scenario specific guides for Pomerium.

  • The ad-guard recipe demonstrates how Pomerium can be used to augment web applications that only support simplistic authorization mechanisms like basic-auth with single-sign-on driven access policy.
  • The argo guide demonstrates how Pomerium can be used to add access control to Argo.
  • The Cloud Run recipe demonstrates deploying Pomerium to Google Cloud Run as well as using it to Authorize users to protected Cloud Run endpoints.
  • The code-server guide demonstrates how Pomerium can be used to add access control to third-party applications that don't ship with fine-grained access control. code-server is a tool to run Visual Studio code as a web application.
  • The JWT Verification guide demonstrates how to verify the Pomerium JWT assertion header using Envoy.
  • The Kubernetes Dashboard guide covers how to secure Kubernetes dashboard using Pomerium.
  • The kubernetes guide covers how to add authentication and authorization to kubernetes dashboard using helm, and letsencrypt certificates. This guide also shows how third party reverse-proxies like nginx/traefik can be used in conjunction with Pomerium using forward-auth.
  • The local OIDC guide demonstrates how Pomerium can be used with local OIDC server for dev/testing.
  • The mTLS guide demonstrates how Pomerium can be used to add mutual authentication using client certificates and a custom certificate authority.
  • Our Synology guide demonstrates how lightweight Pomerium is by installing it on a Synology NAS or similar low-resource product.
  • The TiddlyWiki guide demonstrates how Pomerium can be used to add authentication and authorization to web application using authenticated header.
  • The Transmission guide demonstrates how Pomerium can act as an authentication and authorization proxy for your Transmission daemon's RPC interface, which only provides unencrypted HTTP auth out of the box.