Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Moves troubleshooting page #1355

Merged
merged 1 commit into from
Apr 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion content/docs/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion content/docs/reference/set-response-headers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion content/docs/reference/shared-secret-file.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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).

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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:

Expand Down
1 change: 1 addition & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,7 @@ const sidebars = {
link: {type: 'doc', id: 'docs/community'},
items: [{type: 'autogenerated', dirName: 'docs/community'}],
},
'docs/troubleshooting'
],
reference: [
{
Expand Down
6 changes: 3 additions & 3 deletions static/_redirects
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading