Pixelfed

State directory of the pixelfed user which holds the application's state and data.

Whether to enable automatic migrations for database schema and data.

Whether to enable a local database using UNIX socket authentication.

Database name.

Database engine to use. Note that PGSQL is not well supported: https://github.com/pixelfed/pixelfed/issues/2727

FQDN for the Pixelfed instance.

Whether to enable a Pixelfed instance.

Group account under which pixelfed runs.

::: {.note} If left as the default value this group will automatically be created on system activation, otherwise you are responsible for ensuring the group exists before the pixelfed application starts. :::

Max upload size with units.

With this option, you can customize an nginx virtual host which already has sensible defaults for Pixelfed. Set to {} if you do not need any customization to the virtual host. If enabled, then by default, the {option}serverName is ${domain}, If this is set to null (the default), no nginx virtualHost will be configured.

Host which to proxy requests to if ACME challenge is not found. Useful if you want multiple hosts to be able to verify the same domain name.

With this option, you could request certificates for the present domain with an ACME client that is running on another host, which you would specify here.

Directory for the ACME challenge, which is public. Don't put certs or keys in here. Set to null to inherit from config.security.acme.

Whether to enable HTTPS in addition to plain HTTP. This will set defaults for listen to listen on all interfaces on the respective default ports (80, 443).

Basic Auth protection for a vhost.

WARNING: This is implemented to store the password in plain text in the Nix store.

Basic Auth password file for a vhost. Can be created by running {command}nix-shell --packages apacheHttpd --run 'htpasswd -B -c FILENAME USERNAME'.

Makes this vhost the default.

Whether to ask Let's Encrypt to sign a certificate for this vhost. Alternately, you can use an existing certificate through {option}useACMEHost.

These lines go to the end of the vhost verbatim.

Whether to add a separate nginx server block that redirects (defaults to 301, configurable with redirectCode) all plain HTTP traffic to HTTPS. This will set defaults for listen to listen on all interfaces on the respective default ports (80, 443), where the non-SSL listens are used for the redirect vhosts.

If set, all requests for this host are redirected (defaults to 301, configurable with redirectCode) to the given hostname.

Whether to enable the HTTP/2 protocol. Note that (as of writing) due to nginx's implementation, to disable HTTP/2 you have to disable it on all vhosts that use a given IP address / port. If there is one server block configured to enable http2, then it is enabled for all server blocks on this IP. See https://stackoverflow.com/a/39466948/263061.

Whether to enable the HTTP/3 protocol. This requires using pkgs.nginxQuic package which can be achieved by setting services.nginx.package = pkgs.nginxQuic; and activate the QUIC transport protocol services.nginx.virtualHosts.<name>.quic = true;. Note that HTTP/3 support is experimental and not yet recommended for production. Read more at https://quic.nginx.org/ HTTP/3 availability must be manually advertised, preferably in each location block.

Whether to enable the HTTP/0.9 protocol negotiation used in QUIC interoperability tests. This requires using pkgs.nginxQuic package which can be achieved by setting services.nginx.package = pkgs.nginxQuic; and activate the QUIC transport protocol services.nginx.virtualHosts.<name>.quic = true;. Note that special application protocol support is experimental and not yet recommended for production. Read more at https://quic.nginx.org/

Whether to enable kTLS support. Implementing TLS in the kernel (kTLS) improves performance by significantly reducing the need for copying operations between user space and the kernel. Required Nginx version 1.21.4 or later.

Listen addresses and ports for this virtual host. IPv6 addresses must be enclosed in square brackets. Note: this option overrides addSSL and onlySSL.

If you only want to set the addresses manually and not the ports, take a look at listenAddresses.

Listen address.

Extra parameters of this listen directive.

Port number to listen on. If unset and the listen address is not a socket then nginx defaults to 80.

Enable PROXY protocol.

Enable SSL.

Listen addresses for this virtual host. Compared to listen this only sets the addresses and the ports are chosen automatically.

Note: This option overrides enableIPv6

Declarative location config

Alias directory for requests.

Basic Auth protection for a vhost.

WARNING: This is implemented to store the password in plain text in the Nix store.

Basic Auth password file for a vhost. Can be created by running {command}nix-shell --packages apacheHttpd --run 'htpasswd -B -c FILENAME USERNAME'.

These lines go to the end of the location verbatim.

FastCGI parameters to override. Unlike in the Nginx configuration file, overriding only some default parameters won't unset the default values for other parameters.

Adds index directive.

Order of this location block in relation to the others in the vhost. The semantics are the same as with lib.mkOrder. Smaller values have a greater priority.

Adds proxy_pass directive and sets recommended proxy headers if recommendedProxySettings is enabled.

Whether to support proxying websocket connections with HTTP/1.1.

Enable recommended proxy settings.

Enable recommended uwsgi settings.

Adds a return directive, for e.g. redirections.

Root directory for requests.

Adds try_files directive.

Adds uwsgi_pass directive and sets recommended proxy headers if recommendedUwsgiSettings is enabled.

Whether to enable HTTPS and reject plain HTTP connections. This will set defaults for listen to listen on all interfaces on port 443.

Whether to enable the QUIC transport protocol. This requires using pkgs.nginxQuic package which can be achieved by setting services.nginx.package = pkgs.nginxQuic;. Note that QUIC support is experimental and not yet recommended for production. Read more at https://quic.nginx.org/

HTTP status used by globalRedirect and forceSSL. Possible usecases include temporary (302, 307) redirects, keeping the request method and body (307, 308), or explicitly resetting the method to GET (303). See https://developer.mozilla.org/en-US/docs/Web/HTTP/Redirections.

Whether to listen for and reject all HTTPS connections to this vhost. Useful in default server blocks to avoid serving the certificate for another vhost. Uses the ssl_reject_handshake directive available in nginx versions 1.19.4 and above.

Create an individual listening socket . It is required to specify only once on one of the hosts.

The path of the web root directory.

Additional names of virtual hosts served by this virtual host configuration.

Name of this virtual host. Defaults to attribute name in virtualHosts.

Path to server SSL certificate.

Path to server SSL certificate key.

Path to root SSL certificate for stapling and client certificates.

A host of an existing Let's Encrypt certificate to use. This is useful if you have many subdomains and want to avoid hitting the rate limit. Alternately, you can generate a certificate through {option}enableACME. Note that this option does not create any certificates, nor it does add subdomains to existing ones – you will need to create them manually using .

The pixelfed package to use.

The php83 package to use.

Options for Pixelfed's PHP-FPM pool.

Whether to enable a local Redis database using UNIX socket authentication.

Ruutime directory of the pixelfed user which holds the application's caches and temporary files.

How often the Pixelfed cron task should run

A secret file to be sourced for the .env settings. Place APP_KEY and other settings that should not end up in the Nix store here.

.env settings for Pixelfed. Secrets should use secretFile option instead.

User account under which pixelfed runs.

::: {.note} If left as the default value this user will automatically be created on system activation, otherwise you are responsible for ensuring the user exists before the pixelfed application starts. :::