Skip to content

Admin setup

This guide covers standing up ArcaMira and configuring a tenant. For deeper deployment and database detail, see the technical README files included with your distribution.

Deployment targets

The same codebase serves two targets, controlled by environment variables:

Target How Tenancy
SaaS Vercel (UI) + Render (API) + Supabase (DB) Multi-tenant — tenant derived from subdomain
Demo / self-hosted docker compose up Single-tenant — SINGLE_TENANT_MODE=true

Fastest start (Docker)

docker compose up        # UI at http://localhost:5173, API at http://localhost:3001
                         # login: admin@demo.local / password
docker compose down -v   # reset all data

The API auto-runs pending database migrations on startup — nothing to run manually for fresh installs or upgrades.

First-run checklist

  1. Create users — Admin → Users (/admin/users). Assign roles:
Role Can…
viewer Read-only; sees stakeholder summaries only
editor Create/edit entities, relationships, comments, views
admin All of the above, plus users, settings, integrations, approvals
  1. Configure the tenant — Admin → Settings (/admin/settings):
  2. Display name, integrations, OIDC single sign-on, AI features.

  3. Other tenant-level preferences.

  4. Set the approval workflow — Admin → Approval Workflow (/admin/approval-settings): which roles can approve in the review workflow.

  5. Set the check-in cadence — Admin → Check-in Cadence (/admin/check-in-cadence): how often entities should be re-confirmed.

  6. Get data in — see Importing data.

Integrations

Admin → Integrations (/admin/integrations):

  • Asset discovery — connect AWS, Azure, ServiceNow, or Microsoft Entra ID (multi-signal SaaS discovery). A passive domain scan (from public DNS, no credentials) is also available. Discovered assets land in the Discovery Queue for triage, never auto-created. See Discovery & connecting.
  • AI providers (BYOK) — configure Anthropic, OpenAI, or Azure OpenAI with your own key, with per-tenant quota metering. Enables Ask Your Architecture, capability discovery, import auto-suggestions, and risk narratives. Without it, AI features are simply hidden.
  • Webhooks — Admin → Webhooks (/admin/webhooks) for outbound integration events. Each webhook can be formatted as generic (HMAC-signed JSON envelope), Slack (Block Kit), or Teams (MessageCard) — pick the format and paste the channel's Incoming Webhook URL to post architecture events (e.g. an ARB decision, or an asset moving toward sunset) straight into a channel.

Metamodel & relationships

  • Admin → Metamodel (/admin/metamodel) — entity types and their property schemas.
  • Admin → Relationship Types (/admin/relationship-types) — the relationship vocabulary.

Sensible defaults are pre-loaded; customise only when you have a concrete need.

Email & notifications

ArcaMira can send a weekly digest of overdue check-ins (transport via Brevo). Users can opt out in their account preferences; admins have test/run controls.

Product tiers

Feature gating by tier (Starter / Professional / Enterprise, cumulative) is live and function-gated: higher tiers unlock capabilities such as Entra ID SaaS discovery and enterprise EOL feeds, while core cataloguing is never gated. Manage the tenant's plan under Admin → Settings.