Authentication
GitHub

GitHub

  1. Ensure that authentication is enabled by setting the following environment variable: ADMYRAL_DISABLE_AUTH=false
  2. Go to GitHub Developer Settings
  3. Click on OAuth Apps
  4. Click on New OAuth App

GitHub OAuth

  1. Configure your OAuth app

  2. Set the following Authorization callback URL:

    • For production: https://{YOUR_DOMAIN}/api/auth/callback/github
    • For development (local): http://localhost:3000/api/auth/callback/github
  3. Click on Register application

  4. Copy the Client ID and generate a new Client Secret

  5. Copy the in your environment file:

    # .env
    ADMYRAL_DISABLE_AUTH=false
     
    AUTH_GTIHUB_ID=your_github_client_id
    AUTH_GITHUB_SECRET=your_github_client_secret