Skip to content
gau

Getting Started

This guide will walk you through installing @rttnd/gau and setting it up for the first time.


  1. Install the package
    Section titled “Install the package”
    Terminal window
    npm i @rttnd/gau
  2. Set up environment variables
    Section titled “Set up environment variables”

    gau uses AUTH_SECRET for signing JWTs. You can generate a secure secret using the CLI:

    Terminal window
    npx gau secret

    Then, add the output and your provider credentials to your .env file:

    .env
    AUTH_SECRET="your-generated-secret"
    GITHUB_CLIENT_ID="your-github-client-id"
    GITHUB_CLIENT_SECRET="your-github-client-secret"
  3. Choose your database adapter
    Section titled “Choose your database adapter”

    gau uses a database adapter to connect to your database.

    Drizzle
  4. Choose your integration
    Section titled “Choose your integration”
    SvelteKit
    SolidStart
    Tauri
  5. Add OAuth Providers
    Section titled “Add OAuth Providers”
    GitHub
    Google
    Microsoft