Skip to content

Commit d6163be

Browse files
committed
docs: add Tailscale networking instructions
1 parent 2c2211a commit d6163be

File tree

31 files changed

+207
-114
lines changed

31 files changed

+207
-114
lines changed

docs/.vitepress/config.mts

Lines changed: 23 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,22 +15,16 @@ export default defineConfig({
1515

1616
sidebar: [
1717
{
18-
text: "介绍",
1918
items: [
2019
{ text: "简介", link: "/introduction" },
2120
// { text: "部分界面截图", link: "/screenshot" },
22-
],
23-
},
24-
{
25-
text: "部署指南",
26-
items: [
27-
{ text: "注意 Linux 版本 / 内核要求", link: "/attention" },
21+
{ text: "系统运行基本要求!!! (必读)", link: "/attention" },
2822
{ text: "手工部署", link: "/manual" },
2923
{ text: "康康其他人怎么做 (链接)", link: "/community-guides" },
3024
],
3125
},
3226
{
33-
text: "配置介绍",
27+
text: "目录结构 & 配置",
3428
items: [
3529
{ text: ".landscape-router 目录介绍", link: "/config/home_path.md" },
3630
{ text: "配置文件介绍", link: "/config/index.md" },
@@ -46,13 +40,29 @@ export default defineConfig({
4640
{
4741
text: "基础功能设置",
4842
items: [
49-
{ text: "系统基本设置", link: "/other-features/sys-info" },
43+
{
44+
text: "系统基本设置",
45+
collapsed: true,
46+
items: [
47+
{ text: "基础操作", link: "/other-features/basic/basic" },
48+
{ text: "区域切换", link: "/other-features/basic/zone" },
49+
],
50+
},
51+
{ text: "IPv4 相关", link: "/other-features/ipv4/ipv4" },
5052
{ text: "IPv6 相关", link: "/other-features/ipv6" },
51-
{ text: "DHCPv4 相关", link: "/other-features/dhcpv4" },
53+
{ text: "DHCPv4 Server 相关", link: "/other-features/dhcpv4" },
5254
// { text: "NAT", link: "/feature/route.md" },
5355
{ text: "防火墙设置", link: "/other-features/firewall" },
5456
{ text: "DNS 相关", link: "/other-features/serverdns" },
55-
{ text: "虚拟组网", link: "/other-features/overlay-network" },
57+
{
58+
text: "虚拟组网",
59+
link: "/other-features/overlay/overlay-network",
60+
collapsed: true,
61+
items: [
62+
{ text: "Zerotier", link: "/other-features/overlay/zerotier" },
63+
{ text: "Tailscale", link: "/other-features/overlay/tailscale" },
64+
],
65+
},
5666
// { text: "Docker", link: "/flow.md" },
5767
// { text: "连接信息", link: "/flow.md" },
5868
{
@@ -67,14 +77,15 @@ export default defineConfig({
6777
},
6878
{
6979
text: "编译",
80+
collapsed: true,
7081
items: [
7182
{ text: "编译", link: "/compilation/index.md" },
7283
{ text: "与 Armbian 集成", link: "/compilation/armbian.md" },
7384
{ text: "交叉编译", link: "/compilation/cross.md" },
7485
],
7586
},
7687
{
77-
text: "FAQ",
88+
text: "常见问题",
7889
items: [
7990
{ text: "DNS 服务相关", link: "/faq/dns.md" },
8091
// { text: "在已有网络基础上运行", link: "/faq/coexist.md" },

docs/config/home_path.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33

44
这个就是指定运行时项目的持久化配置存储路径位置. 检查目录你会看到如下内容:
55
```shell
6-
root@router# tree
6+
root@router:/root/.landscape-router# tree
77
.
8-
├── cert.pem # 生成的自签名 证书
9-
├── key.pem # 生成的自签名 证书
8+
├── cert.pem # 生成的 自签名证书
9+
├── key.pem # 生成的 自签名证书
1010
├── geo_tmp # geo 文件缓存路径
1111
│ ├── ip
1212
│ └── site
@@ -15,6 +15,12 @@ root@router# tree
1515
├── landscape_init.lock # lock 文件, 如果重新刷新配置
1616
├── landscape_init.toml # 初始化配置文件 ( 仅读取一次 ) 介绍见 [配置文件介绍]
1717
├── landscape.toml # 配置 日志 / 登录 用户 / 监听端口 等配置 介绍见 [配置文件介绍]
18+
├── logs # 日志文件夹 ( 默认位置 可被修改 )
19+
│ ├── landscape.log.yyyy-MM-dd
20+
├── static # WEB UI 文件夹 ( 默认位置 可被修改 )
21+
│ ├── assets
22+
│ │ └── ...
23+
│ └── index.html
1824
└── unix_link # 与 docker 容器通信的 sock 文件 忽略即可
1925
└── register.sock
2026
```

docs/feature/flow.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
* `Flow`: 一组策略,拥有入口和出口,中文 ``
88
* `入口`: 一组过滤筛选客户端的规则, 使用 `IP 地址` 或者 `MAC` 进行匹配
99
* `出口`: Docker 容器 (容器中的程序需要与[接应程序](#接应程序镜像)配合使用), 或者某个 WAN 网卡. 当前没有多个出口负载, 只有单出口.
10-
* `默认流`: Flow ***ID 0***,所有`未匹配`的流量,默认进入此流, 出口为拓扑中设置的`默认路由`, 比如 [PPPoE](../other-features/sys-info.md#设置-pppoe-网卡为默认路由-添加-pppoe-账号) 中启用 `设置默认路由` 开关
10+
* `默认流`: Flow ***ID 0***,所有`未匹配`的流量,默认进入此流, 出口为拓扑中设置的`默认路由`, 比如 [PPPoE](../other-features/ipv4/ipv4.md#pppoe) 中启用 `设置默认路由` 开关
1111
* `其他流`:Flow ***ID 1~255***,按入口规则匹配,匹配成功则进入此流
1212
* `流内规则匹配方式`: 会检查 DNS 规则还有 IP 规则, 当同时满足两类规则时, 按照优先级选择 (优先级值越小越高),匹配上即发送至出口,后续规则不再进行匹配(只会与一条规则匹配上)
1313
* `优先级`: DNS / IP 规则的 index 值进行定义, 总条目数是 2^32, 当这个值重复时优先使用 DNS 动作处理.
-21 KB
Binary file not shown.

docs/manual.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@
77
3. 以下的可选是在没有使用到时可选
88
:::
99

10+
::: warning
11+
记得先使用 ```ss -lutp``` 检查当前主机是否有 DNS 服务已经占用了 `53` 端口, 如果已被占用则无法启动.
12+
:::
13+
14+
1015
1. Landscape Router 文件主体, 可从 [此处](https://github.com/ThisSeanZhang/landscape/releases/) 下载
1116
2. 静态页面文件, 可从 [此处](https://github.com/ThisSeanZhang/landscape/releases/) 下载, 并且解压到 `/root/.landscape-router/static` 文件夹中
1217
3. (可选) 安装 PPP,用于 pppoe 拨号

docs/other-features/basic/basic.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# 系统基本信息
2+
3+
## 创建网桥
4+
1、创建网桥
5+
2、为网桥绑定网卡
6+
![](../../images/other-features/CicsSystemGroup/13.png)
7+
8+
## 开启/关闭 网卡
9+
![](../../images/other-features/CicsSystemGroup/3.png)
10+
11+
## 无线网卡
12+
将 hostapt 配置填入输入框中即可
13+
14+
## 启用 Wan 和 Lan 网卡的路由转发功
15+
![](../../images/other-features/CicsSystemGroup/12.png)
16+
17+
## vlan 配置
18+
> 当前为临时方案, 如果之后页面上支持创建 vlan 网卡后, 需要再手动删除添加的 vlan 配置
19+
20+
以 Debian 为例在 /etc/network/interfaces 中创建 vlan 网卡,设置为 manual 即可。
21+
↓ 示例
22+
```shell
23+
# This file describes the network interfaces available on your system
24+
# and how to activate them. For more information, see interfaces(5).
25+
26+
source /etc/network/interfaces.d/*
27+
28+
# The loopback network interface
29+
auto lo
30+
iface lo inet loopback
31+
32+
auto eth0
33+
iface eth0 inet manual
34+
35+
# 创建 vlan id 为 10 的网卡,绑定到 物理接口 eth0
36+
auto eth0.10
37+
iface eth0.10 inet manual
38+
vlan-raw-device eth0 # 绑定物理接口
39+
40+
# 创建 vlan id 为 20 的网卡,绑定到 物理接口 eth0
41+
auto eth0.20
42+
iface eth0.20 inet manual
43+
vlan-raw-device eth0 # 绑定物理接口
44+
45+
```
46+

0 commit comments

Comments
 (0)