Settings

Settings

The Console provides a comprehensive settings area for configuring your Keel project, environments, and team access. You can access settings from the sidebar navigation in any project.

Project Settings

Project settings apply globally across all environments in your project.

Project Name

You can update your project name at any time. Keel continues to support previous project names for default domain URLs, so existing integrations won't break.

Project Description

Add an internal description to help team members understand the project's purpose. This is only visible within the Console.

Inactivity Timeout

Configure automatic logout for users after a period of inactivity. Set the timeout value in minutes, or leave empty to disable automatic logout.

Inactivity timeout applies to users accessing Tools and Flows in your project, not to API consumers.

Environments

Keel supports multiple environments to separate your staging and production deployments. Each environment has its own database, secrets, and configuration.

Creating an Environment

To create a new environment:

  1. Navigate to Settings > Environments
  2. Click Create staging environment or Create production environment
  3. Configure the environment settings:
SettingDescription
NameA descriptive name for the environment
RegionThe geographic region where your environment runs
Git branchThe branch to deploy changes from
Deployment strategyChoose between auto deploy or manual approval

Deployment Strategies

StrategyBehaviour
Auto deployChanges are deployed automatically when pushed to the configured branch
Manual approvalBuilds require manual approval in the Console before deployment

Region Selection

Choose a region close to your users for optimal performance. Available regions include:

  • London (UK)
  • Frankfurt (Germany)
  • Singapore
  • North Virginia (US)
  • Oregon (US)
⚠️

The region cannot be changed after environment creation. Choose carefully based on your data residency requirements.

Advanced Settings

For advanced use cases, you can configure the database region separately from the compute region. However, placing your database in a different region will impact performance due to network latency.

Editing an Environment

Click the ⋮ menu on any environment row to:

  • Edit environment - Update name, branch, or deployment strategy
  • Delete - Permanently remove the environment and all its data

Deleting an Environment

🚫

Deleting an environment permanently removes all associated data including your database. This action cannot be undone.

To delete an environment:

  1. Click the ⋮ menu on the environment row
  2. Select Delete
  3. Type the environment name to confirm
  4. Click Yes, I want to delete '[name]' forever

Your repository and other environments remain intact.

Secrets

Secrets store sensitive configuration values like API keys, passwords, and credentials. Each environment has its own set of secrets.

For non-sensitive configuration, use environment variables instead.

Managing Secrets

Navigate to Secrets within your environment to view and manage secrets.

To add a secret:

  1. Click Add secret
  2. Enter a key name (must be UPPER_SNAKE_CASE)
  3. Enter the secret value
  4. Click Save

Secret Naming Rules

  • Keys must be in UPPER_SNAKE_CASE format
  • Keys cannot start with KEEL_
  • Keys must be unique within an environment

Updating Secrets

You can update secret values at any time. The new value takes effect on the next deployment or when the environment restarts.

Secrets that are actively used in your project cannot be deleted or have their keys renamed. The Console shows which secrets are in use.

For more details on defining and using secrets in your code, see the Secrets documentation.

Team Management

Invite team members to collaborate on your project. Team members can access the Console, Tools, and Flows based on their assigned roles.

Adding Team Members

  1. Navigate to Settings > Team
  2. Click Add team member
  3. Enter email addresses (separate multiple emails with commas)
  4. Assign roles
  5. Click Confirm

Invited members receive an email with instructions to join. Pending invitations appear in the team list with an "Invited" badge.

Member Types

TypeDescription
Project membersFull access to the project in the Console
Space-only membersAccess limited to specific Spaces within an environment

Managing Members

Click the ⋮ menu on any member row to:

  • Edit roles - Update role assignments
  • Remove member - Revoke project access

Cancelling Invitations

For pending invitations, you can cancel the invite before the recipient accepts it. Click the ⋮ menu and select Cancel invite.

Authentication Settings

Configure authentication settings for each environment, including signing keys for token validation.

Signing Keys

Keel generates a public/private key pair for each environment to sign authentication tokens.

KeyUsage
Public KeyShare freely; used to validate Keel-issued tokens
Private KeyKeep secret; configure in third-party authentication providers
⚠️

The private key is highly sensitive. Only share it with trusted authentication providers.

The private key is hidden by default. Click Reveal to view it.

Signing keys appear after the first successful build is deployed to an environment.

Danger Zone

The danger zone contains irreversible actions that can permanently affect your project.

Deleting a Project

🚫

Deleting a project permanently removes all environments, databases, and associated data. This action cannot be undone.

To delete a project:

  1. Navigate to Settings > Project settings
  2. In the "Stormy waters" section, click Delete project
  3. Type the project name to confirm
  4. Click Yes, I want to delete '[name]' forever

Your Git repository remains intact after deletion.

BuildsSchema Reference