Chat now with support
Chat with Support

syslog-ng Store Box 5.3.0 - Administration Guide

Preface Introduction The concepts of SSB The Welcome Wizard and the first login Basic settings User management and access control Managing SSB Configuring message sources Storing messages on SSB Forwarding messages from SSB Log paths: routing and processing messages Configuring syslog-ng options Searching log messages Searching the internal messages of SSB Classifying messages with pattern databases The SSB RPC API Troubleshooting SSB Security checklist for configuring SSB About us Third-party contributions

Exporting the configuration of SSB

The configuration of SSB can be exported (for manual archiving, or to migrate it to another SSB unit) from the Basic Settings > System page. Use the respective action buttons to perform the desired operation.

Figure 59: Basic Settings > System — Exporting the SSB configuration

To export the configuration of SSB

  1. Navigate to Basic Settings > System > Export configuration.

  2. Select how to encrypt the configuration:

    • To export the configuration file without encryption, select No encryption.

      Caution:

      Exporting the SSB configuration without encyption is not recommended, as it contains sensitive information such as password hashes and private keys.

    • To encrypt the configuration file with a simple password, select Encrypt with password and enter the password into the Encryption password and Confirm password fields.

      NOTE:

      SSB accepts passwords that are not longer than 150 characters. The following special characters can be used: !"#$%&'()*+,-./:;<=>?@[]^-`{|}

    • To encrypt the configuration file with GPG, select GPG encryption. Note that this option uses the same GPG key that is used to encrypt automatic system backups, and is only available if you have uploaded the public part of a GPG key to SSB at Basic Settings > Management > System backup. For details, see Encrypting configuration backups with GPG.

  3. Click Export.

    NOTE:

    The exported file is a gzip-compressed archive. On Windows platforms, it can be decompressed with common archive managers such as the free 7-Zip tool.

    The name of the exported file is <hostname_of_SSB>-YYYMMDDTHHMM.config. The -encrypted or -gpg suffix is added for password-encrypted and GPG-encrypted files, respectively.

Importing the configuration of SSB

The configuration of SSB can be imported from the Basic Settings > System page. Use the respective action buttons to perform the desired operation.

Figure 60: Basic Settings > System — Importing the SSB configuration

Caution:

It is possible to import a configuration exported from SSB 2.0 or 3.0 into SSB 5.3.0, but it is not possible to restore an 1.1 or 1.0 backup into 5.3.0.

To import the configuration of SSB

  1. Navigate to Basic Settings > System > Import configuration.

  2. Click Choose File and select the configuration file to import.

  3. Enter the password into the Decryption password field and click Upload.

    NOTE:

    SSB accepts passwords that are not longer than 150 characters. The following special characters can be used: !"#$%&'()*+,-./:;<=>?@[]^-`{|}

    Caution:

    When importing an older configuration, it is possible that there are logspaces on SSB that were created after the backing up of the old configuration. In such case, the new logspaces are not lost, but are deactivated and not configured. To make them accessible again, you have to:

    1. Navigate to Log > Logspaces and configure the logspace. Filling the Access Control field is especially important, otherwise the messages stored in the logspace will not be available from the Search > Logspaces interface.

    2. Adjust your log path settings on the Log > Paths page. Here you have to re-create the log path that was sending messages to the logspace.

Accessing the SSB console

This section describes how to use the console menu of SSB, how to enable remote SSH access to SSB, and how to change the root password from the web interface.

Using the console menu of SSB

Connecting to the syslog-ng Store Box locally or remotely using Secure Shell (SSH) allows you to access the console menu of SSB. The console menu provides access to the most basic configuration and management settings of SSB. It is mainly used for troubleshooting purposes, the primary interface of SSB is the web interface.

NOTE:

Detailed host information is displayed in the shell prompt:

The format of the bash prompt is:

(firmware_type/HA_node/hostname)username@HA_node_name:current_working_directory#

For example:

(core/master/documentation-ssb)root@ssb1:/etc#
  • firmware_type is either boot or core

  • HA_node is either master or slave

  • hostname is the FQDN set on the GUI

  • username is always root

The console menu is accessible to the root user using the password set during completing the Welcome Wizard.

Figure 61: The console menu

The console menu allows you to perform the following actions:

  • Change the passwords of the root and admin users.

  • Access the local shells of the core and boot firmwares. This is usually not recommended and only required in certain troubleshooting situations.

  • Access the network-troubleshooting functions and display the available log files.

  • Reboot and shut down the system.

  • Enable and disable sealed mode. For details, see Sealed mode.

  • Set the IP address of the HA interface.

    This option is not available on virtual appliances, or if your SSB license does not include the HA option. If High Availability (HA) operation mode is required in a virtual environment, use the HA function provided by the virtual environment.

NOTE:

Note that logging in to the console menu automatically locks the SSB interface, meaning that users cannot access the web interface while the console menu is used. The console menu can be accessed only if there are no users accessing the web interface. The connection of web-interface users can be terminated to force access to the console menu.

Related Documents