Skip to content

Commit

Permalink
add images and update copy
Browse files Browse the repository at this point in the history
  • Loading branch information
mwickett committed Dec 13, 2024
1 parent cb0ad09 commit 0c37dfb
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions docs/keyless.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,33 +7,35 @@ description: Learn about Clerk's Keyless Mode.

## How does it work?

If Clerk's SDK doesn't detect valid [Clerk keys](TODO) in your environment, it will automatically fetch a set of keys for you. These keys are associated with a Clerk development instance that has a default configuration. When running locally in Keyless Mode, you'll see a banner indicating that you're running in this special mode with a link to claim your instance by signing up for a Clerk account, or signing in if you already have one.
If Clerk's SDK doesn't detect valid [Clerk keys](TODO) in your environment, it will automatically fetch a set of keys for you. These keys are associated with a Clerk development instance that has a default configuration. When running locally in Keyless Mode, you'll see a UI toast indicating that you're running in this special mode with a link to claim your instance by signing up for a Clerk account, or signing in if you already have one.

Keys are written to a file in a `.clerk` directory in your project. Ensure that this directory is added your `.gitignore` file to prevent keys from being committed to your repository.
Keys are written to a file in a `.clerk` directory in your project. The Clerk SDK will try to add this directory to your `.gitignore` file to prevent keys from being committed to your repository.

### Default configuration

Clerk development instances have the following default configuration:

- **Authentication**: Email and password, Sign-in with Google
- **Authentication**: Email and password, Sign-in with Google, Sign-in with GitHub
- **Verification**: Email verification is required
- **Password reset**: Password reset is enabled
- **MFA**: MFA is disabled
- **Appearance**: Default appearance

When using Clerk in Keyless Mode, you're not able to make configuration changes to your instance. To make changes, [claim your instance](#claiming-keyless-keys).
When using Clerk in Keyless Mode, you're not able to make configuration changes to your instance. To make changes, [claim your instance](#claiming-keys).

## Keyless Mode support

Keyless mode works with Clerk's SDKs for [Next.js](/docs/quickstarts/nextjs), [Remix](/docs/quickstarts/remix), and [Tanstack Start](/docs/quickstarts/tanstack-start). If you're using a different framework or SDk, you'll need to manually configure Clerk keys in your environment. Visit the [Clerk Dashboard](https://dashboard.clerk.com/sign-up) to create an account, create an instance and get your keys.

Keyless Mode _may_ work in other environments or SDKs, but it's not officially supported.
Keyless mode works with Clerk's SDKs for [Next.js](/docs/quickstarts/nextjs). If you're using a different framework or SDk, you'll need to manually configure Clerk keys in your environment. Visit the [Clerk Dashboard](https://dashboard.clerk.com/sign-up) to create an account, create an instance and get your keys.

## Claiming keys

When you're ready to make configuration changes to your instance, you can claim the automatically generated keys. To do this, click the "Claim your instance" button in the Clerk toolbar on your local application. You'll then be prompted to sign up for a Clerk account, or sign in if you already have one. After authenticating, give your application a name and the keys will be associated with your account.
When you're ready to make configuration changes to your instance, you can claim the automatically generated keys. To do this, click the "Claim keys" button in the Clerk toolbar on your local application. You'll then be prompted to sign up for a Clerk account, or sign in if you already have one. After authenticating, give your application a name and the keys will be associated with your account.

![Claim keys modal](/docs/images/keyless/claim-keys.png)

You'll need to copy and paste the keys into your `.env` file to persist them in your project. This will disable Keyless Mode. If you don't add keys to your environment, you'll see a warning to let you know the instance has been claimed, but keys haven't been set.

You'll need to copy and paste the keys into your `.env` file to persist them in your project. This will disable Keyless Mode.
![Claimed instance warning](/docs/images/keyless/setting-env-keys.png)

## Feedback

Expand Down
Binary file added public/images/keyless/claim-keys.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/images/keyless/setting-env-keys.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 0c37dfb

Please sign in to comment.