RPJosh
/
authelia
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[MISC] Append log file instead of overwriting (#1450) 

* [MISC] Append log file instead of overwriting

If Authelia is restarted when a `log_file_path` is defined upon restart the log file is overwritten as opposed to appending the existing file.

This change ensures that the log file will be appended to, users will need to ensure that they rotate/truncate this over time especially if running in `debug` or `trace`.

* Amend documentation for log_file_path
pull/1454/head^2
Amir Zarrinkafsh 2020-11-13 10:14:45 +11:00 committed by GitHub
parent 29af1aac6a
commit f392f51df6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 15 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
config.template.yml
View File

@ -5,7 +5,7 @@
# The host and port to listen on # The host and port to listen on
host: 0.0.0.0 host: 0.0.0.0
port: 9091 port: 9091
# tls_key: /config/ssl/key.pem # tls_key: /config/ssl/key.pem
# tls_cert: /config/ssl/cert.pem # tls_cert: /config/ssl/cert.pem
# Configuration options specific to the internal http server # Configuration options specific to the internal http server
@ -22,7 +22,7 @@ server:
# Level of verbosity for logs: info, debug, trace # Level of verbosity for logs: info, debug, trace
log_level: debug log_level: debug
## File path where the logs will be written. If not set logs are written to stdout. ## File path where the logs will be written. If not set logs are written to stdout.
# log_file_path: /config/authelia.log # log_file_path: /config/authelia.log
# The secret used to generate JWT tokens when validating user identity by # The secret used to generate JWT tokens when validating user identity by
# email confirmation. # email confirmation.

11
docs/configuration/miscellaneous.md
View File

@ -39,9 +39,9 @@ tls_cert: /config/ssl/cert.pem
`optional: true` `optional: true`
Defines the level of logs used by Authelia. This level can be set to Defines the level of logs used by Authelia. This level can be set to
`trace`, `debug` or `info`. When setting log_level to trace, you will `trace`, `debug` or `info`. When setting log_level to `trace`, you will
generate a large amount of log entries and expose the /debug/vars and generate a large amount of log entries and expose the `/debug/vars` and
/debug/pprof/ endpoints which should not be enabled in production. `/debug/pprof/` endpoints which should not be enabled in production.
```yaml ```yaml
log_level: debug log_level: debug
@ -52,7 +52,10 @@ log_level: debug
`optional: true` `optional: true`
Logs can be stored in a file when file path is provided. Otherwise logs Logs can be stored in a file when file path is provided. Otherwise logs
are written to standard output. are written to standard output. When setting the log_level to `debug` or
`trace` this will generate large amount of log entries.
Administrators will need to ensure that they rotate and/or truncate the
logs over time to prevent significant long-term disk usage.
```yaml ```yaml
log_file_path: /config/authelia.log log_file_path: /config/authelia.log

2
docs/security/measures.md
View File

@ -146,7 +146,7 @@ applying them blindly.
``` ```
# We don't want any credentials / TOTP secret key / QR code to be cached by # We don't want any credentials / TOTP secret key / QR code to be cached by
# the client # the client
add_header Cache-Control "no-store"; add_header Cache-Control "no-store";
add_header Pragma "no-cache"; add_header Pragma "no-cache";

3
internal/logging/logger.go
View File

@ -24,7 +24,8 @@ func InitializeLogger(filename string) error {
logrus.AddHook(logrus_stack.NewHook(callerLevels, stackLevels)) logrus.AddHook(logrus_stack.NewHook(callerLevels, stackLevels))
if filename != "" { if filename != "" {
f, err := os.OpenFile(filename, os.O_WRONLY|os.O_CREATE, 0600) f, err := os.OpenFile(filename, os.O_APPEND|os.O_WRONLY|os.O_CREATE, 0600)
if err != nil { if err != nil {
return err return err
} }

4
internal/suites/example/compose/nginx/portal/nginx.conf
View File

@ -78,7 +78,7 @@ http {
} }
} }
# Example configuration of domains protected by Authelia. # Example configuration of domains protected by Authelia.
server { server {
listen 8080 ssl; listen 8080 ssl;
server_name public.example.com server_name public.example.com
@ -235,7 +235,7 @@ http {
} }
} }
# Matches all domains. It redirects to the home page. # Matches all domains. It redirects to the home page.
server { server {
listen 8080 ssl; listen 8080 ssl;
server_name _; server_name _;

2
internal/suites/example/compose/squid/squid.conf
View File

@ -1195,7 +1195,7 @@ http_access allow all
# http_access allow localhost # http_access allow localhost
# And finally deny all other access to this proxy # And finally deny all other access to this proxy
# http_access deny all # http_access deny all
# TAG: adapted_http_access # TAG: adapted_http_access
# Allowing or Denying access based on defined access lists # Allowing or Denying access based on defined access lists