在 Rust 中实现的 Nix 二进制缓存(维护者:@Mic92)
Harmonia is a binary cache for nix that serves your /nix/store as a binary cache over http. It's written in Rust for speed.
narOffset in json response but isn't needed for
nix-index/serve// endpoint to allow serving the content of package.
Also discovers index.html to allow serving websites directly from the nix store.There is a module for harmonia in nixpkgs. The following example set's up harmonia as a public binary cache using nginx as a frontend webserver with https encryption:
…To use the latest version with all features, import the harmonia flake:
…You can use the binary cache on a different machine using the following NixOS configuration:
{
nix.settings = {
substituters = [ "https://cache.yourdomain.tld" ];
# FIXME replace the key with the content of /var/lib/secrets/harmonia.pub
trusted-public-keys = [ "cache.yourdomain.tld-1:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=" ];
};
}Configuration is done via a toml file.
Hint: You don't need to interface with the configuration directly in case you are using the NixOS module.
The location of the configuration file should be passed as env var CONFIG_FILE. If no config file is passed the
following default values will be used:
…Per default we wont sign any narinfo because we don't have a secret key, to
enable this feature enable it by providing a path to a private key generated by
nix-store --generate-binary-cache-key cache.example.com-1 /etc/nix/cache.secret /etc/nix/cache.pub
# nix binary cache signing key
sign_key_paths = [ "/run/secrets/cache.secret" ]Harmonia also reads the SIGN_KEY_PATHS environment variable which holds paths to secret keys separated by spaces.
All paths provided by sign_key_paths config option and SIGN_KEY_PATHS environment variable will be used for signing.
Harmonia can serve content over HTTPS without requiring a reverse proxy. To enable TLS, specify the paths to your certificate and private key files in the configuration:
# Path to TLS certificate (PEM format)
tls_cert_path = "/path/to/cert.pem"
# Path to TLS private key (PEM format)
tls_key_path = "/path/to/key.pem"Requirements for TLS certificates:
Example generating a self-signed certificate for testing:
openssl req -x509 -newkey rsa:2048 -keyout key.pem -out cert.pem -days 365 -nodes \
-subj "/C=US/ST=State/O=Organization/CN=cache.example.com"Note: When TLS is enabled, harmonia will only accept HTTPS connections on the configured port.
Logging is handled by tracing and configured via the
RUST_LOG environment variable using
EnvFilter
syntax (compatible with the familiar env_logger directives). The default
filter is info. To only log errors use RUST_LOG=error, and to keep info
messages while disabling actix access logging use
RUST_LOG=info,actix_web::middleware=error.
nix build -Lnix developnix flake check -LHarmonia exposes Prometheus metrics at the /metrics endpoint for monitoring and observability.
HTTP Request Metrics:
harmonia_http_requests_total - Total number of HTTP requests (labeled by method, path, and status code)harmonia_http_request_duration_seconds - Request latency histogram with buckets ranging from 0.0001s to 1.0sA pre-configured Grafana dashboard is available in the repository at harmonia-cache/harmonia-grafana-dashboard.json. This dashboard visualizes:
You can import this dashboard into your Grafana instance to monitor your Harmonia deployment.
To scrape metrics from Harmonia, add the following to your Prometheus configuration:
scrape_configs:
- job_name: 'harmonia'
static_configs:
- targets: ['your-harmonia-host:5000']See CONTRIBUTING.md for development setup, testing, and code style guidelines. For architecture details, see docs/architecture.
暂无开放 Issues,或尚未同步最近议题。