diff --git a/doc/faq.rst b/doc/faq.rst index 1836e5a5e9..2342af1546 100644 --- a/doc/faq.rst +++ b/doc/faq.rst @@ -12,13 +12,42 @@ Frequently Asked Questions Installation and Configuration ============================== -What files will get overwritten when upgrading/installing a new Bro version? ----------------------------------------------------------------------------- +How do I upgrade to a new version of Bro? +----------------------------------------- -Expect everything except things in ``$prefix/share/bro`` and -``$prefix/etc`` to be overwritten, but backing up the entire ``$prefix`` -before upgrading is good practice (``$prefix`` indicating the root of -where Bro was installed). +There's two suggested approaches, either install Bro using the same +installation prefix directory as before, or pick a new prefix and copy +local customizations over. + +Re-Use Previous Install Prefix +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If you choose to configure and install Bro with the same prefix +directory as before, local customization and configuration to files in +``$prefix/share/bro/site`` and ``$prefix/etc`` won't be overwritten +(``$prefix`` indicating the root of where Bro was installed), but making +a backup of local changes before proceeding is recommended. Also, logs +generated at run-time won't be touched by the upgrade. + +After upgrading, remember to check ``$prefix/share/bro/site`` and +``$prefix/etc`` for ``.example`` files, which indicate the +distribution's version of the file differs from the local one, which may +include local changes. Review the differences, and make adjustments +as necessary (for differences that aren't the result of a local change, +use the new version's). + +Pick a New Install prefix +^^^^^^^^^^^^^^^^^^^^^^^^^ + +If you want the install the newer version in a different prefix +directory than before, you can just copy local customization and +configuration files from ``$prefix/share/bro/site`` and ``$prefix/etc`` +to the new location (``$prefix`` indicating the root of where Bro was +originally installed). Make sure to review the files for difference +before copying and make adjustments as necessary (for differences that +aren't the result of a local change, use the new version's). Of +particular note, the copied version of ``$prefix/etc/broctl.cfg`` is +likely to need changes to the ``SpoolDir`` and ``LogDir`` settings. How can I tune my operating system for best capture performance? ----------------------------------------------------------------