Running VectorAdmin in Docker

Running VectorAdmin in Docker is the easily way to get a locally hosted option running as quickly as possible.

Requirements

Install Docker on your computer or machine.

How to install

git clone this repo and cd vector-admin to get to the root directory.
yarn dev:setup
cd docker/
cp .env.example .env to create the .env file.
Edit .env file and update the variables. please update JWT_SECRET,SYS_PASSWORD, and INNGEST_SIGNING_KEY

Note You must have a postgres DB running - the default ENV assumes a containerized PG instance running, but it can be located anywhere (RDS, remote, local host machine). Failure to use a valid DB connection string prior to building vector-admin will result in a build failure.

DATABASE_CONNECTION_STRING should be a valid connection string. On boot the vdbms database will be created for the connection string.

If running the included containerized Postgres DB Run this command first: docker-compose up -d --build postgres

Boot up vector-admin

docker-compose up -d --build vector-admin to build the image - this will take a few moments.

Your docker host will show the image as online once the build process is completed. This will build the app to http://localhost:3001.

How to use the user interface

To access the full application, visit http://localhost:3001 in your browser.
You first login will require you to use the SYS_EMAIL and SYS_PASSWORD set in the .env file. After onboarding this login will be permanently disabled.

Connecting to a Vector Database

Pinecone Once your organization is connected you will need to put in your Pinecone configuration and keys. Once connected you may see a Sync Pinecone Data button on the organization homepage. This indicates there is existing data in your vector database that can be pulled in. If syncing, the time to sync is dependent on how many documents you have embedded in Pinecone. Otherwise, you can just create a workspace and add documents via the UI.

Chroma running locally When trying to connect to a Chroma instance running also on the same machine use http://host.docker.internal:[CHROMA_PORT] as the URL to connect with.

Once connected you may see a Sync Chroma Data button on the organization homepage. This indicates there is existing data in your vector database that can be pulled in. If syncing, the time to sync is dependent on how many documents you have embedded in Chroma. Otherwise, you can just create a workspace and add documents via the UI.

Common questions and fixes

You are likely running the docker container on a remote machine like EC2 or some other instance where the reachable URL is not http://localhost:3001 and instead is something like http://193.xx.xx.xx:3001 - in this case all you need to do is add the following to your frontend/.env.production before running docker-compose up -d --build

# frontend/.env.production
GENERATE_SOURCEMAP=false
VITE_APP_NAME="Vector Admin"
VITE_API_BASE="http://<YOUR_REACHABLE_IP_ADDRESS>:3001/api"

For example, if the docker instance is available on 192.186.1.222 your VITE_API_BASE would look like VITE_API_BASE="http://192.186.1.222:3001/api" in frontend/.env.production.

Still not working?

Ask for help on Discord

3.4 KiB Raw Blame History