编译文档

目前 JumpServer 不支持在 Windows 平台编译

架构图

!架构图

JumpServer 分为多个组件, 大致的架构如上图所示. 其中 Lina 和 Luna 为纯静态文件, 最终由 nginx 整合

Core

Core 是 JumpServer 的核心组件, 由 Django 二次开发而来, 内置了 Gunicorn Celery Beat Flower Daphne 服务

环境要求

CorePythonMySQLMariaDBRedis
v1.0 - v2.6= 3.6>= 5>= 5
>= 2.6>= 3.6>= 5.7>= 10.2>= 5

下载源代码

可以从 Github 网站上获取最新的 Release 副本。这些版本是最新代码的稳定快照，从项目网站下载的源将采用 .tar.gz 存档的形式，通过命令行中提取该存档:

  1. tar -xf jumpserver-v2.9.2.tar.gz
  2. cd jumpserver-v2.9.2
  1. ls -l requirements/
  1. requirements/                     # 对应操作系统需要的依赖包
  2. ├── alpine_requirements.txt       # Alpine
  3. ├── deb_buster_requirements.txt   # Debian 10
  4. ├── deb_requirements.txt          # 基于 Debian 的发行版(如: Ubuntu)
  5. ├── issues.txt                    # macOS 一些问题及解决方案
  6. ├── mac_requirements.txt          # macOS
  7. ├── requirements.txt              # python
  8. └── rpm_requirements.txt          # 基于 RedHat 的发行版(如: CentOS)
OSCommand
macOSbrew install -y $(cat mac_requirements.txt)
Alpineapk add $(cat alpine_requirements.txt)
Ubuntu / Debianapt-get install -y $(cat deb_requirements.txt)
CentOS / RedHatapt-get install -y $(cat deb_requirements.txt)

安装 Python3

从 Python 网站部署 Python3, 请根据 环境要求, 通过命令行中判断是否安装完成:

  1. python3
  1. Python 3.6.8 (default, Nov 16 2020, 16:55:22)
  2. [GCC 4.8.5 20150623 (Red Hat 4.8.5-44)] on linux
  3. Type "help", "copyright", "credits" or "license" for more information.
  4. >>>

安装 python 依赖

推荐为 JumpServer 项目单独创建 python3 虚拟环境

  1. python3 -m venv ~/project/jms_py3
  2. source ~/project/jms_py3

每次运行项目都需要先执行 source ~/project/jms_py3 载入此环境. (jms_py3) [root@jms-test ~]#

  1. pip install -r requirements.txt

修改配置文件

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

启动 Core

后台运行可以加 -d, ./jmsctl.sh start all -d

  1. ./jmsctl.sh start all

Lina

环境要求

LinaNode
all= 10

下载源代码

可以从 Github 网站上获取最新的 Release 副本。这些版本是最新代码的稳定快照，从项目网站下载 Source code.tar.gz 源代码，通过命令行中提取该存档:

  1. tar -xf lina-v2.9.2.tar.gz
  2. cd lina-v2.9.2

安装 Node

从 Node 官方网站参考文档部署 Node.js, 请根据 环境要求, 通过命令行中判断是否安装完成:

  1. node -v

v10.24.1

安装依赖

  1. npm install -g yarn
  2. yarn install

修改配置文件

  1. vi .env.development
  1. # 全局环境变量 请勿随意改动
  2. ENV = 'development'
  4. # base api
  5. VUE_APP_BASE_API = ''
  6. VUE_APP_PUBLIC_PATH = '/ui/'
  8. # vue-cli uses the VUE_CLI_BABEL_TRANSPILE_MODULES environment variable,
  9. # to control whether the babel-plugin-dynamic-import-node plugin is enabled.
  10. # It only does one thing by converting all import() to require().
  11. # This configuration can significantly increase the speed of hot updates,
  12. # when you have a large number of pages.
  13. # Detail:  https://github.com/vuejs/vue-cli/blob/dev/packages/@vue/babel-preset-app/index.js
  15. VUE_CLI_BABEL_TRANSPILE_MODULES = true
  17. # External auth
  18. VUE_APP_LOGIN_PATH = '/core/auth/login/'
  19. VUE_APP_LOGOUT_PATH = '/core/auth/logout/'
  21. # Dev server for core proxy
  22. VUE_APP_CORE_HOST = 'http://localhost:8080'  # 修改成 Core 的 url 地址
  23. VUE_APP_ENV = 'development'

运行 Lina

  1. yarn serve

构建 Lina

构建完成后的 lina 包为 html 文件, 可以直接移到到 nginx 服务器

  1. yarn build

Luna

环境要求

LunaNode
all= 10

下载源代码

可以从 Github 网站上获取最新的 Release 副本。这些版本是最新代码的稳定快照，从项目网站下载 Source code.tar.gz 源代码，通过命令行中提取该存档:

  1. tar -xf luna-v2.9.2.tar.gz
  2. cd luna-v2.9.2

安装 Node

从 Node 官方网站参考文档部署 Node.js, 请根据 环境要求, 通过命令行中判断是否安装完成:

  1. node -v

v10.24.1

安装依赖

  1. npm -i
  2. npm rebuild node-sass

修改配置文件

  1. vi proxy.conf.json
  1. {
  2.   "/api": {
  3.     "target": "http://127.0.0.1:8080",  # Core 地址
  4.     "secure": false                     # https ssl 需要开启
  5.   },
  6.   "/koko": {
  7.     "target": "http://127.0.0.1:5000",  # KoKo 地址
  8.     "secure": false,
  9.     "ws": true
  10.   },
  11.   "/media/": {
  12.     "target": "http://127.0.0.1:8080",  # Core 地址
  13.     "secure": false
  14.   },
  15.   "/guacamole/": {
  16.     "target": "http://127.0.0.1:8081",  # Guacamole 地址
  17.     "secure": false,
  18.     "ws": true,
  19.     "pathRewrite": {
  20.       "^/guacamole": ""
  21.     }
  22.   }
  23. }

运行 Luna

  1. ng serve

构建 Luna

可以加 -prod 来进行生产构建 ng build -prod

  1. ng build

KoKo

Koko 是 Go 版本的 coco；重构了 coco 的 SSH/SFTP 服务和 Web Terminal 服务

环境要求

KoKoGo
v1.0 - v2.6= 1.12
>= 2.6= 1.15

下载源代码

可以从 Github[koko] 网站上获取最新的 Release 副本。这些版本是最新代码的稳定快照，从项目网站下载 Source code.tar.gz 源代码，通过命令行中提取该存档:

OSArchName
Linuxamd64koko-v2.9.2-linux-amd64.tar.gz
macOSamd64koko-v2.9.2-darwin-amd64.tar.gz
  1. tar -xf koko-v2.9.2.tar.gz
  2. cd koko-v2.9.2

安装 Go

从 Go 官方网站参考文档部署 golang, 请根据 环境要求, 通过命令行中判断是否安装完成:

  1. go version

go version go1.15 linux/amd64

编译:

OSArchCommand
Linuxamd64make linux
macOSamd64make darwin
  1. make

修改配置文件

  1. cp config_example.yml config.yml
  2. vi config.yml
  1. # 项目名称, 会用来向Jumpserver注册, 识别而已, 不能重复
  2. # NAME: 
  4. # Jumpserver项目的url, api请求注册会使用
  5. CORE_HOST: http://127.0.0.1:8080   # Core 的地址
  7. # Bootstrap Token, 预共享秘钥, 用来注册coco使用的service account和terminal
  8. # 请和jumpserver 配置文件中保持一致，注册完成后可以删除
  9. BOOTSTRAP_TOKEN: ********  # 和 Core config.yml 的值保持一致
  11. # 启动时绑定的ip, 默认 0.0.0.0
  12. BIND_HOST: 0.0.0.0
  14. # 监听的SSH端口号, 默认2222
  15. SSHD_PORT: 2222            # 使用 0.0.0.0:2222
  17. # 监听的HTTP/WS端口号，默认5000
  18. HTTPD_PORT: 5000           # 使用 0.0.0.0:5000
  20. # 项目使用的ACCESS KEY, 默认会注册,并保存到 ACCESS_KEY_STORE中,
  21. # 如果有需求, 可以写到配置文件中, 格式 access_key_id:access_key_secret
  22. # ACCESS_KEY: null
  24. # ACCESS KEY 保存的地址, 默认注册后会保存到该文件中
  25. # ACCESS_KEY_FILE: data/keys/.access_key
  27. # 设置日志级别 [DEBUG, INFO, WARN, ERROR, FATAL, CRITICAL]
  28. LOG_LEVEL: DEBUG           # 开发建议设置 DEBUG, 生产环境推荐使用 ERROR
  30. # SSH连接超时时间 (default 15 seconds)
  31. # SSH_TIMEOUT: 15
  33. # 语言 [en,zh]
  34. # LANGUAGE_CODE: zh
  36. # SFTP的根目录, 可选 /tmp, Home其他自定义目录
  37. # SFTP_ROOT: /tmp
  39. # SFTP是否显示隐藏文件
  40. # SFTP_SHOW_HIDDEN_FILE: false
  42. # 是否复用和用户后端资产已建立的连接(用户不会复用其他用户的连接)
  43. # REUSE_CONNECTION: true
  45. # 资产加载策略, 可根据资产规模自行调整. 默认异步加载资产, 异步搜索分页; 如果为all, 则资产全部加载, 本地搜索分页.
  46. # ASSET_LOAD_POLICY:
  48. # zip压缩的最大额度 (单位: M)
  49. # ZIP_MAX_SIZE: 1024M
  51. # zip压缩存放的临时目录 /tmp
  52. # ZIP_TMP_PATH: /tmp
  54. # 向 SSH Client 连接发送心跳的时间间隔 (单位: 秒)，默认为30, 0则表示不发送
  55. # CLIENT_ALIVE_INTERVAL: 30
  57. # 向资产发送心跳包的重试次数，默认为3
  58. # RETRY_ALIVE_COUNT_MAX: 3
  60. # 会话共享使用的类型 [local, redis], 默认local
  61. # SHARE_ROOM_TYPE: local
  63. # Redis配置
  64. # REDIS_HOST: 127.0.0.1      # 如果需要部署多个 koko, 需要通过 redis 来保持会话
  65. # REDIS_PORT: 6379
  66. # REDIS_PASSWORD:
  67. # REDIS_CLUSTERS:
  68. # REDIS_DB_ROOM:

启动 KoKo

后台运行可以加 -d, ./koko -d

  1. ./koko

Guacamole

环境要求

JumpServerOpenJDK
All= 1.8

等待更新..

Nginx

从 Nginx 官方网站上获取 Nginx 的最新发行版本 linux_packages, 通过命令行验证安装是否完成:

  1. nginx -v

nginx version: nginx/1.18.0

整合 JumpServer

  1. vi jumpserver.conf
  1. server {
  2.   listen 80;
  3.   # server_name _;
  5.   client_max_body_size 5000m; 文件大小限制
  7.   # Luna 配置
  8.   location /luna/ {
  9.     proxy_pass http://luna:4200;
  10.   }
  12.   # Core data 静态资源
  13.   location /media/replay/ {
  14.     add_header Content-Encoding gzip;
  15.     root /data/;
  16.   }
  18.   location /media/ {
  19.     root /data/;
  20.   }
  22.   location /static/ {
  23.     root /data/;
  24.   }
  26.   # Koko 配置
  27.   location /koko/ {
  28.     proxy_pass       http://koko:5000;
  29.     proxy_set_header X-Real-IP $remote_addr;
  30.     proxy_set_header Host $host;
  31.     proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
  32.     proxy_http_version 1.1;
  33.     proxy_buffering off;
  34.     proxy_set_header Upgrade $http_upgrade;
  35.     proxy_set_header Connection "upgrade";
  36.   }
  38.   # Guacamole 配置
  39.   location /guacamole/ {
  40.     proxy_pass http://guacamole:8081/;
  41.     proxy_buffering off;
  42.     proxy_request_buffering off;
  43.     proxy_http_version 1.1;
  44.     proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
  45.     proxy_set_header Upgrade $http_upgrade;
  46.     proxy_set_header Connection $http_connection;
  47.     proxy_ignore_client_abort on;
  48.     proxy_connect_timeout 600;
  49.     proxy_send_timeout 600;
  50.     proxy_read_timeout 600;
  51.     send_timeout 6000;
  52.   }
  54.   # Core 配置
  55.   location /ws/ {
  56.     proxy_pass http://core:8070;
  57.     proxy_set_header X-Real-IP $remote_addr;
  58.     proxy_set_header Host $host;
  59.     proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
  60.     proxy_http_version 1.1;
  61.     proxy_buffering off;
  62.     proxy_set_header Upgrade $http_upgrade;
  63.     proxy_set_header Connection "upgrade";
  64.   }
  66.   location /api/ {
  67.     proxy_pass http://core:8080;
  68.     proxy_set_header X-Real-IP $remote_addr;
  69.     proxy_set_header Host $host;
  70.     proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
  71.   }
  73.   location /core/ {
  74.     proxy_pass http://core:8080;
  75.     proxy_set_header X-Real-IP $remote_addr;
  76.     proxy_set_header Host $host;
  77.     proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
  78.   }
  80.   # 前端 Lina
  81.   location /ui/ {
  82.     proxy_pass http://lina:9528;
  83.     proxy_set_header X-Real-IP $remote_addr;
  84.     proxy_set_header Host $host;
  85.     proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
  86.   }
  88.   location / {
  89.     rewrite ^/(.*)$ /ui/$1 last;
  90.   }
  91. }
  1. nginx -t
  1. nginx -s reload