Skip to content

Buildables

Optional Arcane features compiled in with a Go build tag.

Buildables are optional features compiled in only when you build with the Go buildables build tag. They’re for testing, CI, or demos. Official images don’t include them.

You need a clone of the Arcane repository, Go, just, and Vite+ for the frontend build. See Contributing to Arcane.

Run these from the repository root.

  1. Build the frontend. It’s written to backend/frontend/dist and embedded in the binary:

    Terminal window
    just build single frontend
  2. Build the backend with the buildables tag and the features you want in EnabledFeatures:

    Terminal window
    cd backend
    CGO_ENABLED=0 go build \
    -tags buildables \
    -ldflags "-X getarcane.dev/arcane/v3/buildables.EnabledFeatures=autologin" \
    -trimpath \
    -o arcane \
    ./cmd/main.go

    To build for a Linux container from another OS or architecture, add GOOS=linux GOARCH=amd64 (or arm64) before go build.

  1. Build a Linux binary as above.

  2. Create backend/Dockerfile.buildables that copies it over the binary in the official image:

    FROM ghcr.io/getarcaneapp/manager:latest
    COPY arcane /app/arcane
  3. Build the image:

    Terminal window
    docker build -f backend/Dockerfile.buildables -t arcane:buildables backend

For an agent image, use ghcr.io/getarcaneapp/agent:latest as the base and copy the binary to /app/arcane-agent instead.

EnabledFeatures is a comma-separated list, for example autologin or feature-a,feature-b. Names are case-insensitive and surrounding spaces are ignored.

Some buildables read extra environment variables at runtime. These only exist in buildables builds.

Current buildables1 available
FeatureDescriptionSourceDocsConfig
autologinAutomatically sign in using build-time enabled credentials.OfficialFull docs
AUTO_LOGIN_USERNAMEAUTO_LOGIN_PASSWORD
  1. Put feature-only code in files guarded with //go:build buildables where appropriate.
  2. Check buildables.HasBuildFeature("your-feature") before running the feature. Without the buildables tag, a stub makes this always return false.
  3. Add any buildable-only settings to BuildablesConfig in backend/internal/config/buildables_config.go.
  4. Build tests for the feature with the buildables tag. just test backend already runs with -tags=exclude_frontend,buildables and EnabledFeatures=autologin.