Compare commits
1 Commits
master
...
docs-har-t
Author | SHA1 | Date |
---|---|---|
James Elliott | e0443b95ad |
|
@ -21,10 +21,10 @@ body:
|
||||||
- Bugs with third-party software.
|
- Bugs with third-party software.
|
||||||
- Mistakes in the documentation.
|
- Mistakes in the documentation.
|
||||||
- Potential bugs where it is not somewhat clear that it's a bug with Authelia itself.
|
- Potential bugs where it is not somewhat clear that it's a bug with Authelia itself.
|
||||||
6. Please read the [Troubleshooting](https://www.authelia.com/r/troubleshooting) reference guide:
|
6. Please read the [Troubleshooting](https://www.authelia.com/r/tshoot) reference guide:
|
||||||
- Do not truncate any logs unless you are complying with the specific instructions in the [Logs](https://www.authelia.com/r/troubleshooting#logs) section.
|
- Do not truncate any logs unless you are complying with the specific instructions in the [Logs](https://www.authelia.com/r/tshoot#logs) section.
|
||||||
- If you plan on sanitizing, removing, or adjusting any values for the logs or configuration files please read the [Sanitization](https://www.authelia.com/r/troubleshooting#sanitization) section.
|
- If you plan on sanitizing, removing, or adjusting any values for the logs or configuration files please read the [Sanitization](https://www.authelia.com/r/tshoot#sanitization) section.
|
||||||
7. Please consider including a [HTTP Archive File](https://www.authelia.com/r/har) if you're having redirection issues.
|
7. Please consider including a [HTTP Archive File](https://www.authelia.com/r/tshoot#http-archive-file) if you're having redirection issues.
|
||||||
- type: dropdown
|
- type: dropdown
|
||||||
id: version
|
id: version
|
||||||
attributes:
|
attributes:
|
||||||
|
@ -140,7 +140,7 @@ body:
|
||||||
attributes:
|
attributes:
|
||||||
label: Logs (Authelia)
|
label: Logs (Authelia)
|
||||||
description: |
|
description: |
|
||||||
Provide complete logs with the log level set to debug or trace. Complete means from application start until the issue occurring. This is clearly explained in the [Logs](https://www.authelia.com/r/troubleshooting#logs) section of the troubleshooting guide.
|
Provide complete logs with the log level set to debug or trace. Complete means from application start until the issue occurring. This is clearly explained in the [Logs](https://www.authelia.com/r/tshoot#logs) section of the troubleshooting guide.
|
||||||
|
|
||||||
The template will automatically put this content in a code block so you can just paste it.
|
The template will automatically put this content in a code block so you can just paste it.
|
||||||
render: shell
|
render: shell
|
||||||
|
|
|
@ -21,10 +21,10 @@ body:
|
||||||
- Bugs with third-party software.
|
- Bugs with third-party software.
|
||||||
- Mistakes in the documentation.
|
- Mistakes in the documentation.
|
||||||
- Potential bugs where it is not somewhat clear that it's a bug with Authelia itself.
|
- Potential bugs where it is not somewhat clear that it's a bug with Authelia itself.
|
||||||
6. Please read the [Troubleshooting](https://www.authelia.com/r/troubleshooting) reference guide:
|
6. Please read the [Troubleshooting](https://www.authelia.com/r/tshoot) reference guide:
|
||||||
- Do not truncate any logs unless you are complying with the specific instructions in the [Logs](https://www.authelia.com/r/troubleshooting#logs) section.
|
- Do not truncate any logs unless you are complying with the specific instructions in the [Logs](https://www.authelia.com/r/tshoot#logs) section.
|
||||||
- If you plan on sanitizing, removing, or adjusting any values for the logs or configuration files please read the [Sanitization](https://www.authelia.com/r/troubleshooting#sanitization) section.
|
- If you plan on sanitizing, removing, or adjusting any values for the logs or configuration files please read the [Sanitization](https://www.authelia.com/r/tshoot#sanitization) section.
|
||||||
7. Please consider including a [HTTP Archive File](https://www.authelia.com/r/har) if you're having redirection issues.
|
7. Please consider including a [HTTP Archive File](https://www.authelia.com/r/tshoot#http-archive-file) if you're having redirection issues.
|
||||||
- type: dropdown
|
- type: dropdown
|
||||||
id: version
|
id: version
|
||||||
attributes:
|
attributes:
|
||||||
|
@ -102,7 +102,7 @@ body:
|
||||||
attributes:
|
attributes:
|
||||||
label: Logs (Authelia)
|
label: Logs (Authelia)
|
||||||
description: |
|
description: |
|
||||||
Provide complete logs with the log level set to debug or trace. Complete means from application start until the issue occurring. This is clearly explained in the [Logs](https://www.authelia.com/r/troubleshooting#logs) section of the troubleshooting guide.
|
Provide complete logs with the log level set to debug or trace. Complete means from application start until the issue occurring. This is clearly explained in the [Logs](https://www.authelia.com/r/tshoot#logs) section of the troubleshooting guide.
|
||||||
|
|
||||||
The template will automatically put this content in a code block so you can just paste it.
|
The template will automatically put this content in a code block so you can just paste it.
|
||||||
render: shell
|
render: shell
|
||||||
|
|
|
@ -1,68 +0,0 @@
|
||||||
---
|
|
||||||
title: "HTTP Archive Files"
|
|
||||||
description: "This guide describes and helps users create HTTP Archive (HAR) files"
|
|
||||||
lead: "This guide describes and helps users create HTTP Archive (HAR) files."
|
|
||||||
date: 2022-08-26T13:50:51+10:00
|
|
||||||
draft: false
|
|
||||||
images: []
|
|
||||||
menu:
|
|
||||||
reference:
|
|
||||||
parent: "guides"
|
|
||||||
weight: 220
|
|
||||||
toc: true
|
|
||||||
aliases:
|
|
||||||
- /r/har
|
|
||||||
---
|
|
||||||
|
|
||||||
## Introduction
|
|
||||||
|
|
||||||
The HTTP Archive File Format (HAR) is a common developer import/export format which shows web requests that browsers
|
|
||||||
make including all headers which includes cookies, forms submitted, etc.
|
|
||||||
|
|
||||||
This format allows users to open the developer tools, perform several actions, and then export a file with all of the
|
|
||||||
requests that still exist in the network tab of the developer tools. This file is stored in JSON which makes it easy to
|
|
||||||
view what information exists before sharing it. Subsequently users may import this file on another browser and see all
|
|
||||||
of these requests which makes it easier to debug certain situations without having to replicate an environment or be
|
|
||||||
present in an environment.
|
|
||||||
|
|
||||||
## Sanitization
|
|
||||||
|
|
||||||
The following section outlines some helpful information if you wish to sanitize your HAR file to share it with others.
|
|
||||||
|
|
||||||
For generic sanitization information see the [Troubleshooting Sanitization guide](troubleshooting.md#sanitization).
|
|
||||||
|
|
||||||
### Security Sensitive Information
|
|
||||||
|
|
||||||
*__Important:__ this file may contain sensitive information which should be sanitized manually before sharing it
|
|
||||||
anywhere with anyone. Sensitive information can vary wildly but some of the key areas that may be sensitive when
|
|
||||||
exporting this for troubleshooting with Authelia are:*
|
|
||||||
- `Cookie` request header
|
|
||||||
- `Set-Cookie` response header
|
|
||||||
- Data sent to the following endpoints:
|
|
||||||
- `/api/firstfactor`: username / password
|
|
||||||
- `/api/*/identity/start`: the token query parameter
|
|
||||||
- `/api/secondfactor/*`: the post data
|
|
||||||
|
|
||||||
## Instructions
|
|
||||||
|
|
||||||
The following are instructions on how to perform valuable HAR exports. The instructions for Chrome / Chromium should be
|
|
||||||
applicable in all Chromium based browsers, and likewise for Firefox based browsers.
|
|
||||||
|
|
||||||
1. Open your browser.
|
|
||||||
2. Open a blank tab.
|
|
||||||
3. Press Ctrl + Shift + I to open the browser Developer Tools.
|
|
||||||
4. Open the `Network` tab.
|
|
||||||
5. Ensure the browser persists logs:
|
|
||||||
1. Firefox:
|
|
||||||
1. Select the `Network Settings` cog symbol at the top right of the `Network` tab.
|
|
||||||
2. Ensure `Persist Logs` is checked.
|
|
||||||
2. Chrome / Chromium:
|
|
||||||
1. Ensure `Preserve logs` in the top left of the `Network` tab is checked.
|
|
||||||
6. Perform your intended requests, or the requests that have been requested.
|
|
||||||
7. Export the HAR File:
|
|
||||||
1. Firefox:
|
|
||||||
1. Select the `Network Settings` cog symbol at the top right of the `Network` tab.
|
|
||||||
2. Select `Save All AS HAR`.
|
|
||||||
2. Chrome / Chromium:
|
|
||||||
1. Right click any request in the `Network` tab.
|
|
||||||
2. Select `Save all as HAR with content` at the bottom of the dialogue.
|
|
|
@ -12,6 +12,8 @@ weight: 220
|
||||||
toc: true
|
toc: true
|
||||||
aliases:
|
aliases:
|
||||||
- /r/sanitize
|
- /r/sanitize
|
||||||
|
- /r/har
|
||||||
|
- /r/tshoot
|
||||||
- /r/troubleshoot
|
- /r/troubleshoot
|
||||||
- /r/troubleshooting
|
- /r/troubleshooting
|
||||||
---
|
---
|
||||||
|
@ -21,6 +23,8 @@ aliases:
|
||||||
See the [Frequently Asked Questions](frequently-asked-questions.md) reference guide for links to frequently asked
|
See the [Frequently Asked Questions](frequently-asked-questions.md) reference guide for links to frequently asked
|
||||||
question documentation.
|
question documentation.
|
||||||
|
|
||||||
|
[x](#http-archive-file)
|
||||||
|
|
||||||
## Logs
|
## Logs
|
||||||
|
|
||||||
It's really important when troubleshooting and even more important when reporting a bug that users provide complete
|
It's really important when troubleshooting and even more important when reporting a bug that users provide complete
|
||||||
|
@ -85,6 +89,59 @@ The listening line will have a message which is similar to the following example
|
||||||
- `Listening for non-TLS connections on ':9091' path '/'`
|
- `Listening for non-TLS connections on ':9091' path '/'`
|
||||||
- `Listening for non-TLS connections on ':9091' path '/' and '/authelia'`
|
- `Listening for non-TLS connections on ':9091' path '/' and '/authelia'`
|
||||||
|
|
||||||
|
## HTTP Archive File
|
||||||
|
|
||||||
|
The HTTP Archive File Format (HAR) is a common developer import/export format which shows web requests that browsers
|
||||||
|
make including all headers which includes cookies, forms submitted, etc.
|
||||||
|
|
||||||
|
This format allows users to open the developer tools, perform several actions, and then export a file with all of the
|
||||||
|
requests that still exist in the network tab of the developer tools. This file is stored in JSON which makes it easy to
|
||||||
|
view what information exists before sharing it. Subsequently users may import this file on another browser and see all
|
||||||
|
of these requests which makes it easier to debug certain situations without having to replicate an environment or be
|
||||||
|
present in an environment.
|
||||||
|
|
||||||
|
### Special Sanitization Notes
|
||||||
|
|
||||||
|
The following section outlines some helpful information if you wish to sanitize your HAR file to share it with others.
|
||||||
|
|
||||||
|
For generic sanitization information see the [Sanitization](troubleshooting.md#sanitization) section.
|
||||||
|
|
||||||
|
#### Security Sensitive Information
|
||||||
|
|
||||||
|
*__Important:__ this file may contain sensitive information which should be sanitized manually before sharing it
|
||||||
|
anywhere with anyone. Sensitive information can vary wildly but some of the key areas that may be sensitive when
|
||||||
|
exporting this for troubleshooting with Authelia are:*
|
||||||
|
- `Cookie` request header (which should be made blank)
|
||||||
|
- `Set-Cookie` response header (which should be made blank)
|
||||||
|
- Data sent to the following endpoints:
|
||||||
|
- `/api/firstfactor`: username / password (where the password should be removed)
|
||||||
|
- `/api/*/identity/start`: the token query parameter
|
||||||
|
- `/api/secondfactor/*`: the post data
|
||||||
|
|
||||||
|
### Instructions
|
||||||
|
|
||||||
|
The following are instructions on how to perform valuable HAR exports. The instructions for Chrome / Chromium should be
|
||||||
|
applicable in all Chromium based browsers, and likewise for Firefox based browsers.
|
||||||
|
|
||||||
|
1. Open your browser.
|
||||||
|
2. Open a blank tab.
|
||||||
|
3. Press Ctrl + Shift + I to open the browser Developer Tools.
|
||||||
|
4. Open the `Network` tab.
|
||||||
|
5. Ensure the browser persists logs:
|
||||||
|
1. Firefox:
|
||||||
|
1. Select the `Network Settings` cog symbol at the top right of the `Network` tab.
|
||||||
|
2. Ensure `Persist Logs` is checked.
|
||||||
|
2. Chrome / Chromium:
|
||||||
|
1. Ensure `Preserve logs` in the top left of the `Network` tab is checked.
|
||||||
|
6. Perform your intended requests, or the requests that have been requested.
|
||||||
|
7. Export the HAR File:
|
||||||
|
1. Firefox:
|
||||||
|
1. Select the `Network Settings` cog symbol at the top right of the `Network` tab.
|
||||||
|
2. Select `Save All AS HAR`.
|
||||||
|
2. Chrome / Chromium:
|
||||||
|
1. Right click any request in the `Network` tab.
|
||||||
|
2. Select `Save all as HAR with content` at the bottom of the dialogue.
|
||||||
|
|
||||||
## Sanitization
|
## Sanitization
|
||||||
|
|
||||||
Some users may wish to hide their domain in files provided during troubleshooting. While this is discouraged, if a user
|
Some users may wish to hide their domain in files provided during troubleshooting. While this is discouraged, if a user
|
||||||
|
|
Loading…
Reference in New Issue