diff --git a/salt/common/tools/sbin/so-analyst-install b/salt/common/tools/sbin/so-analyst-install index c49cb015b..f4eef07fa 100755 --- a/salt/common/tools/sbin/so-analyst-install +++ b/salt/common/tools/sbin/so-analyst-install @@ -6,13 +6,13 @@ # Elastic License 2.0. -doc_workstation_url="https://docs.securityonion.net/en/2.4/analyst-vm.html" {# we only want the script to install the workstation if it is CentOS -#} {% if grains.os == 'CentOS' -%} {# if this is a manager -#} {% if grains.master == grains.id.split('_')|first -%} source /usr/sbin/so-common +doc_workstation_url="$DOC_BASE_URL/analyst-vm.html" pillar_file="/opt/so/saltstack/local/pillar/minions/{{grains.id}}.sls" if [ -f "$pillar_file" ]; then diff --git a/salt/common/tools/sbin/so-common b/salt/common/tools/sbin/so-common index c241c6513..43e6f4446 100755 --- a/salt/common/tools/sbin/so-common +++ b/salt/common/tools/sbin/so-common @@ -5,9 +5,8 @@ # https://securityonion.net/license; you may not use this file except in compliance with the # Elastic License 2.0. - - DEFAULT_SALT_DIR=/opt/so/saltstack/default +DOC_BASE_URL="https://docs.securityonion.net/en/2.4" # Check for prerequisites if [ "$(id -u)" -ne 0 ]; then diff --git a/salt/common/tools/sbin/soup b/salt/common/tools/sbin/soup index b556e80b1..6bdd49661 100755 --- a/salt/common/tools/sbin/soup +++ b/salt/common/tools/sbin/soup @@ -47,7 +47,7 @@ check_err() { ;; 28) echo 'No space left on device' - echo 'Likely ran out of space on disk, please review hardware requirements for Security Onion: https://docs.securityonion.net/en/2.4/hardware.html' + echo "Likely ran out of space on disk, please review hardware requirements for Security Onion: $DOC_BASE_URL/hardware.html" ;; 30) echo 'Read-only file system' @@ -458,7 +458,7 @@ es_indices_check() { if [ -z "$UNSUPPORTED_INDICES" ]; then echo "No unsupported indices found." else - echo "The following indices were created with Elasticsearch 6, and are not supported when upgrading to Elasticsearch 8. These indices may need to be deleted, migrated, or re-indexed before proceeding with the upgrade. Please see https://docs.securityonion.net/en/2.4/soup.html#elastic-8 for more details." + echo "The following indices were created with Elasticsearch 6, and are not supported when upgrading to Elasticsearch 8. These indices may need to be deleted, migrated, or re-indexed before proceeding with the upgrade. Please see $DOC_BASE_URL/soup.html#elastic-8 for more details." echo echo "$UNSUPPORTED_INDICES" exit 1 @@ -1411,7 +1411,7 @@ Each minion is on a random 15 minute check-in period and things like network ban If it looks like you’re missing data after the upgrade, please avoid restarting services and instead make sure at least one search node has completed its upgrade. The best way to do this is to run 'sudo salt-call state.highstate' from a search node and make sure there are no errors. Typically if it works on one node it will work on the rest. Forward nodes are less complex and will update as they check in so you can monitor those from the Grid section of SOC. -For more information, please see https://docs.securityonion.net/en/2.4/soup.html#distributed-deployments. +For more information, please see $DOC_BASE_URL/soup.html#distributed-deployments. EOF @@ -1425,7 +1425,7 @@ EOF A custom Elasticsearch configuration has been found at /opt/so/saltstack/local/elasticsearch/files/elasticsearch.yml. This file is no longer referenced in Security Onion versions >= 2.3.80. -If you still need those customizations, you'll need to manually migrate them to the new Elasticsearch config as shown at https://docs.securityonion.net/en/2.4/elasticsearch.html. +If you still need those customizations, you'll need to manually migrate them to the new Elasticsearch config as shown at $DOC_BASE_URL/elasticsearch.html. EOF @@ -1472,7 +1472,7 @@ if [[ -z $UNATTENDED ]]; then SOUP - Security Onion UPdater Please review the following for more information about the update process and recent updates: -https://docs.securityonion.net/en/2.4/soup.html +$DOC_BASE_URL/soup.html https://blog.securityonion.net EOF diff --git a/setup/so-whiptail b/setup/so-whiptail index 7b2b6d807..c473c29c2 100755 --- a/setup/so-whiptail +++ b/setup/so-whiptail @@ -244,7 +244,7 @@ whiptail_storage_requirements() { You need ${needed_val} to meet minimum requirements. - Visit https://docs.securityonion.net/en/2.4/hardware.html for more information. + Visit $DOC_BASE_URL/hardware.html for more information. Select YES to continue anyway, or select NO to cancel. EOM @@ -460,7 +460,7 @@ whiptail_install_type() { # What kind of install are we doing? install_type=$(whiptail --title "$whiptail_title" --radiolist \ - "What kind of installation would you like to do?\n\nFor more information, please see:\nhttps://docs.securityonion.net/en/2.4/architecture.html" 18 65 5 \ + "What kind of installation would you like to do?\n\nFor more information, please see:\n$DOC_BASE_URL/architecture.html" 18 65 5 \ "EVAL" "Evaluation mode (not for production) " ON \ "STANDALONE" "Standalone production install " OFF \ "DISTRIBUTED" "Distributed install submenu " OFF \ @@ -508,7 +508,7 @@ whiptail_install_type_dist_new() { read -r -d '' mngr_msg <<- EOM Choose a distributed manager type to start a new grid. - See https://docs.securityonion.net/en/2.4/architecture.html for details. + See $DOC_BASE_URL/architecture.html for details. Note: MANAGER is the recommended option for most users. MANAGERSEARCH should only be used in very specific situations. EOM @@ -528,7 +528,7 @@ whiptail_install_type_dist_existing() { local node_msg read -r -d '' node_msg <<- EOM - Choose a distributed node type to join to an existing grid. See https://docs.securityonion.net/en/2.4/architecture.html for details. + Choose a distributed node type to join to an existing grid. See $DOC_BASE_URL/architecture.html for details. Note: Heavy nodes (HEAVYNODE) are NOT recommended for most users. EOM @@ -1298,7 +1298,7 @@ whiptail_storage_requirements() { You need ${needed_val} to meet minimum requirements. - Visit https://docs.securityonion.net/en/2.4/hardware.html for more information. + Visit $DOC_BASE_URL/hardware.html for more information. Select YES to continue anyway, or select NO to cancel. EOM @@ -1351,7 +1351,7 @@ whiptail_you_sure() { Welcome to Security Onion Setup! You can use Setup for several different use cases, from a small standalone installation to a large distributed deployment for your enterprise. You can learn more in the documentation at: - https://docs.securityonion.net/en/2.4/ + $DOC_BASE_URL Setup uses keyboard navigation and you can use arrow keys to move around. Certain screens may provide a list and ask you to select one or more items from that list. You can use the Space bar to select items and the Enter key to proceed to the next screen.