Deploy to production
Learn how to deploy your app to production.
Before you share your app to the world, you'll need to create a production instance. While development instances are convenient, they are not as secure as Clerk's production environment.
It is strongly recommended that you do not go live with a development instance, we are soon going to put up warning messages around this.
Deploying on a Clerk provided domain is coming soon.
Before you start
- You should already have your app working with a development instance.
- You will need to be able to add DNS records on your domain.
- You will need Social Login (OAuth) credentials for any providers that you would like to use in production.
Creating your production instance
The modal is relatively straight forward, but there's a few things you should know. Your development and production instances are separate entities, and don't share anything - to match your development instance you should clone it's settings, which we make easy. If you ever need to change a setting, you should do it in development first to make sure everything works, before making the change to your production instance.
For security reasons, Social Login, Integrations and Paths settings do not copy over, you will need to set these values again.
API Keys and Environment variables
A common mistake when deploying to production is forgetting to change your API keys to your production instances keys. The best way to set this up, is to make use of Environment variables. All modern hosting providers, such as AWS, GCP, Vercel, Heroku, Render, etc.. make it easy to add these values. Locally, you should use an
env file, this way these values are being set dynamically depending on your environment. Here's a list of Clerk variables you'll need to change:
- Frontend API key. Formatted as
clerk.123.abc.lcl.devin development and
clerk.example.comin production. This is passed to the <ClerkProvider /> during initialization.
- Backend API Key. Formatted as
test_xxxxxin development and
live_xxxxxin production. These values are used to access Clerk's Backend API.
- OAuth credentials. In development, Clerk provides you with a set of shared OAuth credentials. These are not secure in production and you will need to provide your own.
Clerk uses DNS records to provide session management, and emails verified from your domain. You will need to go to DNS section to see the records that you need to set. Note: It can take up to 24hrs for DNS Records to fully propagate, so be patient.
Some DNS providers will automatically append the domain for the 'To' field, if this is the case, you will need to omit your domain from the 'To' field. So, add 'clerk' instead of 'clerk.example.com'.
Do not proxy your records. Clerk uses a DNS check to validate this CNAME record. If this subdomain is reverse proxied behind a service that points to generic hostnames, such as Cloudflare, the DNS check will fail. Please set the DNS record for this subdomain to a "DNS only" mode on your host to prevent proxying.
Once you've completed all the above steps, you're ready to go to the home page, and press Deploy to set SSL certificates and finalize the instance deployment. That's all!
If you run into any trouble feel free to reach out to any of our support channels and we can help you out.