Configuration reference
Casdoor reads its settings from one file, conf/app.conf. You can override every option with an environment variable. This page lists all options.
For a minimal setup, set only driverName, dataSourceName, and dbName. See Configure the database.
Backend options
The options appear in the order of conf/app.conf. Restart Casdoor after you change an option.
| Option | Default | Beschreibung |
|---|---|---|
appname | casdoor | Application name. Not used at the moment |
httpport | 8000 | Port that the backend application listens on |
runmode | dev | Running mode: dev or prod |
copyrequestbody | wahr | Whether to copy request body for later use |
driverName | mysql | Database driver (e.g., mysql, postgres, sqlite). See Configure the database |
dataSourceName | root:123456@tcp(localhost:3306)/ | Database connection string. See Configure the database |
dbName | casdoor | Database name used by Casdoor |
tableNamePrefix | (empty) | Prefix for table names when using an adapter |
showSql | falsch | Show SQL statements in logger when log level is greater than INFO |
redisEndpoint | (empty) | Redis endpoint for session storage (e.g., localhost:6379). If empty, sessions are stored locally in ./tmp. For password: host:port,db,password |
sessionCookieLifeTime | (empty) | Session cookie lifetime in seconds. Defaults to 30 days (2592000) when empty or not greater than 0; set a value greater than 0 to override it. |
defaultStorageProvider | (empty) | Default storage provider name for file uploads (e.g., avatars). See storage |
isCloudIntranet | falsch | Whether provider endpoints use intranet addresses |
authState | "casdoor" | Authorization application name that Casdoor checks during sign-in |
socks5Proxy | "127.0.0.1:10808" | SOCKS5 proxy address for OAuth providers (Google, GitHub, etc.) that may be blocked |
verificationCodeTimeout | 10 | Verification code expiration time in minutes |
initScore | 0 | Initial score assigned to new users (used by Casnode, not Casdoor) |
logPostOnly | wahr | Whether to log only POST requests |
isUsernameLowered | falsch | Whether to convert usernames to lowercase |
origin | (empty) | Backend origin URL (e.g., https://door.casdoor.com) |
originFrontend | (empty) | Frontend origin URL if different from backend |
trustedProxies | (empty) | Comma-separated IPs or CIDR ranges of reverse proxies whose X-Forwarded-For and X-Real-IP headers are trusted for the client IP (* trusts any). When empty, loopback and private addresses are trusted |
staticBaseUrl | "https://cdn.casbin.org" | CDN URL for static assets used during database initialization |
frontendCdnUrl | (empty) | Serve the frontend's JavaScript and CSS from a CDN, e.g. https://cdn.jsdelivr.net/npm/{name}@{version}. Only applies to a frontend installed from the casdoor-web npm package; files that fail to load from the CDN are loaded from Casdoor |
isDemoMode | falsch | Enable demo mode restrictions |
batchSize | 100 | Batch size for bulk operations |
showGithubCorner | falsch | Show the GitHub corner ribbon on the UI |
forceLanguage | "" | Force the UI to use a specific language (e.g. "zh", "en"). Overrides the user's browser language. Empty means no override. |
defaultLanguage | "en" | Default UI language when no browser preference or force override is set |
defaultApplication | "app-built-in" | Name of the application to redirect to after sign-in when no specific application is requested |
maxItemsForFlatMenu | 7 | Maximum number of items to show in a flat (non-grouped) sidebar menu. When the count exceeds this, the menu switches to a tree/grouped view |
enableErrorMask | falsch | Whether to mask detailed error messages |
enableErrorMask2 | falsch | Replace every API error message with a generic one, so that responses don't reveal why a request failed |
enableGzip | wahr | Accept and respond with gzip encoding when client supports it |
inactiveTimeoutMinutes | (empty) | Automatic sign-out timeout in minutes. Empty or ≤0 means no timeout |
ldapServerPort | 389 | Port for LDAP server |
ldapsCertId | "" | Certificate ID for LDAPS connections |
ldapsServerPort | 636 | Port for LDAPS (LDAP over SSL) server |
radiusServerPort | 1812 | Port for RADIUS server |
radiusDefaultOrganization | "built-in" | Default organization for RADIUS authentication |
radiusSecret | "secret" | Shared secret for RADIUS authentication |
gatewayHttpPort | 80 | HTTP port of the reverse-proxy gateway for Sites. The gateway only starts when at least one site exists |
gatewayHttpsPort | 443 | HTTPS port of the reverse-proxy gateway for Sites |
acmeEmail | (empty) | Email of the ACME (Let's Encrypt) account used to issue certificates for Sites |
acmePrivateKey | (empty) | Private key (PEM) of that ACME account |
kontingent | {"organization": -1, "user": -1, "application": -1, "provider": -1} | Resource quotas (-1 means unlimited) |
logConfig | {"adapter":"file", "filename": "logs/casdoor.log", "maxdays":99999, "perm":"0770"} | Logging configuration (adapter, file path, rotation, permissions) |
initDataNewOnly | falsch | Only add the objects of the init data file that don't exist yet, existing ones are left as they are |
initDataMerge | false | Update the existing objects with only the fields set in the init data file, instead of deleting and re-creating them |
initDataFile | "./init_data.json" | Path to the data initialization file, JSON or YAML (.yaml/.yml). See Data initialization |
initDataWatchInterval | 0 | Seconds between the checks of the init data file for changes, a changed file is applied again without a restart. 0 applies it only at startup |
frontendBaseDir | "../cc_0" | Base directory for frontend files (only for development) |
Override options with environment variables
An environment variable with the same name as an option in app.conf overrides the value in the file. The name must match the option name exactly, including case. Some Beego options, such as httpport and appname, work the same way.
Set a variable for one run:
appname=casbin go run main.go
Or export it in the shell before you start Casdoor:
export httpport=9000
./casdoor
In Docker, pass the options with -e. See Try with Docker.
Options that affect the admin console
The frontend reads the following options from the backend at runtime. Change them in app.conf or with environment variables and restart the backend. You don't need to rebuild the frontend.
| Option | Effect on the admin console |
|---|---|
defaultApplication | Application whose sign-in page appears when the request names no application |
defaultLanguage | Language used when the browser doesn't ask for a supported one |
forceLanguage | Language used for every user, regardless of the browser language |
isDemoMode | Restricts what the console allows, for public demo sites |
maxItemsForFlatMenu | Number of top menu items above which the menu is grouped |
showGithubCorner | Shows the GitHub corner ribbon |
staticBaseUrl | Base URL of static images such as logos and avatars |
Compile-time frontend settings
The compile-time defaults of the options above, the default theme (ThemeDefault), and an optional custom footer (CustomFooter) are in web/src/Conf.ts. After you change that file, rebuild the frontend:
cd web
yarn build
To set a theme for one organization or one application, use the admin console instead. See Customize the theme.