All Tools View Categories About Contact Privacy

Module Reference

Compare built-in and third-party Nginx modules.

Runs entirely in your browser - nothing is uploaded and no cloud connection is made.
Module information will appear here.
-
results

About Module Reference

Nginx functionality is delivered through modules, and knowing whether a directive comes from a built-in module or a third-party one changes how you install and configure your server. The Module Reference lets you search a built-in glossary of common Nginx modules, see whether each is built-in or third-party, read what it does, and list its key directives. Everything is resolved in your browser from an embedded map, so the lookup is instant and uploads nothing.

At the heart of the configuration are a handful of directives. Core modules modules such as ngx_core_module and ngx_events_module provide the main and events contexts. HTTP core module ngx_http_core_module implements server, location, root and the request routing model. Rewrite module ngx_http_rewrite_module supplies rewrite, return, if and set for URI manipulation. Proxy module ngx_http_proxy_module forwards requests to upstream servers with header and timeout control. SSL module ngx_http_ssl_module enables TLS termination, protocols, ciphers and stapling. Limit modules the limit_req and limit_conn modules protect against abuse and overload. Upstream module ngx_http_upstream_module defines backend pools and load-balancing methods. Third-party modules modules such as ngx_brotli and lua-nginx-module add features outside the official tree. Together they shape how the server behaves, and the tool assembles them in the right context so the result is valid on the first try.

Common mistakes are easy to make. Assuming a directive is built in when it actually needs a third-party or dynamic module. Forgetting that third-party modules often require recompiling nginx, not just a config change. Loading a dynamic module whose version does not match the nginx build will fail to start. Mixing too many third-party modules increases the attack surface and upgrade friction. The generator anticipates each of these and either sets a safe default or rejects the input with a clear message before anything is written to your clipboard.

Validation is strict because small configuration errors fail in subtle ways. Every input is checked for plausibility, and after the block is assembled it is re-parsed by a built-in tokenizer so unbalanced braces, missing semicolons or stray characters cannot reach your clipboard. Stat cards report line and block counts, and copy, download and print exports are one click away. Everything runs in your browser; nothing you type is transmitted to any server.

In practice this block drops into any standard nginx install. Save the output as a file under /etc/nginx/conf.d/ (or sites-available with a symlink), run nginx -t to confirm the syntax, then reload with nginx -s reload. Because the generator emits a single, self-contained server block with no hidden dependencies, it composes cleanly with your existing caching, logging and security configuration without directive collisions.

Beyond producing correct config, the tool is a reference you can read back and learn from. Each control maps to a real nginx directive, the sample button shows a complete working block in seconds, and clearing the form resets every field to its safe default. Standardising on a generator like this removes per-developer variation, keeps your configuration readable, and gives you a repeatable, auditable setup that passes nginx -t on the first try.

When something looks wrong in production, the first move is always to re-run nginx -t and inspect /var/log/nginx/error.log; most failures surface there with a line number. The access log records every request, so a sudden spike or a wall of 499 responses points straight at backend or timeout problems the generator helps you avoid in the first place.

This server block is designed to sit alongside - not fight - your other configuration. Because it declares its own server_name and a single, self-contained set of directives, you can drop it into conf.d without worrying about collisions with global caching, logging or security snippets that live elsewhere in the nginx tree.

For a production site, pair this block with TLS termination: serve on 80 for the redirect or health checks, and place the encrypted listener (or a front-end load balancer / CDN) in front so clients always speak HTTPS. The generator keeps that boundary clean so the two layers compose instead of overlapping.

If a change ever needs to be undone, the output is plain text you control: delete the file from conf.d, re-run nginx -t, and reload. There is no database and no hidden state, so rolling back is as simple as restoring the previous version from version control or your own backup.

Performance and correctness both benefit from explicit configuration. Defaults baked into the generator reflect current best practice rather than decades-old forum snippets, so the block you ship today will not surprise you with deprecated directives or insecure fallbacks six months from now.

Features

  • Core modules - modules such as ngx_core_module and ngx_events_module provide the main and events contexts.
  • HTTP core module - ngx_http_core_module implements server, location, root and the request routing model.
  • Rewrite module - ngx_http_rewrite_module supplies rewrite, return, if and set for URI manipulation.
  • Proxy module - ngx_http_proxy_module forwards requests to upstream servers with header and timeout control.
  • SSL module - ngx_http_ssl_module enables TLS termination, protocols, ciphers and stapling.
  • Limit modules - the limit_req and limit_conn modules protect against abuse and overload.
  • Upstream module - ngx_http_upstream_module defines backend pools and load-balancing methods.
  • Third-party modules - modules such as ngx_brotli and lua-nginx-module add features outside the official tree.
  • Self-verifying output re-parsed before display.
  • Copy, Download and Print exports.
  • Load-sample button fills realistic values.
  • Statistics cards for quick checks.
  • Runs entirely in your browser - nothing uploaded.

How to Use

  1. Type a module name or keyword into the search box (e.g. rewrite or ssl).
  2. Click Look up (or Load sample to prefill rewrite).
  3. Read whether it is built-in or third-party, its description and key directives.
  4. If several modules match, a candidate list with summaries is shown.
  5. Click Download to save the text report or Download JSON for structured data.
  6. Use the key directives list to locate the feature you need.
  7. Clear the box to look up another module.

Examples

Example 1 - Look up rewrite typing rewrite returns ngx_http_rewrite_module as built-in with its key directives.

Example 2 - Look up ssl typing ssl shows the TLS module and its certificate and protocol directives.

Example 3 - Partial match typing http lists every module whose name contains http.

Example 4 - Empty query submitting an empty box returns a clear error asking for a module name.

Example 5 - Unknown module typing a made-up name returns an error indicating no module was found.

Benefits

  • Quickly tells built-in from third-party modules.
  • Lists the key directives each module provides.
  • Helps plan installation and compile-time decisions.
  • Partial matching when you only recall part of a name.
  • One-click JSON and text export for documentation.
  • Private: the glossary is embedded, nothing uploaded.

Frequently Asked Questions

What is an Nginx module?
A module is a compiled-in component that adds directives and behaviour, such as the rewrite module or the proxy module.
What is the difference between built-in and third-party?
Built-in modules ship with the official nginx source; third-party modules are added at compile time from external projects like OpenResty.
How do I know if a module is available?
Run nginx -V to list the configure arguments; dynamically loadable modules also appear in the modules directory.
Can I add a third-party module without recompiling?
Some modules are built as dynamic .so files you can load with load_module, but many still require a custom build.
Why look up a module?
To confirm whether a directive you want is built in or requires installing and loading an extra module.
What are key directives?
Each module entry lists the most important directives it provides so you can find them quickly.
Is the data uploaded?
No. The module glossary is built into the page and lookups run locally in your browser.
Can I export the result?
Yes. Download JSON for structured data or Download for the plain-text report.