Menu
Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.
Enterprise
Open source
GrafanaConfig interface
Describes all the different Grafana configuration values available for an instance.
Signature
export interface GrafanaConfig Import
import { GrafanaConfig } from '@grafana/data';Properties
| Property | Type | Description |
|---|---|---|
| alertingEnabled | boolean | |
| alertingErrorOrTimeout | string | |
| alertingMinInterval | number | |
| alertingNoDataOrNullValues | string | |
| allowOrgCreate | boolean | |
| appSubUrl | string | |
| authProxyEnabled | boolean | |
| autoAssignOrg | boolean | |
| bootData | any | |
| buildInfo | BuildInfo | |
| customTheme | any | |
| datasources | {[str: string]: DataSourceInstanceSettings;} | |
| dateFormats | SystemDateFormatSettings | |
| defaultDatasource | string | |
| disableLoginForm | boolean | |
| disableSanitizeHtml | boolean | |
| disableUserSignUp | boolean | |
| editorsCanAdmin | boolean | |
| exploreEnabled | boolean | |
| externalUserMngInfo | string | |
| externalUserMngLinkName | string | |
| externalUserMngLinkUrl | string | |
| featureToggles | FeatureToggles | |
| http2Enabled | boolean | |
| ldapEnabled | boolean | |
| licenseInfo | LicenseInfo | |
| liveEnabled | boolean | |
| loginError | any | |
| loginHint | any | |
| minRefreshInterval | string | |
| navTree | any | |
| newPanelTitle | string | |
| oauth | any | |
| panels | {[key: string]: PanelPluginMeta;} | |
| passwordHint | any | |
| pluginsToPreload | string[] | |
| samlEnabled | boolean | |
| sentry | SentryConfig | |
| sigV4AuthEnabled | boolean | |
| theme | GrafanaTheme | |
| theme2 | GrafanaTheme2 | |
| verifyEmailEnabled | boolean | |
| viewersCanEdit | boolean | |
| windowTitlePrefix | string |
alertingEnabled property
Signature
alertingEnabled: boolean;alertingErrorOrTimeout property
Signature
alertingErrorOrTimeout: string;alertingMinInterval property
Signature
alertingMinInterval: number;alertingNoDataOrNullValues property
Signature
alertingNoDataOrNullValues: string;allowOrgCreate property
Signature
allowOrgCreate: boolean;appSubUrl property
Signature
appSubUrl: string;authProxyEnabled property
Signature
authProxyEnabled: boolean;autoAssignOrg property
Signature
autoAssignOrg: boolean;bootData property
Signature
bootData: any;buildInfo property
Signature
buildInfo: BuildInfo;customTheme property
Signature
customTheme?: any;datasources property
Signature
datasources: {
[str: string]: DataSourceInstanceSettings;
};dateFormats property
Signature
dateFormats?: SystemDateFormatSettings;defaultDatasource property
Signature
defaultDatasource: string;disableLoginForm property
Signature
disableLoginForm: boolean;disableSanitizeHtml property
Signature
disableSanitizeHtml: boolean;disableUserSignUp property
Signature
disableUserSignUp: boolean;editorsCanAdmin property
Signature
editorsCanAdmin: boolean;exploreEnabled property
Signature
exploreEnabled: boolean;externalUserMngInfo property
Signature
externalUserMngInfo: string;externalUserMngLinkName property
Signature
externalUserMngLinkName: string;externalUserMngLinkUrl property
Signature
externalUserMngLinkUrl: string;featureToggles property
Signature
featureToggles: FeatureToggles;http2Enabled property
Signature
http2Enabled: boolean;ldapEnabled property
Signature
ldapEnabled: boolean;licenseInfo property
Signature
licenseInfo: LicenseInfo;liveEnabled property
Signature
liveEnabled: boolean;loginError property
Signature
loginError: any;loginHint property
Signature
loginHint: any;minRefreshInterval property
Signature
minRefreshInterval: string;navTree property
Signature
navTree: any;newPanelTitle property
Signature
newPanelTitle: string;oauth property
Signature
oauth: any;panels property
Signature
panels: {
[key: string]: PanelPluginMeta;
};passwordHint property
Signature
passwordHint: any;pluginsToPreload property
Signature
pluginsToPreload: string[];samlEnabled property
Signature
samlEnabled: boolean;sentry property
Signature
sentry: SentryConfig;sigV4AuthEnabled property
Signature
sigV4AuthEnabled: boolean;theme property
Signature
theme: GrafanaTheme;theme2 property
Signature
theme2: GrafanaTheme2;verifyEmailEnabled property
Signature
verifyEmailEnabled: boolean;viewersCanEdit property
Signature
viewersCanEdit: boolean;windowTitlePrefix property
Signature
windowTitlePrefix: string;Was this page helpful?
Related resources from Grafana Labs
60 min
Getting started with managing your metrics, logs, and traces using Grafana
In this webinar, we’ll demo how to get started using the LGTM Stack: Loki for logs, Grafana for visualization, Tempo for traces, and Mimir for metrics.
60 min
Getting started with Grafana dashboard design
In this webinar, you'll learn how to design stylish and easily accessible Grafana dashboards that tell a story.
60 min
Building advanced Grafana dashboards
In this webinar, we’ll demo how to build and format Grafana dashboards.