​
Requirements

  • git
  • Docker with compose (docker version >= 1.13.0)
  • System requirements found here

​
Setup

The most common source of issues is under-resourcing. Before beginning, check the system requirements here.

  1. Clone the Onyx repo:
git clone https://github.com/onyx-dot-app/onyx.git
  1. Navigate to onyx/deployment/docker_compose
cd onyx/deployment/docker_compose

  1. (Optional) configure Onyx

  2. Bring up your docker engine and run:

    • To pull images from DockerHub and run Onyx:
    docker compose -f docker-compose.dev.yml -p onyx-stack up -d --pull always --force-recreate
    • Alternatively, to build the containers from source and start Onyx, run:
    docker compose -f docker-compose.dev.yml -p onyx-stack up -d --build --force-recreate
    • This may take 15+ minutes depending on your internet speed.
      • Additionally, once the images have been pulled / built, the initial startup of the api_server may take some time (we download embedding models from HuggingFace to power the search). If you see This site can’t be reached in your browser despite all containers being up and running, check the api_server logs and make sure you see Application startup complete.
      • If you see Killed in the logs, you may need to increase the amount of memory given to Docker. For recommendations, check the system requirements here.

These commands are also used to redeploy if any .env variables are updated

  1. Onyx will now be running on http://localhost:3000.

​
Generative AI API Key

Note: On the initial visit, Onyx will prompt for an OpenAI API key.

You can get an OpenAI API key at: https://platform.openai.com/account/api-keys

You can also replace OpenAI with a model provider of your choice, see here for more info

​
Indexing Documents

This quickstart guide will index a publicly accessible website as this requires no additional authorization setup

  1. Navigate to the top right of Onyx’s home screen and select Admin Panel

  1. In the Web Connector dashboard, pick any base URL to index.
    • This will index all pages under that base URL that is reachable from hyperlinks.
    • You can check the indexing status page to monitor the progress.

  1. After the pages are indexed, you can now navigate back to the homepage and start asking questions and getting answers! 🥳

​
Shutting Down

docker compose -f docker-compose.dev.yml -p onyx-stack down

add -v at the end to additionally delete the volumes (containing users and indexed documents)

IntroductionResourcing