From 28eef1a90b72d5bfeffa65b5c2e85e055e92e460 Mon Sep 17 00:00:00 2001 From: predictiple Date: Fri, 6 Sep 2024 11:20:45 +0200 Subject: [PATCH] Remove panic log duplicate in example server config (#3733) --- docs/references/server.config.yaml | 28 +++++++++++----------------- 1 file changed, 11 insertions(+), 17 deletions(-) diff --git a/docs/references/server.config.yaml b/docs/references/server.config.yaml index 2a1e2cc4032..912776b063b 100644 --- a/docs/references/server.config.yaml +++ b/docs/references/server.config.yaml @@ -321,13 +321,16 @@ Client: logfile_name: "logfile.log" logfile_size: 10000000 - # When Velociraptor is running as a Windows service the system can - # not capture any messages printed to stdout or stderr. This means - # that if Velociraptor crashes we lose the panic backtrace the helps - # debug why it crashed. Setting this to a path on the client, will - # cause Velociraptor to redirect stdout and stderr to this file from - # the Windows service. - panic_file: "" + # On Windows, the client usually runs as a service. If a crash occurs + # while Velociraptor is running as a Windows service the traceback of + # the error is printed to Stderr, however a Windows service discards + # these messages. This means that if Velociraptor crashes we lose the + # panic backtrace which is useful for debugging why it crashed. This + # setting allows us to specify a path to a log file on the client where + # Velociraptor will write stdout and stderr in the event of a crash. + # This feature is currently not implemented for non-Windows platforms + # where this setting will have no effect. + panic_file: $TEMP/panic.log ## Velociraptor keeps a local buffer file to store query results @@ -354,15 +357,6 @@ Client: filename_windows: $TEMP/Velociraptor_Buffer.bin filename_darwin: /var/tmp/Velociraptor_Buffer.bin - # This is path which will accept the windows service panic - # messages. On windows, the client usually runs in a service. If a - # crash occurs the traceback of the error is printed to Stderr but a - # Windows service ignores these messages making it very hard to - # debug the reason for the crash. This setting can specify the path - # to a local file which will be used to collect such panic messages - # from the running service. - panic: $TEMP/panic.log - # Setting this will write clear text network traces to this # file. This is used for debugging network communications in complex # scenarios (e.g. in the presence of proxies etc). Do not leave this @@ -1342,7 +1336,7 @@ defaults: disable_unicode_usernames: false # How often to refresh the search index (default 5 min). This - # rebuilds the search index periodically to avoid inconsitancies + # rebuilds the search index periodically to avoid inconsistencies. reindex_period_seconds: 300 # The client metadata is an arbitrary key/value store that holds