Getting Started

Download and install SearchBlox on Windows, Linux, Amazon Linux, or Docker with guided instructions.

Introduction

Welcome to SearchBlox. This page will help you get up and running as quickly as possible — whether you're installing SearchBlox for the first time, exploring its features, or setting up search for your organization.

Before You Begin

System Requirements

⚠️

SearchBlox v12.1 requires a minimum of 16 GB RAM and 4 CPU cores. Make sure your server meets these requirements before starting installation.

Check the full list of system requirements before downloading:

Upgrading from a Previous Version?

⚠️

An in-place upgrade is not recommended. Always start with a clean installation when moving to a new version of SearchBlox. A trial license and a compatible configuration file can be provided by the SearchBlox team to help with the transition. Contact SearchBlox Support before upgrading.

Why a clean installation is recommended

  • Stability — Prevents conflicts or errors caused by leftover files from previous versions
  • Performance — Avoids slowdowns from outdated settings or cached data
  • Compatibility — Ensures all components are properly configured and fully compatible with v12

Step 1: Download SearchBlox

Download the latest version of SearchBlox (v12.1) from the official website:

Step 2: Install SearchBlox

Choose the installation guide that matches your operating system or deployment environment:

Step 3: Activate Your License

Once SearchBlox is installed, you'll need to activate it with a valid license key before you can use it.

Need a trial license? Contact SearchBlox Support to request one.

Step 4: Log In to the Admin Console

After installation and license activation, open your browser and go to:

http://<your-server-address>:8080/searchblox/admin

Default login credentials

Username: admin
Password: admin

⚠️

Change the default password immediately after your first login. Go to Administration → Users to update it.

Step 5: Create Your First Collection

A collection is a group of content from one data source — for example, your company website, a shared drive, or a database. Creating a collection tells SearchBlox what to index and search.

  1. In the Admin Console, go to Collections → Manage Collections
  2. Click Create New Collection
  3. Choose a collection type (for example, Web, Filesystem, Database)
  4. Enter the URL or path to your content and select a language
  5. Click Start Indexing to begin

Helpful links

Step 6: Test Your Search

Once indexing is complete, test your search from the Admin Console:

  1. Go to Collections → Search Settings
  2. Use the built-in search preview to run a test query
  3. Review results and adjust relevance settings if needed

Helpful links

Step 7: Add Search to Your Website or App

Once search is working, embed it into your website or application:

  1. Go to Collections → Embed Search
  2. Copy the generated code snippet
  3. Paste it into your website or application

Helpful links

What's Next?

Once you're up and running, explore these areas based on your role:

I am a…Start here
AdministratorAdministrator Features
DeveloperDeveloper Features
Content ManagerContent Manager Features
Marketing ManagerMarketing Manager Features
End UserSearch User Features