Skip to content

Quickstart

  1. Download the binary

    # Linux (amd64)
    curl -L -o coldrune https://github.com/user/coldrune/releases/latest/download/coldrune-linux-amd64
    chmod +x coldrune
    sudo mv coldrune /usr/local/bin/
  2. Generate a master key

    openssl rand -hex 32

    Save the output. This 64-character hex string encrypts all your secrets.

  3. Configure the server

    Create a .env file:

    COLDRUNE_MASTER_KEY=<your-64-char-hex-key>
    SUPERADMIN_EMAIL_0=you@example.com
    SMTP_HOST=log

    Setting SMTP_HOST=log prints login codes to the terminal instead of sending email. Good for getting started.

  4. Start the server

    coldrune server start

    The server runs at http://localhost:7100 by default.

  5. Log in and store a secret

    In a new terminal:

    # Request a login code
    coldrune auth login --email you@example.com
    # Enter the 6-digit code from the server logs
    coldrune auth verify --code 123456
    
    # Create an org and project
    coldrune org create --name my-org
    coldrune project create --org my-org --name my-app
    
    # Store a secret
    coldrune secret set DB_PASSWORD=s3cret --org my-org --project my-app --env dev
    
    # Retrieve it
    coldrune secret get DB_PASSWORD --org my-org --project my-app --env dev