diff --git a/.github/ISSUE_TEMPLATE/BUG-REPORT.yaml b/.github/ISSUE_TEMPLATE/BUG-REPORT.yaml index f9861b415..438c9f35b 100644 --- a/.github/ISSUE_TEMPLATE/BUG-REPORT.yaml +++ b/.github/ISSUE_TEMPLATE/BUG-REPORT.yaml @@ -35,6 +35,6 @@ body: id: logs attributes: label: Relevant log output - description: Please run Corso with `--log-level debug`. + description: Please run Corso with `--log-level debug` and attach the log file. placeholder: This will be automatically formatted, so no need for backticks. render: shell diff --git a/website/docs/setup/configuration.md b/website/docs/setup/configuration.md index cee7c7988..85c99c6bb 100644 --- a/website/docs/setup/configuration.md +++ b/website/docs/setup/configuration.md @@ -129,14 +129,29 @@ directory within the container. ## Log Files -The location of log files varies by operating system: +The default location of Corso's log file is shown below but the location can be overridden by using the `--log-file` flag. +You can also use `stdout` or `stderr` as the `--log-file` location to redirect the logs to "stdout" and "stderr" respectively. -* On Linux - `~/.cache/corso/logs/.log` -* On macOS - `~/Library/Logs/corso/logs/.log` -* On Windows - `%LocalAppData%\corso/logs/.log` + + -Log file location can be overridden by setting the `--log-file` flag. + ```powershell + %LocalAppData%\corso\logs\.log + ``` -:::info -You can use `stdout` or `stderr` as the `--log-file` location to redirect the logs to "stdout" and "stderr" respectively. -::: + + + + ```bash + $HOME/.cache/corso/logs/.log + ``` + + + + + ```bash + $HOME/Library/Logs/corso/logs/.log + ``` + + +