diff --git a/.gitignore b/.gitignore index dc51315af..488f8a776 100644 --- a/.gitignore +++ b/.gitignore @@ -5,6 +5,7 @@ .env env env* +venv dist build *.egg diff --git a/docs/contact.rst b/docs/contact.rst index 789207779..d7b8fb71e 100644 --- a/docs/contact.rst +++ b/docs/contact.rst @@ -4,14 +4,17 @@ 商业支持 ~~~~~~~~~~~ -https://market.aliyun.com/products/53690006/cmgj026011.html +`阿里云市场购买: `_ -QQ群 + +QQ 群 ~~~~~~~~ -群1: 390139816 -群2: 399218702 -群3: 552054376 +群1: 390139816 (推荐) + +群2: 399218702 (满) + +群3: 552054376 (满) Github @@ -29,10 +32,10 @@ http://www.jumpserver.org Demo ~~~~~~~~ -http://demo.jumpserver.org:8080 +http://demo.jumpserver.org 邮件 ~~~~~~~~ -ibuler#fit2cloud.com (#替换为@) \ No newline at end of file +support@fit2cloud.com (#替换为@) \ No newline at end of file diff --git a/docs/faq.rst b/docs/faq.rst index d02cca126..90775dc54 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -1,2 +1,19 @@ FAQ -+++++++++++++++++++++ \ No newline at end of file +========== + +1. Windows 无法连接 + +:: + + (1). 如果白屏 可能是nginx设置的不对，也可能运行guacamole的docker容器有问题，总之请求到不了guacamole + (2). 如果显示没有权限 可能是你在 终端管理里没有接受 guacamole的注册，请接受一下，如果还是不行，就删除刚才的注册，重启guacamole的docker重新注册 + (3). 如果显示未知问题 可能是你的资产填写的端口不对，或者授权的系统用户的协议不是rdp + + +2. 用户、系统用户、管理用户的关系 + +:: + + 用户：每个公司的同事创建一个用户账号，用来登录Jumpserver + 系统用户：使用来登录到服务器的用户，如 web, dba, root等 + 管理用户：是服务器上已存在的特权用户，Ansible用来获取硬件信息, 如 root, 或者其它拥有 sudo NOPASSWD: ALL权限的用户 diff --git a/docs/index.rst b/docs/index.rst index 41a9ffcb0..ac111c690 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -19,3 +19,4 @@ Jumpserver 文档 contributor contact snapshot + faq diff --git a/docs/intro.rst b/docs/intro.rst deleted file mode 100644 index a8810e14f..000000000 --- a/docs/intro.rst +++ /dev/null @@ -1,51 +0,0 @@ -简介 -============ - -Jumpserver是混合云下更好用的堡垒机, 分布式架构设计无限扩展，轻松对接混合云资产，支持使用云存储（AWS S3, ES等）存储录像、命令 - -Jumpserver颠覆传统堡垒机, 无主机和并发数量限制，支持水平扩容，FIT2CLOUD提供完备的商业服务支持，用户无后顾之忧 - -Jumpserver拥有极致的用户体验, 极致UI体验，容器化的部署方式，部署过程方便快捷，可持续升级 - - -组件说明 -++++++++++++++++++++++++ - -Jumpserver -``````````` -现指Jumpserver管理后台，是核心组件(Core), 使用 Django Class Based View 风格开发，支持Restful API。 - -`Github `_ - - -Coco -```````` -实现了SSH Server 和 Web Terminal Server的组件，提供ssh和websocket接口, 使用 Paramiko 和 Flask 开发。 - - -`Github `__ - - -Luna -```````` -现在是Web Terminal前端，计划前端页面都由该项目提供，Jumpserver只提供API，不再负责后台渲染html等。 - -`Github `__ - - -Guacamole -``````````` -Apache 跳板机项目，Jumpserver使用其组件实现RDP功能，Jumpserver并没有修改其代码而是添加了额外的插件，支持Jumpserver调用 - - -Jumpserver-python-sdk -``````````````````````` -Jumpserver API Python SDK，Coco目前使用该SDK与Jumpserver API交互 - -`Github `__ - - -组件架构图 -++++++++++++++++++++++++ -.. image:: _static/img/structure.png - :alt: 组件架构图 diff --git a/docs/quickstart.rst b/docs/quickstart.rst index c99675d5a..3a5315416 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -1,9 +1,9 @@ 快速安装 ========================== -Jumpserver 封装了一个 All in one Docker，可以快速启动。该镜像集成了所有需要的组件，可以使用外置 Database 和 Redis +Jumpserver 封装了一个 All in one Docker，可以快速启动。该镜像集成了所需要的组件(Windows组件未暂未集成)，也支持使用外置 Database 和 Redis -Tips: 不建议在生产中使用 +Tips: 不建议在生产中使用, 生产中请使用 详细安装 `详细安装 `_ Docker 安装见: `Docker官方安装文档 `_ @@ -18,9 +18,12 @@ Docker 安装见: `Docker官方安装文档 `_ 访问 ``````````````` -浏览器访问: http://localhost:8080 +浏览器访问: http://<容器所在服务器IP>:8080 + +SSH访问: ssh -p 2222 <容器所在服务器IP> + +XShell等工具请添加connection连接 -SSH访问: ssh -p 2222 localhost 额外环境变量 @@ -33,9 +36,9 @@ SSH访问: ssh -p 2222 localhost - DB_PASSWORD = xxxx - DB_NAME = jumpserver -- REDIS_HOST = '' -- REDIS_PORT = '' -- REDIS_PASSWORD = '' +- REDIS_HOST = +- REDIS_PORT = +- REDIS_PASSWORD = < :: diff --git a/docs/step_by_step.rst b/docs/step_by_step.rst index 3112de67a..aaa398ee1 100644 --- a/docs/step_by_step.rst +++ b/docs/step_by_step.rst @@ -26,7 +26,7 @@ :: - $ yum -y install wget sqlite-devel xz gcc automake zlib-devel openssl-devel epel-release + $ yum -y install wget sqlite-devel xz gcc automake zlib-devel openssl-devel epel-release git **1.2 编译安装** @@ -230,22 +230,33 @@ Luna 已改为纯前端，需要 Nginx 来运行访问 .. code:: shell + # 注意：这里一定要改写一下本机的IP地址, 否则会出错 docker run -d \ - -p 8081:8080 \ + -p 8081:8080 -v /opt/guacamole/key:/config/guacamole/key \ + -e JUMPSERVER_KEY_DIR=/config/guacamole/key \ -e JUMPSERVER_SERVER=http://<填写本机的IP地址>:8080 \ registry.jumpserver.org/public/guacamole:latest 这里所需要注意的是 guacamole 暴露出来的端口是 8081，若与主机上其他端口冲突请自定义一下。 -修改 JUMPSERVER SERVER 的配置，填上 Jumpserver 的内网地址 +再次强调：修改 JUMPSERVER_SERVER 环境变量的配置，填上 Jumpserver 的内网地址, 这时 +去 Jumpserver-会话管理-终端管理 接受[Gua]开头的一个注册 + + 六. 配置 Nginx 整合各组件 ~~~~~~~~~~~~~~~~~~~~~~~~~ 6.1 安装 Nginx 根据喜好选择安装方式和版本 -6.2 配置文件 +.. code:: shell + + yum -y install nginx + + +6.2 准备配置文件 修改 /etc/nginx/nginx.conf + :: @@ -295,4 +306,10 @@ Luna 已改为纯前端，需要 Nginx 来运行访问 6.3 运行 Nginx +:: + + nginx -t + service nginx start + + 6.4 访问 http://192.168.244.144 \ No newline at end of file