Aller au contenu
StudioCMS Docs
Site principal
Démo

Configuration du tableau de bord

Référence du schéma des options de configuration de l’intégration StudioCMS

studiocms.config.mjs
export default 
function defineStudioCMSConfig(config: StudioCMSOptions): {
    sdk?: boolean | {
        cacheConfig?: boolean | {
            lifetime?: string | undefined;
        } | undefined;
    } | undefined;
    dbStartPage?: boolean | undefined;
    imageService?: {
        cdnPlugin?: "cloudinary-js" | undefined;
    } | undefined;
    defaultFrontEndConfig?: boolean | {
        htmlDefaultLanguage?: string | undefined;
        htmlDefaultHead?: {
            tag: "link" | "title" | "base" | "style" | "meta" | "script" | "noscript" | "template";
            attrs?: Record<string, string | boolean | undefined> | undefined;
            content?: string | undefined;
        }[] | undefined;
        favicon?: string | undefined;
        injectQuickActionsMenu?: boolean | undefined;
    } | undefined;
    dashboardConfig?: {
        dashboardEnabled?: boolean | undefined;
        inject404Route?: boolean | undefined;
        faviconURL?: string | undefined;
        dashboardRouteOverride?: string | undefined;
        AuthConfig?: {
            providers?: {
                github?: boolean | undefined;
                discord?: boolean | undefined;
                google?: boolean | undefined;
                auth0?: boolean | undefined;
                usernameAndPassword?: boolean | undefined;
                usernameAndPasswordConfig?: {
                    allowUserRegistration?: boolean | undefined;
                } | undefined;
            } | undefined;
            enabled?: boolean | undefined;
        } | undefined;
        developerConfig?: {
            demoMode?: false | {
                password: string ...
A utility function to define the StudioCMS config object.
This function is used to define the optional StudioCMS
config object in the Astro project root. The expected file
name is studiocms.config.mjs. And it should be adjacent
to the Astro project's astro.config.mjs file.


StudioCMS will attempt to import this file and use the default
export as the StudioCMS config object automatically if it exists.


Using this function is optional, but it can be useful for IDEs
to provide better intellisense and type checking.
@example 
// studiocms.config.mjs
import { defineStudioCMSConfig } from 'studiocms';


export default defineStudioCMSConfig({
 dbStartPage: true,
 contentRenderer: 'marked',
 verbose: true,
 dateLocale: 'en-us',
 // ...Other Options
})
defineStudioCMSConfig({
  
dashboardConfig?: {
    dashboardEnabled?: boolean | undefined;
    inject404Route?: boolean | undefined;
    faviconURL?: string | undefined;
    dashboardRouteOverride?: string | undefined;
    AuthConfig?: {
        providers?: {
            github?: boolean | undefined;
            discord?: boolean | undefined;
            google?: boolean | undefined;
            auth0?: boolean | undefined;
            usernameAndPassword?: boolean | undefined;
            usernameAndPasswordConfig?: {
                allowUserRegistration?: boolean | undefined;
            } | undefined;
        } | undefined;
        enabled?: boolean | undefined;
    } | undefined;
    developerConfig?: {
        demoMode?: false | {
            password: string;
            username: string;
        } | undefined;
    } | undefined;
    versionCheck?: boolean | undefined;
} | undefined
dashboardConfig: {
    
dashboardEnabled?: boolean | undefined
dashboardEnabled: true,
    
dashboardRouteOverride?: string | undefined
dashboardRouteOverride: 'dashboard',
    
developerConfig?: {
    demoMode?: false | {
        password: string;
        username: string;
    } | undefined;
} | undefined
developerConfig: {},
    
faviconURL?: string | undefined
faviconURL: '/favicon.svg',
    
inject404Route?: boolean | undefined
inject404Route: true,
    
versionCheck?: boolean | undefined
versionCheck: true,
    
AuthConfig?: {
    providers?: {
        github?: boolean | undefined;
        discord?: boolean | undefined;
        google?: boolean | undefined;
        auth0?: boolean | undefined;
        usernameAndPassword?: boolean | undefined;
        usernameAndPasswordConfig?: {
            allowUserRegistration?: boolean | undefined;
        } | undefined;
    } | undefined;
    enabled?: boolean | undefined;
} | undefined
AuthConfig: {},
  },
});

dashboardEnabled

'Read the “', dashboardEnabled, '” section'

dashboardEnabled est un booléen utilisé pour déterminer si le tableau de bord est activé.

  • Type : boolean
  • Par défaut : true

Utilisation

'Read the “', Utilisation, '” section'
studiocms.config.mjs
export default 
function defineStudioCMSConfig(config: StudioCMSOptions): {
    sdk?: boolean | {
        cacheConfig?: boolean | {
            lifetime?: string | undefined;
        } | undefined;
    } | undefined;
    dbStartPage?: boolean | undefined;
    imageService?: {
        cdnPlugin?: "cloudinary-js" | undefined;
    } | undefined;
    defaultFrontEndConfig?: boolean | {
        htmlDefaultLanguage?: string | undefined;
        htmlDefaultHead?: {
            tag: "link" | "title" | "base" | "style" | "meta" | "script" | "noscript" | "template";
            attrs?: Record<string, string | boolean | undefined> | undefined;
            content?: string | undefined;
        }[] | undefined;
        favicon?: string | undefined;
        injectQuickActionsMenu?: boolean | undefined;
    } | undefined;
    dashboardConfig?: {
        dashboardEnabled?: boolean | undefined;
        inject404Route?: boolean | undefined;
        faviconURL?: string | undefined;
        dashboardRouteOverride?: string | undefined;
        AuthConfig?: {
            providers?: {
                github?: boolean | undefined;
                discord?: boolean | undefined;
                google?: boolean | undefined;
                auth0?: boolean | undefined;
                usernameAndPassword?: boolean | undefined;
                usernameAndPasswordConfig?: {
                    allowUserRegistration?: boolean | undefined;
                } | undefined;
            } | undefined;
            enabled?: boolean | undefined;
        } | undefined;
        developerConfig?: {
            demoMode?: false | {
                password: string ...
A utility function to define the StudioCMS config object.
This function is used to define the optional StudioCMS
config object in the Astro project root. The expected file
name is studiocms.config.mjs. And it should be adjacent
to the Astro project's astro.config.mjs file.


StudioCMS will attempt to import this file and use the default
export as the StudioCMS config object automatically if it exists.


Using this function is optional, but it can be useful for IDEs
to provide better intellisense and type checking.
@example 
// studiocms.config.mjs
import { defineStudioCMSConfig } from 'studiocms';


export default defineStudioCMSConfig({
 dbStartPage: true,
 contentRenderer: 'marked',
 verbose: true,
 dateLocale: 'en-us',
 // ...Other Options
})
defineStudioCMSConfig({
  
dashboardConfig?: {
    dashboardEnabled?: boolean | undefined;
    inject404Route?: boolean | undefined;
    faviconURL?: string | undefined;
    dashboardRouteOverride?: string | undefined;
    AuthConfig?: {
        providers?: {
            github?: boolean | undefined;
            discord?: boolean | undefined;
            google?: boolean | undefined;
            auth0?: boolean | undefined;
            usernameAndPassword?: boolean | undefined;
            usernameAndPasswordConfig?: {
                allowUserRegistration?: boolean | undefined;
            } | undefined;
        } | undefined;
        enabled?: boolean | undefined;
    } | undefined;
    developerConfig?: {
        demoMode?: false | {
            password: string;
            username: string;
        } | undefined;
    } | undefined;
    versionCheck?: boolean | undefined;
} | undefined
dashboardConfig: {
    
dashboardEnabled?: boolean | undefined
dashboardEnabled: true, // PAR DÉFAUT - Ceci active le tableau de bord.
  }
})

DashboardRouteOverride

'Read the “', DashboardRouteOverride, '” section'

DashboardRouteOverride est une chaîne de caractères utilisée pour déterminer la route du tableau de bord.

  • Type : string
  • Par défaut : 'dashboard'

Utilisation

'Read the “', Utilisation, '” section'
studiocms.config.mjs
export default 
function defineStudioCMSConfig(config: StudioCMSOptions): {
    sdk?: boolean | {
        cacheConfig?: boolean | {
            lifetime?: string | undefined;
        } | undefined;
    } | undefined;
    dbStartPage?: boolean | undefined;
    imageService?: {
        cdnPlugin?: "cloudinary-js" | undefined;
    } | undefined;
    defaultFrontEndConfig?: boolean | {
        htmlDefaultLanguage?: string | undefined;
        htmlDefaultHead?: {
            tag: "link" | "title" | "base" | "style" | "meta" | "script" | "noscript" | "template";
            attrs?: Record<string, string | boolean | undefined> | undefined;
            content?: string | undefined;
        }[] | undefined;
        favicon?: string | undefined;
        injectQuickActionsMenu?: boolean | undefined;
    } | undefined;
    dashboardConfig?: {
        dashboardEnabled?: boolean | undefined;
        inject404Route?: boolean | undefined;
        faviconURL?: string | undefined;
        dashboardRouteOverride?: string | undefined;
        AuthConfig?: {
            providers?: {
                github?: boolean | undefined;
                discord?: boolean | undefined;
                google?: boolean | undefined;
                auth0?: boolean | undefined;
                usernameAndPassword?: boolean | undefined;
                usernameAndPasswordConfig?: {
                    allowUserRegistration?: boolean | undefined;
                } | undefined;
            } | undefined;
            enabled?: boolean | undefined;
        } | undefined;
        developerConfig?: {
            demoMode?: false | {
                password: string ...
A utility function to define the StudioCMS config object.
This function is used to define the optional StudioCMS
config object in the Astro project root. The expected file
name is studiocms.config.mjs. And it should be adjacent
to the Astro project's astro.config.mjs file.


StudioCMS will attempt to import this file and use the default
export as the StudioCMS config object automatically if it exists.


Using this function is optional, but it can be useful for IDEs
to provide better intellisense and type checking.
@example 
// studiocms.config.mjs
import { defineStudioCMSConfig } from 'studiocms';


export default defineStudioCMSConfig({
 dbStartPage: true,
 contentRenderer: 'marked',
 verbose: true,
 dateLocale: 'en-us',
 // ...Other Options
})
defineStudioCMSConfig({
  
dashboardConfig?: {
    dashboardEnabled?: boolean | undefined;
    inject404Route?: boolean | undefined;
    faviconURL?: string | undefined;
    dashboardRouteOverride?: string | undefined;
    AuthConfig?: {
        providers?: {
            github?: boolean | undefined;
            discord?: boolean | undefined;
            google?: boolean | undefined;
            auth0?: boolean | undefined;
            usernameAndPassword?: boolean | undefined;
            usernameAndPasswordConfig?: {
                allowUserRegistration?: boolean | undefined;
            } | undefined;
        } | undefined;
        enabled?: boolean | undefined;
    } | undefined;
    developerConfig?: {
        demoMode?: false | {
            password: string;
            username: string;
        } | undefined;
    } | undefined;
    versionCheck?: boolean | undefined;
} | undefined
dashboardConfig: {
    
dashboardRouteOverride?: string | undefined
dashboardRouteOverride: 'dashboard', // PAR DÉFAUT - Ceci définit la route du tableau de bord sur /dashboard.
  }
})

developerConfig

'Read the “', developerConfig, '” section'

developerConfig est un objet utilisé pour configurer les paramètres du développeur pour le tableau de bord.

Utilisation

'Read the “', Utilisation, '” section'
studiocms.config.mjs
export default 
function defineStudioCMSConfig(config: StudioCMSOptions): {
    sdk?: boolean | {
        cacheConfig?: boolean | {
            lifetime?: string | undefined;
        } | undefined;
    } | undefined;
    dbStartPage?: boolean | undefined;
    imageService?: {
        cdnPlugin?: "cloudinary-js" | undefined;
    } | undefined;
    defaultFrontEndConfig?: boolean | {
        htmlDefaultLanguage?: string | undefined;
        htmlDefaultHead?: {
            tag: "link" | "title" | "base" | "style" | "meta" | "script" | "noscript" | "template";
            attrs?: Record<string, string | boolean | undefined> | undefined;
            content?: string | undefined;
        }[] | undefined;
        favicon?: string | undefined;
        injectQuickActionsMenu?: boolean | undefined;
    } | undefined;
    dashboardConfig?: {
        dashboardEnabled?: boolean | undefined;
        inject404Route?: boolean | undefined;
        faviconURL?: string | undefined;
        dashboardRouteOverride?: string | undefined;
        AuthConfig?: {
            providers?: {
                github?: boolean | undefined;
                discord?: boolean | undefined;
                google?: boolean | undefined;
                auth0?: boolean | undefined;
                usernameAndPassword?: boolean | undefined;
                usernameAndPasswordConfig?: {
                    allowUserRegistration?: boolean | undefined;
                } | undefined;
            } | undefined;
            enabled?: boolean | undefined;
        } | undefined;
        developerConfig?: {
            demoMode?: false | {
                password: string ...
A utility function to define the StudioCMS config object.
This function is used to define the optional StudioCMS
config object in the Astro project root. The expected file
name is studiocms.config.mjs. And it should be adjacent
to the Astro project's astro.config.mjs file.


StudioCMS will attempt to import this file and use the default
export as the StudioCMS config object automatically if it exists.


Using this function is optional, but it can be useful for IDEs
to provide better intellisense and type checking.
@example 
// studiocms.config.mjs
import { defineStudioCMSConfig } from 'studiocms';


export default defineStudioCMSConfig({
 dbStartPage: true,
 contentRenderer: 'marked',
 verbose: true,
 dateLocale: 'en-us',
 // ...Other Options
})
defineStudioCMSConfig({
  
dashboardConfig?: {
    dashboardEnabled?: boolean | undefined;
    inject404Route?: boolean | undefined;
    faviconURL?: string | undefined;
    dashboardRouteOverride?: string | undefined;
    AuthConfig?: {
        providers?: {
            github?: boolean | undefined;
            discord?: boolean | undefined;
            google?: boolean | undefined;
            auth0?: boolean | undefined;
            usernameAndPassword?: boolean | undefined;
            usernameAndPasswordConfig?: {
                allowUserRegistration?: boolean | undefined;
            } | undefined;
        } | undefined;
        enabled?: boolean | undefined;
    } | undefined;
    developerConfig?: {
        demoMode?: false | {
            password: string;
            username: string;
        } | undefined;
    } | undefined;
    versionCheck?: boolean | undefined;
} | undefined
dashboardConfig: {
    
developerConfig?: {
    demoMode?: false | {
        password: string;
        username: string;
    } | undefined;
} | undefined
developerConfig: {
        
demoMode?: false | {
    password: string;
    username: string;
} | undefined
demoMode: false, // PAR DÉFAUT - Ceci désactive le mode démo.
    },
  }
})

faviconURL

'Read the “', faviconURL, '” section'

faviconURL est une chaîne de caractères utilisée pour déterminer le chemin vers le favicon du tableau de bord.

  • Type : string
  • Par défaut : '/favicon.svg'

Utilisation

'Read the “', Utilisation, '” section'
studiocms.config.mjs
export default 
function defineStudioCMSConfig(config: StudioCMSOptions): {
    sdk?: boolean | {
        cacheConfig?: boolean | {
            lifetime?: string | undefined;
        } | undefined;
    } | undefined;
    dbStartPage?: boolean | undefined;
    imageService?: {
        cdnPlugin?: "cloudinary-js" | undefined;
    } | undefined;
    defaultFrontEndConfig?: boolean | {
        htmlDefaultLanguage?: string | undefined;
        htmlDefaultHead?: {
            tag: "link" | "title" | "base" | "style" | "meta" | "script" | "noscript" | "template";
            attrs?: Record<string, string | boolean | undefined> | undefined;
            content?: string | undefined;
        }[] | undefined;
        favicon?: string | undefined;
        injectQuickActionsMenu?: boolean | undefined;
    } | undefined;
    dashboardConfig?: {
        dashboardEnabled?: boolean | undefined;
        inject404Route?: boolean | undefined;
        faviconURL?: string | undefined;
        dashboardRouteOverride?: string | undefined;
        AuthConfig?: {
            providers?: {
                github?: boolean | undefined;
                discord?: boolean | undefined;
                google?: boolean | undefined;
                auth0?: boolean | undefined;
                usernameAndPassword?: boolean | undefined;
                usernameAndPasswordConfig?: {
                    allowUserRegistration?: boolean | undefined;
                } | undefined;
            } | undefined;
            enabled?: boolean | undefined;
        } | undefined;
        developerConfig?: {
            demoMode?: false | {
                password: string ...
A utility function to define the StudioCMS config object.
This function is used to define the optional StudioCMS
config object in the Astro project root. The expected file
name is studiocms.config.mjs. And it should be adjacent
to the Astro project's astro.config.mjs file.


StudioCMS will attempt to import this file and use the default
export as the StudioCMS config object automatically if it exists.


Using this function is optional, but it can be useful for IDEs
to provide better intellisense and type checking.
@example 
// studiocms.config.mjs
import { defineStudioCMSConfig } from 'studiocms';


export default defineStudioCMSConfig({
 dbStartPage: true,
 contentRenderer: 'marked',
 verbose: true,
 dateLocale: 'en-us',
 // ...Other Options
})
defineStudioCMSConfig({
  
dashboardConfig?: {
    dashboardEnabled?: boolean | undefined;
    inject404Route?: boolean | undefined;
    faviconURL?: string | undefined;
    dashboardRouteOverride?: string | undefined;
    AuthConfig?: {
        providers?: {
            github?: boolean | undefined;
            discord?: boolean | undefined;
            google?: boolean | undefined;
            auth0?: boolean | undefined;
            usernameAndPassword?: boolean | undefined;
            usernameAndPasswordConfig?: {
                allowUserRegistration?: boolean | undefined;
            } | undefined;
        } | undefined;
        enabled?: boolean | undefined;
    } | undefined;
    developerConfig?: {
        demoMode?: false | {
            password: string;
            username: string;
        } | undefined;
    } | undefined;
    versionCheck?: boolean | undefined;
} | undefined
dashboardConfig: {
    
faviconURL?: string | undefined
faviconURL: '/favicon.svg', // PAR DÉFAUT - Ceci définit le favicon du tableau de bord.
  }
})

inject404Route

'Read the “', inject404Route, '” section'

inject404Route est un booléen utilisé pour déterminer si la route 404 doit être injectée.

  • Type : boolean
  • Par défaut : true

Utilisation

'Read the “', Utilisation, '” section'
studiocms.config.mjs
export default 
function defineStudioCMSConfig(config: StudioCMSOptions): {
    sdk?: boolean | {
        cacheConfig?: boolean | {
            lifetime?: string | undefined;
        } | undefined;
    } | undefined;
    dbStartPage?: boolean | undefined;
    imageService?: {
        cdnPlugin?: "cloudinary-js" | undefined;
    } | undefined;
    defaultFrontEndConfig?: boolean | {
        htmlDefaultLanguage?: string | undefined;
        htmlDefaultHead?: {
            tag: "link" | "title" | "base" | "style" | "meta" | "script" | "noscript" | "template";
            attrs?: Record<string, string | boolean | undefined> | undefined;
            content?: string | undefined;
        }[] | undefined;
        favicon?: string | undefined;
        injectQuickActionsMenu?: boolean | undefined;
    } | undefined;
    dashboardConfig?: {
        dashboardEnabled?: boolean | undefined;
        inject404Route?: boolean | undefined;
        faviconURL?: string | undefined;
        dashboardRouteOverride?: string | undefined;
        AuthConfig?: {
            providers?: {
                github?: boolean | undefined;
                discord?: boolean | undefined;
                google?: boolean | undefined;
                auth0?: boolean | undefined;
                usernameAndPassword?: boolean | undefined;
                usernameAndPasswordConfig?: {
                    allowUserRegistration?: boolean | undefined;
                } | undefined;
            } | undefined;
            enabled?: boolean | undefined;
        } | undefined;
        developerConfig?: {
            demoMode?: false | {
                password: string ...
A utility function to define the StudioCMS config object.
This function is used to define the optional StudioCMS
config object in the Astro project root. The expected file
name is studiocms.config.mjs. And it should be adjacent
to the Astro project's astro.config.mjs file.


StudioCMS will attempt to import this file and use the default
export as the StudioCMS config object automatically if it exists.


Using this function is optional, but it can be useful for IDEs
to provide better intellisense and type checking.
@example 
// studiocms.config.mjs
import { defineStudioCMSConfig } from 'studiocms';


export default defineStudioCMSConfig({
 dbStartPage: true,
 contentRenderer: 'marked',
 verbose: true,
 dateLocale: 'en-us',
 // ...Other Options
})
defineStudioCMSConfig({
  
dashboardConfig?: {
    dashboardEnabled?: boolean | undefined;
    inject404Route?: boolean | undefined;
    faviconURL?: string | undefined;
    dashboardRouteOverride?: string | undefined;
    AuthConfig?: {
        providers?: {
            github?: boolean | undefined;
            discord?: boolean | undefined;
            google?: boolean | undefined;
            auth0?: boolean | undefined;
            usernameAndPassword?: boolean | undefined;
            usernameAndPasswordConfig?: {
                allowUserRegistration?: boolean | undefined;
            } | undefined;
        } | undefined;
        enabled?: boolean | undefined;
    } | undefined;
    developerConfig?: {
        demoMode?: false | {
            password: string;
            username: string;
        } | undefined;
    } | undefined;
    versionCheck?: boolean | undefined;
} | undefined
dashboardConfig: {
    
inject404Route?: boolean | undefined
inject404Route: true, // PAR DÉFAUT - Ceci injecte la route 404.
  }
})

versionCheck

'Read the “', versionCheck, '” section'

versionCheck est un booléen utilisé pour déterminer si la vérification des versions doit être activée.

  • Type : boolean
  • Par défaut : true

Utilisation

'Read the “', Utilisation, '” section'
studiocms.config.mjs
export default 
function defineStudioCMSConfig(config: StudioCMSOptions): {
    sdk?: boolean | {
        cacheConfig?: boolean | {
            lifetime?: string | undefined;
        } | undefined;
    } | undefined;
    dbStartPage?: boolean | undefined;
    imageService?: {
        cdnPlugin?: "cloudinary-js" | undefined;
    } | undefined;
    defaultFrontEndConfig?: boolean | {
        htmlDefaultLanguage?: string | undefined;
        htmlDefaultHead?: {
            tag: "link" | "title" | "base" | "style" | "meta" | "script" | "noscript" | "template";
            attrs?: Record<string, string | boolean | undefined> | undefined;
            content?: string | undefined;
        }[] | undefined;
        favicon?: string | undefined;
        injectQuickActionsMenu?: boolean | undefined;
    } | undefined;
    dashboardConfig?: {
        dashboardEnabled?: boolean | undefined;
        inject404Route?: boolean | undefined;
        faviconURL?: string | undefined;
        dashboardRouteOverride?: string | undefined;
        AuthConfig?: {
            providers?: {
                github?: boolean | undefined;
                discord?: boolean | undefined;
                google?: boolean | undefined;
                auth0?: boolean | undefined;
                usernameAndPassword?: boolean | undefined;
                usernameAndPasswordConfig?: {
                    allowUserRegistration?: boolean | undefined;
                } | undefined;
            } | undefined;
            enabled?: boolean | undefined;
        } | undefined;
        developerConfig?: {
            demoMode?: false | {
                password: string ...
A utility function to define the StudioCMS config object.
This function is used to define the optional StudioCMS
config object in the Astro project root. The expected file
name is studiocms.config.mjs. And it should be adjacent
to the Astro project's astro.config.mjs file.


StudioCMS will attempt to import this file and use the default
export as the StudioCMS config object automatically if it exists.


Using this function is optional, but it can be useful for IDEs
to provide better intellisense and type checking.
@example 
// studiocms.config.mjs
import { defineStudioCMSConfig } from 'studiocms';


export default defineStudioCMSConfig({
 dbStartPage: true,
 contentRenderer: 'marked',
 verbose: true,
 dateLocale: 'en-us',
 // ...Other Options
})
defineStudioCMSConfig({
  
dashboardConfig?: {
    dashboardEnabled?: boolean | undefined;
    inject404Route?: boolean | undefined;
    faviconURL?: string | undefined;
    dashboardRouteOverride?: string | undefined;
    AuthConfig?: {
        providers?: {
            github?: boolean | undefined;
            discord?: boolean | undefined;
            google?: boolean | undefined;
            auth0?: boolean | undefined;
            usernameAndPassword?: boolean | undefined;
            usernameAndPasswordConfig?: {
                allowUserRegistration?: boolean | undefined;
            } | undefined;
        } | undefined;
        enabled?: boolean | undefined;
    } | undefined;
    developerConfig?: {
        demoMode?: false | {
            password: string;
            username: string;
        } | undefined;
    } | undefined;
    versionCheck?: boolean | undefined;
} | undefined
dashboardConfig: {
    
versionCheck?: boolean | undefined
versionCheck: true, // PAR DÉFAUT - Ceci active la vérification des versions.
  }
})

AuthConfig

'Read the “', AuthConfig, '” section'

AuthConfig est un objet utilisé pour configurer les paramètres d’authentification du tableau de bord.

Utilisation

'Read the “', Utilisation, '” section'
studiocms.config.mjs
export default 
function defineStudioCMSConfig(config: StudioCMSOptions): {
    sdk?: boolean | {
        cacheConfig?: boolean | {
            lifetime?: string | undefined;
        } | undefined;
    } | undefined;
    dbStartPage?: boolean | undefined;
    imageService?: {
        cdnPlugin?: "cloudinary-js" | undefined;
    } | undefined;
    defaultFrontEndConfig?: boolean | {
        htmlDefaultLanguage?: string | undefined;
        htmlDefaultHead?: {
            tag: "link" | "title" | "base" | "style" | "meta" | "script" | "noscript" | "template";
            attrs?: Record<string, string | boolean | undefined> | undefined;
            content?: string | undefined;
        }[] | undefined;
        favicon?: string | undefined;
        injectQuickActionsMenu?: boolean | undefined;
    } | undefined;
    dashboardConfig?: {
        dashboardEnabled?: boolean | undefined;
        inject404Route?: boolean | undefined;
        faviconURL?: string | undefined;
        dashboardRouteOverride?: string | undefined;
        AuthConfig?: {
            providers?: {
                github?: boolean | undefined;
                discord?: boolean | undefined;
                google?: boolean | undefined;
                auth0?: boolean | undefined;
                usernameAndPassword?: boolean | undefined;
                usernameAndPasswordConfig?: {
                    allowUserRegistration?: boolean | undefined;
                } | undefined;
            } | undefined;
            enabled?: boolean | undefined;
        } | undefined;
        developerConfig?: {
            demoMode?: false | {
                password: string ...
A utility function to define the StudioCMS config object.
This function is used to define the optional StudioCMS
config object in the Astro project root. The expected file
name is studiocms.config.mjs. And it should be adjacent
to the Astro project's astro.config.mjs file.


StudioCMS will attempt to import this file and use the default
export as the StudioCMS config object automatically if it exists.


Using this function is optional, but it can be useful for IDEs
to provide better intellisense and type checking.
@example 
// studiocms.config.mjs
import { defineStudioCMSConfig } from 'studiocms';


export default defineStudioCMSConfig({
 dbStartPage: true,
 contentRenderer: 'marked',
 verbose: true,
 dateLocale: 'en-us',
 // ...Other Options
})
defineStudioCMSConfig({
  
dashboardConfig?: {
    dashboardEnabled?: boolean | undefined;
    inject404Route?: boolean | undefined;
    faviconURL?: string | undefined;
    dashboardRouteOverride?: string | undefined;
    AuthConfig?: {
        providers?: {
            github?: boolean | undefined;
            discord?: boolean | undefined;
            google?: boolean | undefined;
            auth0?: boolean | undefined;
            usernameAndPassword?: boolean | undefined;
            usernameAndPasswordConfig?: {
                allowUserRegistration?: boolean | undefined;
            } | undefined;
        } | undefined;
        enabled?: boolean | undefined;
    } | undefined;
    developerConfig?: {
        demoMode?: false | {
            password: string;
            username: string;
        } | undefined;
    } | undefined;
    versionCheck?: boolean | undefined;
} | undefined
dashboardConfig: {
    
AuthConfig?: {
    providers?: {
        github?: boolean | undefined;
        discord?: boolean | undefined;
        google?: boolean | undefined;
        auth0?: boolean | undefined;
        usernameAndPassword?: boolean | undefined;
        usernameAndPasswordConfig?: {
            allowUserRegistration?: boolean | undefined;
        } | undefined;
    } | undefined;
    enabled?: boolean | undefined;
} | undefined
AuthConfig: {
        
enabled?: boolean | undefined
enabled: true, // PAR DÉFAUT - Ceci active l’authentification.
    },
  }
})

providers

'Read the “', providers, '” section'

providers est un objet utilisé pour configurer les fournisseurs d’authentification pour le tableau de bord.

Utilisation

'Read the “', Utilisation, '” section'
studiocms.config.mjs
export default 
function defineStudioCMSConfig(config: StudioCMSOptions): {
    sdk?: boolean | {
        cacheConfig?: boolean | {
            lifetime?: string | undefined;
        } | undefined;
    } | undefined;
    dbStartPage?: boolean | undefined;
    imageService?: {
        cdnPlugin?: "cloudinary-js" | undefined;
    } | undefined;
    defaultFrontEndConfig?: boolean | {
        htmlDefaultLanguage?: string | undefined;
        htmlDefaultHead?: {
            tag: "link" | "title" | "base" | "style" | "meta" | "script" | "noscript" | "template";
            attrs?: Record<string, string | boolean | undefined> | undefined;
            content?: string | undefined;
        }[] | undefined;
        favicon?: string | undefined;
        injectQuickActionsMenu?: boolean | undefined;
    } | undefined;
    dashboardConfig?: {
        dashboardEnabled?: boolean | undefined;
        inject404Route?: boolean | undefined;
        faviconURL?: string | undefined;
        dashboardRouteOverride?: string | undefined;
        AuthConfig?: {
            providers?: {
                github?: boolean | undefined;
                discord?: boolean | undefined;
                google?: boolean | undefined;
                auth0?: boolean | undefined;
                usernameAndPassword?: boolean | undefined;
                usernameAndPasswordConfig?: {
                    allowUserRegistration?: boolean | undefined;
                } | undefined;
            } | undefined;
            enabled?: boolean | undefined;
        } | undefined;
        developerConfig?: {
            demoMode?: false | {
                password: string ...
A utility function to define the StudioCMS config object.
This function is used to define the optional StudioCMS
config object in the Astro project root. The expected file
name is studiocms.config.mjs. And it should be adjacent
to the Astro project's astro.config.mjs file.


StudioCMS will attempt to import this file and use the default
export as the StudioCMS config object automatically if it exists.


Using this function is optional, but it can be useful for IDEs
to provide better intellisense and type checking.
@example 
// studiocms.config.mjs
import { defineStudioCMSConfig } from 'studiocms';


export default defineStudioCMSConfig({
 dbStartPage: true,
 contentRenderer: 'marked',
 verbose: true,
 dateLocale: 'en-us',
 // ...Other Options
})
defineStudioCMSConfig({
  
dashboardConfig?: {
    dashboardEnabled?: boolean | undefined;
    inject404Route?: boolean | undefined;
    faviconURL?: string | undefined;
    dashboardRouteOverride?: string | undefined;
    AuthConfig?: {
        providers?: {
            github?: boolean | undefined;
            discord?: boolean | undefined;
            google?: boolean | undefined;
            auth0?: boolean | undefined;
            usernameAndPassword?: boolean | undefined;
            usernameAndPasswordConfig?: {
                allowUserRegistration?: boolean | undefined;
            } | undefined;
        } | undefined;
        enabled?: boolean | undefined;
    } | undefined;
    developerConfig?: {
        demoMode?: false | {
            password: string;
            username: string;
        } | undefined;
    } | undefined;
    versionCheck?: boolean | undefined;
} | undefined
dashboardConfig: {
    
AuthConfig?: {
    providers?: {
        github?: boolean | undefined;
        discord?: boolean | undefined;
        google?: boolean | undefined;
        auth0?: boolean | undefined;
        usernameAndPassword?: boolean | undefined;
        usernameAndPasswordConfig?: {
            allowUserRegistration?: boolean | undefined;
        } | undefined;
    } | undefined;
    enabled?: boolean | undefined;
} | undefined
AuthConfig: {
        
providers?: {
    github?: boolean | undefined;
    discord?: boolean | undefined;
    google?: boolean | undefined;
    auth0?: boolean | undefined;
    usernameAndPassword?: boolean | undefined;
    usernameAndPasswordConfig?: {
        allowUserRegistration?: boolean | undefined;
    } | undefined;
} | undefined
providers: {
            
google?: boolean | undefined
google: true,
            
github?: boolean | undefined
github: true,
            
discord?: boolean | undefined
discord: true,
            
auth0?: boolean | undefined
auth0: true,
            
usernameAndPassword?: boolean | undefined
usernameAndPassword: true,
            
usernameAndPasswordConfig?: {
    allowUserRegistration?: boolean | undefined;
} | undefined
usernameAndPasswordConfig: {},
        },
    },
  },
})

usernameAndPasswordConfig

'Read the “', usernameAndPasswordConfig, '” section'

usernameAndPasswordConfig est un objet utilisé pour configurer les paramètres de nom d’utilisateur et de mot de passe pour le tableau de bord.

  • Type : { allowUserRegistration?: boolean }
  • Par défaut : {}
Utilisation
'Read the “', Utilisation, '” section'
studiocms.config.mjs
export default 
function defineStudioCMSConfig(config: StudioCMSOptions): {
    sdk?: boolean | {
        cacheConfig?: boolean | {
            lifetime?: string | undefined;
        } | undefined;
    } | undefined;
    dbStartPage?: boolean | undefined;
    imageService?: {
        cdnPlugin?: "cloudinary-js" | undefined;
    } | undefined;
    defaultFrontEndConfig?: boolean | {
        htmlDefaultLanguage?: string | undefined;
        htmlDefaultHead?: {
            tag: "link" | "title" | "base" | "style" | "meta" | "script" | "noscript" | "template";
            attrs?: Record<string, string | boolean | undefined> | undefined;
            content?: string | undefined;
        }[] | undefined;
        favicon?: string | undefined;
        injectQuickActionsMenu?: boolean | undefined;
    } | undefined;
    dashboardConfig?: {
        dashboardEnabled?: boolean | undefined;
        inject404Route?: boolean | undefined;
        faviconURL?: string | undefined;
        dashboardRouteOverride?: string | undefined;
        AuthConfig?: {
            providers?: {
                github?: boolean | undefined;
                discord?: boolean | undefined;
                google?: boolean | undefined;
                auth0?: boolean | undefined;
                usernameAndPassword?: boolean | undefined;
                usernameAndPasswordConfig?: {
                    allowUserRegistration?: boolean | undefined;
                } | undefined;
            } | undefined;
            enabled?: boolean | undefined;
        } | undefined;
        developerConfig?: {
            demoMode?: false | {
                password: string ...
A utility function to define the StudioCMS config object.
This function is used to define the optional StudioCMS
config object in the Astro project root. The expected file
name is studiocms.config.mjs. And it should be adjacent
to the Astro project's astro.config.mjs file.


StudioCMS will attempt to import this file and use the default
export as the StudioCMS config object automatically if it exists.


Using this function is optional, but it can be useful for IDEs
to provide better intellisense and type checking.
@example 
// studiocms.config.mjs
import { defineStudioCMSConfig } from 'studiocms';


export default defineStudioCMSConfig({
 dbStartPage: true,
 contentRenderer: 'marked',
 verbose: true,
 dateLocale: 'en-us',
 // ...Other Options
})
defineStudioCMSConfig({
  
dashboardConfig?: {
    dashboardEnabled?: boolean | undefined;
    inject404Route?: boolean | undefined;
    faviconURL?: string | undefined;
    dashboardRouteOverride?: string | undefined;
    AuthConfig?: {
        providers?: {
            github?: boolean | undefined;
            discord?: boolean | undefined;
            google?: boolean | undefined;
            auth0?: boolean | undefined;
            usernameAndPassword?: boolean | undefined;
            usernameAndPasswordConfig?: {
                allowUserRegistration?: boolean | undefined;
            } | undefined;
        } | undefined;
        enabled?: boolean | undefined;
    } | undefined;
    developerConfig?: {
        demoMode?: false | {
            password: string;
            username: string;
        } | undefined;
    } | undefined;
    versionCheck?: boolean | undefined;
} | undefined
dashboardConfig: {
    
AuthConfig?: {
    providers?: {
        github?: boolean | undefined;
        discord?: boolean | undefined;
        google?: boolean | undefined;
        auth0?: boolean | undefined;
        usernameAndPassword?: boolean | undefined;
        usernameAndPasswordConfig?: {
            allowUserRegistration?: boolean | undefined;
        } | undefined;
    } | undefined;
    enabled?: boolean | undefined;
} | undefined
AuthConfig: {
        
providers?: {
    github?: boolean | undefined;
    discord?: boolean | undefined;
    google?: boolean | undefined;
    auth0?: boolean | undefined;
    usernameAndPassword?: boolean | undefined;
    usernameAndPasswordConfig?: {
        allowUserRegistration?: boolean | undefined;
    } | undefined;
} | undefined
providers: {
            
usernameAndPassword?: boolean | undefined
usernameAndPassword: true,
            
usernameAndPasswordConfig?: {
    allowUserRegistration?: boolean | undefined;
} | undefined
usernameAndPasswordConfig: {
                
allowUserRegistration?: boolean | undefined
allowUserRegistration: true, // PAR DÉFAUT - Ceci permet l’enregistrement de l’utilisateur.
            },
        },
    },
  },
})
AuthProvider
'Read the “', AuthProvider, '” section'
type AuthProviders: {
    github?: boolean | undefined;
    discord?: boolean | undefined;
    google?: boolean | undefined;
    auth0?: boolean | undefined;
    usernameAndPassword?: boolean | undefined;
    usernameAndPasswordConfig?: {
        allowUserRegistration?: boolean | undefined;
    } | undefined;
} | undefined