Skip to content

installation.mdx

Latest commit

 

History

History
133 lines (88 loc) · 2.74 KB

installation.mdx

File metadata and controls

133 lines (88 loc) · 2.74 KB
Raw
title Installation
description Install Studio with the public CE runtime paths or use the published images in your own deployment

Choose Your Path

ShipSec Studio has three public setup paths:

1. Source Development With Docker-Backed Infra

Best for:

  • contributors
  • source-level debugging
  • local product development
git clone https://github.com/ShipSecAI/studio.git
cd studio
just init
just infra up
just dev

This keeps the backing services in Docker and runs frontend, backend, and worker from source with PM2.

2. Full CE Docker Stack

Best for:

  • validating the public CE deployment path
  • running the product on one machine without a source workflow
  • smoke testing the published repo end to end
git clone https://github.com/ShipSecAI/studio.git
cd studio
just ce up

This brings up infra plus frontend, backend, and worker in Docker.

3. Use The Published Images In Your Own Deployment

Best for:

  • self-hosting
  • running Studio on your own infrastructure
  • building your own runtime model around the published images

The public repo publishes the Studio application images. Pair them with the required backing services described in Self-Hosting.

Source Development

Requirements:

  • Bun
  • just
  • Docker
  • Docker Compose

Start:

just init
just infra up

This installs dependencies and creates:

  • backend/.env
  • worker/.env
  • frontend/.env

Start:

just dev

The public repo now ships a minimal CE runtime stack for local source development:

  • docker/docker-compose.infra.yml for shared services
  • docker/docker-compose.apps.yml for the full Docker app overlay

See Development / Multi-Instance Dev for contributor-oriented local instance details.

Full CE Docker Stack

just ce up

This uses:

  • docker/docker-compose.infra.yml
  • docker/docker-compose.apps.yml

The default frontend URL is http://localhost:5173 and the default backend URL is http://localhost:3211.

Environment Basics

Required Everywhere

  • SECRET_STORE_MASTER_KEY

Optional but Common

  • CHAT_AI_MODEL_ID
  • CHAT_AI_BASE_URL
  • CHAT_AI_API_KEY

Integration Configuration

Configure only what you actually plan to use:

  • GitHub
  • AWS
  • GCP
  • Slack
  • Jira

The open-source model is direct configuration, not hosted indirection.

Migration Behavior

just dev applies the committed repo migrations before starting the app services. If your environment layers in extra migration directories, those are picked up by configuration rather than being hardcoded into the public repo.

In the source-development path, just dev also creates the active instance database automatically when the local CE Postgres container is running.