Skip to content

Commit 3233e98

Browse files
Moves troubleshooting page (#1355)
Moves troubleshooting page (#1354) * moves troubleshooting page, adds troubleshooting img dir * updates redirects * fixes broken links Co-authored-by: zachary painter <[email protected]>
1 parent 1166c76 commit 3233e98

10 files changed

+11
-10
lines changed
Original file line numberDiff line numberDiff line change
@@ -1 +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.
1+
If you notice a self-signed certificate warning, see [Handle Self-Signed Certificate Warning](/docs/troubleshooting#handle-self-signed-certificate-warning) to bypass it.

content/docs/quickstart.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ docker compose up
5959

6060
Access the **verify route** you built in your policy: `https://verify.localhost.pomerium.io`
6161

62-
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.
62+
If you get a self-signed certificate warning, see [Handle Self-Signed Certificate Warning](/docs/troubleshooting#handle-self-signed-certificate-warning) to bypass it.
6363

6464
You should be redirected to the **verify** service. You'll see a page like this:
6565

content/docs/reference/set-response-headers.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ Strict-Transport-Security:max-age=31536000; includeSubDomains; preload,
8181

8282
By default, conservative [secure HTTP headers](https://www.owasp.org/index.php/OWASP_Secure_Headers_Project) are set:
8383

84-
- `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.
84+
- `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.
8585
- `includeSubDomains` applies these rules to subdomains, which is how individual routes are defined.
8686
- `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.
8787

content/docs/reference/shared-secret-file.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ shared_secret_file: '/run/secrets/POMERIUM_SHARED_SECRET'
5757
5858
:::note
5959
60-
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).
60+
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).
6161
6262
:::
6363

content/docs/internals/troubleshooting.mdx content/docs/troubleshooting.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -232,11 +232,11 @@ If your directory sync fails, use the **External Data** > **Last Error** and **M
232232

233233
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:
234234

235-
![Check Last Error to see if an error interrupted directory sync](./img/polling-delays/last-error-and-request-duration.gif)
235+
![Check Last Error to see if an error interrupted directory sync](./img/troubleshooting/polling-delays/last-error-and-request-duration.gif)
236236

237237
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.
238238

239-
![Find the IdP Polling Delays settings in the Console](./img/polling-delays/adjust-polling-delay-settings.gif)
239+
![Find the IdP Polling Delays settings in the Console](./img/troubleshooting/polling-delays/adjust-polling-delay-settings.gif)
240240

241241
See [**Identity Provider Polling Min/Max Delay**](/docs/reference/identity-provider-settings#identity-provider-polling-minmax-delay) for more information.
242242

@@ -306,7 +306,7 @@ When using Let's Encrypt certificates, you must use the `fullchain.pem` file, no
306306

307307
If you're testing Pomerium locally with self-signed certificates, you may encounter the following self-signed certificate warning:
308308

309-
![proceed to verify](./img/self-signed-warning/pomerium-proceed-to-verify.png)
309+
![proceed to verify](./img/troubleshooting/self-signed-warning/pomerium-proceed-to-verify.png)
310310

311311
To resolve this error:
312312

sidebars.js

+1
Original file line numberDiff line numberDiff line change
@@ -236,6 +236,7 @@ const sidebars = {
236236
link: {type: 'doc', id: 'docs/community'},
237237
items: [{type: 'autogenerated', dirName: 'docs/community'}],
238238
},
239+
'docs/troubleshooting'
239240
],
240241
reference: [
241242
{

static/_redirects

+3-3
Original file line numberDiff line numberDiff line change
@@ -296,9 +296,9 @@ https://0-20-0.docs.pomerium.com/category/guides https://0-20-0.docs.pomerium.co
296296

297297
# Troubleshooting and FAQs
298298
/docs/FAQ.html /docs/troubleshooting
299-
/docs/troubleshooting /docs/internals/troubleshooting
300-
/docs/troubleshooting.html /docs/internals/troubleshooting
301-
/docs/faq /docs/internals/troubleshooting
299+
/docs/internals/troubleshooting /docs/troubleshooting
300+
/docs/internals/troubleshooting.html /docs/troubleshooting
301+
/docs/faq /docs/troubleshooting
302302

303303
# /docs/glossary.html uses multiple redirects
304304
/docs/glossary.html /docs/overview/glossary

0 commit comments

Comments
 (0)