From 3ce07cf96928276353b377a30dff0ef027d649fd Mon Sep 17 00:00:00 2001 From: ibuler Date: Wed, 12 Jul 2017 20:45:21 +0800 Subject: [PATCH] Update README --- README.md | 65 +++++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 46 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index e808ad576..915a89584 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,61 @@ ## Jumpserver +Jumpserver is a open source proxy server, developed by `Python` and `Django`, aim to help +companies to efficiently user, assets, authority and audit management + Jumpserver是一款使用Python, Django开发的开源跳板机系统, 助力互联网企业高效 用户、资产、权限、审计 管理 -### 环境 - * Python 3.5 # 大部分功能兼容Python2.7 +### Feature 功能 + - Auth 统一认证 + - CMDB 资产管理 + - Perm 统一授权 + - Audit 审计 + - LDAP AUTH 支持LDAP认证 + - Web terminal + - SSH Server + + +### Environment 环境 + * Python 3.5 * Django 1.11 -### 安装 +### Install 安装 +Using docker compose to setup it + 使用docker compose 安装,一键完成,docker compose 安装见 docker官方   $ docker-compose up -### 使用 -   1. 访问 http://你的主机IP:8080 来访问 Jumpserver - -   2. 左侧 应用程序接受 Coco和Luna的注册 +### Usage 使用 +   1. Visit http://$HOST:8080 (访问 http://你的主机IP:8080 来访问 Jumpserver) + +   2. Click left navigation visit Applications-Terminal and accept coco and luna register + (点击左侧 应用程序接受 Coco和Luna的注册) -   3. 添加 管理用户 +   3. Click Assets-Admin user, Create admin user + (添加 管理用户) -   4. 添加 资产 + 4. Click Assets-System user, Create system user + (添加 系统用户) + +   5. Click Assets-Asset, Add a asset + (添加 资产) -   5. 添加授权规则,授权给admin +   6. Click Perms-Asset permission, Add a perm rule + (添加授权规则,授权给admin) -   6. ssh -p2222 admin@你的主机IP 测试连接服务器 +   7. Connect ssh server coco (连接 ssh server coco) + + ssh -p2222 $USER@$Host -   7. 访问 http://你的主机IP:5000 访问Luna,点击左侧服务器连接测试 +   8. Visit web terminal server Luna, click server test connection + (访问 访问Luna,点击左侧服务器连接测试) + + http://$HOST:5000 -### 截图 +### Snapshot 截图 -参见 https://github.com/jumpserver/jumpserver/issues/438 + https://github.com/jumpserver/jumpserver/issues/438 ### Demo @@ -45,14 +72,14 @@ demo使用了开发者模式,并发只能为1 参见 https://github.com/jumpserver/jumpserver/milestone/2 -### 开发者文档 +### Docs 开发者文档 - * [项目结构描述](https://github.com/jumpserver/jumpserver/blob/dev/docs/project_structure.md) - * [Python代码规范](https://github.com/jumpserver/jumpserver/blob/dev/docs/python_style_guide.md) - * [API设计规范](https://github.com/jumpserver/jumpserver/blob/dev/docs/api_style_guide.md) + * [Project structure 项目结构描述](https://github.com/jumpserver/jumpserver/blob/dev/docs/project_structure.md) + * [Code style Python代码规范](https://github.com/jumpserver/jumpserver/blob/dev/docs/python_style_guide.md) + * [Api style API设计规范](https://github.com/jumpserver/jumpserver/blob/dev/docs/api_style_guide.md) -### 贡献者 +### Contributor 贡献者 #### 0.4.0 - ibuler <广宏伟> - 小彧 <李磊> Django资深开发者,为users模块贡献了很多代码