What is indexed?

To provide best search experience, following data is indexed:

• page title
• content excerpt (number of characters is configurable)
• page path (URL)
• page internal ID
• page category (coming soon)

Algolia vs Localsearch

LocalSearch

LocalSearch engine is a client-side search powered by FlexSearch. It does not need any external service to work, index is created during build time and whole searching is done on the client (browser).

To make LocalSearch work there is no additional configuration needed then setting up BooGi 😃

Tuning engine

https://github.com/nextapps-de/flexsearch#options

FlexSearch engine is customizable and you can configure to satisfy your needs (speed, accuracy / relevance, memory consumption).

Default engine configuration is tuned to provide best search results, keeping great search speed and reasonable memory consumption.

Follow this guide to learn more how you can set up FlexSearch engine to satisfy your needs.

To configure Flexsearch engine pass proper configuration to features.search.localSearchEngine property in config.yml.

Algolia

Algolia is a SaaSSaaS - Software as a Service Software licensing and delivery model in which software is licensed on a subscription basis and is centrally hosted and managed search engine, offering full-text search, capable of delivering real-time results. Algolia’s powerful API lets you quickly and seamlessly index content and implement search within your websites.

Algolia offers great free tier, which may be sufficient for plenty of pages using BooGi. For more details on Algolia follow its documentation.

Setting up Algolia

The first step is to create and set up Algolia account. In order to make Algolia working properly with your page, you need following:

1. Algolia application
2. Index
3. Search-only API key for given Index (or whole application), used for searching
4. Admin API key for given Index (or whole application), used only for building and managing index. It is used only during page build time.

Creating Algolia application

You can create a new application in the My Account section of the dashboard. Then, in the Applications tab, select New application. You can then switch between your applications via the top-left dropdown menu.

After creating application, open it to further configure it. Go to API Keys tab in Application' dashboard and note down Application ID which will be required later on when configuring BooGiBooGi T lulzhe best documentation tool in the space! Check it here..

Creating an index

Go to Indices tab in Application' dashboard to create a new index. Click on New... then Index and provide its name.

Setting up Search and Admin API key

Go to API Keys tab in Application' dashboard to manage API keys.

You can either use Application-scoped API keys or more fine-grained Index-scoped API keys.

Application-scoped API keys

Application-scope keys have either search or admin rights to all indices within application. They may have too broad permissions than required.

They are created by default and accessible in Your API Keys tab.

Index-scoped API keys

Index-scope keys allow setting up more fine-grained permissions to API keys. You can configure them to set certain access rights to certain indices.

Go to All API Keys tab and select New API Key. Set up desired configuration and select proper ACLs:

• for Search API Key: search scope,
• for Admin API Key: addObject, deleteObject, browse, settings, editSettings scopes.

Remember to select proper Indices to which API keys will have rights.

Managing environments

There are two main approaches to managing different environments:

• application per environment
• index per environment within single application

Follow this guide to decide which approach will fit you better.

Setting up BooGi

Search configuration is set in config.yaml under features.search key.

Full configuration example - Algolia

features:
  search:
    enabled: true,
    indexName: 'myindex'
    engine: 'algolia'
    excerptSize: 10000
    placeholder: 'Search here...'
    startComponent: 'input'
    debounceTime: 380,
    snippetLength: 22,
    hitsPerPage: 10,
    showStats: true,
    pagination:
      enabled: true,
      totalPages: 10,
      showNext: true,
      showPrevious: true

Full configuration example - LocalSearch

features:
  search:
    enabled: true,
    engine: 'localsearch'
    localSearchEngine: 'balance'
    excerptSize: 10000
    placeholder: 'Search here...'
    startComponent: 'input'
    debounceTime: 380,
    snippetLength: 22,
    hitsPerPage: 10,
    showStats: true,
    pagination:
      enabled: true,
      totalPages: 10,
      showNext: true,
      showPrevious: true