Configuration

Config values, environment variables, profiles, and secrets management.

Synapse stores configuration in your Synapse home directory ($SYNAPSE_HOME, usually ~/.synapse). Manage values interactively or via the CLI. Everything is plain files — inspectable and scriptable.

Config via CLI

bash

synapse config set <key> <value>   # set individual config values
synapse config get <key>           # print individual config values
synapse config                     # open the config editor

A commented example lives at cli-config.yaml.example in the repository root — copy it as a reference for every available key.

Profiles

Tool and integration settings are grouped per profile, so you can keep a personal setup and a work setup side by side without them bleeding into each other. synapse tools always shows the state of the current profile.

Environment variables

OPENROUTER_API_KEY — key for the OpenRouter provider profile
OPENAI_API_KEY — key for the OpenAI provider profile
SYNAPSE_HOME — overrides the Synapse home directory (Railway mounts /opt/data)
SYNAPSE_DASHBOARD=1 — enables the web dashboard on Railway deployments
Every bundled provider profile declares its own env var, discovered automatically by the setup wizard

Bring your own keys per tool whenever you want — the gateway is per-backend, not all-or-nothing.

Secrets

API keys are allowlisted secrets managed by the CLI. For team setups, integrations with Bitwarden and 1Password secret managers are documented in the repository docs. Never paste API keys into logs or screenshots.

Checking your setup

synapse doctor validates config keys, environment, and provider reachability in one shot. Run it after any config change you are unsure about.