Docs update

ddbnl · May 2, 2022 · 677217d · 677217d
1 parent d1eb0bb
commit 677217d
Show file tree

Hide file tree

Showing 6 changed files with 6 additions and 6 deletions.
diff --git a/ConfigExamples/fullConfig.yaml b/ConfigExamples/fullConfig.yaml
@@ -2,7 +2,7 @@ log:  # Log settings. Debug will severely decrease performance
   path: 'collector.log'
   debug: False
 collect:  # Settings determining which audit logs to collect and how to do it
-  rustEngine: False  # Use True to turn on the experimental far faster Rust engine
+  rustEngine: True  # Use False to revert to the old Python engine. If running from python instead of executable, make sure to install the python wheel in the RustEngineWheels folder
   schedule: 0 1 0  # How often to run in days/hours/minutes. Delete this line to just run once and exit.
   contentTypes:
     Audit.General: True

diff --git a/README.md b/README.md
@@ -1,11 +1,12 @@
 # Anouncement:
 
-To improve performance the engine of the log collector has been rewritten in Rust. Consider downloading the newest
-executable and using the following setting in your config:
+To improve performance (10x) and reliability the engine of the log collector has been rewritten in Rust. Consider downloading the newest
+executable to automatically use it. To turn off the new engine (in case of issues or for whatever reason), use the following
+in your config.yaml:
 
 ```
 collect:  
-  rustEngine: True
+  rustEngine: False
 ```
 In my own tests the Rust engine has been at least 5x faster. The default is still Python so people can test the new engine first. If you run into any problems, please remove the
 setting to revert back to the old engine, and consider creating an issue here on Github so I can fix it.

diff --git a/Source/AuditLogCollector.py b/Source/AuditLogCollector.py
@@ -68,7 +68,7 @@ def run_once(self):
         self._prepare_to_run()
         logging.log(level=logging.INFO, msg='Starting run @ {}. Content: {}.'.format(
             datetime.datetime.now(), self.config['collect', 'contentTypes']))
-        if self.config['collect', 'rustEngine']:
+        if not self.config['collect', 'rustEngine'] is False:
             self._start_interfaces()
             self.receive_results_from_rust_engine()
             self._stop_interfaces(force=False)

diff --git a/Source/RustEngine/README.md b/Source/RustEngine/README.md
diff --git a/pip_requirements_linux.txt b/pip_requirements_linux.txt
diff --git a/Source/requirements.txt → pip_requirements_win.txt b/Source/requirements.txt → pip_requirements_win.txt