Setup Guide | Dataspheres AI Docs - Dataspheres AI

Setup Guide Get Dataspheres AI running locally in under 10 minutes. All you need is Docker Desktop and Git — no paid API keys required to boot the core pla...

Setup Guide Get Dataspheres AI running locally in under 10 minutes. All you need is Docker Desktop and Git — no paid API keys required to boot the core platform. Prerequisites Docker Desktop 24+ (includes Docker Compose v2) Git 4 GB RAM minimum allocated to Docker 1. Clone the Repository git clone https://github.com/geekdreamzz/dataspheres-ai.git cd dataspheres-ai 2. Configure Environment Copy the example env file and set the two required credentials for a first-run admin account: cp .env.example .env.oss Open .env.oss and set at minimum: [email protected] SUPER_ADMIN_PASSWORD=YourSecurePassword123! Everything else is optional — vendor features (AI, email, billing) degrade gracefully when keys are absent and can be enabled later by adding the relevant key to .env.oss . 3. Start the Stack docker compose -f docker-compose.oss.yml up -d This starts: postgres — PostgreSQL 15 with pgvector, port 5432 app — Express API (port 3000) + Vite dev server (port 5173) Wait for the health check to pass (usually 20–40 s): docker compose -f docker-compose.oss.yml ps 4. Run Migrations and Seed docker compose -f docker-compose.oss.yml exec app npx prisma migrate deploy docker compose -f docker-compose.oss.yml exec app npx ts-node prisma/seed.ts The seed creates your admin account using SUPER_ADMIN_EMAIL and SUPER_ADMIN_PASSWORD , provisions the default datasphere, and seeds the in-product documentation (this page and its siblings). 5. Verify the Install node scripts/oss-quickstart-check.mjs Expected output: ✓ docker-compose.oss.yml exists ✓ prisma/seed.ts: env-driven admin seed present ✓ GET /api/health -> 200 ✓ POST /api/auth/login -> 200 ✓ POST pages -> 201 ✓ POST tasks -> 201 ✓ GET graphs -> 200 PASS: 7 passed — health, login, page, task, graph all verified. 6. Open the App UI: http://localhost:5173 API: http://localhost:3000 Health: curl http://localhost:3000/api/health Log in with the email and password you set in .env.oss . Enabling Vendor Features Add any of the following to .env.oss and restart the app container. Features activate automatically — no code changes needed. Feature Key to add AI completions & vision OPENAI_API_KEY Text-to-speech ELEVENLABS_API_KEY Email delivery SENDGRID_API_KEY Billing STRIPE_SECRET_KEY SMS notifications TWILIO_ACCOUNT_SID Image/video generation VERTEX_PROJECT_ID See the Environment Variable Reference and Feature Key Matrix pages for the full list. Stopping and Resetting # Stop (preserves data) docker compose -f docker-compose.oss.yml down # Full reset (deletes all data) docker compose -f docker-compose.oss.yml down -v