Caddy: Difference between revisions
Add section on uWSGI usage with Caddy |
|||
| (5 intermediate revisions by 3 users not shown) | |||
| Line 14: | Line 14: | ||
This snippet will let Caddy respond on <code>http://localhost</code> and <code>https://localhost</code> with a dummy text "Hello world!". When no port is mentioned on virtualhost like just <code>localhost</code> instead of <code>localhost:8080</code>, Caddy listens on <code>80</code> and <code>443</code> by default and redirects requests from port 80 (unsecured) to 443 (secured). | This snippet will let Caddy respond on <code>http://localhost</code> and <code>https://localhost</code> with a dummy text "Hello world!". When no port is mentioned on virtualhost like just <code>localhost</code> instead of <code>localhost:8080</code>, Caddy listens on <code>80</code> and <code>443</code> by default and redirects requests from port 80 (unsecured) to 443 (secured). | ||
Use <code>curl -iLk localhost</code> to verify the configuration. | |||
For SSL to work, just supply a public domain and ensure HTTP and HTTPS ports are accessible. Caddy will automatically configure TLS: | For SSL to work, just supply a public domain and ensure HTTP and HTTPS ports are accessible. Caddy will automatically configure TLS: | ||
| Line 143: | Line 145: | ||
</syntaxhighlight>This example will serve a [[uWSGI]] app, provided by a unix socket file, on the host <code>myapp.example.org</code>. | </syntaxhighlight>This example will serve a [[uWSGI]] app, provided by a unix socket file, on the host <code>myapp.example.org</code>. | ||
=== Caching === | |||
Caching can be enabled by adding the official [https://github.com/caddyserver/cache-handler cache-handler plugin]. Note that the corresponding hash and upstream version can change.<syntaxhighlight lang="nix"> | |||
services.caddy = { | |||
package = pkgs.caddy.withPlugins { | |||
plugins = [ "github.com/caddyserver/cache-handler@v0.16.0" ]; | |||
hash = "sha256-XTFwYo3o7il3UfnE2QuJM+UoGTu0Yw+8ka0p9czdgEM="; | |||
}; | |||
globalConfig = '' | |||
cache | |||
''; | |||
virtualHosts = { | |||
"example.org" = { | |||
extraConfig = '' | |||
cache | |||
reverse_proxy your-app:8080 | |||
''; | |||
}; | |||
}; | |||
</syntaxhighlight>If you need to add caching to an existing virtual host entry, which was created by a module, you can prepend it by using <code>lib.mkBefore</code><syntaxhighlight lang="nix"> | |||
services.caddy = { | |||
[...] | |||
virtualHosts."dokuwiki.example.org".extraConfig = lib.mkBefore '' | |||
cache { | |||
ttl 30m | |||
stale 1h | |||
] | |||
''; | |||
}; | |||
</syntaxhighlight>See [https://github.com/caddyserver/cache-handler upstream documentation] for further configuration options. | |||
=== Passing environment variable secrets/configuring acme_dns === | === Passing environment variable secrets/configuring acme_dns === | ||
| Line 164: | Line 198: | ||
=== Check used ports === | === Check used ports === | ||
To check if Caddy is running and listening as configured you can run <code> | To check if Caddy is running and listening as configured you can run <code>ss</code>: | ||
<syntaxhighlight lang=" | <syntaxhighlight lang="console"> | ||
$ | $ sudo ss --listening --no-queues --numeric --processes --tcp --udp | grep 'Process\|caddy' | ||
Netid State Local Address:Port Peer Address:Port Process | |||
tcp LISTEN 127.0.0.1:2019 0.0.0.0:* users:(("caddy",pid=1000,fd=10)) | |||
tcp | tcp LISTEN *:80 *:* users:(("caddy",pid=1000,fd=11)) | ||
tcp LISTEN *:443 *:* users:(("caddy",pid=1000,fd=12)) | |||
udp UNCONN *:443 *:* users:(("caddy",pid=1000,fd=13)) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
The tcp (ipv4) socket port 2019 is Caddy's management endpoint, for when you want manage its config via web REST calls instead of Nix (ignore). | The tcp (ipv4) socket port 2019 is Caddy's management endpoint, for when you want manage its config via web REST calls instead of Nix (ignore). | ||