mirrors/caddy-website
1
0
Fork 0
mirror of https://github.com/caddyserver/website.git synced 2025-04-26 23:16:16 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: Update for v2.3; refactor install information

Browse source 
We now have only 1 download page, yay. Install docs are organized better. Less confusing.

Automatic HTTPS docs improved, and menu added.

Other minor updates to bring up to speed for v2.3.
This commit is contained in:
Matthew Holt 2020-12-30 07:37:15 -07:00
parent 9dd9309a9b
commit 4827cff659
No known key found for this signature in database
GPG key ID: 2A349DD577D586A5
11 changed files with 186 additions and 159 deletions
Download patch file Download diff file Expand all files Collapse all files

6
src/docs/markdown/build.md
View file

@ -20,7 +20,7 @@ Build:
<span class="bash">go build</span></code></pre>
<aside class="tip">
Due to <a href="https://github.com/golang/go/issues/29228">a bug in Go</a>, these basic steps do not embed version information. If you want the version (<code>caddy version</code>), you need to compile Caddy as a dependency rather than as the main module. Instructions for this are in Caddy's <a href="https://github.com/caddyserver/caddy/blob/master/cmd/caddy/main.go">main.go</a> file. Or, you can use <b>xcaddy</b> which automates this.
Due to <a href="https://github.com/golang/go/issues/29228">a bug in Go</a>, these basic steps do not embed version information. If you want the version (<code>caddy version</code>), you need to compile Caddy as a dependency rather than as the main module. Instructions for this are in Caddy's <a href="https://github.com/caddyserver/caddy/blob/master/cmd/caddy/main.go">main.go</a> file. Or, you can use <a href="#xcaddy"><code>xcaddy</code></a> which automates this.
</aside>
## xcaddy
@ -30,7 +30,7 @@ The [`xcaddy` command](https://github.com/caddyserver/xcaddy) is the easiest way
Requirements:
- Go installed (see above)
- Make sure [xcaddy](https://github.com/caddyserver/xcaddy/releases) is in your PATH
- Make sure [`xcaddy`](https://github.com/caddyserver/xcaddy/releases) is in your PATH
You do **not** need to download the Caddy source code (it will do that for you).
@ -44,7 +44,7 @@ To build with plugins, use `--with`:
--with github.com/caddyserver/nginx-adapter
--with github.com/caddyserver/ntlm-transport@v0.1.1</code></pre>
As you can see, you can customize the versions of plugins with `@` syntax. Versions can be a tag name or commit SHA.
As you can see, you can customize the versions of plugins with `@` syntax. Versions can be a tag name, commit SHA, or branch.
Cross-platform compilation with `xcaddy` works the same as with the `go` command (see below).