Skip to content

Commit ee252a4

Browse files
committed
docs: reorder chapters
1 parent 2216c2e commit ee252a4

File tree

2 files changed

+129
-129
lines changed

2 files changed

+129
-129
lines changed

README.md

Lines changed: 65 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,71 @@ make tpls
2525
```
2626
Then compile the project like above.
2727

28-
## Usage for compiled application
28+
## Examples
29+
Start server on port 8080, root directory is current working directory:
30+
```sh
31+
server -l 8080
32+
```
33+
34+
Start server on port 8080, root directory is /usr/share/doc:
35+
```sh
36+
server -l 8080 -r /usr/share/doc
37+
```
38+
39+
Start server on default port, root directory is /tmp, and allow upload files to file system directory /tmp/data:
40+
```sh
41+
server -r /tmp -u /data
42+
```
43+
44+
Share files from /etc, but also mount /usr/share/doc to url path /doc
45+
```sh
46+
server -r /etc -a :/doc:/usr/share/doc
47+
```
48+
49+
Start server on port 8080, serve for HTTPS protocol
50+
```sh
51+
server -k /path/to/certificate/key -c /path/to/certificate/file -l 8080
52+
```
53+
54+
Do not show hidden unix directories and files that starts with `.`.
55+
Tips: wrap wildcard by quotes to prevent expanding by shell.
56+
```sh
57+
server -H '.*'
58+
```
59+
60+
Show access log on console:
61+
```sh
62+
server -L -
63+
```
64+
65+
Http Basic Auth:
66+
- requires authentication for url /files
67+
- username: user1, password: pass1
68+
- username: user2, password: pass2
69+
```sh
70+
server --auth /files --user user1:pass1 --user-sha1 user2:8be52126a6fde450a7162a3651d589bb51e9579d
71+
```
72+
73+
Start 2 virtual hosts:
74+
- server 1
75+
- listen on port 80 for http
76+
- listen on port 443 for https
77+
- cert file: /cert/server1.pem
78+
- key file: /cert/server1.key
79+
- hostname: server1.example.com
80+
- root directory: /var/www/server1
81+
- server 2
82+
- listen on port 80 for http
83+
- listen on port 443 for https
84+
- cert file: /cert/server2.pem
85+
- key file: /cert/server2.key
86+
- hostname: server2.example.com
87+
- root directory: /var/www/server2
88+
```sh
89+
server --listen-plain 80 --listen-tls 443 -c /cert/server1.pem -k /cert/server1.key --hostname server1.example.com -r /var/www/server1 ,, --listen-plain 80 --listen-tls 443 -c /cert/server2.pem -k /cert/server2.key --hostname server2.example.com -r /var/www/server2
90+
```
91+
92+
## Usage
2993
```
3094
server [options]
3195
@@ -165,67 +229,3 @@ server [options]
165229
server will try to use first virtual host that has no hostname,
166230
otherwise use the first virtual host.
167231
```
168-
169-
## Examples
170-
Start server on port 8080, root directory is current working directory:
171-
```sh
172-
server -l 8080
173-
```
174-
175-
Start server on port 8080, root directory is /usr/share/doc:
176-
```sh
177-
server -l 8080 -r /usr/share/doc
178-
```
179-
180-
Start server on default port, root directory is /tmp, and allow upload files to file system directory /tmp/data:
181-
```sh
182-
server -r /tmp -u /data
183-
```
184-
185-
Share files from /etc, but also mount /usr/share/doc to url path /doc
186-
```sh
187-
server -r /etc -a :/doc:/usr/share/doc
188-
```
189-
190-
Start server on port 8080, serve for HTTPS protocol
191-
```sh
192-
server -k /path/to/certificate/key -c /path/to/certificate/file -l 8080
193-
```
194-
195-
Do not show hidden unix directories and files that starts with `.`.
196-
Tips: wrap wildcard by quotes to prevent expanding by shell.
197-
```sh
198-
server -H '.*'
199-
```
200-
201-
Show access log on console:
202-
```sh
203-
server -L -
204-
```
205-
206-
Http Basic Auth:
207-
- requires authentication for url /files
208-
- username: user1, password: pass1
209-
- username: user2, password: pass2
210-
```sh
211-
server --auth /files --user user1:pass1 --user-sha1 user2:8be52126a6fde450a7162a3651d589bb51e9579d
212-
```
213-
214-
Start 2 virtual hosts:
215-
- server 1
216-
- listen on port 80 for http
217-
- listen on port 443 for https
218-
- cert file: /cert/server1.pem
219-
- key file: /cert/server1.key
220-
- hostname: server1.example.com
221-
- root directory: /var/www/server1
222-
- server 2
223-
- listen on port 80 for http
224-
- listen on port 443 for https
225-
- cert file: /cert/server2.pem
226-
- key file: /cert/server2.key
227-
- hostname: server2.example.com
228-
- root directory: /var/www/server2
229-
```sh
230-
server --listen-plain 80 --listen-tls 443 -c /cert/server1.pem -k /cert/server1.key --hostname server1.example.com -r /var/www/server1 ,, --listen-plain 80 --listen-tls 443 -c /cert/server2.pem -k /cert/server2.key --hostname server2.example.com -r /var/www/server2
231-
```

README.zh-CN.md

Lines changed: 64 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,70 @@ make tpls
2525
```
2626
然后再像上面那样编译。
2727

28-
## 编译后程序的使用方法
28+
## 举例
29+
在8080端口启动服务器,根目录为当前工作目录:
30+
```sh
31+
server -l 8080
32+
```
33+
34+
在8080端口启动服务器,根目录为 /usr/share/doc:
35+
```sh
36+
server -l 8080 -r /usr/share/doc
37+
```
38+
39+
在默认端口启动服务器,根目录为/tmp,并允许上传文件到/tmp/data:
40+
```sh
41+
server -r /tmp -u /data
42+
```
43+
44+
共享/etc下的文件,同时把/usr/share/doc挂载到URL路径/doc下:
45+
```sh
46+
server -r /etc -a :/doc:/usr/share/doc
47+
```
48+
49+
在8080端口启动服务器,使用HTTPS协议:
50+
```sh
51+
server -k /path/to/certificate/key -c /path/to/certificate/file -l 8080
52+
```
53+
54+
不显示`.`开头的unix隐藏目录和文件。提示:用引号括起通配符以避免shell展开:
55+
```sh
56+
server -H '.*'
57+
```
58+
59+
在命令行显示访问日志:
60+
```sh
61+
server -L -
62+
```
63+
64+
http基本验证:
65+
- 对URL /files 启用验证
66+
- 用户名:user1,密码:pass1
67+
- 用户名:user2,密码:pass2
68+
```sh
69+
server --auth /files --user user1:pass1 --user-sha1 user2:8be52126a6fde450a7162a3651d589bb51e9579d
70+
```
71+
72+
启动2台虚拟主机:
73+
- 服务器1
74+
- 在80端口提供http服务
75+
- 在443端口提供https服务
76+
- 证书文件:/cert/server1.pem
77+
- 私钥文件:/cert/server1.key
78+
- 主机名:server1.example.com
79+
- 根目录:/var/www/server1
80+
- 服务器2
81+
- 在80端口提供http服务
82+
- 在443端口提供https服务
83+
- 证书文件:/cert/server2.pem
84+
- 私钥文件:/cert/server2.key
85+
- 主机名:server2.example.com
86+
- 根目录:/var/www/server2
87+
```sh
88+
server --listen-plain 80 --listen-tls 443 -c /cert/server1.pem -k /cert/server1.key --hostname server1.example.com -r /var/www/server1 ,, --listen-plain 80 --listen-tls 443 -c /cert/server2.pem -k /cert/server2.key --hostname server2.example.com -r /var/www/server2
89+
```
90+
91+
## 使用方法
2992
```
3093
server [选项]
3194
@@ -163,66 +226,3 @@ server [选项]
163226
服务器尝试使用第一个没有指定主机名的虚拟主机,
164227
如果失败则使用第一个虚拟主机。
165228
```
166-
167-
## 举例
168-
在8080端口启动服务器,根目录为当前工作目录:
169-
```sh
170-
server -l 8080
171-
```
172-
173-
在8080端口启动服务器,根目录为 /usr/share/doc:
174-
```sh
175-
server -l 8080 -r /usr/share/doc
176-
```
177-
178-
在默认端口启动服务器,根目录为/tmp,并允许上传文件到/tmp/data:
179-
```sh
180-
server -r /tmp -u /data
181-
```
182-
183-
共享/etc下的文件,同时把/usr/share/doc挂载到URL路径/doc下:
184-
```sh
185-
server -r /etc -a :/doc:/usr/share/doc
186-
```
187-
188-
在8080端口启动服务器,使用HTTPS协议:
189-
```sh
190-
server -k /path/to/certificate/key -c /path/to/certificate/file -l 8080
191-
```
192-
193-
不显示`.`开头的unix隐藏目录和文件。提示:用引号括起通配符以避免shell展开:
194-
```sh
195-
server -H '.*'
196-
```
197-
198-
在命令行显示访问日志:
199-
```sh
200-
server -L -
201-
```
202-
203-
http基本验证:
204-
- 对URL /files 启用验证
205-
- 用户名:user1,密码:pass1
206-
- 用户名:user2,密码:pass2
207-
```sh
208-
server --auth /files --user user1:pass1 --user-sha1 user2:8be52126a6fde450a7162a3651d589bb51e9579d
209-
```
210-
211-
启动2台虚拟主机:
212-
- 服务器1
213-
- 在80端口提供http服务
214-
- 在443端口提供https服务
215-
- 证书文件:/cert/server1.pem
216-
- 私钥文件:/cert/server1.key
217-
- 主机名:server1.example.com
218-
- 根目录:/var/www/server1
219-
- 服务器2
220-
- 在80端口提供http服务
221-
- 在443端口提供https服务
222-
- 证书文件:/cert/server2.pem
223-
- 私钥文件:/cert/server2.key
224-
- 主机名:server2.example.com
225-
- 根目录:/var/www/server2
226-
```sh
227-
server --listen-plain 80 --listen-tls 443 -c /cert/server1.pem -k /cert/server1.key --hostname server1.example.com -r /var/www/server1 ,, --listen-plain 80 --listen-tls 443 -c /cert/server2.pem -k /cert/server2.key --hostname server2.example.com -r /var/www/server2
228-
```

0 commit comments

Comments
 (0)