Mirrors/xcaddy
1
0
Fork 0
mirror of https://github.com/caddyserver/xcaddy.git synced 2025-03-10 07:38:58 +01:00
Code Issues Projects Releases Packages Wiki Activity

docs: Update README to mention xcaddy version, cleanup (#71)

Browse source
This commit is contained in:
Francis Lavoie 2021-09-03 21:36:13 -04:00 committed by GitHub
parent 8a353a02b6
commit c8b2d00673
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -5,8 +5,6 @@ This command line tool and associated Go package makes it easy to make custom bu
It is used heavily by Caddy plugin developers as well as anyone who wishes to make custom `caddy` binaries (with or without plugins). It is used heavily by Caddy plugin developers as well as anyone who wishes to make custom `caddy` binaries (with or without plugins).
⚠️ Still in development. Supports Caddy 2 only.
Stay updated, be aware of changes, and please submit feedback! Thanks! Stay updated, be aware of changes, and please submit feedback! Thanks!
## Requirements ## Requirements
@ -27,7 +25,7 @@ For Debian, Ubuntu, and Raspbian, an `xcaddy` package is available from our [Clo
```bash ```bash
sudo apt install -y debian-keyring debian-archive-keyring apt-transport-https sudo apt install -y debian-keyring debian-archive-keyring apt-transport-https
curl -1sLf 'https://dl.cloudsmith.io/public/caddy/xcaddy/gpg.key' | sudo apt-key add - curl -1sLf 'https://dl.cloudsmith.io/public/caddy/xcaddy/gpg.key' | sudo tee /etc/apt/trusted.gpg.d/caddy-xcaddy.asc
curl -1sLf 'https://dl.cloudsmith.io/public/caddy/xcaddy/debian.deb.txt' | sudo tee /etc/apt/sources.list.d/caddy-xcaddy.list curl -1sLf 'https://dl.cloudsmith.io/public/caddy/xcaddy/debian.deb.txt' | sudo tee /etc/apt/sources.list.d/caddy-xcaddy.list
sudo apt update sudo apt update
sudo apt install xcaddy sudo apt install xcaddy
@ -84,6 +82,7 @@ $ xcaddy build \
This allows you to hack on Caddy core (and optionally plug in extra modules at the same time!) with relative ease. This allows you to hack on Caddy core (and optionally plug in extra modules at the same time!) with relative ease.
### For plugin development ### For plugin development
If you run `xcaddy` from within the folder of the Caddy plugin you're working on _without the `build` subcommand_, it will build Caddy with your current module and run it, as if you manually plugged it in and invoked `go run`. If you run `xcaddy` from within the folder of the Caddy plugin you're working on _without the `build` subcommand_, it will build Caddy with your current module and run it, as if you manually plugged it in and invoked `go run`.
@ -110,6 +109,13 @@ $ xcaddy run --config caddy.json
The race detector can be enabled by setting `XCADDY_RACE_DETECTOR=1`. The DWARF debug info can be enabled by setting `XCADDY_DEBUG=1`. The race detector can be enabled by setting `XCADDY_RACE_DETECTOR=1`. The DWARF debug info can be enabled by setting `XCADDY_DEBUG=1`.
### Getting `xcaddy`'s version
```
$ xcaddy version
```
## Library usage ## Library usage
```go ```go