Installation Docs Restructuring (#2406)

* rename quick-start as install, move Synology to guides

* add redirects

* expand redirects, rename installation to releases

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",

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

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

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
 

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
 

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
 

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.
 

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

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

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.

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.