JadeTheDragon: Removed outdated information.

2024-08-04T13:01:18Z

Removed outdated information.

← Older revision		Revision as of 13:01, 4 August 2024
Line 1:		Line 1:
	Static Web Server (SWS) is an HTTP server written in Rust with a focus on efficiently serving static files. The project website is https://static-web-server.net/		Static Web Server (SWS) is an HTTP server written in Rust with a focus on efficiently serving static files. The project website is https://static-web-server.net/

	There is a NixOS module ~~(currently on the unstable branch)~~ that allows you to run and configure SWS. First, add the package to your systemPackages:		There is a NixOS module that allows you to run and configure SWS. First, add the package to your systemPackages:

	<syntaxhighlight lang=nix>		<syntaxhighlight lang=nix>

Klinger at 19:07, 19 April 2024

2024-04-19T19:07:01Z

← Older revision		Revision as of 19:07, 19 April 2024
Line 119:		Line 119:

	[[Category:Cookbook]]		[[Category:Cookbook]]
	[[Category:~~NixOS]]~~		[[Category:Server]]
	~~[[Category:Applications~~]]

imported>Mac-chaffee: create page

2023-07-02T01:32:51Z

create page

New page

Static Web Server (SWS) is an HTTP server written in Rust with a focus on efficiently serving static files. The project website is https://static-web-server.net/

There is a NixOS module (currently on the unstable branch) that allows you to run and configure SWS. First, add the package to your systemPackages:

<syntaxhighlight lang=nix>
environment.systemPackages = with pkgs; [
static-web-server
];
</syntaxhighlight>

Here is a minimal viable configuration of SWS:

<syntaxhighlight lang=nix>
services.static-web-server = {
enable = true;
root = "/some/path";
};
</syntaxhighlight>

By default, this will start SWS on <code>[::]:8787</code> and it will serve files from the folder <code>/some/path</code>. Default settings can be found here: https://github.com/NixOS/nixpkgs/blob/3eb8ccf3b3922be5586a263e7d6f4f98e3acf728/nixos/modules/services/web-servers/static-web-server.nix#L9 and here: https://static-web-server.net/configuration/config-file/

SWS will not be exposed to your network unless you also edit the firewall rules:

<syntaxhighlight lang=nix>
networking.firewall.allowedTCPPorts = [ 8787 ];
</syntaxhighlight>

== Advanced Configuration ==

To change the host or port, you can use the "listen" option like this:

<syntaxhighlight lang=nix>
services.static-web-server = {
enable = true;
listen = "[::]:80";
root = "/some/path";
};
</syntaxhighlight>

All other options aside from "listen" and "root" can be configured via SWS's [https://static-web-server.net/configuration/config-file/ TOML config file] like this:

<syntaxhighlight lang=nix>
services.static-web-server = {
enable = true;
listen = "[::]:80";
root = "/some/path";
configuration = {
general = {
directory-listing = true;
};
};
};
</syntaxhighlight>

Any option that can be expressed in SWS's TOML file can also be configured via this same "configuration" option, with the exception of "host", "port", (use "listen" instead) and "root" (use the "root" option instead). This is because the host, port, and root directory choice require changes to the generated systemd unit files.

=== HTTPS ===

NixOS includes an ACME client which will automatically request and renew TLS certificates for you. See the [[ACME]] page for more info. Here is an example of how to integrate the ACME client with SWS:

<syntaxhighlight lang=nix>
security.acme = {
acceptTerms = true;
defaults.email = "your-email@example.com";
certs."your-domain.example" = {
reloadServices = [ "static-web-server" ];
listenHTTP = ":80";
group = "www-data";
# EC is not supported by SWS versions before 2.16.1
keyType = "rsa4096";
};
};

# Now we need to open port 80 for the ACME challenge and port 443 for SWS itself
networking.firewall.allowedTCPPorts = [ 80 443 ];

# Configure SWS to use the generated TLS certs
services.static-web-server = {
enable = true;
root = "/some/path";
listen = "[::]:443";
configuration = {
general = {
http2 = true;
# Edit the domain name in the file to match your real domain name as configured in the ACME settings
http2-tls-cert = "/var/lib/acme/your-domain.example/fullchain.pem";
http2-tls-key = "/var/lib/acme/your-domain.example/key.pem";
# Info here: https://static-web-server.net/features/security-headers/
# This option is only needed for versions prior to 2.18.0, after which it defaults to true
security-headers = true;
};
};
};

# Now we need to override some things in the systemd unit files to allow access to those TLS certs, starting with creating a new Linux group:
users.groups.www-data = {};
# This strategy can be useful to override other advanced features as-needed
systemd.services.static-web-server.serviceConfig.SupplementaryGroups = pkgs.lib.mkForce [ "" "www-data" ];
# Note that "/some/path" should match your "root" option
systemd.services.static-web-server.serviceConfig.BindReadOnlyPaths = pkgs.lib.mkForce ["/some/path" "/var/lib/acme/your-domain.example"];
</syntaxhighlight>

Then run <code>nixos-rebuild switch</code>. The first time you apply this change, SWS may fail to start up if it tries to start before the initial cert is generated (the ACME client should generate a placeholder cert very quickly). If that happens, just wait a few minutes, then run <code>systemctl restart static-web-server.service</code>. It should then be able to load the TLS certificate.

== Troubleshooting ==

To check the logs, use [https://www.man7.org/linux/man-pages/man1/journalctl.1.html journalctl], such as <code>journalctl -u static-web-server.service --since="30 min ago"</code>. You may need to increase the log level like so:

<syntaxhighlight lang=nix>
services.static-web-server = {
...
configuration = {
general = {
log-level = "trace";
};
};
};
</syntaxhighlight>

[[Category:Cookbook]]
[[Category:NixOS]]
[[Category:Applications]]

Static Web Server - Revision history

JadeTheDragon: Removed outdated information.

Klinger at 19:07, 19 April 2024

imported>Mac-chaffee: create page