Skip to content
@sysadmin-labs

Sysadmin labs

Tools, modules and plugins for sysadmins

Sysadmin labs

Modules for nginx, built and tested on FreeBSD and Linux.

nginx modules

Thirty-five repositories, thirty-seven modules -- nginx-sts-module and nginx-geoip2-module each ship two, one for each subsystem they work in.

They all carry the same checks: the release matrix of nginx versions, a FreeBSD virtual machine, address and undefined behaviour sanitizers, valgrind, CodeQL, shellcheck and actionlint. Most add eight reloads in a row and at least one gate that belongs to that module alone, from a hostile client to a collector that takes its datagrams apart. Three have no reload gate: nginx-fips-check-module allocates nothing per cycle and answers no request, so there would be nothing to measure, while nginx-ajp-module and nginx-tarantool-module would each need a stand-in for a binary protocol first. Where a gate is missing it is missing, rather than present and passing on something it does not check.

Module What it does
nginx-accept-language-module Picks a language for the request out of Accept-Language, weights respected, into a variable
nginx-ajp-module Proxies to Tomcat or Jetty over AJP, the binary connector protocol, keeping the connection
nginx-auth-ldap-module Authenticates HTTP basic credentials against an LDAP directory, with group requirements, a connection pool and an answer cache
nginx-auth-pam-module Authenticates HTTP basic credentials against PAM, so a location opens to the accounts the system knows
nginx-cert-expiry-module Warns in the error log before a TLS certificate expires, with a variable for the days left
nginx-dav-ext-module Adds the WebDAV methods nginx's own dav module leaves out: PROPFIND, OPTIONS, LOCK and UNLOCK
nginx-dynamic-upstream-module Adds and removes upstream peers at run time over an HTTP interface, and keeps them in step with DNS
nginx-fips-check-module Reports whether the OpenSSL nginx is linked against runs in FIPS mode, and stops a worker that disagrees
nginx-footer-module Appends text to a response body, built from variables, for the content types you name
nginx-form-input-module Parses application/x-www-form-urlencoded request bodies into nginx variables
nginx-geoip2-module Reads MaxMind GeoIP2 and GeoLite2 databases into variables, for HTTP and for stream
nginx-gridfs-module Serves files out of MongoDB GridFS, byte ranges included
nginx-http-auth-digest Authenticates requests with HTTP Digest, the RFC 2617 scheme, against a password file
nginx-iconv-module Converts between character encodings with iconv(3): a value into a variable, or a whole response body
nginx-ip-anon-module Masks the host part of the client address, IPv4 and IPv6, into variables for logs and limit keys
nginx-json-status-module Reports the connection and request counters and every upstream as one JSON object
nginx-let-module Evaluates an arithmetic or string expression into a variable
nginx-link-function-module Calls functions from a C library loaded at run time, request handling in native code
nginx-mogilefs-module Asks a MogileFS tracker where a key lives and serves it from the storage node that has it, writes included
nginx-postgres-module Queries PostgreSQL directly and answers with text, JSON or a status code
nginx-push-stream-module Server push out of nginx's own shared memory: long polling, EventSource and WebSocket channels
nginx-redis-module Fetches one key from Redis with a single GET and serves the value as the response body
nginx-redis2-module Sends commands to Redis and answers with the raw reply
nginx-rtmp-module An RTMP server in nginx: live relay, recording, and the same stream again as HLS or MPEG-DASH
nginx-sflow-module Samples requests and sends them as sFlow datagrams
nginx-slowfs-cache-module Caches files served from a slow filesystem onto a fast one
nginx-stream-limit-req-module Rate limits incoming connections in the stream subsystem: limit_req for TCP and UDP
nginx-sts-module Counts what goes through the stream subsystem and serves the counters as JSON, a Prometheus exposition or an HTML dashboard
nginx-subs-filter-module Rewrites the response body with string and regular-expression substitutions
nginx-syslog5424-module Logs to syslog in the RFC 5424 format, with timestamp, message id and structured data
nginx-tarantool-module Talks to a Tarantool database over its binary protocol and serves it as REST or JSON-RPC
nginx-upload-module Receives multipart file uploads, resumable ones included, and hands the request on
nginx-upstream-check-module Probes each backend on a timer and takes a failing one out of the balancer before a request lands on it
nginx-websockify-module Bridges a WebSocket to a plain TCP service, a VNC server for example
nginx-zstd-module Zstandard: an output filter, and a server for precompressed .zst files

Some of these were written here. The rest were taken over because the repositories they came from stopped moving, in some cases a decade ago, while the FreeBSD ports tree still pointed at them. Each repository's LICENSE says whose code is in it; where that is somebody else's licence, it is theirs and it stayed.

Each repository has a CHANGELOG.md, a release, and build instructions in its README.

nginx, and the rest of the family

nginx is what is built and tested in continuous integration today, against the releases the FreeBSD ports tree ships. Angie and OpenResty are of interest and are not tested here yet.

Links

  • Blog and write-ups: blog.bsdproject.de
  • Bugs and requests: issues on the repository in question

License

Each module carries the licence of its own code, and the LICENSE in its repository is the one that applies — four of them are not BSD, because their authors chose otherwise. What was written here, including the build and test scaffolding, is BSD 2-Clause.

Popular repositories Loading

  1. nginx-auth-ldap-module nginx-auth-ldap-module Public

    nginx module that authenticates HTTP basic credentials against an LDAP directory, with group requirements and a connection pool

    C 1

  2. nginx-form-input-module nginx-form-input-module Public

    NGINX module that parses application/x-www-form-urlencoded request bodies into nginx variables

    C

  3. nginx-zstd-module nginx-zstd-module Public

    Two nginx modules for Zstandard: an output filter and a server for precompressed .zst files

    C

  4. nginx-let-module nginx-let-module Public

    nginx module that evaluates an arithmetic or string expression into a variable

    C

  5. nginx-slowfs-cache-module nginx-slowfs-cache-module Public

    nginx module that caches files served from a slow filesystem onto a fast one

    C

  6. .github .github Public

    Tools, modules and plugins for web servers, mail and identity. FreeBSD and Linux

Repositories

Showing 10 of 36 repositories

People

This organization has no public members. You must be a member to see who’s a part of this organization.

Top languages

Loading…