Configuration

Updated

Crate has very little to configure. Most of what you manage is data, not settings: the repositories you serve (see Serving packages), the people who can sign in, and the credentials you issue.

Laravel Cloud also injects the database, cache, queue and storage settings for the resources Scalpels attached. Do not set any DB_*, QUEUE_*, CACHE_* or FILESYSTEM_DISK values yourself; a value you set overrides the one Cloud injects and breaks that resource.

Crate has no separate setting for its own public address. Laravel Cloud supplies APP_URL, and Crate follows it when you add a custom domain and redeploy. Do not add APP_URL or CRATE_URL yourself. See Use your own domain.

Optional values

The install screen lists these as optional. Their defaults are correct on Laravel Cloud, so leave them unset.

Key	Default	What it does
`CRATE_ARCHIVE_DISK`	`FILESYSTEM_DISK`	The Laravel disk that holds generated metadata and archives. On Cloud this is the attached bucket.
`CRATE_OUTPUT_DIR`	`satis`	The prefix on that disk the registry output is written under.
`CRATE_SATIS_PATH`	`satis-tool/bin/satis` in the app	The Satis executable a build runs. The build step installs it there. It must be an absolute path to the executable, not its directory.

Changing CRATE_ARCHIVE_DISK or CRATE_OUTPUT_DIR points Crate at an empty location; run a full build afterwards.

Crate also reads CRATE_DB_HOST, CRATE_DB_PORT, CRATE_DB_DATABASE, CRATE_DB_USERNAME and CRATE_DB_PASSWORD for an optional separate Postgres database. A Scalpels install does not use them: Crate's tables live in the attached database. Leave them unset.

Settings inside Crate

After signing in, Settings holds what an Owner or Admin manages day to day:

Members: Owners and Admins invite people by email. Only the Owner can invite or promote an Admin; an Admin can invite Members and deactivate them. Deactivating someone also stops their personal credentials working.
Sessions: see your signed-in sessions and sign out of the others.
Personal credentials and Installation credentials: see Credentials.

Roles matter in two places. Owners and Admins can add and remove served repositories over HTTP; Members can list repositories and builds and replace or clear source tokens. Artisan commands run in the environment are not tied to a role.

Schedule

Crate's scheduler runs two jobs: a full registry build once a day, and a check every minute that re-queues builds an agent requested if their job was lost. Neither is configurable without changing the code in your fork.