Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Configuration

Config File

Crabdrop stores its configuration at:

~/.config/crabdrop/config.toml

This file contains only storage settings (no secrets):

[storage]
endpoint = "https://s3.amazonaws.com"
bucket = "my-bucket"
region = "us-east-1"

Credential Storage

All sensitive credentials are stored in your OS keychain — never in plaintext files:

PlatformBackend
macOSKeychain Access
WindowsCredential Manager
LinuxSecret Service (GNOME Keyring, KDE Wallet)

The keyring entry uses:

  • Service: crabdrop
  • Account: default

Stored as JSON containing access_key_id, secret_access_key, and encryption_passphrase.

Migration from Plaintext

If Crabdrop detects credentials in the TOML config file (from older versions), it automatically migrates them to the keychain and removes them from the file. This happens transparently on startup.

Editing Configuration

You can update your configuration through the Settings screen in the app. Click the gear icon to open settings, modify your values, test the connection, and save.

Required Fields

FieldRequiredNotes
Endpoint URLYesYour S3 endpoint. See Supported Services
Bucket NameYesMust exist before connecting
RegionYese.g. us-east-1, auto for some providers
Access Key IDYesFrom your provider’s console
Secret Access KeyYesFrom your provider’s console
Encryption PassphraseYesUsed for client-side file encryption