Ubuntu 18.04 安装文档

说明

  • # 开头的行表示注释
  • > 开头的行表示需要在 mysql 中执行
  • $ 开头的行表示需要执行的命令

安装过程中遇到问题可参考 安装过程中常见的问题

环境

  • 系统: Ubuntu 18.04
  • IP: 192.168.244.144
  • 目录: /opt
  • 数据库: mariadb
  • 代理: nginx

开始安装

一. 准备 Python3 和 Python 虚拟环境

1.1 安装依赖包

  1. $ apt-get update && apt-get -y upgrade
  2. $ apt-get -y install wget gcc libffi-dev git

1.2 安装 Redis, Jumpserver 使用 Redis 做 cache 和 celery broke

  1. $ apt-get -y install redis-server

1.3 安装 MySQL

本教程使用 Mysql 作为数据库, 如果不使用 Mysql 可以跳过相关 Mysql 安装和配置

  1. $ apt-get -y install mysql-server libmysqlclient-dev

1.4 创建数据库 Jumpserver 并授权

  1. $ DB_PASSWORD=`cat /dev/urandom | tr -dc A-Za-z0-9 | head -c 24`  # 生成随机数据库密码
  2. $ echo -e "\033[31m 你的数据库密码是 $DB_PASSWORD \033[0m"
  3. $ mysql -uroot -p -e "create database jumpserver default charset 'utf8'; grant all on jumpserver.* to 'jumpserver'@'127.0.0.1' identified by '$DB_PASSWORD'; flush privileges;"

1.5 安装 Python3.6

  1. $ apt-get -y install python3.6-dev python3.6-venv

1.6 建立 Python 虚拟环境

为了不扰乱原来的环境我们来使用 Python 虚拟环境

  1. $ cd /opt
  2. $ python3.6 -m venv py3
  3. $ source /opt/py3/bin/activate
  5. # 看到下面的提示符代表成功, 以后运行 Jumpserver 都要先运行以上 source 命令, 以下所有命令均在该虚拟环境中运行
  6. (py3) [root@localhost py3]

二. 安装 Jumpserver

2.1 下载或 Clone 项目

  1. $ cd /opt/
  2. $ git clone https://github.com/jumpserver/jumpserver.git
  3. $ cd /opt/jumpserver
  4. $ git checkout 1.4.8

2.2 安装依赖包

  1. $ cd /opt/jumpserver/requirements
  2. $ apt-get -y install $(cat deb_requirements.txt)

2.3 安装 Python 库依赖

  1. $ pip install --upgrade pip setuptools
  2. $ pip install -r requirements.txt

2.4 修改 Jumpserver 配置文件

  1. $ cd /opt/jumpserver
  2. $ cp config_example.yml config.yml
  4. $ SECRET_KEY=`cat /dev/urandom | tr -dc A-Za-z0-9 | head -c 50`  # 生成随机SECRET_KEY
  5. $ echo "SECRET_KEY=$SECRET_KEY" >> ~/.bashrc
  6. $ BOOTSTRAP_TOKEN=`cat /dev/urandom | tr -dc A-Za-z0-9 | head -c 16`  # 生成随机BOOTSTRAP_TOKEN
  7. $ echo "BOOTSTRAP_TOKEN=$BOOTSTRAP_TOKEN" >> ~/.bashrc
  9. $ sed -i "s/SECRET_KEY:/SECRET_KEY: $SECRET_KEY/g" /opt/jumpserver/config.yml
  10. $ sed -i "s/BOOTSTRAP_TOKEN:/BOOTSTRAP_TOKEN: $BOOTSTRAP_TOKEN/g" /opt/jumpserver/config.yml
  11. $ sed -i "s/# DEBUG: true/DEBUG: false/g" /opt/jumpserver/config.yml
  12. $ sed -i "s/# LOG_LEVEL: DEBUG/LOG_LEVEL: ERROR/g" /opt/jumpserver/config.yml
  13. $ sed -i "s/# SESSION_EXPIRE_AT_BROWSER_CLOSE: false/SESSION_EXPIRE_AT_BROWSER_CLOSE: true/g" /opt/jumpserver/config.yml
  14. $ sed -i "s/DB_PASSWORD: /DB_PASSWORD: $DB_PASSWORD/g" /opt/jumpserver/config.yml
  15. $ Server_IP=`ip addr | grep inet | egrep -v '(127.0.0.1|inet6|docker)' | awk '{print $2}' | tr -d "addr:" | head -n 1 | cut -d / -f1`
  17. $ echo -e "\033[31m 你的SECRET_KEY是 $SECRET_KEY \033[0m"
  18. $ echo -e "\033[31m 你的BOOTSTRAP_TOKEN是 $BOOTSTRAP_TOKEN \033[0m"
  19. $ echo -e "\033[31m 你的服务器IP是 $Server_IP \033[0m"
  21. $ vim config.yml  # 确认内容有没有错误
  1. # SECURITY WARNING: keep the secret key used in production secret!
  2. # 加密秘钥 生产环境中请修改为随机字符串, 请勿外泄
  3. SECRET_KEY:
  5. # SECURITY WARNING: keep the bootstrap token used in production secret!
  6. # 预共享Token coco和guacamole用来注册服务账号, 不在使用原来的注册接受机制
  7. BOOTSTRAP_TOKEN:
  9. # Development env open this, when error occur display the full process track, Production disable it
  10. # DEBUG 模式 开启DEBUG后遇到错误时可以看到更多日志
  11. DEBUG: false
  13. # DEBUG, INFO, WARNING, ERROR, CRITICAL can set. See https://docs.djangoproject.com/en/1.10/topics/logging/
  14. # 日志级别
  15. LOG_LEVEL: ERROR
  16. # LOG_DIR:
  18. # Session expiration setting, Default 24 hour, Also set expired on on browser close
  19. # 浏览器Session过期时间, 默认24小时, 也可以设置浏览器关闭则过期
  20. # SESSION_COOKIE_AGE: 86400
  21. SESSION_EXPIRE_AT_BROWSER_CLOSE: true
  23. # Database setting, Support sqlite3, mysql, postgres ....
  24. # 数据库设置
  25. # See https://docs.djangoproject.com/en/1.10/ref/settings/#databases
  27. # SQLite setting:
  28. # 使用单文件sqlite数据库
  29. # DB_ENGINE: sqlite3
  30. # 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. # 运行时绑定端口
  44. HTTP_BIND_HOST: 0.0.0.0
  45. HTTP_LISTEN_PORT: 8080
  47. # Use Redis as broker for celery and web socket
  48. # Redis配置
  49. REDIS_HOST: 127.0.0.1
  50. REDIS_PORT: 6379
  51. # REDIS_PASSWORD:
  52. # REDIS_DB_CELERY: 3
  53. # REDIS_DB_CACHE: 4
  55. # Use OpenID authorization
  56. # 使用OpenID 来进行认证设置
  57. # BASE_SITE_URL: http://localhost:8080
  58. # AUTH_OPENID: false  # True or False
  59. # AUTH_OPENID_SERVER_URL: https://openid-auth-server.com/
  60. # AUTH_OPENID_REALM_NAME: realm-name
  61. # AUTH_OPENID_CLIENT_ID: client-id
  62. # AUTH_OPENID_CLIENT_SECRET: client-secret
  64. # OTP settings
  65. # OTP/MFA 配置
  66. # OTP_VALID_WINDOW: 0
  67. # OTP_ISSUER_NAME: Jumpserver

2.5 运行 Jumpserver

  1. $ cd /opt/jumpserver
  2. $ ./jms start -d  # 后台运行使用 -d 参数./jms start -d
  4. # 新版本更新了运行脚本, 使用方式./jms start|stop|status all  后台运行请添加 -d 参数

运行不报错, 请继续往下操作

三. 安装 SSH Server 和 WebSocket Server: Coco

3.1 安装 Docker

  1. $ apt-get -y install apt-transport-https ca-certificates curl software-properties-common
  2. $ curl -fsSL http://mirrors.aliyun.com/docker-ce/linux/ubuntu/gpg | sudo apt-key add -
  3. $ add-apt-repository "deb [arch=amd64] http://mirrors.aliyun.com/docker-ce/linux/ubuntu $(lsb_release -cs) stable"
  4. $ apt-get -y update
  5. $ apt-get -y install docker-ce
  6. $ curl -sSL https://get.daocloud.io/daotools/set_mirror.sh | sh -s http://f1361db2.m.daocloud.io
  7. $ systemctl restart docker.service

3.2 部署 Coco

  1. $ docker run --name jms_coco -d -p 2222:2222 -p 5000:5000 -e CORE_HOST=http://$Server_IP:8080 -e BOOTSTRAP_TOKEN=$BOOTSTRAP_TOKEN jumpserver/jms_coco:1.4.8
  2. # BOOTSTRAP_TOKEN 为 Jumpserver/config.yml 里面的 BOOTSTRAP_TOKEN

四. 安装 RDP Server 和 VNC Server: Guacamole

4.1 部署 Guacamole

  1. $ docker run --name jms_guacamole -d -p 8081:8081 -e JUMPSERVER_SERVER=http://$Server_IP:8080 -e BOOTSTRAP_TOKEN=$BOOTSTRAP_TOKEN jumpserver/jms_guacamole:1.4.8
  2. # BOOTSTRAP_TOKEN 为 Jumpserver/config.yml 里面的 BOOTSTRAP_TOKEN

五. 安装 Web Terminal 前端: Luna

访问(https://github.com/jumpserver/luna/releases)下载对应版本的 release 包, 直接解压, 不需要编译

5.1 部署 Luna

  1. $ cd /opt/
  2. $ wget https://github.com/jumpserver/luna/releases/download/1.4.8/luna.tar.gz
  4. # 如果网络有问题导致下载无法完成可以使用下面地址
  5. $ wget https://demo.jumpserver.org/download/luna/1.4.8/luna.tar.gz
  7. $ tar xf luna.tar.gz
  8. $ chown -R root:root luna

六. 配置 Nginx 整合各组件

6.1 安装 Nginx

  1. $ apt-get -y install curl gnupg2 ca-certificates lsb-release
  2. $ add-apt-repository "deb http://nginx.org/packages/ubuntu/ $(lsb_release -cs) nginx"
  3. $ curl -fsSL http://nginx.org/keys/nginx_signing.key | sudo apt-key add -
  4. $ apt-get update
  5. $ apt-get -y install nginx

6.2 准备配置文件 /etc/nginx/conf.d/jumpserver.conf

  1. $ rm -rf /etc/nginx/conf.d/default.conf
  2. $ vim /etc/nginx/conf.d/jumpserver.conf
  4. server {
  5.     listen 80;
  6.     server_name _;
  8.     client_max_body_size 100m;  # 录像及文件上传大小限制
  10.     location /luna/ {
  11.         try_files $uri / /index.html;
  12.         alias /opt/luna/;
  13.     }
  15.     location /media/ {
  16.         add_header Content-Encoding gzip;
  17.         root /opt/jumpserver/data/;
  18.     }
  20.     location /static/ {
  21.         root /opt/jumpserver/data/;
  22.     }
  24.     location /socket.io/ {
  25.         proxy_pass       http://localhost:5000/socket.io/;
  26.         proxy_buffering off;
  27.         proxy_http_version 1.1;
  28.         proxy_set_header Upgrade $http_upgrade;
  29.         proxy_set_header Connection "upgrade";
  30.         proxy_set_header X-Real-IP $remote_addr;
  31.         proxy_set_header Host $host;
  32.         proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
  33.         access_log off;
  34.     }
  36.     location /coco/ {
  37.         proxy_pass       http://localhost:5000/coco/;
  38.         proxy_set_header X-Real-IP $remote_addr;
  39.         proxy_set_header Host $host;
  40.         proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
  41.         access_log off;
  42.     }
  44.     location /guacamole/ {
  45.         proxy_pass       http://localhost:8081/;
  46.         proxy_buffering off;
  47.         proxy_http_version 1.1;
  48.         proxy_set_header Upgrade $http_upgrade;
  49.         proxy_set_header Connection $http_connection;
  50.         access_log off;
  51.         proxy_set_header X-Real-IP $remote_addr;
  52.         proxy_set_header Host $host;
  53.         proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
  54.     }
  56.     location / {
  57.         proxy_pass http://localhost:8080;
  58.         proxy_set_header X-Real-IP $remote_addr;
  59.         proxy_set_header Host $host;
  60.         proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
  61.     }
  63. }

6.3 重启 Nginx

  1. $ nginx -t  # 如果没有报错请继续
  2. $ systemctl restart nginx

6.4 开始使用 Jumpserver

服务全部启动后, 访问 http://192.168.244.144

默认账号: admin 密码: admin

到Jumpserver 会话管理-终端管理 检查 Coco Guacamole 等应用的注册

测试连接

  1. 如果登录客户端是 macOS 或 Linux, 登录语法如下
  2. $ ssh -p2222 admin@192.168.244.144
  3. $ sftp -P2222 admin@192.168.244.144
  4. 密码: admin
  6. 如果登录客户端是 Windows, Xshell Terminal 登录语法如下
  7. $ ssh admin@192.168.244.144 2222
  8. $ sftp admin@192.168.244.144 2222
  9. 密码: admin
  10. 如果能登陆代表部署成功
  12. # sftp默认上传的位置在资产的 /tmp 目录下
  13. # windows拖拽上传的位置在资产的 Guacamole RDP上的 G 目录下

后续的使用请参考 快速入门 如遇到问题可参考 FAQ