diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 0a9e39b91..d775db832 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -71,7 +71,7 @@ module.exports = { sidebarDepth: 0, children: [ "", - "installation", + "releases", "architecture", "background", "FAQ", @@ -80,17 +80,16 @@ module.exports = { ], }, { - title: "Quick Start", + title: "Install", collapsable: false, - path: "/docs/quick-start/", + path: "/docs/install/", type: "group", sidebarDepth: 0, children: [ - "quick-start/", - "quick-start/binary", - "quick-start/helm", - "quick-start/synology", - "quick-start/from-source", + "install/", + "install/binary", + "install/helm", + "install/from-source", ], }, { @@ -165,6 +164,7 @@ module.exports = { "local-oidc", "mtls", "nginx", + "synology", "tcp", "tiddlywiki", "traefik-ingress", diff --git a/docs/.vuepress/public/_redirects b/docs/.vuepress/public/_redirects index d19edf836..864bb457a 100644 --- a/docs/.vuepress/public/_redirects +++ b/docs/.vuepress/public/_redirects @@ -53,3 +53,10 @@ /jobs/Backend-Engineer.html /careers/backend-engineer/ /enterprise/ / + +/docs/installation.html / +/docs/quick-start /docs/install +/docs/quick-start/binary.html /docs/install/binary.html +/docs/quick-start/helm.html /docs/install/helm.html +/docs/quick-start/from-source.html /docs/install/from-source.html +/docs/quick-start/synology.html /docs/guides/synology.html \ No newline at end of file diff --git a/docs/docs/CHANGELOG.md b/docs/docs/CHANGELOG.md index 1e671cd74..0c96dea35 100644 --- a/docs/docs/CHANGELOG.md +++ b/docs/docs/CHANGELOG.md @@ -2869,4 +2869,4 @@ There were no changes in the v0.7.1 release, but we updated the build process sl [gh-97]: https://github.com/pomerium/pomerium/issues/97 [gh-98]: https://github.com/pomerium/pomerium/issues/98 [gh-99]: https://github.com/pomerium/pomerium/issues/99 -[synology tutorial]: ./quick-start/synology.md +[synology tutorial]: ../guides/synology.md diff --git a/docs/docs/quick-start/binary.md b/docs/docs/install/binary.md similarity index 91% rename from docs/docs/quick-start/binary.md rename to docs/docs/install/binary.md index bae817137..862f549ca 100644 --- a/docs/docs/quick-start/binary.md +++ b/docs/docs/install/binary.md @@ -8,7 +8,7 @@ meta: # Binaries -The following quick-start guide covers how to configure and run Pomerium using the official prebuilt binaries. +This document covers how to configure and run Pomerium using the official prebuilt binaries. ## Prerequisites diff --git a/docs/docs/quick-start/from-source.md b/docs/docs/install/from-source.md similarity index 85% rename from docs/docs/quick-start/from-source.md rename to docs/docs/install/from-source.md index cf2a25313..70914947c 100644 --- a/docs/docs/quick-start/from-source.md +++ b/docs/docs/install/from-source.md @@ -8,7 +8,7 @@ meta: # From Source -The following quick-start guide covers how to retrieve and build Pomerium from its source-code as well as how to run Pomerium using a minimal but complete configuration. One of the benefits of compiling from source is that Go supports building static binaries for a [wide array of architectures and operating systems](https://gist.github.com/asukakenji/f15ba7e588ac42795f421b48b8aede63). +This document covers how to retrieve and build Pomerium from its source-code as well as how to run Pomerium using a minimal but complete configuration. One of the benefits of compiling from source is that Go supports building static binaries for a [wide array of architectures and operating systems](https://gist.github.com/asukakenji/f15ba7e588ac42795f421b48b8aede63). ## Prerequisites diff --git a/docs/docs/quick-start/helm.md b/docs/docs/install/helm.md similarity index 100% rename from docs/docs/quick-start/helm.md rename to docs/docs/install/helm.md diff --git a/docs/docs/quick-start/img/kubernetes-gke.png b/docs/docs/install/img/kubernetes-gke.png similarity index 100% rename from docs/docs/quick-start/img/kubernetes-gke.png rename to docs/docs/install/img/kubernetes-gke.png diff --git a/docs/docs/quick-start/img/logged-in-as.png b/docs/docs/install/img/logged-in-as.png similarity index 100% rename from docs/docs/quick-start/img/logged-in-as.png rename to docs/docs/install/img/logged-in-as.png diff --git a/docs/docs/quick-start/readme.md b/docs/docs/install/readme.md similarity index 94% rename from docs/docs/quick-start/readme.md rename to docs/docs/install/readme.md index a97c85f67..91cadd657 100644 --- a/docs/docs/quick-start/readme.md +++ b/docs/docs/install/readme.md @@ -1,6 +1,7 @@ --- -title: Docker +title: Quick-Start lang: en-US +description: Get Pomerium up and running quickly with Docker. meta: - name: keywords content: pomerium identity-access-proxy oidc docker reverse-proxy containers @@ -8,7 +9,7 @@ meta: # Pomerium using Docker -In the following quick-start, we'll create a minimal but complete environment for running Pomerium with containers. +In this quick-start document, we'll create a minimal but complete environment for running Pomerium with containers. ## Prerequisites diff --git a/docs/docs/installation.md b/docs/docs/releases.md similarity index 100% rename from docs/docs/installation.md rename to docs/docs/releases.md diff --git a/docs/docs/topics/production-deployment.md b/docs/docs/topics/production-deployment.md index a61f09e1f..7130a73ba 100644 --- a/docs/docs/topics/production-deployment.md +++ b/docs/docs/topics/production-deployment.md @@ -6,7 +6,7 @@ description: >- # Production Deployment -This page covers the topic of running Pomerium in a production configuration. See the [quick start section](../quick-start/) for canned example configurations. +This page covers the topic of running Pomerium in a production configuration. See the [quick start section](../install/quickstart/) for canned example configurations. Please also see [architecture](../#architecture) for information on component interactions. diff --git a/docs/guides/ad-guard.md b/docs/guides/ad-guard.md index e3bdf98e4..d5f0a8d21 100644 --- a/docs/guides/ad-guard.md +++ b/docs/guides/ad-guard.md @@ -76,4 +76,4 @@ Simply navigate to your new adguard instance (e.g. `https://adguard.domain.examp ![adguard dashboard](./img/adguard-dashboard.png) -[quick start]: ../docs/quick-start/readme.md +[quick start]: ../docs/install/readme.md diff --git a/docs/guides/code-server.md b/docs/guides/code-server.md index 10c938c65..fe30e53ef 100644 --- a/docs/guides/code-server.md +++ b/docs/guides/code-server.md @@ -130,6 +130,6 @@ When the code-server container is rebuilt, any files outside of `/home/coder/pro [integrated terminal]: https://code.visualstudio.com/docs/editor/integrated-terminal [path]: https://en.wikipedia.org/wiki/PATH_(variable) [quick start]: ../docs/quick-start -[synology nas]: ../docs/quick-start/synology.md +[synology nas]: ./synology.md [visual studio code]: https://code.visualstudio.com/ [code-server]: https://github.com/cdr/code-server diff --git a/docs/docs/quick-start/img/synology-certifciate-assignment.png b/docs/guides/img/synology-certifciate-assignment.png similarity index 100% rename from docs/docs/quick-start/img/synology-certifciate-assignment.png rename to docs/guides/img/synology-certifciate-assignment.png diff --git a/docs/docs/quick-start/img/synology-docker-httpbin.png b/docs/guides/img/synology-docker-httpbin.png similarity index 100% rename from docs/docs/quick-start/img/synology-docker-httpbin.png rename to docs/guides/img/synology-docker-httpbin.png diff --git a/docs/docs/quick-start/img/synology-docker-package-center.png b/docs/guides/img/synology-docker-package-center.png similarity index 100% rename from docs/docs/quick-start/img/synology-docker-package-center.png rename to docs/guides/img/synology-docker-package-center.png diff --git a/docs/docs/quick-start/img/synology-docker-pomerium-alias.png b/docs/guides/img/synology-docker-pomerium-alias.png similarity index 100% rename from docs/docs/quick-start/img/synology-docker-pomerium-alias.png rename to docs/guides/img/synology-docker-pomerium-alias.png diff --git a/docs/docs/quick-start/img/synology-docker-pomerium-create-container.png b/docs/guides/img/synology-docker-pomerium-create-container.png similarity index 100% rename from docs/docs/quick-start/img/synology-docker-pomerium-create-container.png rename to docs/guides/img/synology-docker-pomerium-create-container.png diff --git a/docs/docs/quick-start/img/synology-docker-pomerium-done.png b/docs/guides/img/synology-docker-pomerium-done.png similarity index 100% rename from docs/docs/quick-start/img/synology-docker-pomerium-done.png rename to docs/guides/img/synology-docker-pomerium-done.png diff --git a/docs/docs/quick-start/img/synology-docker-pomerium-package.png b/docs/guides/img/synology-docker-pomerium-package.png similarity index 100% rename from docs/docs/quick-start/img/synology-docker-pomerium-package.png rename to docs/guides/img/synology-docker-pomerium-package.png diff --git a/docs/docs/quick-start/img/synology-docker-port-settings.png b/docs/guides/img/synology-docker-port-settings.png similarity index 100% rename from docs/docs/quick-start/img/synology-docker-port-settings.png rename to docs/guides/img/synology-docker-port-settings.png diff --git a/docs/docs/quick-start/img/synology-firewall-rules.png b/docs/guides/img/synology-firewall-rules.png similarity index 100% rename from docs/docs/quick-start/img/synology-firewall-rules.png rename to docs/guides/img/synology-firewall-rules.png diff --git a/docs/docs/quick-start/img/synology-httpbin.png b/docs/guides/img/synology-httpbin.png similarity index 100% rename from docs/docs/quick-start/img/synology-httpbin.png rename to docs/guides/img/synology-httpbin.png diff --git a/docs/docs/quick-start/img/synology-reverse-proxy-rules.png b/docs/guides/img/synology-reverse-proxy-rules.png similarity index 100% rename from docs/docs/quick-start/img/synology-reverse-proxy-rules.png rename to docs/guides/img/synology-reverse-proxy-rules.png diff --git a/docs/docs/quick-start/img/synology-reverse-proxy.png b/docs/guides/img/synology-reverse-proxy.png similarity index 100% rename from docs/docs/quick-start/img/synology-reverse-proxy.png rename to docs/guides/img/synology-reverse-proxy.png diff --git a/docs/docs/quick-start/img/synology-step-1-redirect.png b/docs/guides/img/synology-step-1-redirect.png similarity index 100% rename from docs/docs/quick-start/img/synology-step-1-redirect.png rename to docs/guides/img/synology-step-1-redirect.png diff --git a/docs/docs/quick-start/img/synology-step-2-mfa.png b/docs/guides/img/synology-step-2-mfa.png similarity index 100% rename from docs/docs/quick-start/img/synology-step-2-mfa.png rename to docs/guides/img/synology-step-2-mfa.png diff --git a/docs/docs/quick-start/img/synology-step-3-validate-header.png b/docs/guides/img/synology-step-3-validate-header.png similarity index 100% rename from docs/docs/quick-start/img/synology-step-3-validate-header.png rename to docs/guides/img/synology-step-3-validate-header.png diff --git a/docs/docs/quick-start/img/synology-step-4-unauthorized.png b/docs/guides/img/synology-step-4-unauthorized.png similarity index 100% rename from docs/docs/quick-start/img/synology-step-4-unauthorized.png rename to docs/guides/img/synology-step-4-unauthorized.png diff --git a/docs/docs/quick-start/img/synology-step-4-unauthorized.png2 b/docs/guides/img/synology-step-4-unauthorized.png2 similarity index 100% rename from docs/docs/quick-start/img/synology-step-4-unauthorized.png2 rename to docs/guides/img/synology-step-4-unauthorized.png2 diff --git a/docs/guides/readme.md b/docs/guides/readme.md index 136109084..3fea5581e 100644 --- a/docs/guides/readme.md +++ b/docs/guides/readme.md @@ -11,5 +11,6 @@ This section contains applications, and scenario specific guides for Pomerium. - The [kubernetes](./kubernetes.md) 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](./local-oidc.md) guide demonstrates how Pomerium can be used with local OIDC server for dev/testing. - The [mTLS](./mtls.md) guide demonstrates how Pomerium can be used to add mutual authentication using client certificates and a custom certificate authority. +- Our [Synology](./synology.md) guide demonstrates how lightweight Pomerium is by installing it on a Synology NAS or similar low-resource product. - The [TiddlyWiki](./tiddlywiki.md) guide demonstrates how Pomerium can be used to add authentication and authorization to web application using authenticated header. - The [Transmission](./transmission.md) 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. diff --git a/docs/docs/quick-start/synology.md b/docs/guides/synology.md similarity index 99% rename from docs/docs/quick-start/synology.md rename to docs/guides/synology.md index e867ca289..190b1ac10 100644 --- a/docs/docs/quick-start/synology.md +++ b/docs/guides/synology.md @@ -209,7 +209,7 @@ If that user is authorized to see the httpbin service, you should be redirected You can also navigate to the special pomerium endpoint `httpbin.your.domain.example/.pomerium/` to see your current user details. -![currently logged in user](./img/logged-in-as.png) +![currently logged in user](../docs/install/img/logged-in-as.png) And just to be safe, try logging in from another google account to see what happens. You should be greeted with a `403` unauthorized access page.