Mirrors/xcaddy
1
0
Fork 0
mirror of https://github.com/caddyserver/xcaddy.git synced 2025-03-13 09:08:52 +01:00
Code Issues Projects Releases Packages Wiki Activity

readme: Add pro tip about manual builds

Browse source
This commit is contained in:
Matthew Holt 2022-10-05 18:49:31 -06:00
parent 2b5d89d9e5
commit e0ed12b135
No known key found for this signature in database
GPG key ID: 2A349DD577D586A5
1 changed files with 9 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -31,6 +31,15 @@ sudo apt update
sudo apt install xcaddy
```
## :warning: Pro tip
If you find yourself fighting xcaddy in relation to your custom or proprietary build or development process, **it might be easier to just build Caddy manually!**
Caddy's [main.go file](https://github.com/caddyserver/caddy/blob/master/cmd/caddy/main.go), the main entry point to the application, has instructions in the comments explaining how to build Caddy essentially the same way xcaddy does it. But when you use the `go` command directly, you have more control over the whole thing and it may save you a lot of trouble.
The manual build procedure is very easy: just copy the main.go into a new folder, initialize a Go module, plug in your plugins (add an `import` for each one) and then run `go build`. Of course, you may wish to customize the go.mod file to your liking (specific dependency versions, replacements, etc).
## Command usage
The `xcaddy` command has two primary uses: