Core 环境部署

1 Core 组件简述

1.1 环境要求

NameCorePython
Versionv3.10.13.9

1.2 下载源代码

  • 可以从 Github 网站上获取最新的 Release 副本。这些版本是最新代码的稳定快照，从项目网站下载的源将采用 .tar.gz 存档的形式，通过命令行中提取该存档：
  1. cd /opt
  2. mkdir /opt/jumpserver-v3.10.1
  3. wget -O /opt/jumpserver-v3.10.1.tar.gz https://github.com/jumpserver/jumpserver/archive/refs/tags/v3.10.1.tar.gz
  4. tar -xf jumpserver-v3.10.1.tar.gz -C /opt/jumpserver-v3.10.1 --strip-components 1
  5. cd jumpserver-v3.10.1
  6. rm -f apps/common/utils/ip/geoip/GeoLite2-City.mmdb apps/common/utils/ip/ipip/ipipfree.ipdb
  7. wget https://download.jumpserver.org/files/ip/GeoLite2-City.mmdb -O apps/common/utils/ip/geoip/GeoLite2-City.mmdb
  8. wget https://download.jumpserver.org/files/ip/ipipfree.ipdb -O apps/common/utils/ip/ipip/ipipfree.ipdb
  1. ls -l requirements/
  1. requirements/           # 对应操作系统需要的依赖包
  2. ├── apk_pkg.sh          # Alpine
  3. ├── deb_pkg.sh          # 基于 Debian 的发行版(如: Ubuntu)
  4. ├── issues.txt          # macOS 一些问题及解决方案
  5. ├── mac_pkg.sh          # macOS
  6. ├── requirements.txt    # python
  7. └── rpm_pkg.sh          # 基于 RedHat 的发行版(如: CentOS)

Ubuntu 20.04

  1. apt-get install -y pkg-config libxmlsec1-dev libpq-dev libffi-dev libxml2 libxslt-dev libldap2-dev libsasl2-dev sshpass mariadb-client bash-completion g++ make sshpass

如果你安装的是 MySQL, 将 mariadb 开发包自行替换成 mysql, 或者不要将 数据库 和 Core 部署在一起

  1. apt-get install -y libmariadb-dev

1.3 安装 Python3

  • 从 Python 网站获取部署 Python3 的方法，请根据 环境要求，通过命令行中判断是否安装完成：
  1. apt-get install -y python3.9 python3.9-dev python3.9-venv
  1. python3.9
  1. Python 3.9.5 (default, Nov 23 2021, 15:27:38)
  2. [GCC 9.3.0] on linux
  3. Type "help", "copyright", "credits" or "license" for more information.
  4. >>>

1.4 安装 Python 依赖

  • 为 JumpServer 项目单独创建 python3 虚拟环境。
  1. python3.9 -m venv /opt/py3
  2. source /opt/py3/bin/activate
  • 每次运行项目都需要先执行 source /opt/py3/bin/activate 载入此环境。
  1. poetry install
  • 修改配置文件。
  1. cp config_example.yml config.yml
  2. vi config.yml
  1. # SECURITY WARNING: keep the secret key used in production secret!
  2. # 加密秘钥 生产环境中请修改为随机字符串，请勿外泄, 可使用命令生成
  3. # $ cat /dev/urandom | tr -dc A-Za-z0-9 | head -c 48;echo
  4. SECRET_KEY: ****************  # 必填项, 长度推荐 50 位以上
  6. # SECURITY WARNING: keep the bootstrap token used in production secret!
  7. # 预共享Token koko 和 lion 用来注册服务账号，不在使用原来的注册接受机制
  8. # $ cat /dev/urandom | tr -dc A-Za-z0-9 | head -c 24;echo
  9. BOOTSTRAP_TOKEN: ***********  # 必填项, 长度推荐 20 位以上
  11. # Development env open this, when error occur display the full process track, Production disable it
  12. # DEBUG 模式 开启DEBUG后遇到错误时可以看到更多日志
  13. DEBUG: true                   # 开发建议打开 DEBUG, 生产环境应该关闭
  15. # DEBUG, INFO, WARNING, ERROR, CRITICAL can set. See https://docs.djangoproject.com/en/1.10/topics/logging/
  16. # 日志级别
  17. LOG_LEVEL: DEBUG              # 开发建议设置 DEBUG, 生产环境推荐使用 ERROR
  18. # LOG_DIR:
  20. # Session expiration setting, Default 24 hour, Also set expired on on browser close
  21. # 浏览器Session过期时间，默认24小时, 也可以设置浏览器关闭则过期
  22. # SESSION_COOKIE_AGE: 86400
  23. SESSION_EXPIRE_AT_BROWSER_CLOSE: true  # 浏览器关闭 session 过期
  25. # Database setting, Support sqlite3, mysql, postgres ....
  26. # 数据库设置
  27. # See https://docs.djangoproject.com/en/1.10/ref/settings/#databases
  29. # SQLite setting:
  30. # 使用单文件sqlite数据库
  31. # DB_ENGINE: sqlite3
  32. # DB_NAME:
  33. # MySQL or postgres setting like:
  34. # 使用Mysql作为数据库
  35. DB_ENGINE: mysql
  36. DB_HOST: 127.0.0.1       # 自行配置 数据库相关
  37. DB_PORT: 3306
  38. DB_USER: jumpserver
  39. DB_PASSWORD: ********
  40. DB_NAME: jumpserver
  42. # When Django start it will bind this host and port
  43. # ./manage.py runserver 127.0.0.1:8080
  44. # 运行时绑定端口, 将会使用 0.0.0.0:8080 0.0.0.0:8070 端口
  45. HTTP_BIND_HOST: 0.0.0.0
  46. HTTP_LISTEN_PORT: 8080
  47. WS_LISTEN_PORT: 8070
  49. # Use Redis as broker for celery and web socket
  50. # Redis配置
  51. REDIS_HOST: 127.0.0.1    # 自行配置 Redis 相关
  52. REDIS_PORT: 6379
  53. REDIS_PASSWORD: ********
  54. # REDIS_DB_CELERY: 3
  55. # REDIS_DB_CACHE: 4
  57. # Use OpenID Authorization
  58. # 使用 OpenID 进行认证设置
  59. # AUTH_OPENID: False # True or False
  60. # BASE_SITE_URL: None
  61. # AUTH_OPENID_CLIENT_ID: client-id
  62. # AUTH_OPENID_CLIENT_SECRET: client-secret
  63. # AUTH_OPENID_PROVIDER_ENDPOINT: https://op-example.com/
  64. # AUTH_OPENID_PROVIDER_AUTHORIZATION_ENDPOINT: https://op-example.com/authorize
  65. # AUTH_OPENID_PROVIDER_TOKEN_ENDPOINT: https://op-example.com/token
  66. # AUTH_OPENID_PROVIDER_JWKS_ENDPOINT: https://op-example.com/jwks
  67. # AUTH_OPENID_PROVIDER_USERINFO_ENDPOINT: https://op-example.com/userinfo
  68. # AUTH_OPENID_PROVIDER_END_SESSION_ENDPOINT: https://op-example.com/logout
  69. # AUTH_OPENID_PROVIDER_SIGNATURE_ALG: HS256
  70. # AUTH_OPENID_PROVIDER_SIGNATURE_KEY: None
  71. # AUTH_OPENID_SCOPES: "openid profile email"
  72. # AUTH_OPENID_ID_TOKEN_MAX_AGE: 60
  73. # AUTH_OPENID_ID_TOKEN_INCLUDE_CLAIMS: True
  74. # AUTH_OPENID_USE_STATE: True
  75. # AUTH_OPENID_USE_NONCE: True
  76. # AUTH_OPENID_SHARE_SESSION: True
  77. # AUTH_OPENID_IGNORE_SSL_VERIFICATION: True
  78. # AUTH_OPENID_ALWAYS_UPDATE_USER: True
  80. # Use Radius authorization
  81. # 使用Radius来认证
  82. # AUTH_RADIUS: false
  83. # RADIUS_SERVER: localhost
  84. # RADIUS_PORT: 1812
  85. # RADIUS_SECRET:
  87. # CAS 配置
  88. # AUTH_CAS': False,
  89. # CAS_SERVER_URL': "http://host/cas/",
  90. # CAS_ROOT_PROXIED_AS': 'http://jumpserver-host:port',  
  91. # CAS_LOGOUT_COMPLETELY': True,
  92. # CAS_VERSION': 3,
  94. # LDAP/AD settings
  95. # LDAP 搜索分页数量
  96. # AUTH_LDAP_SEARCH_PAGED_SIZE: 1000
  97. #
  98. # 定时同步用户
  99. # 启用 / 禁用
  100. # AUTH_LDAP_SYNC_IS_PERIODIC: True
  101. # 同步间隔 (单位: 时) (优先）
  102. # AUTH_LDAP_SYNC_INTERVAL: 12
  103. # Crontab 表达式
  104. # AUTH_LDAP_SYNC_CRONTAB: * 6 * * *
  105. #
  106. # LDAP 用户登录时仅允许在用户列表中的用户执行 LDAP Server 认证
  107. # AUTH_LDAP_USER_LOGIN_ONLY_IN_USERS: False
  108. #
  109. # LDAP 认证时如果日志中出现以下信息将参数设置为 0 (详情参见：https://www.python-ldap.org/en/latest/faq.html)
  110. # In order to perform this operation a successful bind must be completed on the connection
  111. # AUTH_LDAP_OPTIONS_OPT_REFERRALS: -1
  113. # OTP settings
  114. # OTP/MFA 配置
  115. # OTP_VALID_WINDOW: 0
  116. # OTP_ISSUER_NAME: Jumpserver
  118. # Perm show single asset to ungrouped node
  119. # 是否把未授权节点资产放入到 未分组 节点中
  120. # PERM_SINGLE_ASSET_TO_UNGROUP_NODE: False
  121. #
  122. # 同一账号仅允许在一台设备登录
  123. # USER_LOGIN_SINGLE_MACHINE_ENABLED: False
  124. #
  125. # 启用定时任务
  126. # PERIOD_TASK_ENABLE: True
  127. #
  128. # 启用二次复合认证配置
  129. # LOGIN_CONFIRM_ENABLE: False
  130. #
  131. # Windows 登录跳过手动输入密码
  132. # WINDOWS_SKIP_ALL_MANUAL_PASSWORD: False
  • 处理国际化。
  1. rm -f apps/locale/zh/LC_MESSAGES/django.mo apps/locale/zh/LC_MESSAGES/djangojs.mo
  2. python apps/manage.py compilemessages

1.5 启动 Core

  • 后台运行可以加 -d，./jms start -d
  1. ./jms start