Commit graph

97 commits

Author SHA1 Message Date
Alex Fornuto
4cb3281af7
Docs: Ingress Controller (#2667)
* update k8s install for ingress conrtoller

* typo correction

* prep k8s section

* squashme

* init Ingress Controller doc

Co-authored-by: travisgroth <tgroth@pomerium.com>
Co-authored-by: wasaga <dmishin@pomerium.com>

* update, organize, annotate

* breakout custom from standard annotations

* more info links

* Update docs/docs/k8s/ingress.md

Co-authored-by: Travis Groth <travisgroth@users.noreply.github.com>

* Update docs/docs/k8s/ingress.md

Co-authored-by: Travis Groth <travisgroth@users.noreply.github.com>

* Update docs/docs/k8s/ingress.md

Co-authored-by: Travis Groth <travisgroth@users.noreply.github.com>

* prep k8s section

* document YAML policies in Ingress

* sort and compress standard annotations

* final draft

* link cleanup

* Create ingress.md

* Update docs/docs/k8s/ingress.md

Co-authored-by: Travis Groth <travisgroth@users.noreply.github.com>

* Apply suggestions from code review

* rm redundant config

* fix file reference

* update available annotations

* Copy Proofread

Grammar updates.

* discussed copy edit

* whitespace cleanup

* add redirect for moved k8s docs

* fixed malformed links

* Update docs/docs/k8s/ingress.md

Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>

* Update docs/docs/k8s/ingress.md

Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>

Update docs/docs/k8s/ingress.md

Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>

Update docs/docs/k8s/ingress.md

Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>

partial copy edits

Update docs/docs/k8s/ingress.md

Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>

Update docs/docs/k8s/ingress.md

Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>

partial copy edits

Update docs/docs/k8s/ingress.md

Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>

Update docs/docs/k8s/ingress.md

Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>

Update docs/docs/k8s/ingress.md

Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>

partial copy edits

* One last TLS

* Update docs/docs/k8s/ingress.md

Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>

* clarify namespaces flag

* Update docs/docs/k8s/ingress.md

Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>

Co-authored-by: travisgroth <tgroth@pomerium.com>
Co-authored-by: wasaga <dmishin@pomerium.com>
Co-authored-by: Travis Groth <travisgroth@users.noreply.github.com>
Co-authored-by: cmo-pomerium <91488121+cmo-pomerium@users.noreply.github.com>
Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>
2021-11-04 12:59:51 -05:00
cmo-pomerium
90f2b00bb6
Docs: Update Community Page (#2713)
* Update readme.md

* bulleted list for updates

* copy edits

* add mailchimp plugin

* Update readme.md

* invoke custom component

* style custom mailchimp form

* List Discourse for support

Co-authored-by: alexfornuto <alex@fornuto.com>
2021-11-01 09:10:58 -05:00
Alex Fornuto
b2b8c481d5
Refresh and Update TCP documentation (#2627)
* init client app doc

* init TCP section

* add redirect for TCP client doc

* Redis and Mysql

* finish TCP exampels

* init Draft template

* cleanup whitespace

* escape markdown image in template

* add redirect and update links

* copy edit

* Update readme.md

* fmt

Signed-off-by: Bobby DeSimone <bobbydesimone@gmail.com>

* optimize png

Signed-off-by: Bobby DeSimone <bobbydesimone@gmail.com>

* header cleanup and child listing

* Update docs/docs/tcp/ssh.md

Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>

Co-authored-by: cmo-pomerium <91488121+cmo-pomerium@users.noreply.github.com>
Co-authored-by: Bobby DeSimone <bobbydesimone@gmail.com>
Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>
2021-10-14 09:35:31 -05:00
Alex Fornuto
18174d8552
make IdP section collapse (#2641) 2021-09-30 11:16:39 -05:00
Alex Fornuto
1a5cfda940
Docs: Batch Updates (#2628)
* define IdP acronym

* remove 'enable user imporsonation', which was removed

* copy edit recovery token

* integrate SA docs into reference

* rename Prometheus as Metrics
2021-09-29 09:49:42 -05:00
Alex Fornuto
637489912c
TCP Client Doc (#2561)
* init client app doc

* Update docs/docs/client.md

Co-authored-by: Alex Fornuto <afornuto@pomerium.com>

* Update docs/docs/client.md

Co-authored-by: Alex Fornuto <afornuto@pomerium.com>

* rm whitespace

* document alternate ports

* add Desktop install instructions

* expand tcp port explanation

* convert to headers for links and update content

* loose ends

Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>
2021-09-22 16:38:20 -05:00
Alex Fornuto
791c27d0cb
Document Enterprise API (#2595)
* init API page

* import examples from repos

* copy edits

* rm whitespace

* squash me

* additional configuration

* document full SA name

* Update docs/enterprise/api.md

Co-authored-by: Travis Groth <travisgroth@users.noreply.github.com>

* Update docs/enterprise/api.md

Co-authored-by: Travis Groth <travisgroth@users.noreply.github.com>

* Update docs/enterprise/api.md

Co-authored-by: Travis Groth <travisgroth@users.noreply.github.com>

* Update docs/enterprise/api.md

Co-authored-by: Travis Groth <travisgroth@users.noreply.github.com>

Co-authored-by: Travis Groth <travisgroth@users.noreply.github.com>
2021-09-21 15:02:45 -05:00
Alex Fornuto
8bc39a682b
add copy button to code snippets (#2597) 2021-09-15 15:30:07 -05:00
Alex Fornuto
62ac580a57
New Topic Page: Original Request Context (#2569)
* init original context doc

* copy edit

* init Service Account page

* update and expand user context article

* fix header name

* copy edit

* update response path through Pomerium

* clarify SA name is user in policy creation
2021-09-09 11:26:57 -05:00
Alex Fornuto
65760a9f70
Update Docker Quickstart (#2482)
* Implement partial files

* fix markdown link

* Update Quickstart Doc

This update simplifies the quickstart process by assuming a local test environment without a TLS solution or a FQDN

* add TLS warning

* point to local verify container

* rm empty file

* reference Certificate topic page instructions

* update mkcert instructions

* Update docs/docs/install/readme.md

Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>

* Update docs/partials/install-mkcert.md

Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>

* Update examples/config/config.docker.yaml

Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>

* Update examples/config/config.docker.yaml

Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>

* Update examples/config/config.docker.yaml

Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>

* Update examples/config/config.docker.yaml

Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>

* review edits

Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>
2021-08-17 10:22:31 -05:00
Alex Fornuto
faecfd460b
Enterprise Upgrade & Changelog Pages (#2453)
* update enterprise reference source

* add upgrade and changelog pages
2021-08-09 10:55:47 -06:00
Alex Fornuto
2b200f8704
Hack the logo to point to the marketing site (#2441) 2021-08-05 17:08:43 -07:00
bobby
5d04531024
docs: update branding (#2435)
- add svg logos
- adjust colors
- add favicon
- remove outdated demo

Signed-off-by: Bobby DeSimone <bobbydesimone@gmail.com>
2021-08-04 22:43:10 -04:00
Travis Groth
490a5f863a
docs: update default version to v0.15 (#2437)
* docs: update default version to v0.15

* Update docs/.vuepress/config.js

Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>

Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>
2021-08-04 22:06:28 -04:00
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
Alex Fornuto
834fa85058
Installation Docs Restructuring (#2406)
* rename quick-start as install, move Synology to guides

* add redirects

* expand redirects, rename installation to releases
2021-07-29 15:40:15 -05:00
Alex Fornuto
97457a3223
Docs sorting (#2346)
* fix Transmission sorting in sidebar

* rename VSCode Server for alphabetizing and clarity

* capitalize Pomerium

* Update docs/guides/code-server.md

Co-authored-by: Joe Previte <jjprevite@gmail.com>

* fix naming and sorting for coder-server, add description

Co-authored-by: Joe Previte <jjprevite@gmail.com>
2021-07-12 10:13:02 -05:00
Alex Fornuto
0bd0dcf1f3
Transmission BitTorrent Client Guide (#2281)
* init transmission guide

* Update docs/guides/transmission.md

Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>

* Update docs/guides/transmission.md

Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>

* Update docs/guides/transmission.md

Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>

Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>
2021-06-13 14:54:30 -07:00
Joe Previte
38a7591395
fix(docs): use correct name for code-server (#2223)
* fix: use correct name for code-server

* chore: update config.js for code-server

* chore: add redirect for code-server
2021-05-20 20:44:52 -07:00
Travis Groth
0071b4e7a5
docs: v0.14.0 (#2174) 2021-05-04 17:39:16 -04:00
Caleb Doxsey
07e150a5af
ping: add documentation (#1976)
* ping: add documentation

* Update docs/docs/identity-providers/ping.md

Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>

* Update docs/docs/identity-providers/ping.md

Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>

* use yaml for config

Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>
2021-03-12 09:03:56 -07:00
Caleb Doxsey
00a1cb7456
docs: add JWT Verification w/Envoy guide (#1974)
* docs: add JWT Verification w/Envoy guide

* add sentence about usage, fix formatting of config
2021-03-10 15:45:37 -07:00
Travis Groth
cc5335bd7f
docs: add v0.13 to docs site menu (#1913) 2021-02-18 17:00:22 -05:00
wasaga
19d78cb844
include envoy's proto specs into config.proto (#1817) 2021-01-25 13:15:50 -05:00
Caleb Doxsey
ab4a68f56f
remove user impersonation and service account cli (#1768)
* remove user impersonation and service account cli

* update doc

* remove user impersonation url query params

* fix flaky test
2021-01-12 09:28:29 -07:00
Travis Groth
b959ddbfc1
docs: update menu for v0.12 (#1755) 2021-01-11 10:48:46 -05:00
Philip Wassermann
2d3190c74e
authenticate: oidc frontchannel-logout endpoint (#1586)
* authenticate: oidc frontchannel-logout endpoint
* move frontchannellogout route and extract logout process
* add frontchannel_logout_uri to wellknown handler
* authenticate: add context to logs in signout process
* docs: single sign-out topic
* gofmt, wording, refactoring method names

Signed-off-by: Bobby DeSimone <bobbydesimone@gmail.com>
Co-authored-by: Bobby DeSimone <bobbydesimone@gmail.com>
2020-12-24 14:30:48 -08:00
Travis Groth
74db362634
docs: add TCP guide (#1714) 2020-12-23 16:24:49 -05:00
Travis Groth
50989a11b3
docs: tcp support (#1712) 2020-12-22 23:03:13 -05:00
Travis Groth
58adeb5a99
docs: add v0.11 link to version menu (#1663) 2020-12-09 07:36:39 -05:00
bobby
0cdd727d5e
update docs (#1645) 2020-12-03 08:29:17 -08:00
Jon Carl
83f998c088
update the documentation for auth0 to include group/role information (#1502)
Signed-off-by: Jon Carl <jon.carl@auth0.com>
2020-10-09 13:42:25 -06:00
Travis Groth
5157726e6f
docs: Add Traefik + Kubernetes example (#1411) 2020-09-19 13:33:32 -04:00
Travis Groth
a69b9957a1
docs: add nginx example (#1329)
* docs: add nginx example

Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>
2020-08-26 17:10:23 -04:00
bobby
332324fa2d
docs: use .com sitemap hostname (#1274)
Signed-off-by: Bobby DeSimone <bobbydesimone@gmail.com>
2020-08-13 10:59:42 -07:00
Travis Groth
6314c43f40
docs: image, sitemap and redirect fixes (#1263)
* docs: fix image linkes for cdn

* docs: use relative top level redirect

* docs: generate sitemap under /docs/
2020-08-12 15:22:53 -04:00
bobby
18a223e1ed
docs: add / redirect (#1241)
Signed-off-by: Bobby DeSimone <bobbydesimone@gmail.com>
2020-08-09 21:08:21 -07:00
bobby
07be1e9530
docs: prepare for enterprise / oss split (#1238)
Signed-off-by: Bobby DeSimone <bobbydesimone@gmail.com>
2020-08-09 20:45:43 -07:00
bobby
bfc3fb67da
v0.10.0 (#1225)
Signed-off-by: Bobby DeSimone <bobbydesimone@gmail.com>
2020-08-06 21:08:19 -07:00
Travis Groth
1cafba18a5
docs: Kubernetes topic (#1222)
* docs: kubernetes topic and installation stub
2020-08-06 15:28:12 -04:00
bobby
8d0cb86098
docs: fix links, fix upgrade guide (#1220)
Signed-off-by: Bobby DeSimone <bobbydesimone@gmail.com>
2020-08-05 23:07:49 -07:00
bobby
ecfe25458e
docs: update reference docs (#1208)
Signed-off-by: Bobby DeSimone <bobbydesimone@gmail.com>
Co-authored-by: Travis Groth <travisgroth@users.noreply.github.com>
2020-08-05 18:22:56 -07:00
bobby
8b68079488
docs: rename docs/reference to docs/topics (#1182)
* docs: rename docs/reference to docs/topics
Signed-off-by: Bobby DeSimone <bobbydesimone@gmail.com>
2020-08-01 10:00:14 -07:00
Travis Groth
417c2f4890
docs: Redis and stateful storage docs (#1173) 2020-07-31 11:56:01 -04:00
bobby
8cae3f27bb
docs: refactor sections, consolidate examples (#1164) 2020-07-30 11:02:14 -07:00
Diep Pham
f41eeaf138
docs: add recipe for TiddlyWiki on Node.js (#1143) 2020-07-30 08:59:04 -07:00
Cuong Manh Le
bec908b9af
docs/.vuepress: fix missing local-oidc recipes section (#1147) 2020-07-28 19:51:17 +07:00
Travis Groth
a1b6bfec56
docs: Cloud Run / GCP Serverless (#1101)
* Add GCP Serverless and Cloud Run docs
2020-07-20 14:00:52 -04:00
Bobby DeSimone
44cf1fba1f
deployment: prepare 0.9.0 (#798)
Signed-off-by: Bobby DeSimone <bobbydesimone@gmail.com>
2020-05-30 18:07:57 -07:00
Caleb Doxsey
b88a619c0d
docs: add mTLS recipe (#807)
* docs: add mTLS recipe

* add argo and mtls to sidebar
2020-05-29 16:10:40 -06:00