跳到主内容

配置

Casdoor通过后端和前端的独立文件进行配置。 本页面记录了所有支持的选项。

后端配置(app.conf)

后端读取一个配置文件:conf/app.conf。 对于最小化配置,请为您的数据库设置 driverNamedataSourceName(请参阅配置数据库)。 下表列出了每个选项。

参数默认值描述
appnamecasdoor应用名称(目前无实际用途)
httpport8000后端应用程序监听的端口
runmodedev运行模式:devprod
copyrequestbodytrue是否复制请求体以供后续使用
driverNamemysql数据库驱动程序(例如:mysqlpostgressqlite)。 请参阅配置数据库
dataSourceNameroot:123456@tcp(localhost:3306)/数据库连接字符串。 请参阅配置数据库
dbNamecasdoorCasdoor 使用的数据库名称
tableNamePrefix(empty)使用适配器时表名的前缀
showSqlfalse当日志级别大于INFO时,在日志中显示 SQL 语句
redisEndpoint(empty)用于会话存储的Redis端点(例如:localhost:6379)。 如果为空,会话将存储在本地./tmp中。 对于密码: 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)文件上传(例如头像)的默认存储提供程序名称。 请参阅 storage
isCloudIntranetfalse提供者端点是否使用内网地址
authState"casdoor"登录时检查的授权应用名称
socks5Proxy"127.0.0.1:10808"OAuth提供商(Google、GitHub等)的SOCKS5代理地址 可能被阻止
verificationCodeTimeout10验证码有效期,单位:分钟
initScore0分配给新用户的初始分数(由Casnode使用,而非Casdoor)
logPostlytrue是否只记录 POST 请求
isUsernameLoweredfalse是否将用户名转换为小写
origin(empty)后端源URL(例如:https://door.casdoor.com
originFrontend(empty)若前后端URL不同则以前端URL为准
staticBaseUrl"https://cdn.casbin.org"数据库初始化期间使用静态资源的 CDN URL
isDemoModefalse启用演示模式限制
batchSize100批量操作的批量大小
showGithubCornerfalse在界面上显示 GitHub 角操作区
force Language""强制UI使用特定语言(例如zh, en)。 覆盖用户的浏览器语言。 空值表示不进行覆盖。
defaultLangue"en"当未设置浏览器偏好或强制覆盖时的默认UI语言
aiAssistantUrl"https://ai.casbin.com"集成到Casdoor UI中的AI助手服务的URL
defaultApplication"app-built-in"登录后未指定具体应用时重定向到的应用程序名称
maxItemsForFlatMenu7平铺(非分组)侧栏菜单中最多显示的项目数。 当计数超过此值时,菜单将切换为树状/分组视图
enableErrorMaskfalse是否屏蔽详细错误消息
enableGziptrue当客户端支持时,接受并以gzip编码响应
inactiveTimeoutMinutes(empty)自动注销在几分钟后超时。 为空或≤0表示无超时
ldapServerPort389LDAP服务器端口
ldapsCertId""LDAPS 连接的证书 ID
ldapsServerPort636LDAPS(LDAP over SSL)服务器端口
radiusServerPort1812RADIUS服务器端口
radiusDefaultOrganization"built-in"RADIUS认证的默认组织
radiusSecret"secret"RADIUS认证共享密钥
quota{"organization": -1, "user": -1, "application": -1, "provider": -1}资源配额(-1 表示无限制)
logConfig"{"adapter":"file", "filename": "logs/casdoor.log", "maxday":9999999, "perm":"0770"}"日志配置 (适配器、文件路径、旋转、权限)
initDataNewOnlyfalse是否仅为新安装初始化数据
initDataFile`"./init_data.json""数据初始化文件路径。 请参阅数据初始化
frontendBaseDir`"../cc_0"前端文件的基础目录 (仅用于开发)

环境变量

app.conf 中的每个 Casdoor 选项均可通过同名的环境变量进行覆盖。 部分 Beego 选项(例如 httpportappname)也受支持。

示例:通过环境变量传递配置启动Casdoor:

appname=casbin go run main.go

变量也可以在 shell 中使用 export 命令导出。 变量名必须与 app.conf 中的键名完全匹配。

备注

环境变量会覆盖 app.conf 中的值。

前端配置(Conf.js)

前端配置位于 web/src/Conf.js。 这些选项控制Casdoor Web UI的行为和外观。

参数默认值描述
默认应用程序"app-built-in"未指定时用于登录的默认应用程序
CasvisorUrl""Casvisor 集成的 URL。 留空以禁用
ShowGithubCornerfalse是否在界面中显示 GitHub 角链接
IsDemoModefalse是否以前端以演示模式运行并受限制
强制语言""强制所有用户使用特定语言。 留空以允许用户选择
DefaultLangue"en"没有设置用户偏好时界面的默认语言
InitThemeAlgorithmtrue是否启用主题算法进行UI样式设置
ThemeDefault{themeType: "default", colorPrimary: "#5734d3", borderRadius: 6, isCompact: false}默认主题设置,包括主题类型、主颜色、边框半径和紧凑模式
CustomFoternull自定义页脚内容。 设置为 null 以使用默认页脚
AiAssistantUrl"https://ai.casbin.com"AI 助手功能的 URL。 设置为空白或 null 以隐藏AI 助手按钮
MaxItemsForFlatMenu7切换为分组/下拉菜单前导航栏项目的最大数量

主题选项

ThemeDefault 对象支持:

属性类型描述
themeTypestring主题类型: "default", "dark", 或 "compact"
colorPrimarystring以十六进制格式表示的主色调(例如:"#5734d3"
borderRadiusnumberUI 元素边框半径
isCompactboolean是否使用紧凑模式来处理密闭界面

应用更改

  1. 编辑您Casdoor树中的web/src/Conf.js
  2. 根据需要调整值。
  3. 重建前端:在 web 目录中运行 yarn build
提示

在开发过程中,对Conf.js的更改生效后,请重启开发服务器(在web目录中运行yarn start)。