diff --git a/INSTALL b/INSTALL index 19ec4206e8..084ca9dc2e 100644 --- a/INSTALL +++ b/INSTALL @@ -233,6 +233,46 @@ OpenBSD users, please see our FAQ at http://www.bro-ids.org/documentation/faq.html if you are having problems installing Bro. + +Upgrading From a Previous Version of Bro +======================================== + +If you're doing an upgrade install (rather than a fresh install), +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). Also, logs +generated at run-time won't be touched by the upgrade. (But making +a backup of local changes before upgrading is still recommended.) + +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 to 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. + + Configure the Run-Time Environment ================================== diff --git a/doc/faq.rst b/doc/faq.rst index 76f81cc618..f265505def 100644 --- a/doc/faq.rst +++ b/doc/faq.rst @@ -12,43 +12,6 @@ Frequently Asked Questions Installation and Configuration ============================== -How do I upgrade to a new version of Bro? ------------------------------------------ - -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). Also, logs -generated at run-time won't be touched by the upgrade. (But making -a backup of local changes before proceeding is still recommended.) - -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 to 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? ----------------------------------------------------------------