diff options
| author | Gary Moon <garymoon@users.noreply.github.com> | 2023-04-13 09:14:06 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-04-13 21:14:06 +0800 |
| commit | 29194a9dd6f5d8a98096a4a01c33d9be89616ed7 (patch) | |
| tree | 7a86b688677d61be3f0cec004d0078096193fd7a /docs/content/doc/administration/config-cheat-sheet.en-us.md | |
| parent | 2b749af50508a28c7088e7d76132c27f96a45789 (diff) | |
| download | gitea-29194a9dd6f5d8a98096a4a01c33d9be89616ed7.tar.gz gitea-29194a9dd6f5d8a98096a4a01c33d9be89616ed7.zip | |
Correct the access log format (#24085)
The default access log format has been unnecessarily escaped, leading to
spurious backslashes appearing in log lines.
Additionally, the `RemoteAddr` field includes the port, which breaks
most log parsers attempting to process it. I've added a call to
`net.SplitHostPort()` attempting to isolate the address alone, with a
fallback to the original address if it errs.
Signed-off-by: Gary Moon <gary@garymoon.net>
Diffstat (limited to 'docs/content/doc/administration/config-cheat-sheet.en-us.md')
| -rw-r--r-- | docs/content/doc/administration/config-cheat-sheet.en-us.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/content/doc/administration/config-cheat-sheet.en-us.md b/docs/content/doc/administration/config-cheat-sheet.en-us.md index 76952df40e..f26e7eaa08 100644 --- a/docs/content/doc/administration/config-cheat-sheet.en-us.md +++ b/docs/content/doc/administration/config-cheat-sheet.en-us.md @@ -878,7 +878,7 @@ Default templates for project boards: - `ENABLE_ACCESS_LOG`: **false**: Creates an access.log in NCSA common log format, or as per the following template - `ACCESS`: **file**: Logging mode for the access logger, use a comma to separate values. Configure each mode in per mode log subsections `\[log.modename.access\]`. By default the file mode will log to `$ROOT_PATH/access.log`. (If you set this to `,` it will log to the default Gitea logger.) -- `ACCESS_LOG_TEMPLATE`: **`{{.Ctx.RemoteAddr}} - {{.Identity}} {{.Start.Format "[02/Jan/2006:15:04:05 -0700]" }} "{{.Ctx.Req.Method}} {{.Ctx.Req.URL.RequestURI}} {{.Ctx.Req.Proto}}" {{.ResponseWriter.Status}} {{.ResponseWriter.Size}} "{{.Ctx.Req.Referer}}\" \"{{.Ctx.Req.UserAgent}}"`**: Sets the template used to create the access log. +- `ACCESS_LOG_TEMPLATE`: **`{{.Ctx.RemoteHost}} - {{.Identity}} {{.Start.Format "[02/Jan/2006:15:04:05 -0700]" }} "{{.Ctx.Req.Method}} {{.Ctx.Req.URL.RequestURI}} {{.Ctx.Req.Proto}}" {{.ResponseWriter.Status}} {{.ResponseWriter.Size}} "{{.Ctx.Req.Referer}}" "{{.Ctx.Req.UserAgent}}"`**: Sets the template used to create the access log. - The following variables are available: - `Ctx`: the `context.Context` of the request. - `Identity`: the SignedUserName or `"-"` if not logged in. |