github
/
jumpserver
mirror of https://github.com/jumpserver/jumpserver
1
0
Fork 0
Code Issues Releases Wiki Activity

Merge branch 'master' of code.simcu.com:jumpserver/jumpserver

pull/530/head
ibuler 2016-08-13 16:17:42 +08:00
parent 1dd17b1814 089b54986a
commit 25f1c9ccf3
6 changed files with 178 additions and 80 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -1,9 +1,9 @@
## [文档和规范]
#### [项目结构描述](https://code.simcu.com/jumpserver/jumpserver/blob/master/docs/project_structure.md)
#### [Python代码规范](https://code.simcu.com/jumpserver/jumpserver/blob/master/docs/python_style_guide.md)
#### [API设计规范](https://code.simcu.com/jumpserver/jumpserver/blob/master/docs/api_style_guide.md)
## [文档和规范]
#### [项目结构描述](https://code.simcu.com/jumpserver/jumpserver/blob/master/docs/project_structure.md)
#### [Python代码规范](https://code.simcu.com/jumpserver/jumpserver/blob/master/docs/python_style_guide.md)
#### [API设计规范](https://code.simcu.com/jumpserver/jumpserver/blob/master/docs/api_style_guide.md)
#### [表结构](https://code.simcu.com/jumpserver/jumpserver/wikis/table_structure_image)

6
docs/README.md
View File

@ -1,2 +1,4 @@
## [代码规范](/jumpserver/jumpserver/blob/master/docs/code_style.md)
## [项目结构](/jumpserver/jumpserver/blob/master/docs/project_structure.md)
#### [项目结构描述](https://code.simcu.com/jumpserver/jumpserver/blob/master/docs/project_structure.md)
#### [Python代码规范](https://code.simcu.com/jumpserver/jumpserver/blob/master/docs/python_style_guide.md)
#### [API设计规范](https://code.simcu.com/jumpserver/jumpserver/blob/master/docs/api_style_guide.md)
#### [表结构](https://code.simcu.com/jumpserver/jumpserver/wikis/table_structure_image)

83
docs/project_structure.md
View File

@ -1,41 +1,42 @@
## 项目骨架
说明如下：
```
.
├── config-example.py // 配置文件样例
├── docs // 所有doc文件放到该目录
│ └── README.md
├── LICENSE
├── README.md
├── install // 安装说明
├── logs // 日志目录
├── dashboard // 管理后台目录，也是各app所在目录
│ └── assets // app目录
│ │ ├── admin.py
│ │ ├── apps.py // 新版本django app设置文件
│ │ ├── api.py // api文件
│ │ ├── __init__.py
│ │ ├── migrations // models Migrations版本控制目录
│ │ │ └── __init__.py
│ │ ├── models.py // 数据模型目录
│ │ ├── static // app下静态资源目录,如果需要
│ │ │ └── assets // 多一层目录，防止资源重名
│ │ │ └── some_image.png
│ │ ├── templates // app下模板目录
│ │ │ └── assets // 多一层目录，防止资源重名
│ │ │ └── asset_list.html
│ │ ├── templatetags // 模板标签目录
│ │ ├── tests.py // 测试用例文件
│ │ ├── urls.py // urlconf文件
│ │ ├── utils.py // 将views和api可复用的代码放在这里, api和views只是请求和返回不同
│ │ └── views.py // views文件
│ ├── jumpserver // 项目设置目录
│ │ ├── __init__.py
│ │ ├── settings.py // 项目设置文件
│ │ ├── urls.py // 项目入口urlconf
│ │ └── wsgi.py
│ ├── manage.py
│ ├── static // 项目静态资源目录
│ └── templates
## 项目骨架
说明如下：
```
.
├── config-example.py // 配置文件样例
├── docs // 所有doc文件放到该目录
│ └── README.md
├── LICENSE
├── README.md
├── install // 安装说明
├── logs // 日志目录
├── dashboard // 管理后台目录，也是各app所在目录
│ └── assets // app目录
│ │ ├── admin.py
│ │ ├── apps.py // 新版本django app设置文件
│ │ ├── api.py // api文件
│ │ ├── __init__.py
│ │ ├── migrations // models Migrations版本控制目录
│ │ │ └── __init__.py
│ │ ├── models.py // 数据模型目录
│ │ ├── static // app下静态资源目录,如果需要
│ │ │ └── assets // 多一层目录，防止资源重名
│ │ │ └── some_image.png
│ │ ├── templates // app下模板目录
│ │ │ └── assets // 多一层目录，防止资源重名
│ │ │ └── asset_list.html
│ │ ├── templatetags // 模板标签目录
│ │ ├── tests.py // 测试用例文件
│ │ ├── urls.py // urlconf文件
│ │ ├── utils.py // 将views和api可复用的代码放在这里, api和views只是请求和返回不同
│ │ └── views.py // views文件
│ ├── jumpserver // 项目设置目录
│ │ ├── __init__.py
│ │ ├── settings.py // 项目设置文件
│ │ ├── urls.py // 项目入口urlconf
│ │ └── wsgi.py
│ ├── manage.py
│ ├── static // 项目静态资源目录
│ └── templates // 项目模板目录
```

151
docs/table_design.xml
View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8" ?>
<!-- SQL XML created by WWW SQL Designer, https://github.com/ondras/wwwsqldesigner/ -->
<!-- Active URL: http://ondras.zarovi.cz/sql/demo/?keyword=default -->
<!-- Active URL: http://ondras.zarovi.cz/sql/demo/?keyword=jumpserver -->
<sql>
<datatypes db="mysql">
<group color="rgb(238,238,170)" label="Numeric">
@ -100,7 +100,7 @@
<part>id</part>
</key>
</table>
<table x="199" y="429" name="role">
<table x="227" y="430" name="role">
<row name="id" null="1" autoincrement="1">
<datatype>INTEGER</datatype>
<default>NULL</default></row>
@ -114,7 +114,7 @@
<part>id</part>
</key>
</table>
<table x="400" y="98" name="usergroup">
<table x="399" y="102" name="usergroup">
<row name="id" null="1" autoincrement="1">
<datatype>INTEGER</datatype>
<default>NULL</default></row>
@ -131,7 +131,7 @@
<part>id</part>
</key>
</table>
<table x="179" y="107" name="user_usergroup">
<table x="159" y="181" name="user_usergroup">
<row name="id" null="1" autoincrement="1">
<datatype>INTEGER</datatype>
<default>NULL</default></row>
@ -147,7 +147,7 @@
<part>id</part>
</key>
</table>
<table x="199" y="586" name="permission">
<table x="220" y="587" name="permission">
<row name="id" null="1" autoincrement="1">
<datatype>INTEGER</datatype>
<default>NULL</default></row>
@ -165,7 +165,7 @@
<part>id</part>
</key>
</table>
<table x="13" y="587" name="cententtype">
<table x="28" y="582" name="cententtype">
<row name="id" null="1" autoincrement="1">
<datatype>INTEGER</datatype>
<default>NULL</default></row>
@ -179,7 +179,7 @@
<part>id</part>
</key>
</table>
<table x="12" y="428" name="role_permission">
<table x="26" y="426" name="role_permission">
<row name="id" null="1" autoincrement="1">
<datatype>INTEGER</datatype>
<default>NULL</default></row>
@ -276,7 +276,7 @@
<part>id</part>
</key>
</table>
<table x="1287" y="722" name="asset待定">
<table x="1278" y="684" name="asset待定">
<row name="id" null="1" autoincrement="1">
<datatype>INTEGER</datatype>
<default>NULL</default></row>
@ -290,7 +290,7 @@
<part>id</part>
</key>
</table>
<table x="1298" y="391" name="idc">
<table x="1274" y="387" name="idc">
<row name="id" null="1" autoincrement="1">
<datatype>INTEGER</datatype>
<default>NULL</default></row>
@ -344,7 +344,7 @@
<part>id</part>
</key>
</table>
<table x="1080" y="92" name="assetgroup">
<table x="1080" y="102" name="assetgroup">
<row name="id" null="1" autoincrement="1">
<datatype>INTEGER</datatype>
<default>NULL</default></row>
@ -361,7 +361,7 @@
<part>id</part>
</key>
</table>
<table x="1260" y="86" name="asset_assetgroup">
<table x="1261" y="101" name="asset_assetgroup">
<row name="id" null="1" autoincrement="1">
<datatype>INTEGER</datatype>
<default>NULL</default></row>
@ -377,7 +377,7 @@
<part>id</part>
</key>
</table>
<table x="1281" y="875" name="adminuser">
<table x="1272" y="806" name="adminuser">
<row name="id" null="1" autoincrement="1">
<datatype>INTEGER</datatype>
<default>NULL</default></row>
@ -412,7 +412,7 @@
<part>id</part>
</key>
</table>
<table x="663" y="659" name="sysuser">
<table x="732" y="571" name="sysuser">
<row name="id" null="1" autoincrement="1">
<datatype>INTEGER</datatype>
<default>NULL</default></row>
@ -468,7 +468,7 @@
<part>id</part>
</key>
</table>
<table x="873" y="656" name="asset_sysuser">
<table x="873" y="572" name="asset_sysuser">
<row name="id" null="1" autoincrement="1">
<datatype>INTEGER</datatype>
<default>NULL</default></row>
@ -484,7 +484,7 @@
<part>id</part>
</key>
</table>
<table x="889" y="886" name="taskhistory">
<table x="870" y="743" name="taskhistory">
<row name="id" null="1" autoincrement="1">
<datatype>INTEGER</datatype>
<default>NULL</default></row>
@ -534,7 +534,7 @@
<part>id</part>
</key>
</table>
<table x="741" y="313" name="perm">
<table x="744" y="322" name="perm">
<row name="id" null="1" autoincrement="1">
<datatype>INTEGER</datatype>
<default>NULL</default></row>
@ -548,7 +548,7 @@
<part>id</part>
</key>
</table>
<table x="560" y="179" name="usergroup_perm">
<table x="560" y="184" name="usergroup_perm">
<row name="id" null="1" autoincrement="1">
<datatype>INTEGER</datatype>
<default>NULL</default></row>
@ -564,7 +564,7 @@
<part>id</part>
</key>
</table>
<table x="566" y="409" name="user_perm">
<table x="566" y="407" name="user_perm">
<row name="id" null="1" autoincrement="1">
<datatype>INTEGER</datatype>
<default>NULL</default></row>
@ -580,7 +580,7 @@
<part>id</part>
</key>
</table>
<table x="867" y="176" name="assetgroup_perm">
<table x="868" y="184" name="assetgroup_perm">
<row name="id" null="1" autoincrement="1">
<datatype>INTEGER</datatype>
<default>NULL</default></row>
@ -596,7 +596,7 @@
<part>id</part>
</key>
</table>
<table x="877" y="406" name="asset_perm">
<table x="872" y="411" name="asset_perm">
<row name="id" null="1" autoincrement="1">
<datatype>INTEGER</datatype>
<default>NULL</default></row>
@ -612,7 +612,7 @@
<part>id</part>
</key>
</table>
<table x="401" y="777" name="loginlog">
<table x="297" y="753" name="loginlog">
<row name="id" null="1" autoincrement="1">
<datatype>INTEGER</datatype>
<default>NULL</default></row>
@ -641,17 +641,14 @@
<part>id</part>
</key>
</table>
<table x="241" y="792" name="adminlog">
<table x="139" y="757" name="adminlog">
<row name="id" null="1" autoincrement="1">
<datatype>INTEGER</datatype>
<default>NULL</default></row>
<row name="date_start" null="1" autoincrement="0">
<datatype>DATETIME</datatype>
<default>NULL</default></row>
<row name="date_finished" null="1" autoincrement="0">
<datatype>DATETIME</datatype>
<default>NULL</default></row>
<row name="user_name" null="1" autoincrement="0">
<row name="username" null="1" autoincrement="0">
<datatype>CHAR</datatype>
<default>NULL</default></row>
<row name="resource" null="1" autoincrement="0">
@ -660,12 +657,110 @@
<row name="action" null="1" autoincrement="0">
<datatype>CHAR</datatype>
<default>NULL</default></row>
<row name="new field" null="1" autoincrement="0">
<row name="detail" null="1" autoincrement="0">
<datatype>CHAR</datatype>
<default>NULL</default></row>
<row name="description" null="1" autoincrement="0">
<datatype>CHAR</datatype>
<default>NULL</default></row>
<key type="PRIMARY" name="">
<part>id</part>
</key>
</table>
<table x="459" y="752" name="proxylog">
<row name="id" null="1" autoincrement="1">
<datatype>INTEGER</datatype>
<default>NULL</default></row>
<row name="username" null="1" autoincrement="0">
<datatype>CHAR</datatype>
<default>NULL</default></row>
<row name="hostname" null="1" autoincrement="0">
<datatype>CHAR</datatype>
<default>NULL</default></row>
<row name="sysuser" null="1" autoincrement="0">
<datatype>CHAR</datatype>
<default>NULL</default></row>
<row name="login_type" null="1" autoincrement="0">
<datatype>CHAR</datatype>
<default>NULL</default></row>
<row name="refer_id" null="1" autoincrement="0">
<datatype>INTEGER</datatype>
<default>NULL</default></row>
<row name="log_file" null="1" autoincrement="0">
<datatype>CHAR</datatype>
<default>NULL</default></row>
<row name="login_ip" null="1" autoincrement="0">
<datatype>VARCHAR</datatype>
<default>NULL</default></row>
<row name="login_city" null="1" autoincrement="0">
<datatype>VARCHAR</datatype>
<default>NULL</default></row>
<row name="is_finished" null="1" autoincrement="0">
<datatype>INTEGER</datatype>
<default>NULL</default></row>
<row name="date_start" null="1" autoincrement="0">
<datatype>DATETIME</datatype>
<default>NULL</default></row>
<row name="date_finished" null="1" autoincrement="0">
<datatype>DATETIME</datatype>
<default>NULL</default></row>
<key type="PRIMARY" name="">
<part>id</part>
</key>
</table>
<table x="575" y="575" name="commandlog">
<row name="id" null="1" autoincrement="1">
<datatype>INTEGER</datatype>
<default>NULL</default></row>
<row name="proxy_log" null="1" autoincrement="0">
<datatype>INTEGER</datatype>
<default>NULL</default><relation table="proxylog" row="id" />
</row>
<row name="date_start" null="1" autoincrement="0">
<datatype>DATE</datatype>
<default>NULL</default></row>
<row name="command" null="1" autoincrement="0">
<datatype>CHAR</datatype>
<default>NULL</default></row>
<key type="PRIMARY" name="">
<part>id</part>
</key>
</table>
<table x="600" y="754" name="notice">
<row name="id" null="1" autoincrement="1">
<datatype>INTEGER</datatype>
<default>NULL</default></row>
<row name="to_user_id" null="1" autoincrement="0">
<datatype>INTEGER</datatype>
<default>NULL</default><relation table="user" row="id" />
</row>
<row name="from_user_id" null="1" autoincrement="0">
<datatype>INTEGER</datatype>
<default>NULL</default><relation table="user" row="id" />
</row>
<row name="notice_method" null="1" autoincrement="0">
<datatype>CHAR</datatype>
<default>NULL</default></row>
<row name="type" null="1" autoincrement="0">
<datatype>VARCHAR</datatype>
<default>NULL</default></row>
<row name="title" null="1" autoincrement="0">
<datatype>VARCHAR</datatype>
<default>NULL</default></row>
<row name="detail" null="1" autoincrement="0">
<datatype>VARCHAR</datatype>
<default>NULL</default></row>
<row name="is_read" null="1" autoincrement="0">
<datatype>INTEGER</datatype>
<default>NULL</default></row>
<row name="date_start" null="1" autoincrement="0">
<datatype>DATETIME</datatype>
<default>NULL</default></row>
<row name="date_read" null="1" autoincrement="0">
<datatype>TIME</datatype>
<default>NULL</default></row>
<key type="PRIMARY" name="">
<part>id</part>
</key>
</table>
</sql>

0
install/example.sh Normal file
View File

0
logs/example.log Normal file
View File