jumpserver/README.md

95 lines
2.9 KiB
Markdown
Raw Normal View History

2017-03-04 08:38:26 +00:00
## Jumpserver
2017-07-12 12:45:21 +00:00
Jumpserver is a open source proxy server, developed by `Python` and `Django`, aim to help
companies to efficiently user, assets, authority and audit management
2017-03-04 08:41:36 +00:00
Jumpserver是一款使用Python, Django开发的开源跳板机系统, 助力互联网企业高效 用户、资产、权限、审计 管理
2017-03-04 08:38:26 +00:00
2017-07-12 12:45:21 +00:00
### Feature 功能
- Auth 统一认证
- CMDB 资产管理
- Perm 统一授权
- Audit 审计
- LDAP AUTH 支持LDAP认证
- Web terminal
- SSH Server
### Environment 环境
* Python 3.5
* Django 1.11
2016-08-12 17:16:52 +00:00
2017-07-12 12:45:21 +00:00
### Install 安装
Using docker compose to setup it
2017-05-22 03:27:30 +00:00
使用docker compose 安装一键完成docker compose 安装见 docker官方
2017-03-04 08:38:26 +00:00
2017-05-22 03:27:30 +00:00
  $ docker-compose up
2017-05-22 04:31:37 +00:00
2017-07-12 12:45:21 +00:00
### 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的注册)
2017-05-24 01:49:02 +00:00
2017-07-12 12:45:21 +00:00
  3. Click Assets-Admin user, Create admin user
(添加 管理用户)
2017-05-24 01:49:02 +00:00
2017-07-12 12:45:21 +00:00
4. Click Assets-System user, Create system user
(添加 系统用户)
  5. Click Assets-Asset, Add a asset
(添加 资产)
2017-05-24 01:49:02 +00:00
2017-07-12 12:45:21 +00:00
  6. Click Perms-Asset permission, Add a perm rule
(添加授权规则授权给admin)
2017-05-24 01:49:02 +00:00
2017-07-12 12:45:21 +00:00
  7. Connect ssh server coco (连接 ssh server coco)
ssh -p2222 $USER@$Host
2017-05-24 01:49:02 +00:00
2017-07-12 12:45:21 +00:00
  8. Visit web terminal server Luna, click server test connection
(访问 访问Luna点击左侧服务器连接测试)
http://$HOST:5000
2017-05-24 01:49:02 +00:00
2017-07-12 12:45:21 +00:00
### Snapshot 截图
2017-05-22 04:31:37 +00:00
2017-07-12 12:45:21 +00:00
https://github.com/jumpserver/jumpserver/issues/438
2017-05-22 04:31:37 +00:00
2017-06-19 15:41:45 +00:00
### Demo
demo使用了开发者模式并发只能为1
- Jumpserver: [访问](http://demo.jumpserver.org:8080) 账号: admin 密码: admin
- Luna: [访问](http://demo.jumpserver.org:5000) 同Jumpserver认证
- Coco: ssh -p 2222 admin@demo.jumpserver.org 密码: admin
2017-07-10 02:57:41 +00:00
### ROADMAP
参见 https://github.com/jumpserver/jumpserver/milestone/2
2017-06-19 15:41:45 +00:00
2017-07-12 12:45:21 +00:00
### Docs 开发者文档
2017-03-04 08:38:26 +00:00
2017-07-12 12:45:21 +00:00
* [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)
2017-06-19 15:15:09 +00:00
2017-07-12 12:45:21 +00:00
### Contributor 贡献者
2017-06-19 15:15:09 +00:00
#### 0.4.0
- ibuler <广宏伟>
- 小彧 <李磊> Django资深开发者为users模块贡献了很多代码
- sofia <周小侠> 资深前端工程师, luna前端代码贡献者和现在维护者
- liuz <刘正> 全栈工程师, 编写了luna大部分代码
2017-06-19 15:48:36 +00:00
- jiaxiangkong <陈尚委> Jumpserver测试运营
#### 0.3.2
- halcyon <王墉> DevOps 资深开发者, jassets开发者
- yumaojun03 <喻茂峻> DevOps 资深开发者jperm开发者擅长Python, Go以及PAAS平台开发
- kelianchun <柯连春> DevOps 资产开发者fix了很多connect.py bug
2017-06-19 15:15:09 +00:00