Directory Layout
This section provides a complete overview of the folder structure created when SearchBlox is installed. Use this as a reference to quickly locate configuration files, log files, data folders, and other important components on both Windows and Linux systems.
| Type | Description | Default Location Windows | Default Location Linux |
|---|---|---|---|
| SearchBlox Home | Default path for SearchBlox installation | C:\SearchBloxServer | /opt/searchblox |
| Opensearch Home | Default path for Opensearch | C:\SearchBloxServer\opensearch | /opt/searchblox/opensearch |
| SearchBlox Services | Location of SearchBlox service files. | C:\SearchBloxServer\service | /opt/searchblox/service |
| SearchBlox logs es.log, index.log, status.log, query.log, parameter.log, auth.log, securesearch.log, user.log, activity.log, pretext.log | Location of SearchBlox-related log files. | C:\SearchBloxServer\webapps\ROOT\logs | /opt/searchblox/webapps /ROOT/logs |
| Opensearch logs | Location of Opensearch logs | C:\SearchBloxServer\opensearch\logs | /opt/searchblox/opensearch /logs |
| Data or Opensearch Index | Location where data is stored in SearchBlox | C:\SearchBloxServer\opensearch\data | /opt/searchblox/opensearch /data |
| SearchBlox Collection Config File config.xml | Location of config file containing details of the collections | C:\SearchBloxServer\webapps\ROOT\WEB-INF\config.xml | /opt/searchblox/webapps/ROOT/WEB-INF/config.xml |
| License File license.xml | Location of license file | C:\SearchBloxServer\webapps\ROOT\WEB-INF\license.xml | /opt/searchblox/webapps/ROOT/WEB-INF/license.xml |
| Server Startup Config Files ssl.ini jvm.ini | Location of ssl.ini and jvm.ini file | C:\SearchBloxServer\start.d | /opt/searchblox/start.d/start.ini |
| Base Template Search | Location of base template search | C:\SearchBloxServer\webapps\ROOT\search | /opt/searchblox/webapps/ROOT/search |
| _Base Template Search Configuration* _facet.js | Location of base template search configuration file | C:\SearchBloxServer\webapps\ROOT\search\facet.js | /opt/searchblox/webapps /ROOT/search/facet.js |
| Opensearch Settings File opensearch.yml searchblox.yml | Location of .yml file for opensearch configuration. Note: Main opensearch.yml would be available in opensearch config folder and searchblox.yml file would be available in WEB-INF folder | C:\SearchBloxServer\opensearch\config opensearch.yml AND C:\SearchBloxServer webapps\ROOT\WEB-INF\searchblox.yml | /opt/searchblox/ opensearch/config/ opensearch.yml AND /opt/searchblox/webapps/ROOT/ WEB-INF/searchblox.yml |
| Mapping Files collection specific mapping files with json extension | Location of json file related to elasticsearch mapping in SearchBlox | C:\SearchBloxServer\webapps\ROOT\WEB-INF\mappings\collections | /opt/searchblox/webapps/ROOT/WEB-INF/mappings/collections |
| Stopwords | Location for customizing stop words | C:\SearchBloxServer\webapps\ROOT\stopwords | /opt/searchblox/webapps/ROOT/stopwords |
| Connectors Port Change | Location and file to configure port | C:\SearchBloxServer\connectors\config.yml | /opt/searchblox/connectors/config.yml |
| Caddy | Location for caddy for port forwarding and load balancer configuration | C:\SearchBloxServer\caddy | /opt/searchblox/caddy |
| Ollama | Location to updated the models folder and to run Ollama service | C:\SearchBloxServer\ollama C:\SearchBloxServer\ollama\models | /opt/searchblox/ollama /opt/searchblox/ollama/models |
