Bots

​

Overview

Ocular is built for flexibility and extensibility which gives developers to choose how to implement the logic of their Search platform.

Bots allow users to interact with Ocular from the platforms that they use the most. Think of Slack, Google Chat or Microsoft teams.

Bots run in the same backend process as the core application thus share the same infrastructure, capacity and maintaince. Bots also have access to services and database within Ocular via a dependency container.

​

Official Ocular Bots

Ocular has official bots that cover communication channels such as Slack etc However contributors can add bots for any platform.

​

Installing Bots

To install a bot in your backend, add the bot to the Ocular config file in your backend.

The following config files are currenlty supported

• core-config-local.js - for running Ocular in Docker.
• core-config-dev.js - for running Ocular in development mode.

Set the following in the core-config-xxx.js bots section.

bots: [
   //..
   {
      resolve: `bot-name`,
      options: {
        // other configurations,
         ...,
         api_key: xxxx
      },
    },
]

​

Bots Configurations

For official Ocular bots in the Ocular repository, you can find in the README.md a list of bots. You can also check the official Ocular documentation below.