跳转至

参数列表

JumpServer 参数说明文档

Core 参数说明

SECRET_KEY: ****           # 用来加密解密的 KEY
BOOTSTRAP_TOKEN: ****      # koko/guacamole 用来向jms注册使用的 token
DEBUG: TRUE                # 是否开启 debug 模式,显示更多信息  开启以后,界面可以显示API调用信息
SITE_URL:  http://1.2.3.4  # 网站的地址,发邮件时使用该地址来做 连接 跳转
LOG_LEVEL: DEBUG           # 日志级别
DB_ENGINE: mysql           # 数据库配置
DB_NAME: jumpserver        # 数据库配置
DB_HOST: 127.0.0.1         # 数据库配置
DB_PORT: 3306              # 数据库配置
DB_USER: root              # 数据库配置
DB_PASSWORD: ****          # 数据库配置
REDIS_HOST: 127.0.0.1      # redis 配置
REDIS_PORT: 6379           # redis 配置
REDIS_PASSWORD: ****       # redis 配置    
REDIS_DB_CELERY: 3         # 存放任务相关信息,包括普通 celery 任务(如发送邮件)和 ansible 任务(如测试资产可连接性)
REDIS_DB_CACHE: 4          # 存放一些程序中所需的缓存数据(如用户授权资产树结构等)
REDIS_DB_SESSION: 5        # 存放用户 session 相关信息
REDIS_DB_WS: 6             #  存放 websocket 相关信息
TOKEN_EXPIRATION: 86400    # api 生成 token 的有效期  调用API会使用到
SESSION_COOKIE_DOMAIN: None   # session 生效域名,多个 jumpserver 共享 session 时使用
CSRF_COOKIE_DOMAIN: None      # csrftoken 生效域名,多个 jumpserver 共享 session 时使用
SESSION_COOKIE_AGE: 86400     # session 有效期  默认界面用户不需要密码自动化登录时间
SESSION_EXPIRE_AT_BROWSER_CLOSE: FALSE  # 关闭浏览器失效登录的 session

# AUTH_OPENID  -  -  查看 Core 配置 AUTH_OPENID 文档
# AUTH_CAS - - 查看 Core 配置 AUTH_CAS 文档

OTP_VALID_WINDOW: 2            # OTP/MFA 延迟几次依然有效
OTP_ISSUER_NAME: Jumpserver    # OTP/MFA 扫描后的名称
EMAIL_SUFFIX: jumpserver.org   # 邮箱后缀,ldap 用户时,如果没有邮箱,会用 用户名@默认后缀   

# AUTH_RADIUS  - - 查看 Core 配置 AUTH_RADIUS 文档

AUTH_LDAP_SEARCH_PAGED_SIZE: 1000   # LDAP 搜索分页数量
AUTH_LDAP_SYNC_IS_PERIODIC: FALSE   # 是否定时同步 ldap 用户
AUTH_LDAP_SYNC_INTERVAL: None       # 同步间隔(单位:时)(优先)
AUTH_LDAP_SYNC_CRONTAB: None        # 同步 Crontab 表达式

AUTH_LDAP_USER_LOGIN_ONLY_IN_USERS: FALSE   # LDAP 用户登录时仅允许在用户列表中的用户执行 LDAP Server 认证
AUTH_LDAP_OPTIONS_OPT_REFERRALS: -1         # LDAP 认证时如果日志中出现以下信息将参数设置为 0
# In order to perform this operation a successful bind must be completed on the connection (详情参见:https://www.python-ldap.org/en/latest/faq.html) 一般用于LDAP配置正确,但是就是无法登录

# AUTH_LDAP 配置使用 SSL 证书认证  无
# 设置 LDAP 使用证书认证:
# LDAP 配置 SSL 证书(证书文件名及存放位置  JumpServer 部署机:/opt/jumpserver/core/data/certs/ldap_ca.pem )
# 添加证书好后,JumpServer 会自动发现并使用证书进行认证,不需要额外的配置项。
# 证书需要是 pem 后缀,如果导出的证书为其他类型,请自行 google 转码。

HTTP_BIND_HOST: 0.0.0.0           # http 监听 Host
HTTP_LISTEN_PORT: 8080            # http 监听端口
WS_LISTEN_PORT: 8070              # websocket 监听端口
LOGIN_LOG_KEEP_DAYS: 90           # 登录日志保留时长
ASSETS_PERM_CACHE_TIME: 86400     # 资产授权缓存时间
SECURITY_MFA_VERIFY_TTL: 3600     # 需要 MFA 确认时,确认后多少时间内不用再次确认
ASSETS_PERM_CACHE_ENABLE: FALSE   # 是否启用资产缓存
SYSLOG_ADDR: 192.168.0.1          # syslog 的地址,多个地址逗号隔开(,)
SYSLOG_FACILITY: user

PERM_SINGLE_ASSET_TO_UNGROUP_NODE: FALSE  # 单独授权的资产(没有授权其所在节点)将该资产放入到未分组节点下
WINDOWS_SSH_DEFAULT_SHELL: cmd            # windows 支持 ansible 时,使用的 shell
PERIOD_TASK_ENABLED: TRUE                 # (1.5.2之后版本) 启用内部任务  内部自动推送用户,获取资产信息等任务
PERIOD_TASK: TRUE                         # (1.5.2及之前版本) 启用内部任务

LOGIN_LOG_KEEP_DAYS: 90                   # 登陆日志保存默认保存时间  登陆日志保存时间,单位天。超过这个时间,后台将自动清理相应的登录信息,即使在页面中设置的审计周期超过对应的的配置参数,也只能查看最近配置(90天)的登录日志。

SECURITY_VIEW_AUTH_NEED_MFA: True         # 查看或导出密码,需要 MFA
SECURITY_LOGIN_CHALLENGE_ENABLED: False   # 登录页面是否开启 CHALLENGE 输入框
SECURITY_LOGIN_CAPTCHA_ENABLED: True      # 登录页面是否开启验证码
AUTH_SSO: False                           # 是否开启其他系统到 JumpServer 的单点登录
AUTH_SSO_AUTHKEY_TTL: 900s                # 单点登录 token 有效时长 (单位:秒)
USER_LOGIN_SINGLE_MACHINE_ENABLED: False  # 只允许用户一个浏览器登录

KoKo 参数说明

NAME: hostname                    # 默认是主机名
CORE_HOST: http://127.0.0.1:8080  # Jumpserver 项目的 url,api 请求注册会使用
BOOTSTRAP_TOKEN: *****            # 预共享秘钥,请和 jumpserver 配置文件中保持一致。
BIND_HOST: 0.0.0.0                # 启动时绑定的 ip, 默认 0.0.0.0
SSHD_PORT: 2222                   # 监听的 SSH 端口号
HTTPD_PORT: 5000                  # 监听的 HTTP/WS 端口号
# ACCESS_KEY:                     # 项目使用的 ACCESS KEY, 默认会注册,并保存到文件
ACCESS_KEY_FILE: data/keys/.access_key  # ACCESS KEY 保存的地址, 默认注册后会保存到该文件中
LOG_LEVEL: DEBUG                  # 可选 [DEBUG, INFO, WARN, ERROR, FATAL, CRITICAL]  debug 模式会自动把用后手动登录填写的密码打印,info 级别不需要
SSH_TIMEOUT: 15                   # SSH 连接超时时间(单位: 秒)  如果用户服务器启用了 useDNS 这些参数,有可能登录时间超过 15S,需要修改此参数
LANG: zh                          # 可选 [en, zh]  切换 KOKO 登录界面中英文
SFTP_ROOT: /tmp                   # SFTP 的根目录, 可选 /tmp, Home 其他自定义目录  1.5.7起已弃用这个选项,需要在在 core 的系统用户页面上配置
SFTP_SHOW_HIDDEN_FILE: false      # SFTP 是否显示隐藏文件
REUSE_CONNECTION: true            # 是否复用同一用户的 SSH 连接
# ASSET_LOAD_POLICY:              # all 则用户资产缓存本地搜索分页;默认异步加载资产, 异步搜索分页;   
ZIP_MAX_SIZE: 1024M               # web sftp 文件下载,zip 支持压缩的最大额度 (单位: M)
ZIP_TMP_PATH: /tmp                # web sftp 文件下载,zip压缩文件存放的临时目录
CLIENT_ALIVE_INTERVAL: 30         # 用户 SSH 登陆 koko 之后,Koko 给 SSH client 发送的心跳间隔,默认 30,0 则表示不发送  保持登陆用户连接不断开
RETRY_ALIVE_COUNT_MAX: 3          # 登陆资产之后,Koko 向资产发送心跳包出现错误的重试次数,默认为3。  当网络不稳定时,可以数值可设置大一些。
SHARE_ROOM_TYPE: local            # 可选择 local 和 redis  会话监控和共享使用的方式
REDIS_HOST: 127.0.0.1             # redis 配置
REDIS_PORT: 6379                  # redis 配置
REDIS_PASSWORD:                   # redis 配置
REDIS_CLUSTERS:                   # redis 配置
REDIS_DB_ROOM: 0                  # redis 配置  选择的 redis 库索引

Guacamole 参数说明

GUACAMOLE_LOG_LEVEL: INFO            # 日志级别 DEBUG,INFO,WARN,ERROR  INFO
JUMPSERVER_SERVER: http://core:8080  # core 地址
BOOTSTRAP_TOKEN: *****               # 注册时预共享 TOKEN
JUMPSERVER_KEY_DIR: /config/guacamole/            # 注册后 Key 文件保存目录
JUMPSERVER_RECORD_PATH: /config/guacamole/record  # 录像保存目录
JUMPSERVER_DRIVE_PATH: /config/guacamole/drive    # 上传文件保存目录
JUMPSERVER_CLEAR_DRIVE_SESSION: false  # 连接断开时清理上传文件 true, false(不清理)
JUMPSERVER_CLEAR_DRIVE_SCHEDULE: 24    # 清理多久以前的上传文件(每隔1小时)  大于1的数值  无(不设置环境变量就不清理)
JUMPSERVER_COLOR_DEPTH: 24             # 颜色深度 8,16,24,32
# JUMPSERVER_DPI:                      # 图像每英寸长度内的像素点数

JUMPSERVER_DISABLE_ALL_UPLOAD_DOWNLOAD: false  # 全局禁用上传下载(>= 2.2.3 版本支持)
JUMPSERVER_DISABLE_ALL_COPY_PASTE: false      # 全局禁用剪切板粘贴复制(>= 2.2.3 版本支持)

JUMPSERVER_DISABLE_AUDIO: false               # 禁止声音 true, false  无(允许声音)
JUMPSERVER_ENABLE_WALLPAPER: false            # 启用墙纸 true, false  无(禁用)
JUMPSERVER_ENABLE_THEMING: false              # 启用主题 true, false  无(禁用)
JUMPSERVER_ENABLE_FONT_SMOOTHING: false       # 启用平滑字体 true, false  无(禁用)
JUMPSERVER_ENABLE_FULL_WINDOW_DRAG: false     # 启用拖拽窗口时渲染全部内容 true, false  无(禁用)
JUMPSERVER_ENABLE_DESKTOP_COMPOSITION: false  # 启用透明窗口和阴影等图形效果 true, false  无(禁用)
JUMPSERVER_ENABLE_MENU_ANIMATIONS: false      # 启用菜单开关动画 true, false  无(禁用)
JUMPSERVER_DISABLE_BITMAP_CACHING: true       # 禁用RDP的内置位图缓存功能 true(禁用), false(启用)  无(启用)
JUMPSERVER_DISABLE_OFFSCREEN_CACHING: true    # 禁用客户端中当前不可见的屏幕区域缓存 true(禁用), false(启用)  无(启用)
JUMPSERVER_DISABLE_GLYPH_CACHING: true        # 禁用RDP会话中的字形缓存 true(禁用), false(启用)  无(启用)