Skip to main content

Docker Deployment

This document describes how to deploy OpenHuman using Docker.

Prerequisites​

  • Docker 18.06+
  • Docker Compose (optional)

Build Image​

docker build -t openhuman:latest .

Run Container​

docker run -d \
  --name openhuman \
  -p 3000:3000 \
  -v $(pwd)/data:/app/data \
  -e OPENHUMAN_API_KEY=sk_xxx \
  openhuman:latest

Using Docker Compose​

version: '3.8'

services:
  openhuman:
    image: openhuman:latest
    container_name: openhuman
    ports:
      - "3000:3000"
    volumes:
      - ./data:/app/data
      - ./memory_tree:/app/memory_tree
    environment:
      - OPENHUMAN_API_KEY=${OPENHUMAN_API_KEY}
      - OPENHUMAN_BASE_URL=https://api.tinyhumans.ai
    restart: unless-stopped

Start:

docker-compose up -d

Data Persistence​

PathDescription
/app/dataApplication data
/app/memory_treeSQLite database
/app/wikiObsidian Markdown

Environment Variables​

OPENHUMAN_API_KEY=sk_xxx
OPENHUMAN_BASE_URL=https://api.tinyhumans.ai
LOG_LEVEL=info

Health Check​

docker inspect --format='{{.State.Health.Status}}' openhuman

Common Issues​

Port Conflict​

# Change mapped port
docker run -d -p 3001:3000 openhuman:latest

Permission Issues​

# May need to specify user on Linux
docker run -d \
  --user $(id -u):$(id -g) \
  -v $(pwd)/data:/app/data \
  openhuman:latest

Next Steps​