跳到主要内容

系统参数设置

1 功能简介​

系统参数写在安装目录的 config.txt 中,控制数据库、Redis、日志、会话 Cookie、认证跳转、Syslog、录像存储等。默认路径:

/opt/jumpserver/config/config.txt

2 前提条件​

  • 已使用具备服务器权限的账号登录 JumpServer 所在主机。
  • 已备份当前 config.txt。
  • 修改前须停止 JumpServer 服务,避免写到一半导致组件连不上。
修改前先停止服务

先执行 ./jmsctl.sh stop,改完配置再 ./jmsctl.sh start 或 ./jmsctl.sh restart。命令说明见 命令行工具。

3 编辑配置​

  1. 进入安装目录(常见为 /opt/jumpserver)。
  2. 停止服务。
  3. 打开配置文件:
vi /opt/jumpserver/config/config.txt
  1. 保存后启动或重启服务。
  2. 执行 ./jmsctl.sh status 确认组件正常。

也可用 ./jmsctl.sh config env 调整环境变量,效果与直接编辑 config.txt 相同,改完同样需要重启。

4 Core 参数说明​

表 1 Core 参数说明
参数名称默认值可选项说明
SECRET_KEY''—用于对敏感字段进行加解密的 Key
BOOTSTRAP_TOKEN''—用于组件向 Core 服务注册使用的 Token
DEBUGfalsetrue
false
Debug 模式,如果开启页面请求 API 报错时会显示更多信息
DEBUG_DEVfalsetrue
false
Debug 开发模式,如果开启后端日志会显示更多信息
LOG_LEVELDEBUGDEBUG
INFO
WARNING
ERROR
CRITICAL
日志级别
LOG_DIR/data/jumpserver/core/logs—日志目录
DB_ENGINEmysql—数据库引擎
DB_NAMEjumpserver—数据库名
DB_HOST127.0.0.1—数据库地址
DB_PORT3306—数据库端口
DB_USERroot—数据库用户
DB_PASSWORD''—数据库用户密码
DB_USE_SSLfalsetrue
false
数据库启用 SSL 方式
REDIS_HOST127.0.0.1—Redis 地址
REDIS_PORT6379—Redis 端口
REDIS_PASSWORD''—Redis 密码
REDIS_USE_SSLfalsetrue
false
Redis 启用 SSL 方式
REDIS_SSL_KEYnull—Redis SSL Key
REDIS_SSL_CERTnull—Redis SSL Cert 证书
REDIS_SSL_CAnull—Redis SSL CA Cert 证书
REDIS_SSL_REQUIREDnull—Redis SSL 证书是否必须
REDIS_MAX_CONNECTIONS100—Redis 最大连接数
REDIS_SENTINEL_HOSTS''—Redis 哨兵地址(多个地址使用 / 分割)
REDIS_SENTINEL_PASSWORD''—Redis 哨兵密码
REDIS_SENTINEL_SOCKET_TIMEOUTnull—Redis 哨兵 Socket 超时时间
REDIS_DB_CELERY30-15Redis 库编号,Celery 任务使用
REDIS_DB_CACHE40-15Redis 库编号,缓存使用
REDIS_DB_SESSION50-15Redis 库编号,用户 Session 使用
REDIS_DB_WS6—Redis 库编号,WebSocket 使用
TOKEN_EXPIRATION3600 * 24(s)—通过 API 创建用户 Token 的有效期;配置为空或 0 时默认 3600
DEFAULT_EXPIRED_YEARS70(year)—创建资源的默认过期年份,例如授权规则,不允许修改
SESSION_COOKIE_DOMAINnull—用户 Session Cookie 域,例如 fit2cloud.com
CSRF_COOKIE_DOMAINnull—用户 CSRF Cookie 域,默认与 SESSION_COOKIE_DOMAIN 保持一致
SESSION_COOKIE_NAME_PREFIXnull—Session Cookie 的名称前缀
SESSION_COOKIE_AGE3600 * 24(s)—用户 Session Cookie 的有效期
SESSION_EXPIRE_AT_BROWSER_CLOSEfalsetrue
false
用户 Session 在浏览器关闭后过期
CONNECTION_TOKEN_ONETIME_EXPIRATION5 * 60>= 5 * 60有效期内 ConnectionToken 只能使用一次
CONNECTION_TOKEN_REUSABLE_EXPIRATION3600 * 24 * 30(s)—有效期内 ConnectionToken 可以多次使用
CONNECTION_TOKEN_REUSABLEfalsetrue
false
ConnectionToken 是否可以多次使用
AUTH_CUSTOMfalsetrue
false
开启自定义用户认证
AUTH_CUSTOM_FILE_MD5''—自定义用户认证的文件 md5 值
MFA_CUSTOMfalsetrue
false
开启自定义 MFA 认证
MFA_CUSTOM_FILE_MD5''—自定义 MFA 认证的文件 md5 值
AUTH_TEMP_TOKENfalsetrue
false
开启临时密码功能
AUTH_SSOfalsetrue
false
启用 SSO 认证
AUTH_SSO_AUTHKEY_TTL60 * 15(s)—SSO 认证密钥 TTL
LOGIN_REDIRECT_TO_BACKEND''Direct(直接进入内部登录页面)
OpenID
CAS
SAML2
OAuth2 的服务提供商名称
开启第三方认证后,不出现倒计时跳转页面,直接跳转到认证服务
LOGIN_REDIRECT_MSG_ENABLEDtruetrue
false
开启第三方跳转倒计时页面
SYSLOG_ADDR''—SysLog 服务地址
SYSLOG_FACILITYuser—SysLog FACILITY
SYSLOG_SOCKTYPE2—SysLog SockType
PERM_EXPIRED_CHECK_PERIODIC60 * 60(s)—校验过期的资产授权规则并过期用户授权树的周期
LANGUAGE_CODEenzh
en
ja
语言
TIME_ZONEAsia/Shanghai—时区
SESSION_COOKIE_SECUREfalsetrue
false
用户 Session Cookie 安全模式,开启后只允许在 https 协议下发送
DOMAINS''—指定 JumpServer 应用程序允许的域名
CSRF_COOKIE_SECUREfalsetrue
false
用户 CSRF Token 安全模式,开启后只允许在 https 协议下发送
REFERER_CHECK_ENABLEDfalsetrue
false
是否开启 REFERER 校验
CSRF_TRUSTED_ORIGINS——CSRF 同源信任,多个地址使用逗号分割
SESSION_ENGINEcache—用户 Session 引擎
SESSION_SAVE_EVERY_REQUESTtruetrue
false
每个请求都要保存用户 Session
SESSION_EXPIRE_AT_BROWSER_CLOSE_FORCEfalsetrue
false
浏览器关闭后强制过期用户 Session
SERVER_REPLAY_STORAGE空对象—服务端录像存储。组件上传录像到 Core 后,Core 自动上传到配置的对象存储
CHANGE_AUTH_PLAN_SECURE_MODE_ENABLEDtruetrue
false
改密计划安全模式。启用后不支持用户改自己的密文;禁用后支持,例如 root 改 root
SECURITY_VIEW_AUTH_NEED_MFAtruetrue
false
查看密文等操作是否需要校验 MFA
SECURITY_DATA_CRYPTO_ALGOnull—数据加密算法
GMSSL_ENABLEDfalsetrue
false
开启国密算法。若与 SECURITY_DATA_CRYPTO_ALGO 同时配置,优先使用 SECURITY_DATA_CRYPTO_ALGO
OPERATE_LOG_ELASTICSEARCH_CONFIG空对象—操作日志「变更字段」的 Elasticsearch 配置
MAGNUS_ORACLE_PORTS30000-30030—Magnus 组件需要监听的 Oracle 端口范围
APPLET_DOWNLOAD_HOST''—Applet 等软件的下载地址
FTP_FILE_MAX_STORE0—FTP 文件上传下载备份阈值,单位 MB;小于等于 0 时不备份
MAX_LIMIT_PER_PAGE10000—允许的最大导出记录数
FILE_UPLOAD_SIZE_LIMIT_MB200—文件上传大小上限,单位 MB
THROTTLE_RATES_ANON60/minstring未登录用户访问限流
THROTTLE_RATES_USER180/minstring用户访问限流
THROTTLE_RATES_SERVICE_ACCOUNT300/minstring组件账号访问限流
JSON 类参数

SERVER_REPLAY_STORAGE、OPERATE_LOG_ELASTICSEARCH_CONFIG 须填写合法 JSON。示例结构见安装部署中的 参数说明。配错会导致服务起不来,改前请备份文件。

5 后续操作​