gatsby-plugin-clerk

Changelog · Report a Bug · Request a Feature · Ask a Question

Overview

Clerk is the easiest way to add authentication and user management to your Gatsby application. Add sign up, sign in, and profile management to your application in minutes.

Getting Started

Prerequisites

• Gatsby v5+
• Node.js >=18.17.0 or later

Installation

npm install gatsby-plugin-clerk

Usage

Make sure the following environment variables are set in a .env file:

GATSBY_CLERK_PUBLISHABLE_KEY=your_publishable_key
CLERK_SECRET_KEY=your_secret_key

You can get these from the API Keys screen in your Clerk dashboard.

To initialize Clerk with your Gatsby application, simply register the plugin in your gatsby-config.ts/gatsby-config.js file. Also, use dotenv to access environment variables.

// gatsby-config.ts
import type { GatsbyConfig } from 'gatsby';

require('dotenv').config({
  path: `.env.${process.env.NODE_ENV}`,
});

const config: GatsbyConfig = {
  // ...the rest of your config object
  plugins: ['gatsby-plugin-clerk'],
};

export default config;

Client-side

After those changes are made, you can use Clerk components in your pages.

For example, in src/pages/index.tsx:

import { SignedIn, SignedOut, SignInButton, UserButton } from 'gatsby-plugin-clerk';

const IndexPage = () => {
  return (
    <div>
      <h1>Hello Clerk!</h1>
      <SignedIn>
        <UserButton />
      </SignedIn>
      <SignedOut>
        <SignInButton mode='modal' />
      </SignedOut>
    </div>
  );
};

export default IndexPage;

Server-Side Rendering (SSR)

Using withServerAuth from 'gatsby-plugin-clerk/ssr'. Example file /pages/ssr.tsx:

import * as React from 'react';
import { GetServerData } from 'gatsby';
import { withServerAuth } from 'gatsby-plugin-clerk/ssr';

export const getServerData: GetServerData<any> = withServerAuth(
  async props => {
    return { props: { data: '1', auth: props.auth } };
  },
  { loadUser: true },
);

function SSRPage({ serverData }: any) {
  return (
    <main>
      <h1>SSR Page with Clerk</h1>
      <pre>{JSON.stringify(serverData, null, 2)}</pre>
    </main>
  );
}

export default SSRPage;

Server API routes

Importing 'gatsby-plugin-clerk/api' gives access to all the exports coming from @clerk/sdk-node. Example file /api/hello.ts:

import { clerkClient, withAuth } from 'gatsby-plugin-clerk/api';

const handler = withAuth(async (req, res) => {
  const { totalCount } = await clerkClient.users.getUserList();
  res.send({ title: `We have ${totalCount} users`, auth: req.auth });
});

export default handler;

For further details and examples, please refer to our Documentation.

Build

To build the package locally with the TypeScript compiler, run:

npm run build

To build the package in watch mode, run the following:

npm run dev

Support

You can get in touch with us in any of the following ways:

• Join our official community Discord server
• Create a GitHub Discussion
• Contact options listed on our Support page

Contributing

We’re open to all community contributions! If you’d like to contribute in any way, please read our contribution guidelines.

Security

gatsby-plugin-clerk follows good practices of security, but 100% security cannot be assured.

gatsby-plugin-clerk is provided “as is” without any warranty. Use at your own risk.

For more information and to report security issues, please refer to our security documentation.

License

This project is licensed under the MIT license.

See LICENSE for more information.