参数说明

注意

  • 修改配置文件前请先关闭 JumpServer 服务。

1 Core 参数说明

  • 打开 config.txt 配置文件。
  1. vi /opt/jumpserver/config/config.txt
  • Core 参数如下:
  1. SECRET_KEY=**** # 用来加密解密的 KEY
  2. BOOTSTRAP_TOKEN=**** # koko/lion 用来向jms注册使用的 token
  3. DEBUG=True # 是否开启 debug 模式,显示更多信息 开启以后,界面可以显示API调用信息
  4. SITE_URL= http://1.2.3.4 # 网站的地址,发邮件时使用该地址来做 连接 跳转
  5. LOG_LEVEL=DEBUG # 日志级别
  6. DB_ENGINE=mysql # 数据库配置
  7. DB_NAME=jumpserver # 数据库配置
  8. DB_HOST=127.0.0.1 # 数据库配置
  9. DB_PORT=3306 # 数据库配置
  10. DB_USER=root # 数据库配置
  11. DB_PASSWORD=**** # 数据库配置
  12. REDIS_HOST=127.0.0.1 # redis 配置
  13. REDIS_PORT=6379 # redis 配置
  14. REDIS_PASSWORD=**** # redis 配置
  15. REDIS_DB_CELERY=3 # 存放任务相关信息,包括普通 celery 任务(如发送邮件)和 ansible 任务(如测试资产可连接性)
  16. REDIS_DB_CACHE=4 # 存放一些程序中所需的缓存数据(如用户授权资产树结构等)
  17. REDIS_DB_SESSION=5 # 存放用户 session 相关信息
  18. REDIS_DB_WS=6 # 存放 websocket 相关信息
  19. TOKEN_EXPIRATION=86400 # api 生成 token 的有效期 调用API会使用到
  20. SESSION_COOKIE_DOMAIN=None # session 生效域名,多个 jumpserver 共享 session 时使用
  21. CSRF_COOKIE_DOMAIN=None # csrftoken 生效域名,多个 jumpserver 共享 session 时使用
  22. SESSION_COOKIE_AGE=86400 # session 有效期 默认界面用户不需要密码自动化登录时间
  23. SESSION_EXPIRE_AT_BROWSER_CLOSE=False # 关闭浏览器失效登录的 session
  24. # AUTH_OPENID - - 查看 Core 配置 AUTH_OPENID 文档
  25. # AUTH_CAS - - 查看 Core 配置 AUTH_CAS 文档
  26. OTP_VALID_WINDOW=2 # OTP/MFA 延迟几次依然有效
  27. OTP_ISSUER_NAME=Jumpserver # OTP/MFA 扫描后的名称
  28. EMAIL_SUFFIX=jumpserver.org # 邮箱后缀,ldap 用户时,如果没有邮箱,会用 用户名@默认后缀
  29. # AUTH_RADIUS - - 查看 Core 配置 AUTH_RADIUS 文档
  30. AUTH_LDAP_SEARCH_PAGED_SIZE=1000 # LDAP 搜索分页数量
  31. AUTH_LDAP_SYNC_IS_PERIODIC=False # 是否定时同步 ldap 用户
  32. AUTH_LDAP_SYNC_INTERVAL=None # 同步间隔(单位:时)(优先)
  33. AUTH_LDAP_SYNC_CRONTAB=None # 同步 Crontab 表达式
  34. AUTH_LDAP_USER_LOGIN_ONLY_IN_USERS=False # LDAP 用户登录时仅允许在用户列表中的用户执行 LDAP Server 认证
  35. AUTH_LDAP_OPTIONS_OPT_REFERRALS=-1 # LDAP 认证时如果日志中出现以下信息将参数设置为 0
  36. # 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配置正确,但是就是无法登录
  37. # AUTH_LDAP 配置使用 SSL 证书认证 无
  38. # 设置 LDAP 使用证书认证:
  39. # LDAP 配置 SSL 证书(证书文件名及存放位置 JumpServer 部署机:/opt/jumpserver/core/data/certs/ldap_ca.pem )
  40. # 添加证书好后,JumpServer 会自动发现并使用证书进行认证,不需要额外的配置项。
  41. # 证书需要是 pem 后缀,如果导出的证书为其他类型,请自行 google 转码。
  42. HTTP_BIND_HOST=0.0.0.0 # http 监听 Host
  43. HTTP_LISTEN_PORT=8080 # http 监听端口
  44. WS_LISTEN_PORT=8070 # websocket 监听端口
  45. ASSETS_PERM_CACHE_TIME=86400 # 资产授权缓存时间
  46. SECURITY_MFA_VERIFY_TTL=3600 # 需要 MFA 确认时,确认后多少时间内不用再次确认
  47. ASSETS_PERM_CACHE_ENABLE=False # 是否启用资产缓存
  48. SYSLOG_ADDR=192.168.0.1 # syslog 的地址,多个地址逗号隔开(,)
  49. SYSLOG_FACILITY=user
  50. PERM_SINGLE_ASSET_TO_UNGROUP_NODE=False # 单独授权的资产(没有授权其所在节点)将该资产放入到未分组节点下
  51. WINDOWS_SSH_DEFAULT_SHELL=cmd # windows 支持 ansible 时,使用的 shell
  52. PERIOD_TASK_ENABLED=True # (1.5.2之后版本) 启用内部任务 内部自动推送用户,获取资产信息等任务
  53. PERIOD_TASK=True # (1.5.2及之前版本) 启用内部任务
  54. LOGIN_LOG_KEEP_DAYS=90 # 登陆日志保存默认保存时间 登陆日志保存时间,单位天。超过这个时间,后台将自动清理相应的登录信息,即使在页面中设置的审计周期超过对应的的配置参数,也只能查看最近配置(90天)的登录日志。
  55. SECURITY_VIEW_AUTH_NEED_MFA=True # 查看或导出密码,需要 MFA
  56. SECURITY_LOGIN_CHALLENGE_ENABLED=False # 登录页面是否开启 CHALLENGE 输入框
  57. SECURITY_LOGIN_CAPTCHA_ENABLED=True # 登录页面是否开启验证码
  58. AUTH_SSO=False # 是否开启其他系统到 JumpServer 的单点登录
  59. AUTH_SSO_AUTHKEY_TTL=900 # 单点登录 token 有效时长 (单位:秒)
  60. USER_LOGIN_SINGLE_MACHINE_ENABLED=False # 只允许用户一个浏览器登录
  61. ONLY_ALLOW_AUTH_FROM_SOURCE=False # 是否仅允许从 用户来源 处登录 v2.8 添加
  62. ONLY_ALLOW_EXIST_USER_AUTH=False # 是否仅允许 已创建 的用户登录,如果是,则 ldap 需先导入再登录 v2.8 添加
  63. DISK_CHECK_ENABLED=True # 是否开启 硬盘空间监测 v2.8 添加
  64. CONNECTION_TOKEN_EXPIRATION=300 # client token 连接过期时间 (koko magnus 等组件) v2.23 添加

2 KoKo 参数说明

  • KoKo 参数如下:
  1. NAME=hostname # 默认是主机名
  2. CORE_HOST=http://127.0.0.1:8080 # Jumpserver 项目的 url,api 请求注册会使用
  3. BOOTSTRAP_TOKEN=***** # 预共享秘钥,请和 jumpserver 配置文件中保持一致。
  4. BIND_HOST=0.0.0.0 # 启动时绑定的 ip, 默认 0.0.0.0
  5. SSHD_PORT=2222 # 监听的 SSH 端口号
  6. HTTPD_PORT=5000 # 监听的 HTTP/WS 端口号
  7. # ACCESS_KEY= # 项目使用的 ACCESS KEY, 默认会注册,并保存到文件
  8. ACCESS_KEY_FILE=data/keys/.access_key # ACCESS KEY 保存的地址, 默认注册后会保存到该文件中
  9. LOG_LEVEL=DEBUG # 可选 [DEBUG, INFO, WARN, ERROR, FATAL, CRITICAL] debug 模式会自动把用后手动登录填写的密码打印,info 级别不需要
  10. SSH_TIMEOUT=15 # SSH 连接超时时间(单位=秒) 如果用户服务器启用了 useDNS 这些参数,有可能登录时间超过 15S,需要修改此参数
  11. LANG=zh # 可选 [en, zh] 切换 KOKO 登录界面中英文 (v2.0之前的版本)
  12. LANGUAGE_CODE=zh # 可选 [en, zh] 切换 KOKO 登录界面中英文 (v2.0之后的版本)
  13. UPLOAD_FAILED_REPLAY_ON_START=True # 未上传录像遗留文件,启动时是否上传
  14. SFTP_ROOT=/tmp # SFTP 的根目录, 可选 /tmp, Home 其他自定义目录 1.5.7起已弃用这个选项,需要在在 core 的系统用户页面上配置
  15. SFTP_SHOW_HIDDEN_FILE=False # SFTP 是否显示隐藏文件
  16. REUSE_CONNECTION=True # 是否复用同一用户的 SSH 连接
  17. # ASSET_LOAD_POLICY=all # all 则用户资产缓存本地搜索分页;默认异步加载资产, 异步搜索分页;
  18. ZIP_MAX_SIZE=1024M # web sftp 文件下载,zip 支持压缩的最大额度 (单位=M)
  19. ZIP_TMP_PATH=/tmp # web sftp 文件下载,zip压缩文件存放的临时目录
  20. CLIENT_ALIVE_INTERVAL=30 # 用户 SSH 登陆 koko 之后,Koko 给 SSH client 发送的心跳间隔,默认 30,0 则表示不发送 保持登陆用户连接不断开
  21. RETRY_ALIVE_COUNT_MAX=3 # 登陆资产之后,Koko 向资产发送心跳包出现错误的重试次数,默认为3。 当网络不稳定时,可以数值可设置大一些。
  22. SHARE_ROOM_TYPE=local # 可选择 local 和 redis 会话监控和共享使用的方式
  23. REDIS_HOST=127.0.0.1 # redis 配置
  24. REDIS_PORT=6379 # redis 配置
  25. REDIS_PASSWORD= # redis 配置
  26. REDIS_CLUSTERS= # redis 配置
  27. REDIS_DB_ROOM=0 # redis 配置 选择的 redis 库索引
  28. ENABLE_LOCAL_PORT_FORWARD=True # 是否开启本地转发 (目前仅对 vscode remote ssh 有效果) v2.11 新增
  29. ENABLE_VSCODE_SUPPORT=True # 是否开启 针对 vscode 的 remote-ssh 远程开发支持 ( 前置条件: 必须开启 ENABLE_LOCAL_PORT_FORWARD ) v2.11 新增。( 注意: vscode 的连接操作,无审计功能 )

3 Lion 参数说明

  • Lion 参数如下:
  1. NAME=hostname # 默认是主机名
  2. CORE_HOST=http://127.0.0.1:8080 # Jumpserver 项目的 url,api 请求注册会使用
  3. BOOTSTRAP_TOKEN=***** # 预共享秘钥,请和 jumpserver 配置文件中保持一致。
  4. BIND_HOST=0.0.0.0 # 启动时绑定的 ip, 默认 0.0.0.0
  5. HTTPD_PORT=8081 # 监听的 HTTP/WS 端口号
  6. GUA_HOST=127.0.0.1 # Guacd 项目 url
  7. GUA_PORT=4822 # Guacd 项目 端口
  8. LOG_LEVEL=DEBUG # 可选 [DEBUG, INFO, WARN, ERROR, FATAL, CRITICAL] debug 模式会自动把用后手动登录填写的密码打印,info 级别不需要
  9. SHARE_ROOM_TYPE=local # 可选择 local 和 redis 会话监控和共享使用的方式
  10. REDIS_HOST=127.0.0.1 # redis 配置
  11. REDIS_PORT=6379 # redis 配置
  12. REDIS_PASSWORD= # redis 配置
  13. REDIS_DB_ROOM=0 # redis 配置 选择的 redis 库索引
  14. JUMPSERVER_DISABLE_ALL_COPY_PASTE=False # 全局禁用上传下载
  15. JUMPSERVER_DISABLE_ALL_UPLOAD_DOWNLOAD=False # 全局禁用剪切板粘贴复制
  16. JUMPSERVER_REMOTE_APP_UPLOAD_DOWNLOAD_ENABLE=False # 开启Remote app的上传下载
  17. JUMPSERVER_REMOTE_APP_COPY_PASTE_ENABLE=False # 开启Remote app的剪切板粘贴复制
  18. JUMPSERVER_COLOR_DEPTH=32 # 颜色深度 低色 16位, 真彩 24位, 真彩 32位
  19. JUMPSERVER_DPI=120 # 图像每英寸长度内的像素点数 120, 160, 240 等
  20. JUMPSERVER_DISABLE_AUDIO=False # 禁止声音 true, false 无(允许声音)
  21. JUMPSERVER_ENABLE_WALLPAPER=False # 启用墙纸 true, false 无(禁用)
  22. JUMPSERVER_ENABLE_THEMING=False # 启用主题 true, false 无(禁用)
  23. JUMPSERVER_ENABLE_FONT_SMOOTHING=False # 启用平滑字体 true, false 无(禁用)
  24. JUMPSERVER_ENABLE_FULL_WINDOW_DRAG=False # 启用拖拽窗口时渲染全部内容 true, false 无(禁用)
  25. JUMPSERVER_ENABLE_DESKTOP_COMPOSITION=False # 启用透明窗口和阴影等图形效果 true, false 无(禁用)
  26. JUMPSERVER_ENABLE_MENU_ANIMATIONS=False # 启用菜单开关动画 true, false 无(禁用)
  27. JUMPSERVER_DISABLE_BITMAP_CACHING=True # 禁用RDP的内置位图缓存功能 true(禁用), false(启用) 无(启用)
  28. JUMPSERVER_DISABLE_OFFSCREEN_CACHING=True # 禁用客户端中当前不可见的屏幕区域缓存 true(禁用), false(启用) 无(启用)
  29. JUMPSERVER_DISABLE_GLYPH_CACHING=True # 禁用RDP会话中的字形缓存 true(禁用), false(启用) 无(启用)
  30. JUMPSERVER_CLEAN_DRIVE_SCHEDULE_TIME=1 # 定时清理挂载盘文件的时间间隔 (单位:小时),如果设置值 0,则不清理。( v2.13新增 )