Skip to main content

Getting Started

Prerequisites

Setup

./existential.sh

This will:

  1. Find all .example files and create non-example counterparts (directories first, then files)
  2. Prompt for any EXIST_CLI placeholder values interactively
  3. Auto-generate passwords, keys, and UUIDs for other placeholders
  4. Generate a unified docker-compose.yml from all enabled services
  5. Generate a master .env by merging .env.exist with all enabled service .env files

Enable/Disable Services

Edit .env.exist and set services to true or false:

EXIST_ENABLE_AI_OLLAMA=true
EXIST_ENABLE_SERVICES_DECREE=true
EXIST_ENABLE_SERVICES_NOCODB=false

Then regenerate the compose file (already done during initial setup above):

./existential.sh compose

Deploy

docker compose up -d

Integrations

Some services require additional OAuth or configuration steps:

./existential.sh setup gmail # Gmail OAuth
./existential.sh setup rclone # Remote file storage

See Integrations for setup details, or Scripts for the full CLI reference.