Skip to content

J
jumpserver
Unverified Commit 427fd2c0 authored by wojiushixiaobai's avatar wojiushixiaobai Committed by GitHub
Browse files
Options

Merge pull request #1446 from wojiushixiaobai/docs 

[Update]更新文档
parents 2517c85e 43247e43
Show whitespace changes
Inline Side-by-side
Showing with 232 additions and 143 deletions
docs/admin_create_asset.rst
View file @ 427fd2c0
......@@ -12,101 +12,61 @@
1.1 基本设置
.. image:: _static/img/basic_setting.jpg
1.2 配置邮件发送服务器
点击页面上边的"邮件设置" TAB ，进入邮件设置页面：
.. image:: _static/img/smtp_setting.jpg
配置 QQ 邮箱的 SMTP 服务可参考（http://blog.csdn.net/Aaron133/article/details/78363844），仅使用只需要看完第二部分即可。
配置邮件服务后，点击页面的"测试连接"按钮，如果配置正确，Jumpserver 会发送一条测试邮件到您的 SMTP 账号邮箱里面：
.. image:: _static/img/smtp_test.jpg
二、创建用户
`````````````````````
2.1 创建 Jumpserver 用户
点击页面左侧“用户列表”菜单下的“用户列表“，进入用户列表页面。
点击页面左上角“创建用户”按钮，进入创建用户页面，填写账户，角色安全，个人等信息。
其中，用户名即 Jumpserver 登录账号。用户组是用于资产授权，当某个资产对一个用户组授权后，这个用户组下面的所有用户就都可以使用这个资产了。角色用于区分一个用户是管理员还是普通用户。
.. image:: _static/img/create_jumpserver_user.jpg
成功提交用户信息后，Jumpserver 会发送一条设置"用户密码"的邮件到您填写的用户邮箱。
.. image:: _static/img/create_user_success.jpg
点击邮件中的设置密码链接，设置好密码后，您就可以用户名和密码登录 Jumpserver 了。
用户首次登录 Jumpserver，会被要求完善用户信息。
Linux/Unix 生成 SSH 密钥可以参考（https://www.cnblogs.com/horanly/p/6604104.html)
Windows 生成 SSH 密钥可以参考（https://www.cnblogs.com/horanly/p/6604104.html)
查看公钥信息
::
$ cat ~/.ssh/id_rsa.pub
ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDadDXxxx......
复制 SSH 公钥，添加到 Jumpserver 中。
# 修改 URL 的 localhost 为你的实际 url 地址，否则邮件收到的地址将为 localhost
修改完 url 地址后需要重启 jumpserver 服务（重启才能生效，后续会解决这个问题）
.. image:: _static/img/set_ssh_key.jpg
.. image:: _static/img/basic_setting.jpg
1.2 邮件设置
除了使用浏览器登录 Jumpserver 外，还可使用命令行登录：
::
确保 Coco 服务正常
# 点击页面上边的"邮件设置" TAB ，进入邮件设置页面
# 配置邮件服务后，点击页面的"测试连接"按钮，如果配置正确，Jumpserver 会发送一条测试邮件到
您的 SMTP 账号邮箱里面，确定收到测试邮件后点击保存即可使用。
.. image:: _static/img/coco_check.jpg
.. image:: _static/img/smtp_setting.jpg
鉴于心态检测存在延迟，您也可以直接在 Jumpserver 主机上执行如下命令检测 Coco 是否存活，Coco 服务默认使用 2222 端口:
1.3 LDAP设置
::
$ netstat -ntpl
# 先测试通过才能保存
# DN 和 OU 一定要完整(如DN:cn=Manage,ou=Jumpserver,dc=jumpserver,ou=org)
注：可借用第三方 gui 工具查看 ldap 用户的属性，新版本已经支持中文名登录，即cn=中文也可正常使用
效果如下：
.. image:: _static/img/coco_check_terminal.jpg
如 coco 不在线或者服务不正常，可以尝试重启 coco
1.4 终端设置
::
$ cd /opt/coco
$ ./cocod restart # 请确保 jumpserver 已经正常运行。
如 guacamole 不在线或者服务不正常，可以尝试重启容器
# 命令记录保存到 elastic
{"default": {"TYPE":"server"}, "ali-es": {"TYPE": "elasticsearch", "HOSTS": ["http://elastic:changeme@localhost:9200"]}}
::
# 录像存储在 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"}}
$ docker ps # 查询正在运行的容器，记录下容器的 <CONTAINER ID> ，可以附加 -a 参数查询所有容器
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
6b15fcf0e5f3 registry.jumpserver.org/public/guacamole:latest "/init" 2 weeks ago Exited (0) 10 days ago gracious_hugle
注：修改后，需要修改在Jumpserver 会话管理-终端管理 修改terminal的配置 录像存储 命令记录，然后重启 Jumpserver 服务
$ docker restart 6b15fcf0e5f3 # 6b15fcf0e5f3 是通过docker ps查询到的，请不要直接复制。
1.5 安全设置
# docker 用法： docker start|stop|restart|rm|rmi <CONTAINER ID>
二、创建用户
`````````````````````
命令行登录 Jumpserver 使用如下命令：
2.1 创建 Jumpserver 用户
::
$ ssh -p 2222 用户名@Jumpserver IP地址
登录成功后界面如下:
# 点击页面左侧“用户列表”菜单下的“用户列表“，进入用户列表页面
# 点击页面左上角“创建用户”按钮，进入创建用户页面，（也可以通过右上角导入模版进行用户导入）
# 其中，用户名即 Jumpserver 登录账号（具有唯一性，不能重名）。名称为页面右上角用户标识（可重复）
# 成功提交用户信息后，Jumpserver 会发送一条设置"用户密码"的邮件到您填写的用户邮箱
# 点击邮件中的设置密码链接，设置好密码后，您就可以用户名和密码登录 Jumpserver 了。
# 用户首次登录 Jumpserver，会被要求完善用户信息，按照向导操作即可。
注：MFA 即 Google Authenticator ，使用此软件需要APP时间与浏览器时间同步
.. image:: _static/img/coco_success.jpg
.. image:: _static/img/admin_user.jpg
三、创建资产
``````````````````
......@@ -115,19 +75,21 @@ Windows 生成 SSH 密钥可以参考（https://www.cnblogs.com/horanly/p/660410
3.1.1 编辑资产树
节点不能重名，右击节点可以添加、删除和重命名节点，以及进行资产相关的操作。
::
# 节点不能重名，右击节点可以添加、删除和重命名节点，以及进行资产相关的操作
注：如果有 linux 资产和 windows 资产，建议先建立 Linux 节点与 Windows 节点，不然授权时不好处理
.. image:: _static/img/asset_tree.jpg
3.1.2 创建管理用户
管理用户是服务器的 root，或拥有 NOPASSWD: ALL sudo 权限的用户，Jumpserver 使用该用户来推送系统用户、获取资产硬件信息等。
如果使用ssh私钥，需要先在资产上设置，这里举个例子供参考（本例登录资产使用root为例）
::
# 管理用户是资产上的 root，或拥有 NOPASSWD: ALL sudo 权限的用户，Jumpserver 使用该用
户来推送系统用户、获取资产硬件信息等
# 如果使用ssh私钥管理资产，需要先在资产上设置，这里举个例子供参考（本例登录资产使用root为例）
(1). 在资产上生成 root 账户的公钥和私钥
$ ssh-keygen -t rsa # 默认会输入公钥和私钥文件到 ~/.ssh 目录
......@@ -150,67 +112,87 @@ Windows 生成 SSH 密钥可以参考（https://www.cnblogs.com/horanly/p/660410
(5). 上传 ~/.ssh 目录下的 id_rsa 私钥到 jumpserver 的管理用户中
这样就可以使用 ssh私钥 进行管理服务器。
# 这样就可以使用 ssh私钥 进行管理服务器
名称可以按资产树来命名。用户名root。密码和 SSH 私钥必填一个。
# 名称可以按资产树来命名。用户名root。密码和 SSH 私钥必填一个
.. image:: _static/img/create_asset_admin_user.jpg
3.1.3 创建系统用户
系统用户是 Jumpserver 跳转登录资产时使用的用户，可以理解为登录资产用户，如 web, sa, dba(`ssh web@some-host`), 而不是使用某个用户的用户名跳转登录服务器(`ssh xiaoming@some-host`); 简单来说是 用户使用自己的用户名登录Jumpserver, Jumpserver使用系统用户登录资产。
系统用户的 Sudo 栏填写允许当前系统用户免sudo密码执行的程序路径，如默认的/sbin/ifconfig，意思是当前系统用户可以直接执行 ifconfig 命令或 sudo ifconfig 而不需要输入当前系统用户的密码，执行其他的命令任然需要密码，以此来达到权限控制的目的。
::
# 系统用户是 Jumpserver 跳转登录资产时使用的用户，可以理解为登录资产用户
# 系统用户的 Sudo 栏设定用户的 sudo 权限
# 这里简单举几个例子
Sudo /bin/su # 当前系统用户可以免sudo密码执行sudo su命令（也就是可以直接切换到root，生产环境不建议这样操作）
  Sudo /usr/bin/git,/usr/bin/php,/bin/cat,/bin/more,/bin/less,/usr/bin/head,/usr/bin/tail # 当前系统用户可以免sudo密码执行git php cat more less head tail
Sudo /bin/su # 当前系统用户可以免sudo密码执行sudo su命令
# 此处的权限应该根据使用用户的需求汇总后定制，原则上给予最小权限即可。
  Sudo /usr/bin/git,/usr/bin/php,/bin/cat,/bin/more,/bin/less,/usr/bin/tail
# 当前系统用户可以免sudo密码执行git php cat more less tail
系统用户创建时，如果选择了自动推送 Jumpserver 会使用 Ansible 自动推送系统用户到资产中，如果资产(交换机、Windows )不支持 Ansible, 请手动填写账号密码。
Sudo !/usr/bin/yum # 禁止执行 yum 权限
Linux 系统协议项务必选择 ssh 。如果用户在系统中已存在，请去掉自动生成密钥、自动推送勾选。
# 此处的权限应该根据使用用户的需求汇总后定制，原则上给予最小权限即可
# 下图为不允许用户执行一些危险的操作，允许其他的所有权限
.. image:: _static/img/create_user_sudo.jpg
::
# 系统用户创建时，如果选择了自动推送 Jumpserver 会使用 Ansible 自动推送系统用户到资产中，
如果资产(交换机、Windows )不支持 Ansible, 请手动填写资产上已有的账号及账号密码
# 如果不想使用 Jumpserver 推送用户，请去掉自动生成密钥、自动推送勾选。手动填写资产上已有的账号及账号密码
.. image:: _static/img/create_asset_system_user.jpg
3.1.4 创建资产
点击页面左侧的“资产管理”菜单下的“资产列表”按钮，查看当前所有的资产列表。
点击页面左上角的“创建资产”按钮，进入资产创建页面，填写资产信息。
::
IP 地址和管理用户要确保正确，确保所选的管理用户的用户名和密码能"牢靠"地登录指定的 IP 主机上。资产的系统平台也务必正确填写。公网 IP 信息只用于展示，可不填，Jumpserver 连接资产使用的是 IP 信息。
# 点击页面左侧的“资产管理”菜单下的“资产列表”按钮，查看当前所有的资产列表。
# 点击页面左上角的“创建资产”按钮，进入资产创建页面，填写资产信息。
# IP 地址和管理用户要确保正确，确保所选的管理用户的用户名和密码能"牢靠"地登录指定的 IP 主机上。
资产的系统平台也务必正确填写。公网 IP 信息只用于展示，可不填，Jumpserver 连接资产使用的是 IP 信息。
.. image:: _static/img/create_asset.jpg
资产创建信息填写好保存之后，可测试资产是否能正确连接：
::
# 资产创建信息填写好保存之后，可测试资产是否能正确连接
注：被连接资产需要python组件，且版本大于等于2.6，Ubuntu等资产默认不允许root用户远程ssh登录，请自行处理
# 如果资产不能正常连接，请检查管理用户的用户名和密钥是否正确以及该管理用户是否能使用 SSH 从 Jumpserver 主机正确登录到资产主机上
.. image:: _static/img/check_asset_connect.jpg
如果资产不能正常连接，请检查管理用户的用户名和密钥是否正确以及该管理用户是否能使用 SSH 从 Jumpserver 主机正确登录到资产主机上。
参考 `Linux 资产连接说明 <faq_linux.html>`_
3.1.5 网域列表
网域功能是为了解决部分环境无法直接连接而新增的功能，原理是通过网关服务器进行跳转登录。
点击页面左侧的“网域列表”按钮，查看所有网域列表。
::
点击页面左上角的“创建网域”按钮，进入网域创建页面，选择资产里用作网域的网关服务器。
# 网域功能是为了解决部分环境无法直接连接而新增的功能，原理是通过网关服务器进行跳转登录
# 点击页面左侧的“网域列表”按钮，查看所有网域列表
# 点击页面左上角的“创建网域”按钮，进入网域创建页面，选择资产里用作网域的网关服务器
注：混合云适用
.. image:: _static/img/create_domain.jpg
点击网域的名称，进入网域详情列表。
点击页面的“网关”按钮，选择网关列表的“创建网关”按钮，进入网关创建页面，填写网关信息。
::
IP信息一般默认填写网域资产的IP即可（如用作网域的资产有多块网卡和IP地址，选能与jumpserer通信的任一IP即可），用户名与密码可以在资产上面创建亦可使用jumpserver的推送功能（需要手动输入密码），确认该用户拥有执行ssh命令的权限。
# 点击网域的名称，进入网域详情列表。
# 点击页面的“网关”按钮，选择网关列表的“创建网关”按钮，进入网关创建页面，填写网关信息。
# IP信息一般默认填写网域资产的IP即可（如用作网域的资产有多块网卡和IP地址，选能与jumpserer通信的任一IP即可）
注：用户名与密码可以使用网关资产上已存在的任一拥有执行 ssh 命令权限的用户
.. image:: _static/img/create_geteway.jpg
保存信息后点击测试连接，确定设置无误后到资产列表添加需要使用网关登录的资产即可。
::
注：保存信息后点击测试连接，确定设置无误后到资产列表添加需要使用网关登录的资产即可。
.. image:: _static/img/create_asset02.jpg
......@@ -218,72 +200,92 @@ IP信息一般默认填写网域资产的IP即可（如用作网域的资产有
3.2.1 创建 Windows 系统管理用户
同 Linux 系统的管理用户一样，名称可以按资产树来命名，用户名是管理员用户名，密码是管理员的密码。
::
注：同 Linux 系统的管理用户一样，名称可以按资产树来命名，用户名是管理员用户名，密码是管理员的密码
.. image:: _static/img/create_windows_admin.jpg
3.2.2 创建 Windows 系统系统用户
目前 Windows 暂不支持自动推送，用户必须在系统中存在且有权限使用远程连接，请去掉自动生成密钥、自动推送勾选；请确认 windows 资产的 rdp 防火墙已经开放。
::
Windows 资产协议务必选择 rdp。
# 目前 Windows 暂不支持自动推送，用户必须在系统中存在且有权限使用远程连接，请确认资产的防火墙已经开放
注：Windows 资产协议务必选择 rdp
.. image:: _static/img/create_windows_user.jpg
3.2.3 创建 Windows 资产
同创建 Linux 资产一样。
::
创建 Windows 资产，系统平台请选择正确的 Windows，端口号为3389，IP 和 管理用户请正确选择，确保管理用户能正确登录到指定的 IP 主机上。
# 同创建 Linux 资产一样。
# 创建 Windows 资产，系统平台请选择正确的 Windows，默认 RDP 端口号为3389，IP 和 管理用户请正确选择，
注：确保管理用户能正确登录到指定的 IP 主机上
.. image:: _static/img/create_windows_asset.jpg
参考 `Windows 资产连接说明 <faq_windows.html>`_
四、资产节点管理
``````````````````````
4.1 为资产树节点分配资产
在资产列表页面，选择要添加资产的节点，右键，选择添加资产到节点。
::
注：在资产列表页面，选择要添加资产的节点，右键，选择添加资产到节点(一台资产可以同时在多个节点下面)
.. image:: _static/img/add_asset_to_node.jpg
选择要被添加的资产，点击"确认"即可。
::
注：选择要被添加的资产，点击"确认"即可。
.. image:: _static/img/select_asset_to_node.jpg
4.2 删除节点资产
选择要被删除的节点，选择"从节点删除"，点击"提交"即可。
::
注：选择要被删除的节点，选择"从节点删除"，点击"提交"即可。
.. image:: _static/img/delete_asset_from_node.jpg
五、创建授权规则
`````````````````````
节点，对应的是资产，代表该节点下的所有资产。
用户组，对应的是用户，代表该用户组下所有的用户。
系统用户，及所选的用户组下的用户能通过该系统用户使用所选节点下的资产。
::
节点，用户组，系统用户是一对一的关系，所以当拥有 Linux、Windows 不同类型资产时，应该分别给 Linux 资产和 Windows 资产创建授权规则。
# 节点，对应的是资产，代表该节点下的所有资产
# 用户组，对应的是用户，代表该用户组下所有的用户
# 系统用户，及所选的用户组下的用户能通过该系统用户使用所选节点下的资产
# 节点，用户组，系统用户是一对一的关系，所以当拥有 Linux、Windows 不同类型资产时，
应该分别给 Linux 资产和 Windows 资产创建授权规则。
.. image:: _static/img/create_auth_rules.jpg
创建的授权规节点要与资产所在的节点一致。
::
注：创建的授权规节点要与资产所在的节点一致。
.. image:: _static/img/auth_rule_list.jpg
::
# 原则上，一个授权只能同时授予一个用户或者一个组
# 意思是：把个人的资产授权给个人，把部门的资产授权给部门，把项目的资产授权给项目...
# 职责不同，权限就不同，安装职责制定系统用户
# 这样授权就不会乱
六、用户使用资产
`````````````````````
6.1 登录 Jumpserver
创建授权规则的时候，选择了用户组，所以这里需要登录所选用户组下面的用户才能看见相应的资产。
.. image:: _static/img/jumpserver_user_list.jpg
::
用户正确登录后的页面：
# 用户只能看到自己被管理员授权了的资产，如果登录后无资产，请联系管理员进行确认
.. image:: _static/img/user_login_success.jpg
......@@ -291,25 +293,30 @@ Windows 资产协议务必选择 rdp。
6.2.1 连接资产
点击页面左边的 Web 终端：
::
# 点击页面左边的 Web 终端：
.. image:: _static/img/link_web_terminal.jpg
打开资产所在的节点：
::
# 打开资产所在的节点：
.. image:: _static/img/luna_index.jpg
双击资产名字，就连上资产了：
::
如果显示连接超时，请检查为资产分配的系统用户用户名和密钥是否正确，是否正确选择 Windows 操作系统，协议 rdp，端口3389，是否正确选择 Linux 操作系统，协议 ssh，端口22，以及资产的防火墙策略是否正确配置等信息。
# 点击资产名字，就连上资产了，整个过程不需要用户输入资产的任何信息
# 如果显示连接超时，请参考FAQ文档进行处理
.. image:: _static/img/windows_assert.jpg
接下来，就可以对资产进行操作了。
6.2.2 断开资产
点击页面顶部的 Server 按钮会弹出选个选项，第一个断开所选的连接，第二个断开所有连接。
::
# 点击页面顶部的 Server 按钮会弹出选个选项，第一个断开所选的连接，第二个断开所有连接。
.. image:: _static/img/disconnect_assert.jpg
......
docs/distributed_04.rst
View file @ 427fd2c0
......@@ -69,8 +69,10 @@
...
class Config:
# Use it to encrypt or decrypt data
# SECURITY WARNING: keep the secret key used in production secret!
SECRET_KEY = os.environ.get('SECRET_KEY') or '2vym+ky!997d5kkcc64mnz06y1mmui3lut#(^wd=%s_qj$1%x'
# Jumpserver 使用 SECRET_KEY 进行加密
# SECRET_KEY = os.environ.get('SECRET_KEY') or '2vym+ky!997d5kkcc64mnz06y1mmui3lut#(^wd=%s_qj$1%x'
SECRET_KEY = os.environ.get('SECRET_KEY') or '请随意输入随机字符串（推荐字符大于等于 50位）'
# Django security setting, if your disable debug model, you should setting that
ALLOWED_HOSTS = ['*']
......
docs/setup_by_centos7.rst
View file @ 427fd2c0
......@@ -113,8 +113,9 @@ CentOS 7 安装文档
...
class Config:
# Use it to encrypt or decrypt data
# SECURITY WARNING: keep the secret key used in production secret!
SECRET_KEY = os.environ.get('SECRET_KEY') or '2vym+ky!997d5kkcc64mnz06y1mmui3lut#(^wd=%s_qj$1%x'
# Jumpserver 使用 SECRET_KEY 进行加密
# SECRET_KEY = os.environ.get('SECRET_KEY') or '2vym+ky!997d5kkcc64mnz06y1mmui3lut#(^wd=%s_qj$1%x'
SECRET_KEY = os.environ.get('SECRET_KEY') or '请随意输入随机字符串（推荐字符大于等于 50位）'
# Django security setting, if your disable debug model, you should setting that
ALLOWED_HOSTS = ['*']
......@@ -333,7 +334,8 @@ CentOS 7 安装文档
$ nginx -t # 确保配置没有问题, 有问题请先解决
$ systemctl start nginx
# 访问 http://192.168.244.144 默认账号: admin 密码: admin 到会话管理-终端管理 接受 Coco Guacamole 等应用的注册
# 访问 http://192.168.244.144 (注意，没有 :8080，通过 nginx 代理端口进行访问)
# 默认账号: admin 密码: admin 到会话管理-终端管理 接受 Coco Guacamole 等应用的注册
# 测试连接
$ ssh -p2222 admin@192.168.244.144
$ sftp -P2222 admin@192.168.244.144
......
docs/setup_by_ubuntu.rst
View file @ 427fd2c0
......@@ -124,13 +124,33 @@
::
class Config:
# Use it to encrypt or decrypt data
# Jumpserver 使用 SECRET_KEY 进行加密
# SECRET_KEY = os.environ.get('SECRET_KEY') or '2vym+ky!997d5kkcc64mnz06y1mmui3lut#(^wd=%s_qj$1%x'
SECRET_KEY = os.environ.get('SECRET_KEY') or '请随意输入随机字符串（推荐字符大于等于 50位）'
...
# Django security setting, if your disable debug model, you should setting that
ALLOWED_HOSTS = ['*']
# Development env open this, when error occur display the full process track, Production disable it
# DEBUG 模式 True为开启 False为关闭，默认开启，生产环境推荐关闭
DEBUG = False
# DEBUG, INFO, WARNING, ERROR, CRITICAL can set. See https://docs.djangoproject.com/en/1.10/topics/logging/
# 日志级别，默认为DEBUG，可调整为INFO, WARNING, ERROR, CRITICAL，默认INFO
LOG_LEVEL = 'WARNING'
LOG_DIR = os.path.join(BASE_DIR, 'logs')
# 找到如下所示，修改 sqlite3 为 mysql， 请勿直接复制粘贴
# Database setting, Support sqlite3, mysql, postgres ....
# See https://docs.djangoproject.com/en/1.10/ref/settings/#databases
# 使用的数据库配置，支持sqlite3, mysql, postgres等，默认使用sqlite3
# SQLite setting:
# 默认使用SQLite，如果使用其他数据库请注释下面两行
# DB_ENGINE = 'sqlite3'
# DB_NAME = os.path.join(BASE_DIR, 'data', 'db.sqlite3')
# MySQL or postgres setting like:
# 如果需要使用mysql或postgres，请取消下面的注释并输入正确的信息,本例使用mysql做演示
DB_ENGINE = 'mysql'
DB_HOST = '127.0.0.1'
DB_PORT = 3306
......@@ -138,7 +158,22 @@
DB_PASSWORD = 'somepassword'
DB_NAME = 'jumpserver'
# 到此结束，其他内容如果你不知道用途请勿更改
# When Django start it will bind this host and port
# Django 监听的ip和端口，生产环境推荐把0.0.0.0修改成127.0.0.1，这里的意思是允许x.x.x.x访问，127.0.0.1表示仅允许自身访问。
# ./manage.py runserver 127.0.0.1:8080
HTTP_BIND_HOST = '127.0.0.1'
HTTP_LISTEN_PORT = 8080
# Use Redis as broker for celery and web socket
# Redis 相关设置
REDIS_HOST = '127.0.0.1'
REDIS_PORT = 6379
REDIS_PASSWORD = ''
BROKER_URL = 'redis://%(password)s%(host)s:%(port)s/3' % {
'password': REDIS_PASSWORD,
'host': REDIS_HOST,
'port': REDIS_PORT,
}
...
config = DevelopmentConfig()
......
docs/step_by_step.rst
View file @ 427fd2c0
......@@ -155,8 +155,35 @@ Pip 加速设置请参考 <https://segmentfault.com/a/1190000011875306>
::
class DevelopmentConfig(Config):
DEBUG = True
...
class Config:
# Use it to encrypt or decrypt data
# Jumpserver 使用 SECRET_KEY 进行加密
# SECRET_KEY = os.environ.get('SECRET_KEY') or '2vym+ky!997d5kkcc64mnz06y1mmui3lut#(^wd=%s_qj$1%x'
SECRET_KEY = os.environ.get('SECRET_KEY') or '请随意输入随机字符串（推荐字符大于等于 50位）'
# Django security setting, if your disable debug model, you should setting that
ALLOWED_HOSTS = ['*']
# Development env open this, when error occur display the full process track, Production disable it
# DEBUG 模式 True为开启 False为关闭，默认开启，生产环境推荐关闭
DEBUG = False
# DEBUG, INFO, WARNING, ERROR, CRITICAL can set. See https://docs.djangoproject.com/en/1.10/topics/logging/
# 日志级别，默认为DEBUG，可调整为INFO, WARNING, ERROR, CRITICAL，默认INFO
LOG_LEVEL = 'WARNING'
LOG_DIR = os.path.join(BASE_DIR, 'logs')
# Database setting, Support sqlite3, mysql, postgres ....
# See https://docs.djangoproject.com/en/1.10/ref/settings/#databases
# 使用的数据库配置，支持sqlite3, mysql, postgres等，默认使用sqlite3
# SQLite setting:
# 默认使用SQLite，如果使用其他数据库请注释下面两行
# DB_ENGINE = 'sqlite3'
# DB_NAME = os.path.join(BASE_DIR, 'data', 'db.sqlite3')
# MySQL or postgres setting like:
# 如果需要使用mysql或postgres，请取消下面的注释并输入正确的信息,本例使用mysql做演示
DB_ENGINE = 'mysql'
DB_HOST = '127.0.0.1'
DB_PORT = 3306
......@@ -164,9 +191,25 @@ Pip 加速设置请参考 <https://segmentfault.com/a/1190000011875306>
DB_PASSWORD = 'somepassword'
DB_NAME = 'jumpserver'
# When Django start it will bind this host and port
# Django 监听的ip和端口，生产环境推荐把0.0.0.0修改成127.0.0.1，这里的意思是允许x.x.x.x访问，127.0.0.1表示仅允许自身访问。
# ./manage.py runserver 127.0.0.1:8080
HTTP_BIND_HOST = '127.0.0.1'
HTTP_LISTEN_PORT = 8080
# Use Redis as broker for celery and web socket
# Redis 相关设置
REDIS_HOST = '127.0.0.1'
REDIS_PORT = 6379
REDIS_PASSWORD = ''
BROKER_URL = 'redis://%(password)s%(host)s:%(port)s/3' % {
'password': REDIS_PASSWORD,
'host': REDIS_HOST,
'port': REDIS_PORT,
}
...
config = DevelopmentConfig() # 确保使用的是刚才设置的配置文件
config = DevelopmentConfig()
**2.8 生成数据库表结构和初始化数据**
......
docs/upgrade.rst
View file @ 427fd2c0
......@@ -5,7 +5,7 @@
::
# 新版本更新了自动升级脚本，升级只需要到 utils 目录下执行 sh upgrade.sh 即可，请做好备份
# 升级前请做好 jumpserver 与 数据库 备份，谨防意外，具体的备份命令可以参考离线升级
$ cd /opt/jumpserver
$ git pull
$ pip install -r requirements/requirements.txt # 如果使用其他源下载失败可以使用 -i 参数指定源
......@@ -18,7 +18,7 @@
::
# 新版本更新了自动升级脚本，升级只需要到 utils 目录下执行 sh upgrade.sh 即可
# 如果 coco 目录非默认位置请手动修改
$ cd /opt/coco
$ git pull && pip install -r requirements/requirements.txt
......
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