Getting Started

How to get started with Onyx.

Prerequisites

Docker installed

Installation

git clone https://github.com/onyxassistant/onyx.git
cd onyx
mv .env.example .env # <-- Set your environment variables here
docker compose up

Accessing the UI

Open your browser and navigate to http://DOMAIN with the DOMAIN being the value you set in your .env file.

Introduction Architecture