StudioCMSOptions

StudioCMS Integration config options schema reference

studiocms.config.mjs

import { defineStudioCMSConfig } from 'studiocms/config';
// ---cut---
// Default Values shown
export default defineStudioCMSConfig({
  dbStartPage: true,
  db: {},
  verbose: false,
  logLevel: 'Info',
  plugins: [],
  componentRegistry: {},
  locale: {},
  features: {}
});

dbStartPage

Project initialization page - Used during first time setup to create your database configuration.

• Type: boolean
• Default: true

Usage

studiocms.config.mjs

import { defineStudioCMSConfig } from 'studiocms/config';
// ---cut---
export default defineStudioCMSConfig({
  dbStartPage: true, // DEFAULT - This injects a start page to setup your DB data.
})

db

db is an object that is used to configure the database dialect.

• Type: DBConfigSchema
• Default: {}

Usage

studiocms.config.mjs

import { defineStudioCMSConfig } from 'studiocms/config';
// ---cut---
export default defineStudioCMSConfig({
  db: {
    dialect: 'libsql', // 'libsql' | 'postgresql' | 'mysql'
  },
})

storageManager

storageManager is used to configure the storage manager plugin for StudioCMS.

• Type: StudioCMSStorageManager
• Default: undefined

Usage

studiocms.config.mjs

import { defineStudioCMSConfig } from 'studiocms/config';
// ---cut---
import s3Storage from '@studiocms/s3-storage';
export default defineStudioCMSConfig({
  storageManager: s3Storage(),
})

verbose

verbose is a boolean that is used to enable or disable verbose logging.

• Type: boolean
• Default: false

Usage

studiocms.config.mjs

import { defineStudioCMSConfig } from 'studiocms/config';
// ---cut---
export default defineStudioCMSConfig({
  verbose: false, // DEFAULT - This sets the verbose logging to false.
})

logLevel

logLevel is a union for setting the LogLevel for Effect based code.

• Type: All | Fatal | Error | Warning | Info | Debug | Trace | None
• Default: Info

Usage

studiocms.config.mjs

import { defineStudioCMSConfig } from 'studiocms/config';
// ---cut---
export default defineStudioCMSConfig({
  logLevel: 'Info', // DEFAULT
})

plugins

plugins is an array that is used to determine which plugins should be loaded.

• Type: StudioCMSPlugin[]
• Default: []

Usage

studiocms.config.mjs

import { defineStudioCMSConfig } from 'studiocms/config';
// ---cut---
import blog from '@studiocms/blog';
export default defineStudioCMSConfig({
  plugins: [
    blog(),
  ],
})

componentRegistry

componentRegistry is an object that is used to register components.

• Type: Record<string, string>
• Default: {}

Usage

studiocms.config.mjs

import { defineStudioCMSConfig } from 'studiocms/config';
// ---cut---
export default defineStudioCMSConfig({
  componentRegistry: {
    'my-component': './src/components/MyComponent.astro',
  },
})

locale

locale allows setting Locale specific settings

See locale for full options

features

features is an object that allows adjusting the StudioCMS Dashboard features

See features for full options