Skip to content
StudioCMS Docs
Main Site
Live Demo

Environment Variables

For StudioCMS to work correctly, you must set up the correct environment variables. These variables are essential for establishing a secure connection to Astro DB and authenticating with the StudioCMS API. Without correctly configuring these environment variables, the application will not function as intended.

You can create a .env file in the root directory of your project and add the required environment variables. The .env file is a text file that contains key-value pairs of environment variables. The environment variables are read by the application at runtime.

For future reference on how to work with environment variables within Astro you can checkout Environment Variables^ from the Astro documentation.

Required Environment Variables

'Read the “', Required Environment Variables, '” section'

In order to use StudioCMS, there are a few required environment variables that you must set up in your .env file.

Database URL and Token for @astrojs/db

'Read the “', Database URL and Token for @astrojs/db, '” section'

ASTRO_DB_REMOTE_URL - The connection URL to your libSQL server ASTRO_DB_APP_TOKEN - The app token for your libSQL server

.env
ASTRO_DB_REMOTE_URL=libsql://your.server.io
ASTRO_DB_APP_TOKEN=eyJh...RUCg
For more information about @astrojs/db see, the Astro docs for Astro DB^

Encryption Key for @studiocms/auth

'Read the “', Encryption Key for @studiocms/auth, '” section'

CMS_ENCRYPTION_KEY - A secure encryption key for encrypting sensitive data

.env
CMS_ENCRYPTION_KEY="wqR+w...sRcg=="

Optional Environment Variables

'Read the “', Optional Environment Variables, '” section'

oAuth Authentication Environment Variables

'Read the “', oAuth Authentication Environment Variables, '” section'

For more information about setting up oAuth authentication, see the Configure oAuth Authentication documentation.

GitHub (Optional)

'Read the “', GitHub (Optional), '” section'

To authenticate with GitHub, you need to add the following environment variables to your .env file:

.env
# credentials for GitHub OAuth
CMS_GITHUB_CLIENT_ID=
CMS_GITHUB_CLIENT_SECRET=
CMS_GITHUB_REDIRECT_URI=

Discord (Optional)

'Read the “', Discord (Optional), '” section'
.env
# credentials for Discord OAuth
CMS_DISCORD_CLIENT_ID=
CMS_DISCORD_CLIENT_SECRET=
CMS_DISCORD_REDIRECT_URI=

Google (Optional)

'Read the “', Google (Optional), '” section'
.env
# credentials for Google OAuth
CMS_GOOGLE_CLIENT_ID=
CMS_GOOGLE_CLIENT_SECRET=
CMS_GOOGLE_REDIRECT_URI=

Auth0 (Optional)

'Read the “', Auth0 (Optional), '” section'
.env
# credentials for auth0 OAuth
CMS_AUTH0_CLIENT_ID=
CMS_AUTH0_CLIENT_SECRET=
CMS_AUTH0_DOMAIN=
CMS_AUTH0_REDIRECT_URI=

Image Handler Environment Variables

'Read the “', Image Handler Environment Variables, '” section'

Cloudinary (Optional)

'Read the “', Cloudinary (Optional), '” section'

If you choose to use the built-in Cloudinary plugin, you will need to define the following:

.env
## Cloudinary Javascript SDK
CMS_CLOUDINARY_CLOUDNAME="demo"