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

restructure the "build from source" page

Browse source
This commit is contained in:
Mohammed Al Sahaf 2024-02-01 08:22:34 +00:00 • committed by Francis Lavoie
parent a57d9e3ea2
commit 3404802d92
No known key found for this signature in database
GPG key ID: 0F66EE1687682239
1 changed files with 25 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -4,10 +4,24 @@ title: "Build from source"
# Build from source # Build from source
There are 2 ways to build Caddy, as opposed to installation of pre-built executable:
- Build from Git repo
- Build using `xcaddy`
Requirements: Requirements:
- [Go](https://golang.org/doc/install) 1.20 or newer - [Go](https://golang.org/doc/install) 1.20 or newer
You can easily cross-compile, i.e. build Caddy on one operating system or architecture for a different, using the same tooling. You'll find details on this in the respective section.
The latest section contains instructions for users who installed Caddy using the APT command on Debian-derivative system yet need the custom build executable for their operations.
## Build from Git repo
Requirements:
- Go installed (see above)
Clone the repository: Clone the repository:
<pre><code class="cmd bash">git clone "https://github.com/caddyserver/caddy.git"</code></pre> <pre><code class="cmd bash">git clone "https://github.com/caddyserver/caddy.git"</code></pre>
@ -26,8 +40,17 @@ Due to [a bug in Go](https://github.com/golang/go/issues/29228), these basic ste
</aside> </aside>
Go programs are easy to compile for other platforms. Just set the `GOOS`, `GOARCH`, and/or `GOARM` environment variables that are different. ([See the go documentation for details.](https://golang.org/doc/install/source#environment))
## xcaddy For example, to compile Caddy for Windows when you're not on Windows:
<pre><code class="cmd bash">GOOS=windows go build</code></pre>
Or similarly for Linux ARMv6 when you're not on Linux or on ARMv6:
<pre><code class="cmd bash">GOOS=linux GOARCH=arm GOARM=6 go build</code></pre>
## Build using `xcaddy`
The [`xcaddy` command](https://github.com/caddyserver/xcaddy) is the easiest way to build Caddy with version information and/or plugins. The [`xcaddy` command](https://github.com/caddyserver/xcaddy) is the easiest way to build Caddy with version information and/or plugins.
@ -50,22 +73,7 @@ To build with plugins, use `--with`:
As you can see, you can customize the versions of plugins with `@` syntax. Versions can be a tag name, commit SHA, or branch. 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). Cross-platform compilation with `xcaddy` works the same as with the `go` command. For example, to cross-compile for macOS:
## Cross-platform
Go programs are easy to compile for other platforms. Just set the `GOOS`, `GOARCH`, and/or `GOARM` environment variables that are different. ([See the go documentation for details.](https://golang.org/doc/install/source#environment))
For example, to compile Caddy for Windows when you're not on Windows:
<pre><code class="cmd bash">GOOS=windows go build</code></pre>
Or similarly for Linux ARMv6 when you're not on Linux or on ARMv6:
<pre><code class="cmd bash">GOOS=linux GOARCH=arm GOARM=6 go build</code></pre>
The same works for `xcaddy`. To cross-compile for macOS:
<pre><code class="cmd bash">GOOS=darwin xcaddy build</code></pre> <pre><code class="cmd bash">GOOS=darwin xcaddy build</code></pre>