​
Build and Deploy Ocular in Docker

Ocular is a platform to create AI powered Search and Chat for Organisations. In its simplest form, Ocular is a Node.js backend with the core API, plugins, and modules installed through npm.

Ocular can be built and deployed using Docker either on your Local Machine or in the Cloud.

​
Prerequisites

First, make sure you have the Docker installed on your device. You can download and install it from here.

Once Docker is installed, follow the instructions below to run Ocular in Docker.

​
Step 1: Clone Ocular Repo

Clone the Ocular repo and navigate to home directory. git clone https://github.com/OcularEngineering/ocular.git && cd ocular

​
Step 2: Set Up Environment Variables

Open env.local and the following environment variables.

  1. Required Open AI Keys
  • To run Ocular an LLM provider must be setup in the backend.
  • Add the OPEN_AI_KEY and OPEN_AI_CHAT_MODEL keys which you can get from OpenAI

​
Step 3: Run Ocular In Docker

docker compose -f docker-compose.local.yml up --build --force-recreate

​
Step 4: Open Ocular

Navigate to http://localhost:3001/create-account to access Ocular.

OverviewArchitecture