> ## Documentation Index
> Fetch the complete documentation index at: https://gigi-f9937525.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Setup

> Local setup for the Go foundation runtime.

# Setup

## Requirements

* Go 1.26.3
* Docker with Compose plugin

## Configure

```bash theme={null}
cp .env.example .env
```

The default runtime requires `GIGI_DATABASE_URL` and can use `GIGI_MIGRATIONS_DIR` when migrations are not under `db/migrations`.

Set `GIGI_DISCORD_ENABLED=true` only when `DISCORD_TOKEN` and `DISCORD_CLIENT_ID` are configured. Discord starts with `/ping`, DM/mention liveness routing, `/permissions`, `/llm`, `/plugins`, deterministic external app matching, policy-gated semantic routing, guild mention chat fallback, guild memory count/search scaffolding, cited context-pack metadata, durable agent run records, aggregate agent stats, opt-in reply latency footers, gateway memory-delete tombstones, and consented opt-in public `send_message` prefix dispatch. Guild mention LLM behavior needs a configured guild provider credential, model profile, and `/llm routing` mode when using tool routing. Rich DM chat and restricted external app dispatch are not live.

Set `GIGI_DISCORD_SYNC_COMMANDS=true` only when you want Gigi to bulk-overwrite its current slash command set. Use `GIGI_DISCORD_GUILD_ID` for a test server during development; leaving it blank targets global application commands.

Use [Configure Discord](/configure-discord) for the Discord application, bot role, command sync, and smoke-test sequence.

LLM provider add/rotate commands require `GIGI_LLM_SECRET_KEY_BASE64`; when blank, `/llm provider add` and `rotate` stay disabled while list/delete/model commands remain available. The key must be standard base64 for exactly 32 bytes. `GIGI_LLM_SECRET_KEY_ID` defaults to `local-v1`.

```bash theme={null}
openssl rand -base64 32
```

Provider API keys are entered through `/llm provider add` or `/llm provider rotate` private modals and sealed as guild credentials. Do not set provider keys in `OPENAI_API_KEY`; that environment variable is reserved and unused for provider calls.

Agent `web.search` uses DuckDuckGo HTML by default. Set `BRAVE_SEARCH_API_KEY` to use Brave Search API for `web.search`; Gigi automatically selects Brave when this key is present unless `GIGI_WEB_SEARCH_PROVIDER=duckduckgo` is set. Set `SEARXNG_BASE_URL` to use a SearXNG instance; Gigi automatically selects SearXNG when this value is present and no Brave key is set. SearXNG instances must have JSON output enabled for `format=json`; many public instances disable it and return `403`. Use `GIGI_WEB_SEARCH_FALLBACK=duckduckgo` to back up Brave or SearXNG with DuckDuckGo, or `GIGI_WEB_SEARCH_FALLBACK=searxng` to back up DuckDuckGo or Brave with SearXNG. SearXNG fallback requires `SEARXNG_BASE_URL`; Brave cannot be configured as a fallback.

Local Docker Compose includes a private SearXNG service with JSON output enabled. Inside Docker, Gigi reaches it through `SEARXNG_BASE_URL=http://searxng:8080`; from the host, open `http://127.0.0.1:8081`. The local Compose defaults select SearXNG with DuckDuckGo fallback.

After adding a guild credential, select model profiles for live guild mention behavior:

```text theme={null}
/llm model set purpose:chat label:<label> model:<model-id>
/llm model set purpose:routing label:<label> model:<model-id>
```

Use [Configure LLM Providers](/configure-llm-providers) for the full Discord command flow.

## Run Checks

```bash theme={null}
go test ./...
go vet ./...
go build ./cmd/gigi
```

## Run With Docker Compose

```bash theme={null}
docker compose -f compose.yaml up --build
```

Then verify:

```bash theme={null}
curl http://127.0.0.1:8080/healthz
curl http://127.0.0.1:8080/readyz
curl "http://127.0.0.1:8081/search?q=lebron+james&format=json"
```

## Database

Local PostgreSQL starts through Docker Compose. The initial schema lives under `db/migrations/` and is mounted into the Postgres container for fresh database creation. The app also runs the same idempotent migration files on startup, which lets an existing Docker volume catch up after schema-only foundation changes.

The database is exposed on `127.0.0.1:55432` by default to avoid collisions with a local Postgres on `5432`. Override with `GIGI_DB_PORT` if needed.

Supabase is not used by the foundation runtime.