Introduction to Caddy

Caddy is a powerful, highly scalable web server that has currently gained 38K Stars on GitHub. Caddy is written in Go language and can be used for static resource hosting and reverse proxy.

Caddy has the following main features:

• Compared with Nginx’s complex configuration, its original Caddyfile configuration is very simple;

• The configuration can be dynamically modified through the Admin API it provides;

• supports automated HTTPS configuration by default, and can automatically apply for HTTPS certificates and configure them;

• Can be expanded to tens of thousands of sites;

• can be executed anywhere, with no additional dependencies;

• is written in Go language , memory security is more guaranteed.

Installation

First of all, we install Caddy directly on CentOS 8. Installation using the DNF tool is undoubtedly the simplest. The Docker installation method will be introduced later.

Use the following command to install Caddy through the DNF tool. After successful installation, Caddy will be registered as a system service;

dnf install 'dnf-command(copr)'
dnf copr enable @caddy/caddy
dnf install caddy

Use systemctl status caddy to check the status of Caddy. You can find that Caddy has been registered as a system service. service, but it is not enabled yet.

Usage

Let’s experience the basic use of Caddy. They are common operations for web servers. You can definitely use them!

Basic usage

Let us try to use Caddy to get started, specifying that Caddy runs on the 2015 port and returns the "Hello, world!" message.

Using the caddy command directly will output the common commands of Caddy. Basically, you will know how to use it by reading the introduction. The common commands are marked;

Use caddy The start command allows the Caddy service to run in the background;

Caddy uses the JSON format configuration file by default. However, since it is more troublesome to write the JSON format configuration, Caddyfile is also provided. Simple configuration form, use the following command to automatically convert Caddyfile into JSON configuration;

caddy adapter

We can first create a file named Caddyfile with the following content, and then use caddy adapter to convert it into JSON configuration, Then use caddy reload to make the configuration effective. The configuration will listen to the 2015 port and return Hello, world!;

:2015

respond "Hello, world!"

Then we use the curl command to access localhost:2015 and the specified information will be returned;

Of course we can also use the Admin API provided by Caddy to view the configuration information, just use the following command;

curl localhost:2019/config/

The current JSON configuration is as follows, if you use JSON configuration directly You need to write the following configuration, using Caddyfile is indeed much more convenient!

{
	"apps": {
		"http": {
			"servers": {
				"srv0": {
					"listen": [":2015"],
					"routes": [{
						"handle": [{
							"body": "Hello, world!",
							"handler": "static_response"
						}]
					}]
				}
			}
		}
	}
}

Basic syntax of Caddyfile

The following case will use Caddyfile for configuration. We need to understand its syntax. The specific syntax rules of Caddyfile are as follows.

Introduce the keywords in the above picture to help understanding.

反向代理

反向代理就是當(dāng)請(qǐng)求訪問你的代理服務(wù)器時(shí)，代理服務(wù)器會(huì)對(duì)你的請(qǐng)求進(jìn)行轉(zhuǎn)發(fā)，可以轉(zhuǎn)發(fā)到靜態(tài)的資源路徑上去，也可以轉(zhuǎn)發(fā)到動(dòng)態(tài)的服務(wù)接口上去。我們以代理域名為例，講解如何進(jìn)行靜態(tài)和動(dòng)態(tài)代理。

靜態(tài)代理

靜態(tài)代理就是將請(qǐng)求代理到不同的靜態(tài)資源路徑上去，這里我們將對(duì)docs.macrozheng.com的請(qǐng)求代理到我的文檔項(xiàng)目中，對(duì)mall.macrozheng.com的請(qǐng)求代理到mall的前端項(xiàng)目中。

首先我們修改下本機(jī)的host文件：

192.168.3.106 docs.macrozheng.com
192.168.3.106 mall.macrozheng.com

然后將我們的文檔項(xiàng)目和mall前端項(xiàng)目上傳到Caddy的html目錄中去，并進(jìn)行解壓操作：

修改Caddyfile文件，使用如下配置，修改完成后使用caddy reload命令刷新配置；

http://docs.macrozheng.com {
        root * /mydata/caddy/html/docs
        file_server browse
}

http://mall.macrozheng.com {
        root * /mydata/caddy/html/mall
        file_server browse
}

如果你的Caddyfile文件格式不太合格的話，會(huì)出現(xiàn)如下警告，直接使用caddy fmt --overwrite格式化并重寫配置即可解決；

通過docs.macrozheng.com即可訪問部署好的文檔項(xiàng)目了：

通過mall.macrozheng.com即可訪問到部署好的前端項(xiàng)目了。

動(dòng)態(tài)代理

動(dòng)態(tài)代理就是把代理服務(wù)器的請(qǐng)求轉(zhuǎn)發(fā)到另一個(gè)服務(wù)上去，這里我們將把對(duì)api.macrozheng.com的請(qǐng)求代理到演示環(huán)境的API服務(wù)上去。

首先我們修改下本機(jī)的host文件，添加如下規(guī)則

192.168.3.106 api.macrozheng.com

修改Caddyfile文件，使用如下配置，修改完成后使用caddy reload命令刷新配置；

http://api.macrozheng.com {
        reverse_proxy http://admin-api.macrozheng.com
}

之后通過api.macrozheng.com/swagger-ui.html即可訪問到mall-admin的API文檔頁面了。

文件壓縮

如果我們的服務(wù)器帶寬比較低，網(wǎng)站訪問速度會(huì)很慢，這時(shí)我們可以通過讓Caddy開啟Gzip壓縮來提高網(wǎng)站的訪問速度。這里我們以mall的前端項(xiàng)目為例來演示下它的提速效果。

我們需要修改Caddyfile文件，使用encode指令開啟Gzip壓縮，修改完成后使用caddy reload命令刷新配置；

http://mall.macrozheng.com {
        root * /mydata/caddy/html/mall
        encode {
            gzip
        }
        file_server browse
}

有個(gè)比較大的JS文件壓縮前是1.7M；

壓縮后為544K，訪問速度也有很大提示；

另外我們可以看下響應(yīng)信息，如果有Content-Encoding: gzip這個(gè)響應(yīng)頭表明Gzip壓縮已經(jīng)啟用了。

地址重寫

有的時(shí)候我們的網(wǎng)站更換了域名，但還有用戶在使用老的域名訪問，這時(shí)可以通過Caddy的地址重寫功能來讓用戶跳轉(zhuǎn)到新的域名進(jìn)行訪問。

我們需要修改Caddyfile文件，使用redir指令重寫地址，修改完成后使用caddy reload命令刷新配置；

http://docs.macrozheng.com {
        redir http://www.macrozheng.com
}

此時(shí)訪問舊域名docs.macrozheng.com會(huì)直接跳轉(zhuǎn)到www.macrozheng.com去。

按目錄劃分

有時(shí)候我們需要使用同一個(gè)域名來訪問不同的前端項(xiàng)目，這時(shí)候就需要通過子目錄來區(qū)分前端項(xiàng)目了。

比如說我們需要按以下路徑來訪問各個(gè)前端項(xiàng)目；

www.macrozheng.com #訪問文檔項(xiàng)目
www.macrozheng.com/admin #訪問后臺(tái)項(xiàng)目
www.macrozheng.com/app #訪問移動(dòng)端項(xiàng)目

我們需要修改Caddyfile文件，使用route指令定義路由，修改完成后使用caddy reload命令刷新配置。

http://www.macrozheng.com {
        route /admin/* {
                uri strip_prefix /admin
                file_server {
                        root /mydata/caddy/html/admin
                }
        }
        route /app/* {
                uri strip_prefix /app
                file_server {
                        root /mydata/caddy/html/app
                }
        }
        file_server * {
                root /mydata/caddy/html/www
        }
}

HTTPS

Caddy能自動(dòng)支持HTTPS，無需手動(dòng)配置證書，這就是之前我們?cè)谂渲糜蛎麜r(shí)需要使用http://開頭的原因，要想使用Caddy默認(rèn)的HTTPS功能，按如下步驟操作即可。

首先我們需要修改域名的DNS解析，直接在購買域名的網(wǎng)站上設(shè)置即可，這里以docs.macrozheng.com域名為例；

請(qǐng)使用以下命令確認(rèn)DNS解析記錄是否正確，注意所配置的服務(wù)器的80和443端口需要在外網(wǎng)中可以正常訪問：

curl "https://cloudflare-dns.com/dns-query?name=docs.macrozheng.com&type=A" \
  -H "accept: application/dns-json"

修改Caddyfile配置文件，進(jìn)行如下配置；

docs.macrozheng.com {
        root * /mydata/caddy/html/docs
        file_server browse
}

然后使用caddy run命令啟動(dòng)Caddy服務(wù)器即可，是不是非常方便！

caddy run

Docker支持

當(dāng)然Caddy也是支持使用Docker進(jìn)行安裝使用的，其使用和直接在CentOS上安裝基本一致。

首先使用如下命令下載Caddy的Docker鏡像；

docker pull caddy

然后在/mydata/caddy/目錄下創(chuàng)建Caddyfile配置文件，文件內(nèi)容如下；

http://192.168.3.105:80

respond "Hello, world!"

之后使用如下命令啟動(dòng)caddy服務(wù)，這里將宿主機(jī)上的Caddyfile配置文件、Caddy的數(shù)據(jù)目錄和網(wǎng)站目錄掛載到了容器中；

docker run -p 80:80 -p 443:443 --name caddy \
    -v /mydata/caddy/Caddyfile:/etc/caddy/Caddyfile \
    -v /mydata/caddy/data:/data \
    -v /mydata/caddy/html:/usr/share/caddy \
    -d caddy

之后使用docker exec進(jìn)入caddy容器內(nèi)部執(zhí)行命令；

docker exec -it caddy /bin/sh

輸入Caddy命令即可操作，之后的操作就和我們直接在CentOS上安裝一樣了。

The above is the detailed content of How to use Nginx web server caddy. For more information, please follow other related articles on the PHP Chinese website!