Skip to content

J
jumpserver
Commit f724f46e authored by fit2cloud-fengyi's avatar fit2cloud-fengyi
Browse files
Options

细节改动

parent 31ba73e2
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 71 additions and 817 deletions
docs/_build/html/_sources/index.rst.txt
View file @ f724f46e
...@@ -4,40 +4,17 @@ ...@@ -4,40 +4,17 @@
contain the root `toctree` directive. contain the root `toctree` directive.
Jumpserver 文档 Jumpserver 文档
====================================== ====================
有关Jumpserver
`````````````````
欢迎来到 Jumpserver 文档。
Jumpserver是全球首款完全开源的堡垒机，使用GNU GPL v2.0开源协议，是符合 4A 的专业运维审计系统。
Jumpserver使用Python / Django 进行开发，遵循 Web 2.0 规范，配备了业界领先的 Web Terminal 解决方案，交互界面美观、用户体验好。
Jumpserver采纳分布式架构，支持多机房跨区域部署，中心节点提供 API，各机房部署登录节点，可横向扩展、无并发访问限制。
改变世界，从一点点开始。
目录：
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
:caption: 文档:
intro introduce
installation installation
admin_guide admin_guide
user_guide user_guide
development development
contributor contributor
contact contact
faq
索引
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
docs/_build/html/admin_asset.html
View file @ f724f46e
...@@ -8,7 +8,7 @@ ...@@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>资产管理模块 &mdash; jumpserver 0.5.0 文档</title> <title>资产管理模块 &mdash; Jumpserver 0.5.0 文档</title>
...@@ -35,7 +35,7 @@ ...@@ -35,7 +35,7 @@
<link rel="index" title="索引" <link rel="index" title="索引"
href="genindex.html"/> href="genindex.html"/>
<link rel="search" title="搜索" href="search.html"/> <link rel="search" title="搜索" href="search.html"/>
<link rel="top" title="jumpserver 0.5.0 文档" href="index.html"/> <link rel="top" title="Jumpserver 0.5.0 文档" href="index.html"/>
<link rel="up" title="管理文档" href="admin_guide.html"/> <link rel="up" title="管理文档" href="admin_guide.html"/>
<link rel="next" title="资产列表" href="asset_list.html"/> <link rel="next" title="资产列表" href="asset_list.html"/>
<link rel="prev" title="登录日志" href="login_log.html"/> <link rel="prev" title="登录日志" href="login_log.html"/>
...@@ -67,6 +67,9 @@ ...@@ -67,6 +67,9 @@
</a> </a>
<div role="search"> <div role="search">
...@@ -87,9 +90,8 @@ ...@@ -87,9 +90,8 @@
<p class="caption"><span class="caption-text">文档:</span></p> <ul class="current">
<ul class="current"> <li class="toctree-l1"><a class="reference internal" href="introduce.html">总体介绍</a></li>
<li class="toctree-l1"><a class="reference internal" href="intro.html">简介</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">安装文档</a></li> <li class="toctree-l1"><a class="reference internal" href="installation.html">安装文档</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="admin_guide.html">管理文档</a><ul class="current"> <li class="toctree-l1 current"><a class="reference internal" href="admin_guide.html">管理文档</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="admin_user.html">用户管理模块</a></li> <li class="toctree-l2"><a class="reference internal" href="admin_user.html">用户管理模块</a></li>
...@@ -106,7 +108,6 @@ ...@@ -106,7 +108,6 @@
<li class="toctree-l1"><a class="reference internal" href="development.html">开发文档</a></li> <li class="toctree-l1"><a class="reference internal" href="development.html">开发文档</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributor.html">贡献者</a></li> <li class="toctree-l1"><a class="reference internal" href="contributor.html">贡献者</a></li>
<li class="toctree-l1"><a class="reference internal" href="contact.html">联系方式</a></li> <li class="toctree-l1"><a class="reference internal" href="contact.html">联系方式</a></li>
<li class="toctree-l1"><a class="reference internal" href="faq.html">FAQ</a></li>
</ul> </ul>
...@@ -121,7 +122,7 @@ ...@@ -121,7 +122,7 @@
<nav class="wy-nav-top" role="navigation" aria-label="top navigation"> <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">jumpserver</a> <a href="index.html">Jumpserver</a>
</nav> </nav>
......
docs/_build/html/admin_user.html
View file @ f724f46e
...@@ -8,7 +8,7 @@ ...@@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>用户管理模块 &mdash; jumpserver 0.5.0 文档</title> <title>用户管理模块 &mdash; Jumpserver 0.5.0 文档</title>
...@@ -35,7 +35,7 @@ ...@@ -35,7 +35,7 @@
<link rel="index" title="索引" <link rel="index" title="索引"
href="genindex.html"/> href="genindex.html"/>
<link rel="search" title="搜索" href="search.html"/> <link rel="search" title="搜索" href="search.html"/>
<link rel="top" title="jumpserver 0.5.0 文档" href="index.html"/> <link rel="top" title="Jumpserver 0.5.0 文档" href="index.html"/>
<link rel="up" title="管理文档" href="admin_guide.html"/> <link rel="up" title="管理文档" href="admin_guide.html"/>
<link rel="next" title="用户列表" href="user.html"/> <link rel="next" title="用户列表" href="user.html"/>
<link rel="prev" title="管理文档" href="admin_guide.html"/> <link rel="prev" title="管理文档" href="admin_guide.html"/>
...@@ -67,6 +67,9 @@ ...@@ -67,6 +67,9 @@
</a> </a>
<div role="search"> <div role="search">
...@@ -87,9 +90,8 @@ ...@@ -87,9 +90,8 @@
<p class="caption"><span class="caption-text">文档:</span></p> <ul class="current">
<ul class="current"> <li class="toctree-l1"><a class="reference internal" href="introduce.html">总体介绍</a></li>
<li class="toctree-l1"><a class="reference internal" href="intro.html">简介</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">安装文档</a></li> <li class="toctree-l1"><a class="reference internal" href="installation.html">安装文档</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="admin_guide.html">管理文档</a><ul class="current"> <li class="toctree-l1 current"><a class="reference internal" href="admin_guide.html">管理文档</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">用户管理模块</a><ul> <li class="toctree-l2 current"><a class="current reference internal" href="#">用户管理模块</a><ul>
...@@ -105,7 +107,6 @@ ...@@ -105,7 +107,6 @@
<li class="toctree-l1"><a class="reference internal" href="development.html">开发文档</a></li> <li class="toctree-l1"><a class="reference internal" href="development.html">开发文档</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributor.html">贡献者</a></li> <li class="toctree-l1"><a class="reference internal" href="contributor.html">贡献者</a></li>
<li class="toctree-l1"><a class="reference internal" href="contact.html">联系方式</a></li> <li class="toctree-l1"><a class="reference internal" href="contact.html">联系方式</a></li>
<li class="toctree-l1"><a class="reference internal" href="faq.html">FAQ</a></li>
</ul> </ul>
...@@ -120,7 +121,7 @@ ...@@ -120,7 +121,7 @@
<nav class="wy-nav-top" role="navigation" aria-label="top navigation"> <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">jumpserver</a> <a href="index.html">Jumpserver</a>
</nav> </nav>
......
docs/_build/html/index.html
View file @ f724f46e
...@@ -8,7 +8,7 @@ ...@@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Jumpserver 文档 &mdash; jumpserver 0.5.0 文档</title> <title>Jumpserver 文档 &mdash; Jumpserver 0.5.0 文档</title>
...@@ -35,8 +35,8 @@ ...@@ -35,8 +35,8 @@
<link rel="index" title="索引" <link rel="index" title="索引"
href="genindex.html"/> href="genindex.html"/>
<link rel="search" title="搜索" href="search.html"/> <link rel="search" title="搜索" href="search.html"/>
<link rel="top" title="jumpserver 0.5.0 文档" href="#"/> <link rel="top" title="Jumpserver 0.5.0 文档" href="#"/>
<link rel="next" title="简介" href="intro.html"/> <link rel="next" title="总体介绍" href="introduce.html"/>
<script src="_static/js/modernizr.min.js"></script> <script src="_static/js/modernizr.min.js"></script>
...@@ -65,6 +65,9 @@ ...@@ -65,6 +65,9 @@
</a> </a>
<div role="search"> <div role="search">
...@@ -85,16 +88,14 @@ ...@@ -85,16 +88,14 @@
<p class="caption"><span class="caption-text">文档:</span></p> <ul>
<ul> <li class="toctree-l1"><a class="reference internal" href="introduce.html">总体介绍</a></li>
<li class="toctree-l1"><a class="reference internal" href="intro.html">简介</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">安装文档</a></li> <li class="toctree-l1"><a class="reference internal" href="installation.html">安装文档</a></li>
<li class="toctree-l1"><a class="reference internal" href="admin_guide.html">管理文档</a></li> <li class="toctree-l1"><a class="reference internal" href="admin_guide.html">管理文档</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_guide.html">用户使用文档</a></li> <li class="toctree-l1"><a class="reference internal" href="user_guide.html">用户使用文档</a></li>
<li class="toctree-l1"><a class="reference internal" href="development.html">开发文档</a></li> <li class="toctree-l1"><a class="reference internal" href="development.html">开发文档</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributor.html">贡献者</a></li> <li class="toctree-l1"><a class="reference internal" href="contributor.html">贡献者</a></li>
<li class="toctree-l1"><a class="reference internal" href="contact.html">联系方式</a></li> <li class="toctree-l1"><a class="reference internal" href="contact.html">联系方式</a></li>
<li class="toctree-l1"><a class="reference internal" href="faq.html">FAQ</a></li>
</ul> </ul>
...@@ -109,7 +110,7 @@ ...@@ -109,7 +110,7 @@
<nav class="wy-nav-top" role="navigation" aria-label="top navigation"> <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">jumpserver</a> <a href="#">Jumpserver</a>
</nav> </nav>
...@@ -158,17 +159,10 @@ ...@@ -158,17 +159,10 @@
<div class="section" id="jumpserver"> <div class="section" id="jumpserver">
<h1>Jumpserver 文档<a class="headerlink" href="#jumpserver" title="永久链接至标题"></a></h1> <h1>Jumpserver 文档<a class="headerlink" href="#jumpserver" title="永久链接至标题"></a></h1>
<div class="section" id="id1"> <p>目录：</p>
<h2>有关Jumpserver<a class="headerlink" href="#id1" title="永久链接至标题"></a></h2>
<p>欢迎来到 Jumpserver 文档。</p>
<p>Jumpserver是全球首款完全开源的堡垒机，使用GNU GPL v2.0开源协议，是符合 4A 的专业运维审计系统。</p>
<p>Jumpserver使用Python / Django 进行开发，遵循 Web 2.0 规范，配备了业界领先的 Web Terminal 解决方案，交互界面美观、用户体验好。</p>
<p>Jumpserver采纳分布式架构，支持多机房跨区域部署，中心节点提供 API，各机房部署登录节点，可横向扩展、无并发访问限制。</p>
<p>改变世界，从一点点开始。</p>
<div class="toctree-wrapper compound"> <div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">文档:</span></p>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="intro.html">简介</a></li> <li class="toctree-l1"><a class="reference internal" href="introduce.html">总体介绍</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">安装文档</a><ul> <li class="toctree-l1"><a class="reference internal" href="installation.html">安装文档</a><ul>
<li class="toctree-l2"><a class="reference internal" href="quickstart.html">快速安装</a></li> <li class="toctree-l2"><a class="reference internal" href="quickstart.html">快速安装</a></li>
<li class="toctree-l2"><a class="reference internal" href="step_by_step.html">一步一步安装</a></li> <li class="toctree-l2"><a class="reference internal" href="step_by_step.html">一步一步安装</a></li>
...@@ -200,18 +194,8 @@ ...@@ -200,18 +194,8 @@
<li class="toctree-l2"><a class="reference internal" href="contact.html#id3">邮件</a></li> <li class="toctree-l2"><a class="reference internal" href="contact.html#id3">邮件</a></li>
</ul> </ul>
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="faq.html">FAQ</a></li>
</ul> </ul>
</div> </div>
</div>
</div>
<div class="section" id="id2">
<h1>索引<a class="headerlink" href="#id2" title="永久链接至标题"></a></h1>
<ul class="simple">
<li><a class="reference internal" href="genindex.html"><span class="std std-ref">索引</span></a></li>
<li><a class="reference internal" href="py-modindex.html"><span class="std std-ref">模块索引</span></a></li>
<li><a class="reference internal" href="search.html"><span class="std std-ref">搜索页面</span></a></li>
</ul>
</div> </div>
...@@ -224,7 +208,7 @@ ...@@ -224,7 +208,7 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="intro.html" class="btn btn-neutral float-right" title="简介" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> <a href="introduce.html" class="btn btn-neutral float-right" title="总体介绍" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
</div> </div>
......
docs/_build/html/searchindex.js
View file @ f724f46e
This diff is collapsed.
docs/_static/img/logo-text.png 100644 → 100755
View replaced file @ 31ba73e2 View file @ f724f46e
docs/_static/img/logo-text.png

12.4 KB | W: | H:

docs/_static/img/logo-text.png

39 KB | W: | H:

docs/_static/img/logo-text.png
docs/_static/img/logo-text.png
docs/_static/img/logo-text.png
docs/_static/img/logo-text.png
  • 2-up
  • Swipe
  • Onion skin
docs/asset_list.rst
View file @ f724f46e
...@@ -5,37 +5,37 @@ ...@@ -5,37 +5,37 @@
.. contents:: Topics .. contents:: Topics
.. _view_asset_List:: .. _view_asset_list:
查看资产列表 查看资产列表
````````````` `````````````
点击页面左侧的“资产管理”菜单下的“资产列表”按钮，查看当前所有的资产列表。 点击页面左侧的“资产管理”菜单下的“资产列表”按钮，查看当前所有的资产列表。
.. _create_asset:: .. _create_asset:
创建资产 创建资产
`````````` ````````````
点击页面左上角的“创建资产”按钮，进入资产创建页面，填写资产信息，点击“提交”按钮，完成资产创建。 点击页面左上角的“创建资产”按钮，进入资产创建页面，填写资产信息，点击“提交”按钮，完成资产创建。
.. _update_asset:: .. _update_asset:
更新资产 更新资产
`````````` ````````````
点击页面右边的“更新”按钮，进入编辑资产页面，更新资产信息，点击“提交”按钮，完成资产更新。 点击页面右边的“更新”按钮，进入编辑资产页面，更新资产信息，点击“提交”按钮，完成资产更新。
.. _delete_asset:: .. _delete_asset:
删除资产 删除资产
````````` `````````
点击页面右边的“删除”按钮，弹出删除确认框，点击“确认”按钮，完成资产删除。 点击页面右边的“删除”按钮，弹出删除确认框，点击“确认”按钮，完成资产删除。
.. _batch_operation:: .. _batch_operation:
批量操作 批量操作
`````````` ````````````
选中资产，选择页面左下角批量操作选项，点击“提交”按钮，完成批量操作。 选中资产，选择页面左下角批量操作选项，点击“提交”按钮，完成批量操作。
\ No newline at end of file
docs/conf.py
View file @ f724f46e
...@@ -20,7 +20,7 @@ import sphinx_rtd_theme ...@@ -20,7 +20,7 @@ import sphinx_rtd_theme
# -- Project information ----------------------------------------------------- # -- Project information -----------------------------------------------------
project = 'jumpserver' project = 'Jumpserver'
copyright = '北京堆栈科技有限公司 © 2014-2018' copyright = '北京堆栈科技有限公司 © 2014-2018'
author = 'Jumpserver team' author = 'Jumpserver team'
...@@ -88,7 +88,7 @@ html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] ...@@ -88,7 +88,7 @@ html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
# #
html_theme_options = { html_theme_options = {
'logo_only': True, 'logo_only': True,
'display_version': False 'display_version': True
} }
# Add any paths that contain custom static files (such as style sheets) here, # Add any paths that contain custom static files (such as style sheets) here,
...@@ -137,7 +137,7 @@ latex_elements = { ...@@ -137,7 +137,7 @@ latex_elements = {
# (source start file, target name, title, # (source start file, target name, title,
# author, documentclass [howto, manual, or own class]). # author, documentclass [howto, manual, or own class]).
latex_documents = [ latex_documents = [
(master_doc, 'jumpserver.tex', 'jumpserver Documentation', (master_doc, 'Jumpserver.tex', 'Jumpserver Documentation',
'Jumpserver team', 'manual'), 'Jumpserver team', 'manual'),
] ]
...@@ -147,7 +147,7 @@ latex_documents = [ ...@@ -147,7 +147,7 @@ latex_documents = [
# One entry per manual page. List of tuples # One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section). # (source start file, name, description, authors, manual section).
man_pages = [ man_pages = [
(master_doc, 'jumpserver', 'jumpserver Documentation', (master_doc, 'Jumpserver', 'Jumpserver Documentation',
[author], 1) [author], 1)
] ]
...@@ -158,8 +158,8 @@ man_pages = [ ...@@ -158,8 +158,8 @@ man_pages = [
# (source start file, target name, title, author, # (source start file, target name, title, author,
# dir menu entry, description, category) # dir menu entry, description, category)
texinfo_documents = [ texinfo_documents = [
(master_doc, 'jumpserver', 'jumpserver Documentation', (master_doc, 'Jumpserver', 'Jumpserver 文档',
author, 'jumpserver', 'One line description of project.', author, 'Jumpserver', ' Jumpserver是全球首款完全开源的堡垒机，是符合 4A 的专业运维审计系统',
'Miscellaneous'), 'Miscellaneous'),
] ]
......
docs/contributor.rst
View file @ f724f46e
...@@ -4,10 +4,10 @@ ...@@ -4,10 +4,10 @@
感谢一下朋友为Jumpserver做出的贡献，世界因你们而不同，排名不分先后 感谢一下朋友为Jumpserver做出的贡献，世界因你们而不同，排名不分先后
- **小彧 <李磊>** Django资深开发者，为用户模块贡献了很多代码 - **小彧 <李磊>** Django 资深开发者，为用户模块贡献了很多代码
- **sofia <周小侠>** 资深前端工程师, 前端代码贡献者 - **sofia <周小侠>** 资深前端工程师, 前端代码贡献者
- **liuz <刘正> 全栈工程师** 编写了Web terminal大部分代码 - **liuz <刘正> 全栈工程师** 编写了 Web Terminal 大部分代码
- **jiaxiangkong <陈尚委>** Jumpserver测试运营 - **jiaxiangkong <陈尚委>** Jumpserver测试运营
- **halcyon <王墉>** DevOps 资深开发者, 0.3.2 核心开发者之一 - **halcyon <王墉>** DevOps 资深开发者, 0.3.2 核心开发者之一
- **yumaojun03 <喻茂峻>** DevOps 资深开发者，擅长Python, Go以及PAAS平台开发 - **yumaojun03 <喻茂峻>** DevOps 资深开发者，擅长Python, Go以及 PaaS 平台开发
- **kelianchun <柯连春>** DevOps 资产开发者，fix了很多bug - **kelianchun <柯连春>** DevOps 资产开发者，fix了很多bug
\ No newline at end of file
docs/faq.rst deleted 100644 → 0
View file @ 31ba73e2
FAQ
+++++++++++++++++++++
\ No newline at end of file
docs/index.rst
View file @ f724f46e
...@@ -4,40 +4,17 @@ ...@@ -4,40 +4,17 @@
contain the root `toctree` directive. contain the root `toctree` directive.
Jumpserver 文档 Jumpserver 文档
====================================== ====================
有关Jumpserver
`````````````````
欢迎来到 Jumpserver 文档。
Jumpserver是全球首款完全开源的堡垒机，使用GNU GPL v2.0开源协议，是符合 4A 的专业运维审计系统。
Jumpserver使用Python / Django 进行开发，遵循 Web 2.0 规范，配备了业界领先的 Web Terminal 解决方案，交互界面美观、用户体验好。
Jumpserver采纳分布式架构，支持多机房跨区域部署，中心节点提供 API，各机房部署登录节点，可横向扩展、无并发访问限制。
改变世界，从一点点开始。
目录：
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
:caption: 文档:
intro introduce
installation installation
admin_guide admin_guide
user_guide user_guide
development development
contributor contributor
contact contact
faq
索引
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
docs/intro.rst deleted 100644 → 0
View file @ 31ba73e2
简介
============
这里是Jumpserver简介。
docs/introduce.rst 0 → 100644
View file @ f724f46e
总体介绍
==================
欢迎来到 Jumpserver 文档。
Jumpserver是全球首款完全开源的堡垒机，使用GNU GPL v2.0开源协议，是符合 4A 的专业运维审计系统。
Jumpserver使用Python / Django 进行开发，遵循 Web 2.0 规范，配备了业界领先的 Web Terminal 解决方案，交互界面美观、用户体验好。
Jumpserver采纳分布式架构，支持多机房跨区域部署，中心节点提供 API，各机房部署登录节点，可横向扩展、无并发访问限制。
改变世界，从一点点开始。
\ No newline at end of file
docs/old/README.md deleted 100644 → 0
View file @ 31ba73e2
#### [项目结构描述](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)
\ No newline at end of file
docs/old/api_style_guide.md deleted 100644 → 0
View file @ 31ba73e2
## REST API规范约定
这里仅考虑REST API的基本情况。参考
[RESTful API 设计指南](http://www.ruanyifeng.com/blog/2014/05/restful_api.html)
[github api文档](https://developer.github.com/v3/)
### 协议
API与用户的通信协议，总是使用HTTPs协议。
### 域名
这版api相对简单, 没有前后端分离, 没有独立app, 所以放在主域名下
```
https://example.org/api/
```
### 版本
将API的版本号放入URL中, 由于一个项目多个app所以Jumpserver使用以下风格,
将版本号放到app后面
```
https://example.com/api/:app:/:version:/:resource:
https://example.com/api/assets/v1.0/assets [GET, POST]
https://example.com/api/assets/v1.0/assets/1 [GET, PUT, DELETE]
```
### 路径
路径又称"终点"（endpoint），表示API的具体网址。
在RESTful架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应。一般来说，数据库中的表都是同种记录的"集合"（collection），所以API中的名词也应该使用复数。
举例来说 cmdb中的assets列表, idc列表
```
https://example.com/api/:app:/:version:/:resource:
https://example.com/api/assets/v1.0/assets [GET, POST]
https://example.com/api/assets/v1.0/assets/1 [GET, PUT, DELETE]
https://example.com/api/assets/v1.0/idcs [GET, POST]
```
一般性的增删查改(CRUD)API，完全使用HTTP method加上url提供的语义，url中的可变部分（比如上面提到的<role_id>）
一般用来传递该API操作的核心实体对象的唯一ID，如果有更多的参数需要提供，GET方法请使用url parameter
(例如："?client_id=xxxxx&app_id=xxxxxx")，PUT/POST/DELETE方法请使用请求体传递参数。
### HTTP Method
对于资源的具体操作类型，由HTTP动词表示。
常用的HTTP动词有下面五个（括号里是对应的SQL命令）。
- GET（SELECT）：从服务器取出资源（一项或多项）。
- POST（CREATE）：在服务器新建一个资源。
- PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源, 幂等
- PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性）。
- DELETE（DELETE）：从服务器删除资源。
### 过滤信息
常见参数约定
```
?keyword=localhost 模糊搜索
?limit=10：指定返回记录的数量
?offset=10：指定返回记录的开始位置。
?page=2&per_page=100：指定第几页，以及每页的记录数。
?sort=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序。
?asset_id=1：指定筛选条件
```
### 状态码
服务器向用户返回的状态码和提示信息，常见的有以下一些（方括号中是该状态码对应的HTTP动词）。
- 200 OK - [GET]：服务器成功返回用户请求的数据，该操作是幂等的（Idempotent）。
- 201 CREATED - [POST/PUT/PATCH]：用户新建或修改数据成功。
- 202 Accepted - [*]：表示一个请求已经进入后台排队（异步任务）
- 204 NO CONTENT - [DELETE]：用户删除数据成功。
- 400 INVALID REQUEST - [POST/PUT/PATCH]：用户发出的请求有错误，服务器没有进行新建或修改数据的操作，该操作是幂等的。
- 401 Unauthorized - [*]：表示用户没有权限（令牌、用户名、密码错误）。
- 403 Forbidden - [*] 表示用户得到授权（与401错误相对），但是访问是被禁止的。
- 404 NOT FOUND - [*]：用户发出的请求针对的是不存在的记录，服务器没有进行操作，该操作是幂等的。
- 406 Not Acceptable - [GET]：用户请求的格式不可得（比如用户请求JSON格式，但是只有XML格式）。
- 410 Gone -[GET]：用户请求的资源被永久删除，且不会再得到的。
- 422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时，发生一个验证错误。
- 500 INTERNAL SERVER ERROR - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。
### 错误处理
如果状态码是4xx，就应该向用户返回出错信息。一般来说，返回的信息中将error作为键名，出错信息作为键值即可。
```
{
error: "Invalid API key"
}
```
### 返回结果
针对不同操作，服务器向用户返回的结果应该符合以下规范。
```
GET /collection：返回资源对象的列表（数组）
GET /collection/resource：返回单个资源对象
POST /collection：返回新生成的资源对象
PUT /collection/resource：返回完整的资源对象
PATCH /collection/resource：返回完整的资源对象
DELETE /collection/resource：返回一个空文档
```
### Hypermedia API
RESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么。
比如，当用户向api.example.com的根目录发出请求，会得到这样一个文档。
```
{"link": {
"rel": "collection https://www.example.com/zoos",
"href": "https://api.example.com/zoos",
"title": "List of zoos",
"type": "application/vnd.yourformat+json"
}}
```
上面代码表示，文档中有一个link属性，用户读取这个属性就知道下一步该调用什么API了。
rel表示这个API与当前网址的关系（collection关系，并给出该collection的网址），
href表示API的路径，title表示API的标题，type表示返回类型。
Hypermedia API的设计被称为HATEOAS。
Github的API就是这种设计.
### 其它
（1）API的身份认证应该使用OAuth 2.0框架。
（2）服务器返回的数据格式，应该尽量使用JSON
docs/old/django_class_base_view_inheritance.py deleted 100644 → 0
View file @ 31ba73e2
#!/usr/bin/env python
# ~*~ coding: utf-8 ~*~
#
from django.core.paginator import InvalidPage, Paginator
class View(object):
http_method_names = []
def __init__(self, **kwargs):
pass
@classmethod
def as_view(cls, **initkwargs):
pass
def dispatch(self, request, *args, **kwargs):
pass
def http_method_not_allowed(self, request, *args, **kwargs):
pass
def options(self, request, *args, **kwargs):
pass
def _allowed_method(self):
pass
class TemplateResponseMixin(object):
template_name = None
template_engine = None
response_class = None
content_type = None
def render_to_response(self, context, **response_kwargs):
pass
def get_template_name(self):
pass
class ContextMixin(object):
def get_context_data(self, **kwargs):
pass
class RedirectView(View):
permanent = False
url = None
pattern_name = None
query_string = False
def get_redirect_url(self, *args, **kwargs):
pass
def get(self, request, *args, **kwargs):
pass
def head(self, request, *args, **kwargs):
pass
def post(self, request, *args, **kwargs):
pass
def options(self, request, *args, **kwargs):
pass
def delete(self, request, *args, **kwargs):
pass
def put(self, request, *args, **kwargs):
pass
def patch(self, request, *args, **kwargs):
pass
class TemplateView(TemplateResponseMixin, ContextMixin, View):
def get(self, request, *args, **kwargs):
pass
class SingleObjectMixin(ContextMixin):
model = None
queryset = None
slug_field = 'slug'
context_object_name = None
slug_url_kwarg = 'slug'
pk_url_kwarg = 'pk'
query_pk_and_slug = False
def get_object(self):
pass
def get_queryset(self):
pass
def get_slug_field(self):
pass
def get_context_object_name(self, obj):
pass
def get_context_data(self, **kwargs):
pass
class BaseDetailView(SingleObjectMixin, View):
def get(self, request, *args, **kwargs):
pass
class SingleObjectTemplateResponseMixin(TemplateResponseMixin):
template_name_field = None
template_name_suffix = '_detail'
def get_template_name(self):
pass
class DetailView(SingleObjectTemplateResponseMixin, BaseDetailView):
pass
class FormMixin(ContextMixin):
initial = {}
form_class = None
success_url = None
prefix = None
def get_initial(self):
pass
def get_prefix(self):
pass
def get_form_class(self):
pass
def get_form(self, form_class):
pass
def get_form_kwargs(self):
pass
def get_success_url(self):
pass
def form_valid(self, form):
pass
def form_invalid(self, form):
pass
def get_context_data(self, **kwargs):
pass
class ModelFormMixin(FormMixin, SingleObjectMixin):
fields = None
def get_form_class(self):
pass
def get_form_kwargs(self):
pass
def get_success_url(self):
pass
def form_valid(self, form):
pass
class ProcessFormView(View):
def get(self, request, *args, **kwargs):
pass
def post(self, request, *args, **kwargs):
pass
def put(self, request, *args, **kwargs):
pass
class BaseFormView(FormMixin, ProcessFormView):
pass
class FormView(TemplateResponseMixin, BaseFormView):
pass
class BaseCreateView(ModelFormMixin, ProcessFormView):
def get(self, request, *args, **kwargs):
pass
def post(self, request, *args, **kwargs):
pass
class CreateView(SingleObjectTemplateResponseMixin, BaseCreateView):
template_name_suffix = '_form'
class BaseUpdateView(ModelFormMixin, ProcessFormView):
def get(self, request, *args, **kwargs):
pass
def post(self, request, *args, **kwargs):
pass
class UpdateView(SingleObjectTemplateResponseMixin, BaseUpdateView):
template_name_suffix = '_form'
class DeletionMixin(object):
success_url = None
def delete(self, request, *args, **kwargs):
pass
def post(self, request, *args, **kwargs):
pass
def get_success_url(self):
pass
class BaseDeleteView(DeletionMixin, BaseDetailView):
pass
class DeleteView(SingleObjectTemplateResponseMixin, BaseDeleteView):
pass
class MultipleObjectMixin(ContextMixin):
allow_empty = True
queryset = None
model = None
paginate_by = None
paginate_orphans = 0
context_object_name = None
paginator_class = Paginator
page_kwarg = 'page'
ordering = None
def get_queryset(self):
pass
def get_ordering(self):
pass
def paginate_queryset(self, queryset, page_size):
pass
def get_paginate_by(self, queryset):
pass
def get_paginator(self, queryset, per_page, orphans=0,
allow_empty_first_page=True, **kwargs):
pass
def get_paginate_orphans(self):
pass
def get_allow_empty(self):
pass
def get_context_object_name(self, object_list):
pass
def get_context_data(self, **kwargs):
pass
class BaseListView(MultipleObjectMixin, View):
def get(self, request, *args, **kwargs):
pass
class MultipleObjectTemplateResponseMixin(TemplateResponseMixin):
template_name_suffix = '_list'
def get_template_name(self):
pass
class ListView(MultipleObjectTemplateResponseMixin, BaseListView):
pass
docs/old/install.md deleted 100644 → 0
View file @ 31ba73e2
More see [安装文档](https://github.com/jumpserver/jumpserver/wiki/v0.5.0-%E5%9F%BA%E4%BA%8E-CentOS7)
docs/old/project_structure.md deleted 100644 → 0
View file @ 31ba73e2
## 项目骨架
说明如下：
```
.
├── config-example.py // 配置文件样例
├── docs // 所有doc文件放到该目录
│ └── README.md
├── LICENSE
├── README.md
├── install // 安装说明
├── logs // 日志目录
├── apps // 管理后台目录，也是各app所在目录
│ └── assets // app目录
│ │ ├── admin.py
│ │ ├── apps.py // 新版本django app设置文件
│ │ ├── api.py // api文件
│ │ ├── __init__.py // 对外暴露的接口，放到该文件中，方便别的app引用
│ │ ├── 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文件
│ ├── common
│ │ ├── templatetags // 通用template tag
│ │ ├── utils.py // 通用的函数方法
│ │ └── views.py
│ ├── fixtures // 初始化数据目录
│ │ ├── init.json // 初始化项目数据库
│ │ └── fake.json // 生成大量测试数据
│ ├── jumpserver // 项目设置目录
│ │ ├── __init__.py
│ │ ├── settings.py // 项目设置文件
│ │ ├── urls.py // 项目入口urlconf
│ │ └── wsgi.py
│ ├── manage.py
│ ├── static // 项目静态资源目录
│   ├── i18n                     // 项目多语言目录
│ └── templates // 项目模板目录
```
docs/old/python_style_guide.md deleted 100644 → 0
View file @ 31ba73e2
# Jumpserver 项目规范（Draft）
## 语言框架
1. Python 3.6.1 (当前最新)
2. Django 1.11 (当前最新)
3. Flask 0.12 Luna (当前最新)
4. Paramiko 2.12 Coco (当前最新)
## Django规范
1. 尽量使用Class Base View编程，更少代码
2. 使用Django Form
3. 每个url独立命名，不要硬编码，同理static也是
4. 数据库表名手动指定，不要使用默认
5. 代码优雅简洁
6. 注释明确优美
7. 测试案例尽可能完整
8. 尽可能利用Django造好的轮子
## 代码风格
Python方面大致的风格，我们采用pocoo的[Style Guidance](http://www.pocoo.org/internal/styleguide/)，但是有些细节部分会尽量放开
参考国内翻译
### 基本的代码布局
#### 缩进
1. Python严格采用4个空格的缩进，任何python代码都都必须遵守此规定。
2. web部分代码(HTML, CSS, JavaScript)，Node.js采用2空格缩进，同样不使用tab (\t)。
之所以与Python不同，是因为js中有大量回调式的写法，2空格可以显著降低视觉上的负担。
#### 最大行长度
按PEP8规范，Python一般限制最大79个字符, 但是Django的命名,url等通常比较长,
而且21世纪都是宽屏了,所以我们限制最大120字符
**补充说明：HTML代码不受此规范约束。**
#### 长语句缩进
编写长语句时，可以使用换行符（\）换行。在这种情况下，下一行应该与上一行的最后
一个“.”句点或“=”对齐，或者是缩进4个空格符
```
this_is_a_very_long(function_call, 'with many parameters') \
.that_returns_an_object_with_an_attribute
MyModel.query.filter(MyModel.scalar > 120) \
.order_by(MyModel.name.desc()) \
.limit(10)
```
如果你使用括号“()”或花括号“{}”为长语句换行，那么下一行应与括号或花括号对齐：
```
this_is_a_very_long(function_call, 'with many parameters',
23, 42, 'and even more')
```
对于元素众多的列表或元组，在第一个“[”或“(”之后马上换行：
```
items = [
'this is the first', 'set of items', 'with more items',
'to come in this line', 'like this'
]
```
#### 空行
顶层函数与类之间空两行，此外都只空一行。不要在代码中使用太多的空行来区分不同的逻辑模块。
```
def hello(name):
print 'Hello %s!' % name
def goodbye(name):
print 'See you %s.' % name
class MyClass(object):
"""This is a simple docstring."""
def __init__(self, name):
self.name = name
def get_annoying_name(self):
return self.name.upper() + '!!!!111'
```
### 语句和表达式
#### 一般空格规则
1. 单目运算符与运算对象之间不空格（例如，-，~等），即使单目运算符位于括号内部也一样。
2. 双目运算符与运算对象之间要空格。
```
exp = -1.05
value = (item_value / item_count) * offset / exp
value = my_list[index]
value = my_dict['key']
```
#### 比较
1. 任意类型之间的比较，使用“==”和“!=”。
2. 与单例（singletons）进行比较时，使用is和is not。
3. 永远不要与True或False进行比较（例如，不要这样写：foo == False，而应该这样写：not foo）。
#### 否定成员关系检查
使用foo not in bar，而不是not foo in bar。
### 命名约定
1. 类名称：采用骆驼拼写法（CamelCase），首字母缩略词保持大写不变（HTTPWriter，而不是HttpWriter）。
2. 变量名：小写_以及_下划线（lowercase_with_underscores）。
3. 方法与函数名：小写_以及_下划线（lowercase_with_underscores）。
4. 常量：大写_以及_下划线（UPPERCASE_WITH_UNDERSCORES）。
5. 预编译的正则表达式：name_re。
6. 受保护的元素以一个下划线为前缀。双下划线前缀只有定义混入类（mixin classes）时才使用。
7. 如果使用关键词（keywords）作为类名称，应在名称后添加后置下划线（trailing underscore）。
允许与内建变量重名，不要在变量名后添加下划线进行区分。如果函数需要访问重名的内建变量，请将内建变量重新绑定为其他名称。
8. 命名要有寓意, 不使用拼音,不使用无意义简单字母命名 (循环中计数例外 for i in)
9. 命名缩写要谨慎, 尽量是大家认可的缩写
#### 函数和方法的参数：
1. 类方法：cls为第一个参数。
2. 实例方法：self为第一个参数。
3. property函数中使用匿名函数（lambdas）时，匿名函数的第一个参数可以用x替代，
例如：display_name = property(lambda x: x.real_name or x.username)。
### 文档注释(Docstring，即各方法，类的说明文档注释)
所有文档字符串均以reStructuredText格式编写，方便Sphinx处理。文档字符串的行数不同，布局也不一样。
如果只有一行，代表字符串结束的三个引号与代表字符串开始的三个引号在同一行。
如果为多行，文档字符串中的文本紧接着代表字符串开始的三个引号编写，代表字符串结束的三个引号则自己独立成一行。
(有能力尽可能用英文, 否则请中文优雅注释)
```
def foo():
"""This is a simple docstring."""
def bar():
"""This is a longer docstring with so much information in there
that it spans three lines. In this case, the closing triple quote
is on its own line.
"""
```
文档字符串应分成简短摘要（尽量一行）和详细介绍。如果必要的话，摘要与详细介绍之间空一行。
### 模块头部
模块文件的头部包含有utf-8编码声明（如果模块中使用了非ASCII编码的字符，建议进行声明），以及标准的文档字符串。
```
# -*- coding: utf-8 -*-
"""
package.module
~~~~~~~~~~~~~~
A brief description goes here.
:copyright: (c) YEAR by AUTHOR.
:license: LICENSE_NAME, see LICENSE_FILE for more details.
"""
```
### 注释(comment)
注释的规范与文档字符串编写规范类似。二者均以reStructuredText格式编写。
如果使用注释来编写类属性的文档，请在#符号后添加一个冒号":"。
(有能力尽可能用英文, 否则请中文优雅注释)
```
class User(object):
#: the name of the user as unicode string
name = Column(String)
#: the sha1 hash of the password + inline salt
pw_hash = Column(String)
```
docs/old/table_design.xml deleted 100644 → 0
View file @ 31ba73e2
This diff is collapsed.
docs/python_style_guide.rst
View file @ f724f46e
...@@ -34,8 +34,7 @@ Guidance`_\ ，但是有些细节部分会尽量放开 参考国内翻译 ...@@ -34,8 +34,7 @@ Guidance`_\ ，但是有些细节部分会尽量放开 参考国内翻译
^^^^ ^^^^
1. Python严格采用4个空格的缩进，任何python代码都都必须遵守此规定。 1. Python严格采用4个空格的缩进，任何python代码都都必须遵守此规定。
2. web部分代码(HTML, CSS, 2. web部分代码(HTML, CSS,JavaScript)，Node.js采用2空格缩进，同样不使用tab。
JavaScript)，Node.js采用2空格缩进，同样不使用tab (:raw-latex:`\t`)。
之所以与Python不同，是因为js中有大量回调式的写法，2空格可以显著降低视觉上的负担。 之所以与Python不同，是因为js中有大量回调式的写法，2空格可以显著降低视觉上的负担。
最大行长度 最大行长度
......
docs/user.rst
View file @ f724f46e
...@@ -36,14 +36,14 @@ ...@@ -36,14 +36,14 @@
选中用户，点击右上角的“导出”按钮，导出用户完成。 选中用户，点击右上角的“导出”按钮，导出用户完成。
.. _inport_user: .. _import_user:
导入用户 导入用户
```````` ````````
点击右上角的“导入”按钮，弹出导入对话框，选择要导入的CSV格式文件，点击“确认”按钮，导入用户完成。 点击右上角的“导入”按钮，弹出导入对话框，选择要导入的CSV格式文件，点击“确认”按钮，导入用户完成。
.. _batch_operation: .. _batch_user_operation:
批量操作 批量操作
```````` ````````
......
docs/user_guide.rst
View file @ f724f46e
用户使用文档 用户使用文档
=========== ===============
这部分给您介绍Jumpserver的用户使用方法。 这部分给您介绍Jumpserver的用户使用方法。
......
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