更新说明文档

This commit is contained in:
bjdgyc 2021-08-13 16:24:51 +08:00
parent d4f1793675
commit 60019f3cf4
2 changed files with 49 additions and 50 deletions

View File

@ -8,7 +8,7 @@
![GitHub downloads)](https://img.shields.io/github/downloads/bjdgyc/anylink/total)
![LICENSE](https://img.shields.io/github/license/bjdgyc/anylink)
AnyLink 是一个企业级远程办公sslvpn的软件可以支持多人同时在线使用。
AnyLink 是一个企业级远程办公 sslvpn 的软件,可以支持多人同时在线使用。
## Repo
@ -21,9 +21,9 @@ AnyLink 是一个企业级远程办公sslvpn的软件可以支持多人同时
AnyLink 基于 [ietf-openconnect](https://tools.ietf.org/html/draft-mavrogiannopoulos-openconnect-02)
协议开发,并且借鉴了 [ocserv](http://ocserv.gitlab.io/www/index.html) 的开发思路,使其可以同时兼容 AnyConnect 客户端。
AnyLink 使用TLS/DTLS进行数据加密因此需要RSA或ECC证书可以通过 Let's Encrypt 和 TrustAsia 申请免费的SSL证书。
AnyLink 使用 TLS/DTLS 进行数据加密,因此需要 RSA ECC 证书,可以通过 Let's Encrypt 和 TrustAsia 申请免费的 SSL 证书。
AnyLink 服务端仅在CentOS 7、Ubuntu 18.04测试通过如需要安装在其他系统需要服务端支持tun/tap功能、ip设置命令。
AnyLink 服务端仅在 CentOS 7、Ubuntu 18.04 测试通过,如需要安装在其他系统,需要服务端支持 tun/tap 功能、ip 设置命令。
## Screenshot
@ -31,7 +31,7 @@ AnyLink 服务端仅在CentOS 7、Ubuntu 18.04测试通过,如需要安装在
## Installation
> 没有编程基础的同学建议直接下载release包从下面的地址下载 anylink-deploy.tar.gz
> 没有编程基础的同学建议直接下载 release 包,从下面的地址下载 anylink-deploy.tar.gz
>
> https://github.com/bjdgyc/anylink/releases
@ -41,7 +41,7 @@ AnyLink 服务端仅在CentOS 7、Ubuntu 18.04测试通过,如需要安装在
>
> 需要提前安装好 golang 和 nodejs
>
> 使用客户端前必须申请安全的https证书不支持私有证书连接
> 使用客户端前,必须申请安全的 https 证书,不支持私有证书连接
```shell
git clone https://github.com/bjdgyc/anylink.git
@ -62,23 +62,23 @@ sudo ./anylink
## Feature
- [x] IP分配(实现IP、MAC映射信息的持久化)
- [x] TLS-TCP通道
- [x] DTLS-UDP通道
- [x] 兼容AnyConnect
- [x] 基于tun设备的nat访问模式
- [x] 基于tap设备的桥接访问模式
- [x] 基于macvtap设备的桥接访问模式
- [x] IP 分配(实现 IP、MAC 映射信息的持久化)
- [x] TLS-TCP 通道
- [x] DTLS-UDP 通道
- [x] 兼容 AnyConnect
- [x] 基于 tun 设备的 nat 访问模式
- [x] 基于 tap 设备的桥接访问模式
- [x] 基于 macvtap 设备的桥接访问模式
- [x] 支持 [proxy protocol v1](http://www.haproxy.org/download/2.2/doc/proxy-protocol.txt) 协议
- [x] 用户组支持
- [x] 多用户支持
- [x] TOTP令牌支持
- [x] TOTP令牌开关
- [x] TOTP 令牌支持
- [x] TOTP 令牌开关
- [x] 流量速率限制
- [x] 后台管理界面
- [x] 访问权限管理
- [ ] IP访问审计功能
- [ ] 基于ipvtap设备的桥接访问模式
- [ ] IP 访问审计功能
- [ ] 基于 ipvtap 设备的桥接访问模式
## Config
@ -110,21 +110,21 @@ sudo ./anylink
网络模式选择,需要配置 `link_mode` 参数,如 `link_mode="tun"`,`link_mode="tap"`,`link_mode="macvtap"` 等参数。 不同的参数需要对服务器做相应的设置。
建议优先选择tun模式其次选择macvtap模式因客户端传输的是IP层数据无须进行数据转换。 tap模式是在用户态做的链路层到IP层的数据互相转换性能会有所下降。 如果需要在虚拟机内开启tap模式请确认虚拟机的网卡开启混杂模式。
建议优先选择 tun 模式,其次选择 macvtap 模式,因客户端传输的是 IP 层数据,无须进行数据转换。 tap 模式是在用户态做的链路层到 IP 层的数据互相转换,性能会有所下降。 如果需要在虚拟机内开启 tap 模式,请确认虚拟机的网卡开启混杂模式。
### tun设置
### tun 设置
1. 开启服务器转发
```shell
# flie: /etc/sysctl.conf
net.ipv4.ip_forward = 1
```shell
# flie: /etc/sysctl.conf
net.ipv4.ip_forward = 1
#执行如下命令
sysctl -w net.ipv4.ip_forward=1
```
#执行如下命令
sysctl -w net.ipv4.ip_forward=1
```
2. 设置nat转发规则
2. 设置 nat 转发规则
```shell
systemctl stop firewalld.service
@ -138,9 +138,9 @@ iptables -t nat -A POSTROUTING -s 192.168.10.0/24 -o eth0 -j MASQUERADE
iptables -nL -t nat
```
3. 使用AnyConnect客户端连接即可
3. 使用 AnyConnect 客户端连接即可
### macvtap设置
### macvtap 设置
1. 设置配置文件
@ -157,7 +157,7 @@ ipv4_start = "192.168.10.100"
ipv4_end = "192.168.10.200"
```
### tap设置
### tap 设置
1. 创建桥接网卡
@ -184,20 +184,20 @@ sh bridge-init.sh
## Systemd
添加 systemd脚本
添加 systemd 脚本
* anylink 程序目录放入 `/usr/local/anylink-deploy`
- anylink 程序目录放入 `/usr/local/anylink-deploy`
systemd 脚本放入:
* centos: `/usr/lib/systemd/system/`
* ubuntu: `/lib/systemd/system/`
- centos: `/usr/lib/systemd/system/`
- ubuntu: `/lib/systemd/system/`
操作命令:
* 启动: `systemctl start anylink`
* 停止: `systemctl stop anylink`
* 开机自启: `systemctl enable anylink`
- 启动: `systemctl start anylink`
- 停止: `systemctl stop anylink`
- 开机自启: `systemctl enable anylink`
## Docker
@ -220,7 +220,7 @@ systemd 脚本放入:
#Passwd:$2a$10$lCWTCcGmQdE/4Kb1wabbLelu4vY/cUwBwN64xIzvXcihFgRzUvH2a
```
4. 生成jwt secret
4. 生成 jwt secret
```bash
docker run -it --rm bjdgyc/anylink tool -s
@ -263,7 +263,9 @@ systemd 脚本放入:
## Donate
> 如果您觉得anylink对你有帮助欢迎给我们打赏也是帮助anylink更好的发展。
> 如果您觉得 anylink 对你有帮助,欢迎给我们打赏,也是帮助 anylink 更好的发展。
>
> [查看打赏列表](doc/README.md)
<p>
<img src="doc/screenshot/wxpay2.png" width="400" />
@ -271,22 +273,21 @@ systemd 脚本放入:
## Discussion
添加QQ群: 567510628
添加 QQ 群: 567510628
QQ群共享文件有相关软件下载
QQ 群共享文件有相关软件下载
## Contribution
欢迎提交 PR、Issues感谢为AnyLink做出贡献。
欢迎提交 PR、Issues感谢为 AnyLink 做出贡献。
注意新建PR需要提交到dev分支其他分支暂不会合并。
注意新建 PR需要提交到 dev 分支,其他分支暂不会合并。
## Other Screenshot
<details>
<summary>展开查看</summary>
![system.jpg](doc/screenshot/system.jpg)
![setting.jpg](doc/screenshot/setting.jpg)
![users.jpg](doc/screenshot/users.jpg)

View File

@ -1,6 +1,6 @@
## Donate
> 如果您觉得AnyLink对你有帮助欢迎给我们打赏也是帮助AnyLink更好的发展。
> 如果您觉得 AnyLink 对你有帮助,欢迎给我们打赏,也是帮助 AnyLink 更好的发展。
<p>
<img src="screenshot/wxpay2.png" width="500" />
@ -8,11 +8,9 @@
## Donator
> 感谢以下同学的打赏AnyLink有你更美好
| 昵称 | 主页 |
| -------- | -------- |
|代码oo8 | |
|甘磊 | |
> 感谢以下同学的打赏AnyLink 有你更美好!
| 昵称 | 主页 |
| -------- | ---------------------------- |
| 代码 oo8 | |
| 甘磊 | https://github.com/ganlei333 |