Caddy - Revision history

Fenhl: the version of Caddy in nixpkgs stable has HTTP/3 enabled by default

2026-04-21T12:08:38Z

the version of Caddy in nixpkgs stable has HTTP/3 enabled by default

← Older revision		Revision as of 12:08, 21 April 2026
Line 1:		Line 1:
	[https://caddyserver.com/ Caddy] is an efficient, HTTP/2 capable web server that can serve static and dynamic web pages.		[https://caddyserver.com/ Caddy] is an efficient, HTTP/2 and HTTP/3 capable web server that can serve static and dynamic web pages.
	It can also be a reverse proxy to serve multiple web services under one server. Its main features are its simple config setup and automatic HTTPS: It will automatically request and renew a LetsEncrypt certificate so that users of your service get a Browser-trusted and secure connection.		It can also be a reverse proxy to serve multiple web services under one server. Its main features are its simple config setup and automatic HTTPS: It will automatically request and renew a LetsEncrypt certificate so that users of your service get a Browser-trusted and secure connection.

Onny: /* PHP support FrankenPHP plugin */

2026-04-09T11:26:47Z

PHP support FrankenPHP plugin

← Older revision		Revision as of 11:26, 9 April 2026
Line 90:		Line 90:
	You'll need a [[Phpfpm\|PHP-FPM]] socket listening on Unix socket path <code>/var/run/phpfpm/localhost.sock</code>.		You'll need a [[Phpfpm\|PHP-FPM]] socket listening on Unix socket path <code>/var/run/phpfpm/localhost.sock</code>.

	=== PHP support FrankenPHP plugin ===		=== PHP support using FrankenPHP plugin ===

	Instead of Caddy, the FrankenPHP package can be defined as drop-in replacement for the Caddy-service which will allow serving PHP applications without additional external process managers. In case you want to use FrankenPHP as an additional Caddy plugin, you can try this modifications		Instead of Caddy, the FrankenPHP package can be defined as drop-in replacement for the Caddy-service which will allow serving PHP applications without additional external process managers. In case you want to use FrankenPHP as an additional Caddy plugin, you can try this modifications

Onny: /* PHP support FrankenPHP plugin */

2026-04-09T09:52:01Z

PHP support FrankenPHP plugin

← Older revision		Revision as of 09:52, 9 April 2026
Line 127:		Line 127:
	package = pkgs.caddy.withPlugins {		package = pkgs.caddy.withPlugins {
	plugins = [		plugins = [
	"github.com/dunglas/frankenphp@v1.12.1"		"github.com/dunglas/frankenphp/caddy@v1.12.1"
	];		];
	hash = "sha256-~~uqVHU4PkriIJ67uf2JqggL4LpXMN1mx9Jo2JRu7bjFE~~=";		hash = "sha256-WWUg717C7VcW7hNDpyoMdNE37JXgyvEU0vmMtZQXFSY=";
	};		};
	virtualHosts."localhost".extraConfig = ''		virtualHosts."localhost".extraConfig = ''

Onny at 09:08, 9 April 2026

2026-04-09T09:08:36Z

← Older revision		Revision as of 09:08, 9 April 2026
Line 9:		Line 9:
	enable = true;		enable = true;
	virtualHosts."localhost".extraConfig = ''		virtualHosts."localhost".extraConfig = ''
			tls internal
	respond "Hello, world!"		respond "Hello, world!"
	'';		'';

Onny: /* PHP support FrankenPHP plugin */

2026-04-09T09:08:12Z

PHP support FrankenPHP plugin

← Older revision		Revision as of 09:08, 9 April 2026
Line 130:		Line 130:
	hash = "sha256-uqVHU4PkriIJ67uf2JqggL4LpXMN1mx9Jo2JRu7bjFE=";		hash = "sha256-uqVHU4PkriIJ67uf2JqggL4LpXMN1mx9Jo2JRu7bjFE=";
	};		};
	virtualHosts."~~http://~~localhost".extraConfig = ''		virtualHosts."localhost".extraConfig = ''
			tls internal
	respond "Hello, world!"		respond "Hello, world!"
	'';		'';

Onny: /* PHP with FrankenPHP */

2026-04-09T09:04:28Z

PHP with FrankenPHP

← Older revision		Revision as of 09:04, 9 April 2026
Line 89:		Line 89:
	You'll need a [[Phpfpm\|PHP-FPM]] socket listening on Unix socket path <code>/var/run/phpfpm/localhost.sock</code>.		You'll need a [[Phpfpm\|PHP-FPM]] socket listening on Unix socket path <code>/var/run/phpfpm/localhost.sock</code>.

	=== PHP ~~with~~ FrankenPHP ===		=== PHP support FrankenPHP plugin ===

	Instead of Caddy, the FrankenPHP package can be defined as drop-in replacement for the Caddy-service which will allow serving PHP applications without additional external process managers. In case you want to use FrankenPHP as an additional Caddy plugin, you can try this modifications		Instead of Caddy, the FrankenPHP package can be defined as drop-in replacement for the Caddy-service which will allow serving PHP applications without additional external process managers. In case you want to use FrankenPHP as an additional Caddy plugin, you can try this modifications

Onny: Caddy with FrankenPHP plugin

2026-04-09T09:04:04Z

Caddy with FrankenPHP plugin

← Older revision		Revision as of 09:04, 9 April 2026
Line 88:		Line 88:

	You'll need a [[Phpfpm\|PHP-FPM]] socket listening on Unix socket path <code>/var/run/phpfpm/localhost.sock</code>.		You'll need a [[Phpfpm\|PHP-FPM]] socket listening on Unix socket path <code>/var/run/phpfpm/localhost.sock</code>.

			=== PHP with FrankenPHP ===

			Instead of Caddy, the FrankenPHP package can be defined as drop-in replacement for the Caddy-service which will allow serving PHP applications without additional external process managers. In case you want to use FrankenPHP as an additional Caddy plugin, you can try this modifications

			<syntaxhighlight lang="nix">
			nixpkgs.overlays = [
			(self: super: {
			phpWithEmbed = super.php.override {
			embedSupport = true;
			ztsSupport = true;
			staticSupport = super.stdenv.hostPlatform.isDarwin;
			zendSignalsSupport = false;
			zendMaxExecutionTimersSupport = super.stdenv.hostPlatform.isLinux;
			};
			caddy = super.caddy.overrideAttrs (oldAttrs: {
			buildInputs =
			(oldAttrs.buildInputs or [ ])
			++ [
			self.watcher
			self.phpWithEmbed.unwrapped
			self.brotli
			]
			++ self.phpWithEmbed.unwrapped.buildInputs;
			preBuild = ''
			export CGO_CFLAGS="$(${self.phpWithEmbed.unwrapped.dev}/bin/php-config --includes)"
			export CGO_LDFLAGS="-DFRANKENPHP_VERSION=${self.frankenphp.version} \
			$(${self.phpWithEmbed.unwrapped.dev}/bin/php-config --ldflags) \
			$(${self.phpWithEmbed.unwrapped.dev}/bin/php-config --libs)"
			'';
			});
			})
			];

			services.caddy = {
			enable = true;
			package = pkgs.caddy.withPlugins {
			plugins = [
			"github.com/dunglas/frankenphp@v1.12.1"
			];
			hash = "sha256-uqVHU4PkriIJ67uf2JqggL4LpXMN1mx9Jo2JRu7bjFE=";
			};
			virtualHosts."http://localhost".extraConfig = ''
			respond "Hello, world!"
			'';
			};
			</syntaxhighlight>

	=== Plug-ins ===		=== Plug-ins ===

Onny: /* Caching */

2026-02-22T12:05:22Z

Caching

← Older revision		Revision as of 12:05, 22 February 2026
Line 172:		Line 172:
	ttl 30m		ttl 30m
	stale 1h		stale 1h
	~~default_max_age 600~~
	]		]
	'';		'';

Onny: Add section about caching

2026-02-22T11:53:57Z

Add section about caching

← Older revision		Revision as of 11:53, 22 February 2026
Line 145:		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
			default_max_age 600
			]
			'';
			};

			</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 ===

Andrew: /* Check used ports */ Replace deprecated netstat with ss

2025-12-09T17:44:50Z

Check used ports: Replace deprecated netstat with ss

← Older revision		Revision as of 17:44, 9 December 2025
Line 166:		Line 166:

	=== Check used ports ===		=== Check used ports ===
	To check if Caddy is running and listening as configured you can run <code>~~netstat~~</code>:		To check if Caddy is running and listening as configured you can run <code>ss</code>:

	<syntaxhighlight lang="console">		<syntaxhighlight lang="console">