Skip to content

J
jumpserver
Unverified Commit 97414e4e authored by wojiushixiaobai's avatar wojiushixiaobai Committed by GitHub
Browse files
Options

Merge pull request #1937 from wojiushixiaobai/docs 

[Update]更新文档
parents 7d5c0ae0 50e1ab3c
Hide whitespace changes
Inline Side-by-side
Showing with 43 additions and 28 deletions
docs/admin_create_asset.rst
View file @ 97414e4e
...@@ -24,8 +24,9 @@ ...@@ -24,8 +24,9 @@
:: ::
# 点击页面上边的"邮件设置" TAB ，进入邮件设置页面 # 点击页面上边的"邮件设置" TAB ，进入邮件设置页面
# 配置邮件服务后，点击页面的"测试连接"按钮，如果配置正确，Jumpserver 会发送一条测试邮件到 # 默认使用 25 端口，不勾选 SSL 和 TLS；如果需要勾选 SSL，端口需要修改成 465；如果需要勾选 TLS，端口需要改成 587
您的 SMTP 账号邮箱里面，确定收到测试邮件后点击保存即可使用。 # 不可以同时勾选 SSL 和 TLS，
配置邮件服务后，点击页面的"测试连接"按钮，如果配置正确，Jumpserver 会发送一条测试邮件到您的 SMTP 账号邮箱里面，确定收到测试邮件后点击保存即可使用
.. image:: _static/img/smtp_setting.jpg .. image:: _static/img/smtp_setting.jpg
...@@ -37,18 +38,19 @@ ...@@ -37,18 +38,19 @@
# 先测试通过才能保存 # 先测试通过才能保存
# DN 和 OU 一定要完整(如DN:cn=Manage,ou=Jumpserver,dc=jumpserver,ou=org) # DN 和 OU 一定要完整(如DN:cn=Manage,ou=Jumpserver,dc=jumpserver,ou=org)
注：可借用第三方 gui 工具查看 ldap 用户的属性，新版本已经支持中文名登录，即cn=中文也可正常使用 注：可借用第三方 gui 工具查看 ldap 用户的属性，新版本已经支持中文名登录，即cn=中文也可正常使用
详细设置请参考`LDAP 使用说明 <faq_ldap.html>`_
1.4 终端设置 1.4 终端设置
:: ::
# 命令记录保存到 elastic # 命令记录保存到 elastic （命令记录需要所有地址都正常可用，否则 历史会话 和 命令记录 页面无法正常访问，如果不清楚，请勿修改命令记录设置）
{"default": {"TYPE":"server"}, "ali-es": {"TYPE": "elasticsearch", "HOSTS": ["http://elastic:changeme@localhost:9200"]}} {"default": {"TYPE":"server"}, "ali-es": {"TYPE": "elasticsearch", "HOSTS": ["http://elastic:changeme@localhost:9200"]}}
# 录像存储在 oss，Jumpserver 系统设置-终端设置 录像存储 # 录像存储在 oss，Jumpserver 系统设置-终端设置 录像存储
{"default": {"TYPE": "server"}, "cn-north-1": {"TYPE": "s3", "BUCKET": "jumpserver", "ACCESS_KEY": "", "SECRET_KEY": "", "REGION": "cn-north-1"}, "ali-oss": {"TYPE": "oss", "BUCKET": "jumpserver", "ACCESS_KEY": "", "SECRET_KEY": "", "ENDPOINT": "http://oss-cn-hangzhou.aliyuncs.com"}} {"default": {"TYPE": "server"}, "cn-north-1": {"TYPE": "s3", "BUCKET": "jumpserver", "ACCESS_KEY": "", "SECRET_KEY": "", "REGION": "cn-north-1"}, "ali-oss": {"TYPE": "oss", "BUCKET": "jumpserver", "ACCESS_KEY": "", "SECRET_KEY": "", "ENDPOINT": "http://oss-cn-hangzhou.aliyuncs.com"}}
注：修改后，需要修改在Jumpserver 会话管理-终端管理 修改terminal的配置 录像存储 命令记录，然后重启 Jumpserver 服务 修改后，需要修改在Jumpserver 会话管理-终端管理 修改terminal的配置 录像存储 命令记录，然后重启 Jumpserver 服务
1.5 安全设置 1.5 安全设置
......
docs/faq_install.rst
View file @ 97414e4e
...@@ -39,22 +39,22 @@ ...@@ -39,22 +39,22 @@
:: ::
# 一般是由于 py3 环境未载入 一般是由于 py3 环境未载入
$ source /opt/py3/bin/activate $ source /opt/py3/bin/activate
# 看到下面的提示符代表成功，以后运行 Jumpserver 都要先运行以上 source 命令，以下所有命令均在该虚拟环境中运行 看到下面的提示符代表成功，以后运行 Jumpserver 都要先运行以上 source 命令，以下所有命令均在该虚拟环境中运行
(py3) [root@localhost py3] (py3) [root@localhost py3]
# 如果已经在 py3 虚拟环境下，任然报 Are you sure it's installed and available on your PYTHONPATH environment variable? Did you forget to activate a virtual environment? 如果已经在 py3 虚拟环境下，任然报 Are you sure it's installed and available on your PYTHONPATH environment variable? Did you forget to activate a virtual environment?
$ cd /opt/jumpserver/requirements $ cd /opt/jumpserver/requirements
$ pip install -r requirements.txt $ pip install -r requirements.txt
# 然后重新执行 bash make_migrations.sh 然后重新执行 bash make_migrations.sh
7. sh make_migrations.sh 报错 CommandError: Conflicting migrations detected; multiple ... django_celery_beat ... 7. sh make_migrations.sh 报错 CommandError: Conflicting migrations detected; multiple ... django_celery_beat ...
:: ::
# 这是由于 django-celery-beat老版本有bug引起的 这是由于 django-celery-beat老版本有bug引起的
$ rm -rf /opt/py3/lib/python3.6/site-packages/django_celery_beat/migrations/ $ rm -rf /opt/py3/lib/python3.6/site-packages/django_celery_beat/migrations/
$ pip uninstall django-celery-beat $ pip uninstall django-celery-beat
$ pip install django-celery-beat $ pip install django-celery-beat
...@@ -91,25 +91,25 @@ ...@@ -91,25 +91,25 @@
:: ::
# 一般是由于 py3 环境未载入 一般是由于 py3 环境未载入
$ source /opt/py3/bin/activate $ source /opt/py3/bin/activate
# 看到下面的提示符代表成功，以后运行 Jumpserver 都要先运行以上 source 命令，以下所有命令均在该虚拟环境中运行 看到下面的提示符代表成功，以后运行 Jumpserver 都要先运行以上 source 命令，以下所有命令均在该虚拟环境中运行
(py3) [root@localhost py3] (py3) [root@localhost py3]
# 如果已经在 py3 虚拟环境下 如果已经在 py3 虚拟环境下
$ cd /opt/coco/ $ cd /opt/coco/
$ pip install -r requirements/requirements.txt $ pip install -r requirements/requirements.txt
# 然后重新执行 ./cocod start 即可 然后重新执行 ./cocod start 即可
13. 执行 ./cocod start 后提示 Failed register terminal xxxx exist already 13. 执行 ./cocod start 后提示 Failed register terminal xxxx exist already
:: ::
# 这是由于 coco 注册未成功造成的，需要重新注册 (能正常访问 jumpserver 页面后再处理) 这是由于 coco 注册未成功造成的，需要重新注册 (能正常访问 jumpserver 页面后再处理)
# 到 Jumpserver后台 会话管理-终端管理 删掉 coco 的注册 到 Jumpserver后台 会话管理-终端管理 删掉 coco 的注册
# 必须到 Jumpserver后台 会话管理-终端管理 删掉 coco 的注册 必须到 Jumpserver后台 会话管理-终端管理 删掉 coco 的注册
# 一定要先到 Jumpserver后台 会话管理-终端管理 删掉 coco 的注册 一定要先到 Jumpserver后台 会话管理-终端管理 删掉 coco 的注册
$ cd /opt/coco && ./cocod stop $ cd /opt/coco && ./cocod stop
$ rm /opt/coco/keys/.access_key # coco, 如果你是按文档安装的，key应该在这里，如果不存在key文件直接下一步 $ rm /opt/coco/keys/.access_key # coco, 如果你是按文档安装的，key应该在这里，如果不存在key文件直接下一步
$ ./cocod start -d # 正常运行后到Jumpserver 会话管理-终端管理 里面接受coco注册 $ ./cocod start -d # 正常运行后到Jumpserver 会话管理-终端管理 里面接受coco注册
...@@ -118,7 +118,7 @@ ...@@ -118,7 +118,7 @@
:: ::
# 这是因为当前系统的 hostname 有 coco 不支持的字符，需要手动指定 coco 的 NAME 这是因为当前系统的 hostname 有 coco 不支持的字符，需要手动指定 coco 的 NAME
$ cd /opt/coco/ $ cd /opt/coco/
$ vim conf.py $ vim conf.py
...@@ -126,23 +126,36 @@ ...@@ -126,23 +126,36 @@
# NAME = "localhost" # NAME = "localhost"
NAME = "coco" NAME = "coco"
# 保存后重新执行 ./cocod start 即可 保存后重新执行 ./cocod start 即可
15. 运行 ./cocod start 后提示 No such file or directory: '/opt/coco/xxx/xxx' 15. 运行 ./cocod start 后提示 No such file or directory: '/opt/coco/xxx/xxx'
:: ::
# 这是一个小 bug，之后的版本会修复掉 这是一个小 bug，之后的版本会修复掉
$ cd /opt/coco $ cd /opt/coco
$ mkdir keys logs $ mkdir keys logs
# 保存后重新执行 ./cocod start 即可 保存后重新执行 ./cocod start 即可
16. 通过 nginx 代理的端口访问 jumpserver 页面显示不正常 16. 运行 ./cocod start 后提示 Connect endpoint http://xxxx:8080 error: HTTPConnectionPool(host='xxxx', port=8080)
:: ::
# 这是因为你没有按照教程进行安装，修改了安装目录，需要在 nginx 的配置文件里面修改资源路径 这是因为 coco 无法连接到 jumpserver 报的错误，确定 http://xxxx:8080 设置正确（配置文件 coco/conf.py）
如果 jumpserver 的IP和端口不对，请手动修改 conf.py 的 CORE_HOST
17. 运行 ./cocod start 后提示 Unexpected error occur: 'AppService' object has no attribute 'get_system_user_cmd_filter_rules'
::
这是因为你的 pip 依赖包未正确安装，参考本文档第 4 条
18. 通过 nginx 代理的端口访问 jumpserver 页面显示不正常
::
这是因为你没有按照教程进行安装，修改了安装目录，需要在 nginx 的配置文件里面修改资源路径
$ vim /etc/nginx/nginx.conf $ vim /etc/nginx/nginx.conf
... ...
...@@ -194,7 +207,7 @@ ...@@ -194,7 +207,7 @@
... ...
17. 访问 luna 页面提示 Luna是单独部署的一个程序，你需要部署luna，coco，配置nginx做url分发... 19. 访问 luna 页面提示 Luna是单独部署的一个程序，你需要部署luna，coco，配置nginx做url分发...
:: ::
......
docs/faq_rdp.rst
View file @ 97414e4e
...@@ -13,6 +13,8 @@ RDP 协议资产连接错误排查思路 ...@@ -13,6 +13,8 @@ RDP 协议资产连接错误排查思路
1. 检查终端是否在线 1. 检查终端是否在线
.. image:: _static/img/faq_windows_01.jpg
:: ::
注：连接 Windows 资产提示连接错误，您没有权限访问此连接，请按照此步骤解决 注：连接 Windows 资产提示连接错误，您没有权限访问此连接，请按照此步骤解决
...@@ -36,8 +38,6 @@ RDP 协议资产连接错误排查思路 ...@@ -36,8 +38,6 @@ RDP 协议资产连接错误排查思路
# 正常运行后到Jumpserver 会话管理-终端管理 里面接受gua注册 # 正常运行后到Jumpserver 会话管理-终端管理 里面接受gua注册
$ docker restart jms_guacamole # 如果接受注册后显示不在线，重启gua就好了 $ docker restart jms_guacamole # 如果接受注册后显示不在线，重启gua就好了
.. image:: _static/img/faq_windows_01.jpg
2. 登录要连接的windows资产，检查远程设置和防火墙设置 2. 登录要连接的windows资产，检查远程设置和防火墙设置
:: ::
......
docs/faq_ssh.rst
View file @ 97414e4e
...@@ -11,6 +11,8 @@ SSH 协议资产连接错误排查思路 ...@@ -11,6 +11,8 @@ SSH 协议资产连接错误排查思路
1. 检查终端是否在线 1. 检查终端是否在线
.. image:: _static/img/faq_linux_01.jpg
:: ::
# 确定已经在Jumpserver后台 会话管理-终端管理 里接受 coco 的注册 # 确定已经在Jumpserver后台 会话管理-终端管理 里接受 coco 的注册
...@@ -33,8 +35,6 @@ SSH 协议资产连接错误排查思路 ...@@ -33,8 +35,6 @@ SSH 协议资产连接错误排查思路
$ rm /opt/coco/keys/.access_key # coco, 如果你是按文档安装的，key应该在这里，如果不存在，直接下一步 $ rm /opt/coco/keys/.access_key # coco, 如果你是按文档安装的，key应该在这里，如果不存在，直接下一步
$ ./cocod start -d # 正常运行后到Jumpserver 会话管理-终端管理 里面接受coco注册 $ ./cocod start -d # 正常运行后到Jumpserver 会话管理-终端管理 里面接受coco注册
.. image:: _static/img/faq_linux_01.jpg
2. 访问 luna 界面不显示资产信息 2. 访问 luna 界面不显示资产信息
:: ::
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment