Setting Up Sign-In via GitHub OAuth

If you use LockMyCal in a technical or developer team, you can let users sign in conveniently and securely with their existing GitHub account.

1. Creating a GitHub OAuth App

1. Sign in at github.com.
2. In the top right corner, click your avatar and open Settings.
3. In the left menu, scroll all the way down and click Developer settings.
4. Choose OAuth Apps -> New OAuth App.
5. Fill in the form:
   • Application name: LockMyCal
   • Homepage URL: https://bookings.yourdomain.com
   • Authorization callback URL:

     https://bookings.yourdomain.com/auth/github/callback

6. Click Register application.

2. Generating the Client Secret

1. On the application page you'll see the Client ID.
2. Click the Generate a new client secret button.
3. Confirm your password and copy the displayed code.

3. Setting it up in LockMyCal

Save the sign-in keys to the .env configuration file:

ENABLE_GITHUB_AUTH=true
GITHUB_CLIENT_ID=Iv1.xxxxxxxxxxxxxxxx
GITHUB_CLIENT_SECRET=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

After restarting the instance, a Sign in with GitHub button appears on the LockMyCal sign-in screen. Sign-in methods can also be turned on in Administration → Application settings → Authentication.