GitHub

Create a GitHub Application

• Go to your Github Developer settings
• Create a new GitHub app

GitHub Application Configuration

• Give it a GitHub App name and set your Homepage URL
  • Example for localhost: http://localhost:3080
  • Example for a domain: https://example.com

• Add a valid Callback URL:
  • Example for localhost: http://localhost:3080/oauth/github/callback
  • Example for a domain: https://example.com/oauth/github/callback

• Uncheck the box labeled Active in the Webhook section

• Scroll down to Account permissions and set Email addresses to Access: Read-only

• Click on Create GitHub App

.env Configuration

• Click Generate a new client secret

• Copy the Client ID and Client Secret in the .env file

DOMAIN_CLIENT=https://your-domain.com # use http://localhost:3080 if not using a custom domain
DOMAIN_SERVER=https://your-domain.com # use http://localhost:3080 if not using a custom domain
 
GITHUB_CLIENT_ID=your_client_id
GITHUB_CLIENT_SECRET=your_client_secret
GITHUB_CALLBACK_URL=/oauth/github/callback
 
# GitHub Enterprise (optional)
# Uncomment and configure the following if you are using GitHub Enterprise for authentication
# GITHUB_ENTERPRISE_BASE_URL=https://your-ghe-instance.com
# GITHUB_ENTERPRISE_USER_AGENT=YourEnterpriseAppName

• Save the .env file

Note: If using Docker, run docker compose up -d to apply the .env configuration changes