跳到主要内容

参数说明

1 组件启停参数​

默认全部组件都会启动,不需要某个组件时,将对应的 {组件名}_ENABLED 设为 0 即可关闭:

表 1 组件启停参数说明
参数名称默认值可选项说明
CORE_ENABLED10
1
Core 服务开关
KAEL_ENABLED10
1
Kael 组件开关
CELERY_ENABLED10
1
Celery 任务组件开关
KOKO_ENABLED10
1
KoKo 组件开关(SSH / Web 终端)
CHEN_ENABLED10
1
Chen 组件开关(作业执行)
WEB_ENABLED10
1
Web 前端开关
VIDEO_WORKER_ENABLED10
1
录像转换服务开关(企业版)
CELERY_PRIVILEGEDtruetrue
false
Celery 容器是否以特权模式运行
KOKO_PRIVILEGEDtruetrue
false
KoKo 容器是否以特权模式运行,为 false 时 Kubernetes 集群连接会提示部署权限不足

2 Core 参数说明​

Core 参数如下:

表 2 Core 参数说明
参数名称默认值可选项说明
SECRET_KEY''-用于对敏感字段进行加解密的 Key
BOOTSTRAP_TOKEN''-用于组件向 Core 服务注册使用的 Token
DEBUGfalsetrue
false
Debug 模式,如果开启页面请求 API 报错时会显示更多信息
DEBUG_DEVfalsetrue
false
Debug 开发模式,如果开启后端日志会显示更多信息
LOG_LEVELDEBUGDEBUG
INFO
WARNING
ERROR
CRITICAL
日志级别
LOG_DIR/opt/jumpserver/data/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-Reids 地址
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_REQUIRED'none'-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 的有效期
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(s)-有效期内 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(直接进入内部登录页面)
第三方认证的服务提供商名称
开启第三方认证后,不出现倒计时跳转页面直接跳转到指定认证服务
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
es
ko
ru
vi
语言
TIME_ZONEAsia/Shanghai-时区
SESSION_COOKIE_SECUREfalsetrue
false
用户 Session Cookie 安全模式,开启后只允许在 https 协议下发送
DOMAINS''-指定JumpServer应用程序允许的域名
CSRF_COOKIE_SECUREfalsetrue
false
用户 CSRF Token 安全模式,开启后只允许在 https 协议下发送
REFERER_CHECK_ENABLEDfalsetrue
false
是否开启 REFERER 校验
SESSION_ENGINEcache-用户 Session 引擎
SESSION_SAVE_EVERY_REQUESTtruetrue
false
每个请求都要保存用户 Session
SERVER_REPLAY_STORAGE{}-服务端录像存储,可配置将录像上传到对象存储服务
CHANGE_AUTH_PLAN_SECURE_MODE_ENABLEDtruetrue
false
改密计划安全模式
SECURITY_VIEW_AUTH_NEED_MFAtruetrue
false
需要校验 MFA
SECURITY_DATA_CRYPTO_ALGOnull-数据加密算法
GMSSL_ENABLEDfalsetrue
false
开启国密算法
OPERATE_LOG_ELASTICSEARCH_CONFIG{}-操作日志“变更字段”的存储 ES 配置
APPLET_DOWNLOAD_HOST''-Applet 等软件的下载地址
FTP_FILE_MAX_STORE0-FTP 文件上传下载备份阈值,单位(M),当值<=0时,不备份文件
MAX_LIMIT_PER_PAGE10000-设置允许的最大导出记录数
FILE_UPLOAD_SIZE_LIMIT_MB200-设置文件上传的最大大小限制(单位:MB)
THROTTLE_RATES_ANON2048/minstring未登录用户访问限流
THROTTLE_RATES_USER4096/minstring用户访问限流
THROTTLE_RATES_SERVICE_ACCOUNT20480/minstring组件账号访问限流

3 后续操作​

配置文件的编辑步骤与生效方式见 系统参数设置;应用日志、Syslog、会话命令与录像见 日志存储配置;启停命令见 命令行工具。