Skip to content

Commit

Permalink
Update docs for v1.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@r4ntix
r4ntix committed Oct 11, 2014
1 parent bd93bcc commit 53a81b6
Show file tree
Hide file tree
Showing 12 changed files with 98 additions and 23 deletions.
Binary file modified website/docs/static/img/dial_03.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified website/docs/static/img/dial_04.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added website/docs/static/img/dial_08.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added website/docs/static/img/dial_09.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added website/docs/static/img/dial_10.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified website/docs/static/img/snat_02.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified website/docs/static/img/snat_03.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 8 additions & 1 deletion website/docs/templates/docs/changelog.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,14 @@
<div class="panel">
<h3>ChangeLog</h3>
<hr />
<h5>1.0.0</h5>
<h5>1.1.0 － 2014.10.11</h5>
<ul>
<li>拨号VPN：查看、修改账号时，密码默认隐藏，支持手工显示。</li>
<li>拨号VPN：可配置支持客户端间相互通信、单账号同时多个客户端在线。</li>
<li>拨号VPN：可配置通信协议为"UDP"或"TCP"。</li>
<li>更新文档描述，增加Classic 网络环境应用场景事例。</li>
</ul>
<h5>1.0.0 － 2014.09.05</h5>
<ul>
<li>首次发布，支持IPSec VPN、拨号VPN、SNAT 功能。</li>
</ul>
Expand Down
82 changes: 72 additions & 10 deletions website/docs/templates/docs/dial.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,66 @@
<div class="panel">
<h3>拨号 VPN 使用指南</h3>
<hr />
<h5>应用场景：</h5>
<ol>
<li>Classic 网络场景。跨账号、跨地域的云服务器之间内网互通。</li>
<li>VPC 网络场景。管理员接入VPC 进行私网访问、管理。</li>
</ol>

<h3>Classic 网络场景</h3>
<hr />
<img src="{{ url_for('docs.static', filename='img/dial_08.png') }}">
<p>如上图所示，用户在杭州、北京、青岛区域用不同的账号各买了1台ECS VM，现在想让这3台VM 之间进行内网通信，我们需要把这3台VM 拨入到同一个VPN 网络中，用VPN 分配的地址进行通信。<br />
本例：杭州的VM 选为VPN GateWay，北京和青岛的VM 拨入到杭州的VPN 中。使用VPN 分配的地址10.8.8.7、10.8.8.9 进行相互通信。</p>
<h5>第一、启动拨号VPN 服务</h5>
<hr />
<p>进入拨号VPN 的「VPN 服务管理」页面，确保GateWay VM启动了拨号VPN 服务。</p>
<img src="{{ url_for('docs.static', filename='img/dial_02.png') }}">
<ul>
<li>启动VPN 服务：仅启动本机的拨号VPN。</li>
<li>停止VPN 服务：停止本机的拨号VPN。已经连接上的隧道将全部断开。</li>
<li>配置下发&amp;重载：进行拨号VPN 「设置」时，该动作会自动进行。但某些情况下，如果你想重新生成VPN 服务端配置，可手动执行该操作。</li>
</ul>
<h5>第二、设置</h5>
<hr />
<img src="{{ url_for('docs.static', filename='img/dial_09.png') }}">
<ul>
<li>通信协议：可选"UDP"、"TCP"。注：每次修改保存后，请重新下载客户端配置文件。</li>
<li>虚拟IP 地址池：即VPN Server 分配给客户端的虚拟IP 地址池。本例为：10.8.8.0/24</li>
<li>允许client 间通信：本例子中，这里请选“是”。</li>
<li>允许单个账号同时在线：可选“是”或“否”。</li>
<li>子网网段：即允许拨号client 访问的子网。本例不需要client 访问子网，填写VPN GateWay VM 私网IP 即可：10.171.112.120/32。</li>
</ul>
<h5>第四、添加拨号VPN 账号</h5>
<hr />
<p>点击「新增账号」按钮，即可新增账号：</p>
<img src="{{ url_for('docs.static', filename='img/dial_05.png') }}">
<ul>
<li>账号名：只可包含如下字符：数字、字母、下划线。</li>
<li>密码：只可包含如下字符：数字、字母、下划线。</li>
</ul>
<h5>第五、配置客户端</h5>
<hr />
<p>点击「客户端下载」按钮，可以下载VPN 客户端和相应的配置文件。</p>
<img src="{{ url_for('docs.static', filename='img/dial_07.png') }}">
<ul>
<li>修改配置文件：将配置文件中的「remote IP」字段修改为GateWay VM 的公网地址。</li>
<li>Windows 平台：安装完客户端后，将配置文件client.ovpn和ca.crt 文件放到安装目录下的config 文件夹中。然后启动openvpn-gui.exe，根据提示进行连接。</li>
<li>Linux 平台：在配置文件client.conf 和ca.crt 的目录下执行命令：openvpn client.conf，根据提示进行连接。</li>
</ul>
<h5>第六、查看账号列表</h5>
<hr />
<p>点击「账号列表」按钮，可以查看已经添加的账号列表。如果该账号已经拨入VPN，将看到更明细的信息：</p>
<img src="{{ url_for('docs.static', filename='img/dial_10.png') }}">
<ul>
<li>状态：由于VPN 的keepalive 机制，会有1分钟左右的延时。</li>
</ul>
<h5>第七、使用VPN IP 进行通信</h5>
<hr />
<p>现在，即可使用VPN 分配的地址10.8.8.7、10.8.8.9 进行相互通信了。</p>

<h3>VPC 网络场景</h3>
<hr />
<img src="{{ url_for('docs.static', filename='img/dial_01.png') }}">
<p>如上图所示，管理员想接入VPC2 的私网内，以便管理维护VM1和VM2。其中，VPC2 中有一台使用VPN/SNAT 镜像安装的GateWay VM，并绑定了EIP。<br />
本例：管理员从公网通过VPN 隧道访问VPC2 的192.168.0.3 。</p>
Expand All @@ -33,7 +93,10 @@ <h5>第二、设置</h5>
<hr />
<img src="{{ url_for('docs.static', filename='img/dial_03.png') }}">
<ul>
<li>通信协议：可选"UDP"、"TCP"。注：每次修改保存后，请重新下载客户端配置文件。</li>
<li>虚拟IP 地址池：即VPN Server 分配给客户端的虚拟IP 地址池。</li>
<li>允许client 间通信：可“是”或“否”。</li>
<li>允许单个账号同时在线：可选“是”或“否”。</li>
<li>子网网段：即我们VPC2 的子网192.168.0.0/24。</li>
</ul>
<h5>第三、配置SNAT</h5>
Expand All @@ -47,17 +110,9 @@ <h5>第四、添加拨号VPN 账号</h5>
<img src="{{ url_for('docs.static', filename='img/dial_05.png') }}">
<ul>
<li>账号名：只可包含如下字符：数字、字母、下划线。</li>
<li>密码：只可包含如下字符：数字、字母、下划线。密码以明文方式保存和显示，以让系统管理员可随时查看和修改。</li>
</ul>
<h5>第五、查看账号列表</h5>
<hr />
<p>点击「账号列表」按钮，可以查看已经添加的账号列表。如果该账号已经拨入VPN，将看到更明细的信息：</p>
<img src="{{ url_for('docs.static', filename='img/dial_06.png') }}">
<ul>
<li>状态：由于VPN 的keepalive 机制，会有1分钟左右的延时。</li>
<li>密码：只可包含如下字符：数字、字母、下划线。</li>
</ul>

<h5>第六、配置客户端</h5>
<h5>第五、配置客户端</h5>
<hr />
<p>点击「客户端下载」按钮，可以下载VPN 客户端和相应的配置文件。</p>
<img src="{{ url_for('docs.static', filename='img/dial_07.png') }}">
Expand All @@ -66,6 +121,13 @@ <h5>第六、配置客户端</h5>
<li>Windows 平台：安装完客户端后，将配置文件client.ovpn和ca.crt 文件放到安装目录下的config 文件夹中。然后启动openvpn-gui.exe，根据提示进行连接。</li>
<li>Linux 平台：在配置文件client.conf 和ca.crt 的目录下执行命令：openvpn client.conf，根据提示进行连接。</li>
</ul>
<h5>第六、查看账号列表</h5>
<hr />
<p>点击「账号列表」按钮，可以查看已经添加的账号列表。如果该账号已经拨入VPN，将看到更明细的信息：</p>
<img src="{{ url_for('docs.static', filename='img/dial_06.png') }}">
<ul>
<li>状态：由于VPN 的keepalive 机制，会有1分钟左右的延时。</li>
</ul>
</div>
</div>
</div>
Expand Down
20 changes: 13 additions & 7 deletions website/docs/templates/docs/guide.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,15 @@ <h3>介绍</h3>
<p>本程序提供了VPN、SNAT 基础服务。</p>
<h5>主要提供以下几点功能：</h5>
<ol>
<li>IPSec Site-to-Site 功能。可快速的帮助你将两个不同的VPC 私网以IPSec Site-to-Site 的方式连接起来。</li>
<li>拨号VPN 功能。可让你通过拨号方式，接入VPC 私网，进行日常维护管理。</li>
<li>SNAT 功能。可方便的设置Source NAT，以让VPC 私网内的VM 通过Gateway VM 访问外网。</li>
<li>IPSec Site-to-Site 功能。可快速的帮助你将两个不同的ECS 私网以IPSec Site-to-Site 的方式连接起来。</li>
<li>拨号VPN 功能。可让你通过拨号方式，接入ECS 私网，进行日常维护管理。</li>
<li>SNAT 功能。可方便的设置Source NAT，以让ECS 私网内的VM 通过Gateway VM 访问外网。</li>
</ol>
<h5>典型的应用场景包括：</h5>
<ol>
<li>VPC 用户通过VPN 将云上环境和用户侧网络打通(Site-to-Site)。</li>
<li>同一用户名下多个VPC(包括同Region/不同Region)之间通过VPN 打通(Site-to-Site)。</li>
<li>跨账号、跨区域的云服务器之间内网互通(拨号VPN。可将不同账号下的云服务器拨入同一个FlexGW VPN 内，然后用VPN 分配的私网地址进行互通)。</li>
</ol>

<h3>软件组成</h3>
Expand All @@ -40,15 +46,15 @@ <h5>OpenVPN</h5>

<h3>程序说明</h3>
<hr />
<h5>ECS VPN（即本程序）</h5>
<h5>FlexGW（即本程序）</h5>
<ul>
<li>目录：/usr/local/flexgw</li>
<li>数据库文件：/usr/local/flexgw/instance/website.db</li>
<li>日志文件：/usr/local/flexgw/logs/website.log</li>
<li>启动脚本：/etc/init.d/flexgw 或/usr/local/flexgw/website_console</li>
<li>实用脚本：/usr/local/flexgw/scripts</li>
<li>日志文件目录：/usr/local/flexgw/logs</li>
<li>实用脚本目录：/usr/local/flexgw/scripts</li>
</ul>
<p>「数据库文件」保存了我们所有的VPN 配置，建议定期备份。如果数据库损坏，可通过「实用脚本」目录下的initdb.py 脚本对数据库进行初始化，初始化之后所有的配置将清空。</p>
<p>「数据库文件」保存了我们所有的VPN 配置，建议定期备份。如果数据库损坏，可通过「实用脚本目录」下的initdb.py 脚本对数据库进行初始化，初始化之后所有的配置将清空。</p>
<h5>Strongswan</h5>
<ul>
<li>目录：/etc/strongswan</li>
Expand Down
2 changes: 1 addition & 1 deletion website/docs/templates/docs/ipsec.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<div class="row">
<div class="large-12 columns">
<div class="panel">
<h3>IPSec Site-to-Site VPN 使用指南</h3>
<h3>IPSec Site-to-Site VPN 使用指南（VPC 网络场景）</h3>
<hr />
<img src="{{ url_for('docs.static', filename='img/ipsec_01.png') }}">
<p>如上图所示，VPC1私网为：172.16.0.0/24，VPC2私网为：192.168.0.0/24。其中，两个VPC 中各有一台使用VPN/SNAT镜像安装的GateWay VM，并绑定了EIP。<br />
Expand Down
8 changes: 4 additions & 4 deletions website/docs/templates/docs/snat.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,17 +26,17 @@ <h5>第一、添加SNAT 条目</h5>
<p>进入SNAT 的「SNAT 新增」页面：</p>
<img src="{{ url_for('docs.static', filename='img/snat_02.png') }}">
<ul>
<li>SNAT源IP（段）：为VPC1 中需要访问公网的私网网段。本例中为：172.16.0.0/24</li>
<li>SNAT转发IP：为VPC1 中GateWay VM 的私网IP，而非EIP。本例中为：172.16.0.1</li>
<li>需转换的源IP（或网段）：为VPC1 中需要访问公网的私网网段。本例中为：172.16.0.0/24</li>
<li>转换后的IP：为VPC1 中GateWay VM 的私网IP，而非EIP。本例中为：172.16.0.1</li>
</ul>

<h5>第二、查看SNAT 列表</h5>
<hr />
<p>新增SNAT 条目之后，会自动跳转到「SNAT 列表」页面，即可看到：</p>
<img src="{{ url_for('docs.static', filename='img/snat_03.png') }}">
<ul>
<li>转发网络：为VPC1 中需要访问公网的私网网段。本例中为：172.16.0.0/24</li>
<li>转发后IP：为VPC1 中GateWay VM 的私网IP，而非EIP。本例中为：172.16.0.1</li>
<li>需转换的源IP（或网段）：为VPC1 中需要访问公网的私网网段。本例中为：172.16.0.0/24</li>
<li>转换后的IP：为VPC1 中GateWay VM 的私网IP，而非EIP。本例中为：172.16.0.1</li>
<li>删除：点击「删除」按钮，即可删除该SNAT 条目，且立即生效。</li>
</ul>
</div>
Expand Down

0 comments on commit 53a81b6

Please sign in to comment.