Skip to content

Commit 9c0ae72

Browse files
committed
fix:优化内容说明
1 parent 1dc0f12 commit 9c0ae72

32 files changed

Lines changed: 165 additions & 164 deletions

docs/.vitepress/theme/style.css

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@
77

88
html[lang^='en'] .VPNavBar .content-body,
99
html[lang^='en'] .VPNavBar .menu {
10-
overflow: hidden;
10+
/* Keep locale/theme dropdown panels from being clipped. */
11+
overflow: visible;
1112
}
1213

1314
html[lang^='en'] .VPNavBar .menu {

docs/case/case1.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Shell 版本:[https://github.com/spiritLHLS/ecs](https://github.com/spiritLHLS
2929
|---------------------------|--------------|---------------------------|---------------|
3030
| amd64 | amd64 | Linux | Linux |
3131
| arm64 | arm64 | Windows | Windows |
32-
| arm | | MacOS(Darwin) | MacOS |
32+
| arm | | macOS(Darwin) | macOS |
3333
| 386 | | FreeBSD | |
3434
| mips,mipsle | | Android | |
3535
| mips64,mips64le | | | |
@@ -68,7 +68,7 @@ Shell 版本:[https://github.com/spiritLHLS/ecs](https://github.com/spiritLHLS
6868

6969
## **使用说明**
7070

71-
### **Linux/FreeBSD/MacOS**
71+
### **Linux/FreeBSD/macOS**
7272

7373
#### **一键命令**
7474

@@ -355,7 +355,7 @@ go build -o goecs
355355
```bash
356356
# 编译 Windows 版本
357357
GOOS=windows GOARCH=amd64 go build -o goecs.exe
358-
# 编译 MacOS 版本
358+
# 编译 macOS 版本
359359
GOOS=darwin GOARCH=amd64 go build -o goecs_darwin
360360
```
361361
</details>

docs/en/guide/docker/docker_build.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ outline: deep
44

55
# Introduction
66

7-
There are two methods of building
7+
There are two deployment methods.
88

99
## Setting Up Standalone
1010

11-
- Generate only one docker
12-
- Can be configured to bind a separate IPv6 address, but requires a docker previously installed using the environment installation command of this set of scripts, and requires the host to be bound to at least the /112 IPv6 subnet
11+
- Generate a single Docker container
12+
- Can bind an independent IPv6 address, but requires Docker to be installed with this project's installer and a host IPv6 subnet of at least /112
1313
- Support for x86_64 and ARM architecture servers
1414

1515
### Download the Script
@@ -22,7 +22,7 @@ curl -L https://raw.githubusercontent.com/oneclickvirt/docker/main/scripts/onedo
2222

2323
### Example
2424

25-
Running the supported variables are as follows
25+
Supported parameters are as follows:
2626

2727
```
2828
./onedocker.sh name cpu memory password sshport startport endport <independent_ipv6> <system> <disk>
@@ -39,7 +39,7 @@ Currently, the system only supports selecting:
3939

4040
with Debian being the default choice.
4141

42-
The hard disk size can only be set by filling in the value if you have selected the option to support limiting the hard disk size during the previous Docker installation, it is not limited when not filled in by default.
42+
Disk size can be set only if you previously enabled disk-limit support during Docker installation. If omitted, disk size is unlimited by default.
4343

4444
```shell
4545
./onedocker.sh test 1 512 123456 25000 34975 35000 N debian 5
@@ -78,7 +78,7 @@ docker exec -it test /bin/bash
7878

7979
To exit the container, simply execute ```exit```.
8080

81-
Inquiry Information
81+
Query Information
8282

8383
```shell
8484
cat Container_Name(change me)
@@ -90,7 +90,7 @@ The output format is
9090
Container_Name SSH_Port Root_Password Number_of_Cores Memory Start_of_Public_Port End_of_Public_Port
9191
```
9292

93-
The docker's ipv6 address can only be looked up within the container itself, it doesn't exist in the docker's configuration
93+
The container IPv6 address can only be checked from inside the container; it is not exposed in the default Docker output here.
9494

9595
## Batch Deployment
9696

@@ -116,11 +116,11 @@ The output format is
116116
Container_Name SSH_Port Root_Password Number_of_Cores Memory Start_of_Public_Port End_of_Public_Port Disk_Size
117117
```
118118

119-
One line corresponds to information about a container, the docker's ipv6 address can only be looked up within the container itself, it doesn't exist in the docker's configuration.
119+
Each line corresponds to one container. The IPv6 address can only be checked from inside that container.
120120

121121
## Uninstall all Docker containers and images
122122

123-
The following command offload ignores ndpresponder to prevent IPv6 configuration failure
123+
The following cleanup command keeps `ndpresponder` to avoid breaking IPv6 configuration.
124124

125125
```shell
126126
docker ps -a --format '{{.Names}}' | grep -vE '^ndpresponder' | xargs -r docker rm -f
@@ -156,15 +156,15 @@ curl -sSL https://raw.githubusercontent.com/oneclickvirt/docker/main/scripts/cre
156156

157157
## Start all containers after host reboot
158158

159-
The default containers are not set to restart themselves after stopping, you need to execute the following command to start all stopped containers.
159+
By default, containers are not configured for auto-restart after host reboot. Run the following command to start all stopped containers.
160160

161161
```
162162
docker start $(docker ps -aq)
163163
```
164164

165165
## Start SSH service for all containers after host reboot
166166

167-
Since the container itself does not have a daemon, the SSH service cannot start itself, and you need to execute the following command to start the SSH process for all containers.
167+
Because these containers do not run a full init system by default, SSH may not auto-start. Use the following command to start SSH in all running containers.
168168

169169
```
170170
container_ids=$(docker ps -q)

docs/en/guide/docker/docker_install.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ outline: deep
66

77
Support for running Docker virtualization on various systems, including Linux, Android, and Windows.
88

9-
If your host does not have an IPv6 subnet and you want to assign IPv6 addresses to containers, then please check the ``Customize`` partition in the ``LXD`` module for the ``Attach a free IPv6 address segment`` to the host, and attach an IPv6 subnet to the host before installing the environment.
9+
If your host has no IPv6 subnet but you want to assign IPv6 addresses to containers, check the ``Customize`` section in the ``Docker`` module for ``Attach a free IPv6 address segment to the host``, then attach an IPv6 subnet before installation.
1010

1111
## Setting Up Virtual Memory
1212

@@ -48,7 +48,7 @@ bash dockerinstall.sh
4848
```
4949

5050
:::tip
51-
The environment installation process may require you to reboot the server and then execute the script again, see the instructions after the script is run for more details
51+
The installation process may require a reboot. If prompted, reboot the server and run the script again.
5252
:::
5353

5454
## Detect whether Docker supports limiting container hard disk size

docs/en/guide/docker/docker_precheck.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Introduction
22

3-
The following is an introduction to the non-customized sections. Please ensure that you don't confuse them with the customized parts.
3+
This page introduces the standard (non-customized) workflow.
44

5-
If your host does not have an IPv6 subnet and you want to assign IPv6 addresses to containers, then please check the ``Customize`` partition in the ``incus`` module for the ``Attach a free IPv6 address segment`` to the host, and attach an IPv6 subnet to the host before installing the environment.
5+
If your host has no IPv6 subnet but you want to assign IPv6 addresses to containers, check the ``Customize`` section in the ``Docker`` module for ``Attach a free IPv6 address segment to the host``, then attach an IPv6 subnet before installation.
66

77
:::warning
8-
If the host has an IPv6 network, the installation will change the network structure of the host, please make sure that the host can reset the system at any time and that there is no important data on the host before running.
8+
If the host has IPv6 networking, installation may change host network structure. Ensure the host can be recovered/reinstalled at any time, and do not run on machines with critical data.
99
:::
1010

1111
Feel free to give the project a ```Star``` for free support!-->[https://github.com/oneclickvirt/docker](https://github.com/oneclickvirt/docker)
@@ -21,7 +21,7 @@ Containers are created as unprivileged by default, and Docker daemon sockets are
2121

2222
By default, lxcfs is installed and enabled, so that when querying resources within a container, CPU and memory use the configured view instead of the host's view.
2323

24-
By default, you can choose whether or not to share the hard disk of the host machine, and you can choose whether or not to install it as an environment that can limit the size of the hard disk during Docker installation.
24+
By default, the installer lets you choose whether to share host disk space and whether to enable container disk-size limits.
2525

2626
## Configuration requirements
2727

docs/en/guide/incus/incus_custom.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,7 @@ Copy the last red box of the page without the blank lines.
246246
Then open [https://ipv6tunnel.spiritlhl.top/](https://ipv6tunnel.spiritlhl.top/) and select```Option```for```TunnelBrokerCh```, another drop-down selection box to choose the name of the package you successfully installed previously, then paste what you copied in the input box.
247247

248248

249-
Then click```Covert```to convert the format, and wait for the page to refresh to show the converted configuration file.
249+
Then click ```Convert``` to convert the format, and wait for the page to refresh to show the converted configuration file.
250250

251251

252252
Then use vim or vi to modify the```/etc/network/interfaces```file to add content, or modify the following command to add new content
@@ -304,7 +304,7 @@ For these four lines, press ctrl+c to copy or right-click to copy
304304

305305
Then open [https://ipv6tunnel.spiritlhl.top/](https://ipv6tunnel.spiritlhl.top/) and select```Option```for```ip4market```, another drop-down selection box to choose the name of the package you successfully installed previously, then paste what you copied in the input box.
306306

307-
Then click```Covert```to convert the formatting
307+
Then click ```Convert``` to convert the formatting
308308

309309
![](images/incus17.png)
310310

@@ -345,7 +345,7 @@ The above content will appear, copy all the boxed parts without blank lines.
345345

346346
Then open [https://ipv6tunnel.spiritlhl.top/](https://ipv6tunnel.spiritlhl.top/) and select```Option```for```NetAssist```, another drop-down selection box to choose the name of the package you successfully installed previously, then paste what you copied in the input box.
347347

348-
Then click on```Covert```to convert the formatting
348+
Then click ```Convert``` to convert the formatting
349349

350350
![c](images/incus20.png)
351351

docs/en/guide/incus/incus_install.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ If you need to specify the path of a non-system disk as the default pool, then y
6464
If the corresponding disk has 18 Gigabytes of free hard disk space in addition to the occupied space and you want to open a 15 Gigabyte storage pool, follow the command line prompts to enter ```15```.
6565

6666
:::tip
67-
The execution process **may** require a **manual reboot** to load the storage type into the kernel, the installation is completed at the end of the execution will **automatically reboot** the server, the first time after the complete installation of the reboot will take about 400 ~ 500 seconds, please be patient
67+
The process **may** require a **manual reboot** to load storage drivers into the kernel. At the end of installation, the server may **automatically reboot**. The first full reboot can take about 400-500 seconds.
6868
:::
6969

7070
:::warning
@@ -123,16 +123,16 @@ apt-get install incus -y
123123
incus -h
124124
```
125125

126-
If there are no exceptions, continue execution
126+
If no errors occur, continue with:
127127

128128
```
129129
incus admin init
130130
```
131131

132-
Just enter the default for the normal options
132+
For standard options, keep the defaults.
133133

134134
Choose the size of the physical disk (hint: select the default option with a minimum of 1GB). Generally, I fill in the available disk space minus the memory size, then multiply by 0.95 and round down. Here, I entered 10GB.
135135

136-
Remember to select 'no' for options containing 'auto' when prompted to update the image, in order to avoid occupying the system.
136+
When prompted about automatic image updates, choose `no` to avoid unnecessary resource usage.
137137

138138

docs/en/guide/incus/incus_lxc.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ A portion of the available system parameters are shown here for your reference:
1212
- ubuntu18, ubuntu20, ubuntu22
1313
- centos8, centos9 (actually opened out of the Stream version)
1414
- alpine3.15, alpine3.16, alpine3.17, alpine3.18
15-
- openwrt21openwrt22fedora37fedora38fedora39
16-
- rockylinux8rockylinux9,oralce8,oracle9
17-
- oralce7,centos7 (CGroupV1 needs to be enabled in GRUB or it won't start.)
18-
- kaliarchlinux
15+
- openwrt21, openwrt22, fedora37, fedora38, fedora39
16+
- rockylinux8, rockylinux9, oracle8, oracle9
17+
- oracle7, centos7 (CGroupV1 needs to be enabled in GRUB or it won't start.)
18+
- kali, archlinux
1919

2020
* Note that **the combination of lowercase letters + numbers** or **only lowercase letters**, try it yourself, if the search is not the system will automatically exit the script
2121
* The version number can be with English decimal point, in order to adapt to the alpine version number has been supported.
@@ -47,19 +47,19 @@ curl -L https://raw.githubusercontent.com/oneclickvirt/incus/main/scripts/buildc
4747
. /buildct.sh name Cpu_num Memory_size Hard_disk_size SSH_port Extranet_start_port Extranet_stop_port Download_speed Upload_speed Whether_IPV6_is_enabled(Y or N) System(leave blank for debian11)
4848
```
4949

50-
Memory size is calculated in MB, hard disk size is calculated in GB, download speed upload speed is calculated in Mbit, whether to enable IPv6 does not have to fill in Y or N, no this parameter can also be left blank default does not enable IPv6
50+
Memory is in MB, disk size in GB, and download/upload speeds in Mbit. For IPv6, you can provide `Y` or `N`, or leave it empty (default: disabled).
5151

52-
If ```external start port`` and ```external stop port`` are both set to 0, then we don't do interval port mapping, only the basic SSH port is mapped, note that ```can't be null``, and it needs to be set to 0 if it's not to be mapped.
52+
If both ```external start port``` and ```external stop port``` are set to `0`, no port-range mapping is created and only SSH is mapped. These fields cannot be empty.
5353

54-
Support custom container system, do not fill in the leave blank default use debian11, pay attention to the incoming parameters for the system name + version number
54+
Custom container systems are supported. If left empty, `debian11` is used by default. Use the format `system + version`.
5555

5656
### Example
5757

58-
Here is the information about the example chick that is being raised:
58+
Example container configuration:
5959

6060
| Attribute | Value |
6161
|-----------------------------|-----------------|
62-
| container's Name | test |
62+
| Container Name | test |
6363
| Username for SSH Login | root |
6464
| Password for SSH Login | Randomly generated |
6565
| Number of CPU Cores | 1 |
@@ -87,9 +87,9 @@ For example, the information for the query example is
8787
cat test
8888
```
8989

90-
If you have already generated chicks through the above methods and still need to batch generate chicks, you can use a customized batch generation version of the script, but note that you should first delete the test chicks before batch generating chicks
90+
If you already created a test container and want to do batch generation, delete the test container first.
9191

92-
### Delete Test Chick
92+
### Delete Test Container
9393

9494
```shell
9595
incus stop test
@@ -101,14 +101,14 @@ ls
101101

102102
## Normal version batch generation
103103

104-
Opened Chick Configuration:
104+
Batch Profile:
105105

106106
- 1 core 256MB RAM 1GB hard disk limited to 300Mbit bandwidth
107107
- With 1 SSH port, 24 extranet ports
108108
- Default memory and hard disk size
109109

110110
:::tip
111-
incus if the command is no problem, the execution of the initialization of the opening of the containers, this step is best to put ```screen`` in the background to suspend the execution of the opening of the containers, the length of time with you to open a few and the mother hen configuration-related
111+
If `incus` commands run normally, proceed with initialization. It is recommended to run this in a `screen` session because runtime depends on host resources and the number of containers.
112112
:::
113113

114114
Execute the following command to load the boot script
@@ -119,24 +119,24 @@ Command:
119119
curl -L https://raw.githubusercontent.com/oneclickvirt/incus/main/scripts/init.sh -o init.sh && chmod +x init.sh && dos2unix init.sh
120120
```
121121

122-
The following command opens **10** chicks with the name prefix **tj**.
122+
The following command opens **10** containers with prefix **tj**.
123123

124124
```shell
125125
./init.sh tj 10
126126
```
127127

128-
Sometimes there is a problem with the path where init.sh is run, in this case it is recommended to add sudo in front of it to force it to run in the root directory
128+
If path issues occur when running `init.sh`, prepend `sudo` and run it from the root directory.
129129

130130
## Bulk generation of pure SSH port versions
131131

132-
Opened Chick Configuration:
132+
Batch Profile:
133133

134134
- 1 core 128MB RAM 1GB hard disk limited to 300Mbit bandwidth
135135
- Only one SSH port
136136
- Unable to mount warp
137137

138138
:::tip
139-
incus if the command is no problem, the execution of the initialization of the opening of the chick, this step is best to put the ```screen`` in the background to hang the execution of the opening of the chick, the length of time you open the chick with the opening of a few and the mother hen configuration-related
139+
If `incus` commands run normally, proceed with initialization. Use a `screen` session to avoid interruption; runtime depends on host resources and container count.
140140
:::
141141

142142
Load boot script
@@ -147,13 +147,13 @@ Command:
147147
curl -L https://raw.githubusercontent.com/oneclickvirt/incus/main/scripts/least.sh -o least.sh && chmod +x least.sh && dos2unix least.sh
148148
```
149149

150-
The last line of the following command opens **10** chicks with the chick name prefix **tj**
150+
The last command below opens **10** containers with prefix **tj**.
151151

152152
```shell
153153
./least.sh tj 10
154154
```
155155

156-
Sometimes there is a problem with the path where last.sh is run, in this case it is recommended to force the root directory to run by adding sudo in front of it.
156+
If path issues occur when running `least.sh`, prepend `sudo` and run it from the root directory.
157157

158158
## Custom Batch Generation of Versions
159159

@@ -168,28 +168,28 @@ Command:
168168
curl -L https://github.com/oneclickvirt/incus/raw/main/scripts/add_more.sh -o add_more.sh && chmod +x add_more.sh && bash add_more.sh
169169
```
170170

171-
Can be run multiple times to batch generate chicks, and inherit the previous part has been generated in the back to add, customizable memory and hard disk size
171+
This script can be run multiple times. It appends new containers while inheriting previous configuration, with customizable memory and disk size.
172172

173-
## View the information of the batch opened chicks
173+
## View Batch Container Information
174174

175-
After opening the chicks, the specific information will be generated in the log file in the current directory, with the following format
175+
After creation, container information is written to a log file in the current directory in this format:
176176

177177
```shell
178178
container_1_Name Password SSH_Port Public_Port_Start Public_Port_End
179179
container_2_Name Password SSH_Port Public_Port_Start Public_Port_End
180180
```
181181

182-
To view it, simply print the log file by executing the following command in the current directory
182+
To view it, print the log file from the current directory:
183183

184184
```shell
185185
cat log
186186
```
187187

188188
:::warning
189-
Don't use the chicks opened by this script as a production environment, incus virtualization doesn't support changing kernel, dd, turning on bbr, etc.
189+
Do not use containers created by this script as production environments. Incus containers do not support kernel replacement, DD reinstall flows, BBR toggling, and similar host-level changes.
190190
:::
191191

192-
## Some common incus commands
192+
## Common Incus Commands
193193

194194
View all containers:
195195

docs/en/guide/incus/incus_precheck.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Feel free to give the project a ```Star``` for free support!-->[https://github.c
1313
## Requirements
1414

1515
Hardware requirements.
16-
- System: Ubuntu 20+, Debian 11+, RockyLinux 9+, AlmaLinux 9+, Centos 9+, Alpine(After installing bash on your own), Arch
16+
- System: Ubuntu 20+, Debian 11+, RockyLinux 9+, AlmaLinux 9+, CentOS 9+, Alpine (install bash first), Arch
1717
- Virtualization: KVM, VMWARE recommended.
1818
- CPU: The number of cores should be greater than or equal to 2, otherwise there may be a kernel idling slice cycle resulting in 100% occupancy
1919
- Memory: At least 512MB of RAM

0 commit comments

Comments
 (0)