Configuration

Configuration files in SearchBlox store essential collection and search-related settings, making it easy to manage, back up, and migrate configurations across different environments or during system upgrades.

Key Features of Configuration Files

Export and Import Functionality: Configuration files can be exported or imported during initial setup, upgrades, or migrations, allowing seamless transfer of configurations between different SearchBlox servers.

Data Clearance on Import: When a configuration file is imported, all existing data in the collections is cleared. Reindexing all collections is required after import to ensure data is refreshed and accessible.

❗️

Important Note

  • Uploading a configuration file will delete all existing collections.
  • A valid license key is required; configuration import works only in licensed versions.
  • Configuration files from older SearchBlox versions are not supported for import in SearchBlox 10.x.

You can find configuration features under SearchBlox Admin Console > Administration > Configuration

  • In the Rollback Configuration section, you can revert the configuration using the Revert button, restoring it to a previous version.
  • You can revert to any of the last 10 versions. SearchBlox automatically creates a timestamped backup of the configuration file whenever settings are added or modified.
  • All backed-up configuration files are stored in the following path:
    `/webapps/ROOT/WEB-INF/confbackup
  • When exporting the configuration, an XML file named exportconfig.xml with a timestamp is downloaded. This file can be imported into the current or any future SearchBlox build.
  • After the configuration file is successfully imported, you will be redirected to the login page for authentication.
  • Once you access the Admin Dashboard, the collections imported from the configuration file will be available, and all previously existing collections will be removed.
  • In Reset Configuration, you can reset the SearchBlox configuration to its default state.
  • Resetting the configuration will also remove all Featured Results.
  • After the reset, SearchBlox will revert to the default Web collection and default search settings.
  • When performing a configuration reset, the user must provide a reason, which is logged in the status.log file for reference.

Important Information on Configuration File

  • After importing a configuration file, reindex all collections or schedule them to ensure data is indexed before users perform searches.
  • It is recommended to create a manual backup of the configuration file at least once a month (or more often if collections change frequently) by exporting and saving the current file.
  • This configuration file can be uploaded during upgrades, reinstallation, or when replicating the setup on another server.
  • The password can be reset by removing signed="true" or by replacing the existing encrypted password in <SEARCHBLOX_INSTALLATION_PATH>/webapps/ROOT/WEB-INF/config.xml with the password provided in the following line:
<config password="Fms/jGO/du9Mzl1jayYxMnOdxD4=" apikey="636D91FAABEAA4942298" signed="true">