All Tools View Categories About Contact Privacy

Nginx Directive Reference

Find directive syntax, context and defaults at a glance.

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

About Nginx Directive Reference

A correct nginx configuration is a web of directives, each with its own allowed context, default value and argument syntax. Memorising all of them is unrealistic, and the official docs are spread across many module pages. The Nginx Directive Reference is a built-in glossary you can search in seconds: type a directive name and get its syntax, the contexts where it is valid, its default, and a ready-to-use example. The whole reference runs locally in your browser, so it works offline and uploads nothing.

At the heart of the configuration are a handful of directives. Core directives directives such as listen and server_name define how virtual servers are created and matched. Location directives directives such as location, root and try_files route and serve files for matched URIs. Proxy directives directives such as proxy_pass and proxy_set_header forward requests to upstream servers. Rewrite directives directives such as rewrite, return and if change or redirect the request URI. Header directives directives such as add_header and expires control response headers and caching. TLS directives directives such as ssl_certificate and ssl_protocols configure HTTPS and cipher policy. Logging directives directives such as access_log and error_log control what nginx records. Limit directives directives such as limit_req and limit_conn protect against abuse and overload. 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. Placing a directive in the wrong context fails nginx -t, so always check the context field first. Assuming a directive has no default is risky; many inherit a safe but non-obvious value. The if directive is notoriously easy to misuse outside the rewrite module; prefer dedicated directives. Forgetting a trailing semicolon is one of the most common syntax errors the parser catches. 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 directives - directives such as listen and server_name define how virtual servers are created and matched.
  • Location directives - directives such as location, root and try_files route and serve files for matched URIs.
  • Proxy directives - directives such as proxy_pass and proxy_set_header forward requests to upstream servers.
  • Rewrite directives - directives such as rewrite, return and if change or redirect the request URI.
  • Header directives - directives such as add_header and expires control response headers and caching.
  • TLS directives - directives such as ssl_certificate and ssl_protocols configure HTTPS and cipher policy.
  • Logging directives - directives such as access_log and error_log control what nginx records.
  • Limit directives - directives such as limit_req and limit_conn protect against abuse and overload.
  • 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 directive name into the search box (no dollar sign needed).
  2. Click Look up (or Load sample to prefill server_name).
  3. Read the syntax, context, default and example in the report.
  4. If several directives match, a candidate list with summaries is shown.
  5. Click Download to save the text report or Download JSON for structured data.
  6. Copy the example line into your own configuration.
  7. Clear the box to look up another directive.

Examples

Example 1 - Look up server_name typing server_name returns its context, default and a multi-name example.

Example 2 - Look up proxy_pass typing proxy_pass shows the forwarding syntax and a backend example.

Example 3 - Partial match typing proxy lists proxy_pass and proxy_set_header together.

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

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

Benefits

  • Fast, offline lookup of common Nginx directives.
  • Context and default shown so you avoid misplacement errors.
  • Copy-ready examples for immediate use in config.
  • 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 directive?
A directive is a configuration instruction such as listen or root that tells nginx how to behave; it has a name, arguments and a context.
What does context mean?
Context is the block where a directive is legal, such as main, http, server, location or if. Using it elsewhere is a config error.
What is the default value?
The default is what nginx assumes when the directive is omitted; the report shows it so you know what you inherit.
Is the dollar sign needed?
No. Directives have no dollar sign; just type the name, for example server_name.
Can I see example usage?
Yes. Every entry includes a copy-ready example line you can paste into your own configuration.
What if I only remember part of the name?
The tool lists every directive whose name contains your search term, with a short summary for each.
Is the data uploaded?
No. The glossary is embedded in the page and lookups happen locally in your browser.
Can I export the result?
Yes. Download JSON for structured data or Download for the plain-text report.