GitHub

In this guide will show you how to configure WunderGraph to use Github as an authentication provider.

You can get your Github client secret keys from your application configuration page on Github . Always store your secrets in environment variables.

Open your project's wundergraph.config.ts and scroll down to the authentication object. Inside the nested cookieBased object is a nested array object called providers. Inside this array, add an github auth provider as shown below:

// ...
authentication: {
  cookieBased: {
    providers: [
      authProviders.github({
        id: 'github', // unique id for this provider
        clientId: new EnvironmentVariable('GH_CLIENT_ID'),
        clientSecret: new EnvironmentVariable('GH_CLIENT_SECRET'),
      }),
    ];
  }
}
// ...

On production you have to configure cookie keys and crsf token secret to make sure your application is secure, read more.

Once configured you can use the WunderGraph client to authenticate users in your application.

The login function takes the provider id as the first argument and a redirectURL as the second argument. Calling the login function will initiate the authentication flow and redirect the user to the identity provider, after succesful authentication the user will be redirected back to the provided redirectURL or the default redirectURL configured at the provider.

TypeScript Client

import { createClient } from '.wundergraph/generated/client';

const client = createClient();

client.login('github');

Next.js Example

import { useAuth } from 'components/generated/nextjs';

export default function Page() {
  const { login } = useAuth();

  return <button onClick={() => login('github')}>Login with Keycloak</button>;
}

The logout method can be used to log out the current user. By default this will only remove the authentication cookie from the browser. If you want to log out the user from the identity provider as well, you can pass the logoutOpenidConnectProvider option.

TypeScript Client

client.logout({
  logoutOpenidConnectProvider: true,
});

Next.js Example

import { useAuth } from 'components/generated/nextjs';

export default function Page() {
  const { logout } = useAuth();

  return <button onClick={() => logout({ logoutOpenidConnectProvider: true })}>Logout</button>;
}

You can customize the authentication flow by using hooks. For example to create a new user in your database after a successful authentication.

export default configureWunderGraphServer(() => ({
  hooks: {
    authentication: {
      postAuthentication: async ({ user, log }) => {
        log.info(`User ${user.id} has been authenticated`);
      },
    },
  },
}));

• Creating a Github OAuth App
• Configuration reference
• TypeScript client reference
• postAuthentication hook reference
• mutatingPostAuthentication hook reference