From f0c6b4749e77a14188145d147aa78728ca9b687e Mon Sep 17 00:00:00 2001 From: zachary painter <60552605+ZPain8464@users.noreply.github.com> Date: Wed, 10 Apr 2024 17:19:00 -0400 Subject: [PATCH] Moves troubleshooting page (#1354) * moves troubleshooting page, adds troubleshooting img dir * updates redirects * fixes broken links --- .../_handle-self-signed-certificate-warning.mdx | 2 +- .../adjust-polling-delay-settings.gif | Bin .../last-error-and-request-duration.gif | Bin .../pomerium-proceed-to-verify.png | Bin content/docs/quickstart.mdx | 2 +- content/docs/reference/set-response-headers.mdx | 2 +- content/docs/reference/shared-secret-file.mdx | 2 +- content/docs/{internals => }/troubleshooting.mdx | 6 +++--- sidebars.js | 1 + static/_redirects | 6 +++--- 10 files changed, 11 insertions(+), 10 deletions(-) rename content/docs/{internals/img => img/troubleshooting}/polling-delays/adjust-polling-delay-settings.gif (100%) rename content/docs/{internals/img => img/troubleshooting}/polling-delays/last-error-and-request-duration.gif (100%) rename content/docs/{internals/img => img/troubleshooting}/self-signed-warning/pomerium-proceed-to-verify.png (100%) rename content/docs/{internals => }/troubleshooting.mdx (98%) diff --git a/content/docs/admonitions/_handle-self-signed-certificate-warning.mdx b/content/docs/admonitions/_handle-self-signed-certificate-warning.mdx index 9a6263083..6f46af73f 100644 --- a/content/docs/admonitions/_handle-self-signed-certificate-warning.mdx +++ b/content/docs/admonitions/_handle-self-signed-certificate-warning.mdx @@ -1 +1 @@ -If you notice a self-signed certificate warning, see [Handle Self-Signed Certificate Warning](/docs/internals/troubleshooting#handle-self-signed-certificate-warning) to bypass it. +If you notice a self-signed certificate warning, see [Handle Self-Signed Certificate Warning](/docs/troubleshooting#handle-self-signed-certificate-warning) to bypass it. diff --git a/content/docs/internals/img/polling-delays/adjust-polling-delay-settings.gif b/content/docs/img/troubleshooting/polling-delays/adjust-polling-delay-settings.gif similarity index 100% rename from content/docs/internals/img/polling-delays/adjust-polling-delay-settings.gif rename to content/docs/img/troubleshooting/polling-delays/adjust-polling-delay-settings.gif diff --git a/content/docs/internals/img/polling-delays/last-error-and-request-duration.gif b/content/docs/img/troubleshooting/polling-delays/last-error-and-request-duration.gif similarity index 100% rename from content/docs/internals/img/polling-delays/last-error-and-request-duration.gif rename to content/docs/img/troubleshooting/polling-delays/last-error-and-request-duration.gif diff --git a/content/docs/internals/img/self-signed-warning/pomerium-proceed-to-verify.png b/content/docs/img/troubleshooting/self-signed-warning/pomerium-proceed-to-verify.png similarity index 100% rename from content/docs/internals/img/self-signed-warning/pomerium-proceed-to-verify.png rename to content/docs/img/troubleshooting/self-signed-warning/pomerium-proceed-to-verify.png diff --git a/content/docs/quickstart.mdx b/content/docs/quickstart.mdx index 30ea1f654..a7ccff5de 100644 --- a/content/docs/quickstart.mdx +++ b/content/docs/quickstart.mdx @@ -59,7 +59,7 @@ docker compose up Access the **verify route** you built in your policy: `https://verify.localhost.pomerium.io` -If you get a self-signed certificate warning, see [Handle Self-Signed Certificate Warning](/docs/internals/troubleshooting#handle-self-signed-certificate-warning) to bypass it. +If you get a self-signed certificate warning, see [Handle Self-Signed Certificate Warning](/docs/troubleshooting#handle-self-signed-certificate-warning) to bypass it. You should be redirected to the **verify** service. You'll see a page like this: diff --git a/content/docs/reference/set-response-headers.mdx b/content/docs/reference/set-response-headers.mdx index a9d00aa74..897ca2562 100644 --- a/content/docs/reference/set-response-headers.mdx +++ b/content/docs/reference/set-response-headers.mdx @@ -81,7 +81,7 @@ Strict-Transport-Security:max-age=31536000; includeSubDomains; preload, By default, conservative [secure HTTP headers](https://www.owasp.org/index.php/OWASP_Secure_Headers_Project) are set: -- `max-age=31536000` instructs the browser to pin the certificate for a domain for a year. This helps prevent man-in-the-middle attacks, but can create issues when developing new environments with temporary certificates. See [Troubleshooting - HSTS](/docs/internals/troubleshooting#http-strict-transport-security-hsts) for more information. +- `max-age=31536000` instructs the browser to pin the certificate for a domain for a year. This helps prevent man-in-the-middle attacks, but can create issues when developing new environments with temporary certificates. See [Troubleshooting - HSTS](/docs/troubleshooting#http-strict-transport-security-hsts) for more information. - `includeSubDomains` applies these rules to subdomains, which is how individual routes are defined. - `preload` instructs the browser to preload the certificate from an HSTS preload service if available. This means that the certificate can be loaded from an already-trusted secure connection, and the user never needs to connect to your domain without TLS. diff --git a/content/docs/reference/shared-secret-file.mdx b/content/docs/reference/shared-secret-file.mdx index e3008e8b5..20e256d9f 100644 --- a/content/docs/reference/shared-secret-file.mdx +++ b/content/docs/reference/shared-secret-file.mdx @@ -57,7 +57,7 @@ shared_secret_file: '/run/secrets/POMERIUM_SHARED_SECRET' :::note -If you adjust your shared secret and/or how it's accessed by Pomerium, you may create a [**secret mismatch**](/docs/internals/troubleshooting#shared-secret-mismatch). +If you adjust your shared secret and/or how it's accessed by Pomerium, you may create a [**secret mismatch**](/docs/troubleshooting#shared-secret-mismatch). ::: diff --git a/content/docs/internals/troubleshooting.mdx b/content/docs/troubleshooting.mdx similarity index 98% rename from content/docs/internals/troubleshooting.mdx rename to content/docs/troubleshooting.mdx index 501ae2ace..eda767660 100644 --- a/content/docs/internals/troubleshooting.mdx +++ b/content/docs/troubleshooting.mdx @@ -232,11 +232,11 @@ If your directory sync fails, use the **External Data** > **Last Error** and **M 1. In the Console, go to **External Data** > **Last Error** to check for errors that may have caused the sync to fail. Go to **External Data** > **Metrics** to review request durations: -![Check Last Error to see if an error interrupted directory sync](./img/polling-delays/last-error-and-request-duration.gif) +![Check Last Error to see if an error interrupted directory sync](./img/troubleshooting/polling-delays/last-error-and-request-duration.gif) 2. Select **Settings** > **Identity Providers** to see the **IdP Polling Min/Max Delay** settings. Increase the **Polling Min Delay** and **Polling Max Delay** settings before attempting to sync your directory again. Continue to monitor the sync; if it fails due to timeout, increase the durations. -![Find the IdP Polling Delays settings in the Console](./img/polling-delays/adjust-polling-delay-settings.gif) +![Find the IdP Polling Delays settings in the Console](./img/troubleshooting/polling-delays/adjust-polling-delay-settings.gif) See [**Identity Provider Polling Min/Max Delay**](/docs/reference/identity-provider-settings#identity-provider-polling-minmax-delay) for more information. @@ -306,7 +306,7 @@ When using Let's Encrypt certificates, you must use the `fullchain.pem` file, no If you're testing Pomerium locally with self-signed certificates, you may encounter the following self-signed certificate warning: -![proceed to verify](./img/self-signed-warning/pomerium-proceed-to-verify.png) +![proceed to verify](./img/troubleshooting/self-signed-warning/pomerium-proceed-to-verify.png) To resolve this error: diff --git a/sidebars.js b/sidebars.js index 3f79061e7..61f3aa41d 100644 --- a/sidebars.js +++ b/sidebars.js @@ -236,6 +236,7 @@ const sidebars = { link: {type: 'doc', id: 'docs/community'}, items: [{type: 'autogenerated', dirName: 'docs/community'}], }, + 'docs/troubleshooting' ], reference: [ { diff --git a/static/_redirects b/static/_redirects index 256941ed1..aaeb83f31 100644 --- a/static/_redirects +++ b/static/_redirects @@ -296,9 +296,9 @@ https://0-20-0.docs.pomerium.com/category/guides https://0-20-0.docs.pomerium.co # Troubleshooting and FAQs /docs/FAQ.html /docs/troubleshooting -/docs/troubleshooting /docs/internals/troubleshooting -/docs/troubleshooting.html /docs/internals/troubleshooting -/docs/faq /docs/internals/troubleshooting +/docs/internals/troubleshooting /docs/troubleshooting +/docs/internals/troubleshooting.html /docs/troubleshooting +/docs/faq /docs/troubleshooting # /docs/glossary.html uses multiple redirects /docs/glossary.html /docs/overview/glossary