Introduction

SapienAI is designed to be self-hosted, allowing you to run it on your own device. This documentation provides details on the different settings that can be configured. For the quick start guide, see the Self Hosting Quick Start section below.

All configuration options need to be set in the .env file. This file is called example.env in the repository but needs to be renamed to .env to work.

Once you have configured the .env file, follow on with the Self Hosting Quick Start section below to get started with running SapienAI.

Self Hosting Quick Start

Requirements

To run this software, you will need Docker and Docker Compose.

The easiest way to start is to download Docker Desktop, which automatically installs Docker Compose. Instructions to download Docker Desktop can be found here.

Install

You can clone the SapienAI repository or download it as a zip file (and then unzip once downloaded).

To continue with the installation, you can open the folder in an IDE or a text editor such as Visual Studio Code.

Setting the environmental variables

SapienAI has been built to be as customisable as possible. All configurable options are outlined in the example.env file and detailed in the documentation you are currently reading.

To get started, rename the example.env file to .env.

The quickest way to get up and running is to provide an OpenAI API key.

Example .env file entry:

env

OPENAI_KEY=your_openai_api_key_here

You can get an API key here by signing up (or logging in) here: https://platform.openai.com/settings/organization/api-keys

Start SapienAI

Once you have set the OpenAI key (and any other variables), you can start the service by running the following command in the terminal from the root of the repository:

docker compose up -d

You will then be able to access SapienAI at http://localhost:3000.

Introduction ​

Self Hosting Quick Start ​

Requirements ​

Install ​