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.

[Experimental] astro:env

StudioCMS makes use of Astro’s new Experimental astro:env for handling all of its Environment Variables. If you face any issues with environment variables please submit an issue on Github

Required Environment Variables

If using Astro’s Studio with @astrojs/db

Astro Studio Account Required

Sunset

Astro Studio is currently in a sunset phase and users will no longer be able to create new databases after October 1st, 2024. We recommend using another libSQL provider such as Turso or self-hosting your own libSQL server.

For more information regarding the sunset of Studio, see Astro's 'Goodbye Studio, Hello DB' Blog Post

ASTRO_STUDIO_APP_TOKEN - Token provided from the Astro Studio Dashboard

.env

ASTRO_STUDIO_APP_TOKEN=your_app_token

If using libSQL with @astrojs/db

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=file://local-copy.db?encryptionKey=your-encryption-key&syncInterval=60&syncUrl=libsql%3A%2F%2Fyour.server.io
ASTRO_DB_APP_TOKEN=token-to-your-remote-url

Authentication Environment Variables

Currently there are 5 ways to authenticate with StudioCMS:

Local Development oAuth

Use http://localhost:4321 for local development and testing callback urls, and https://your-domain.tld for your callback urls in production!

GitHub

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

.env

# credentials for GitHub OAuth
# Callback URL for github (NOT AN ENV VARIABLE): 'http://localhost:4321/dashboard/login/github/callback'
CMS_GITHUB_CLIENT_ID=your_client_id
CMS_GITHUB_CLIENT_SECRET=your_client_secret

Discord

.env

# credentials for Discord OAuth
CMS_DISCORD_CLIENT_ID=
CMS_DISCORD_CLIENT_SECRET=
CMS_DISCORD_REDIRECT_URI=http://localhost:4321/dashboard/login/discord/callback

Google

.env

# credentials for Google OAuth
CMS_GOOGLE_CLIENT_ID=
CMS_GOOGLE_CLIENT_SECRET=
CMS_GOOGLE_REDIRECT_URI=http://localhost:4321/dashboard/login/google/callback

Auth0

.env

# credentials for auth0 OAuth
CMS_AUTH0_CLIENT_ID=
CMS_AUTH0_CLIENT_SECRET=
CMS_AUTH0_DOMAIN=
CMS_AUTH0_REDIRECT_URI=http://localhost:4321/dashboard/login/auth0/callback

Username and Password

Alternatively, you can authenticate with StudioCMS using your username and password which doesn’t require any additional environment variables.

Note

When Username and Password authentication is enabled you can modify its configuration and level of security using the generated studiocms-auth.config.json file.

Image Handler Environment Variables

Cloudinary (Optional)

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"