Nginx common configuration - Universal config and snippets
A collection of production-ready Nginx configuration snippets, templates, and best practices for common web server setups.
What is Nginx common configuration - Universal config and snippets?
nginx-common-configuration is a collection of reusable Nginx configuration files, snippets, and templates that implement production best practices for security, performance, and maintainability. It solves the problem of manually assembling and debugging Nginx configs by providing modular, well-documented setups for common use cases like SSL, caching, logging, and Docker deployment.
DevOps engineers, system administrators, and backend developers who deploy and manage Nginx servers for websites, applications, APIs, or load balancing.
Developers choose this project because it offers battle-tested configurations from real-world high-traffic environments, avoids common pitfalls documented in the 'Known traps' section, and saves significant time compared to piecing together solutions from scattered documentation.
Overview
Nginx common useful configuration
Use Cases
Best For
- Quickly setting up a secure Nginx reverse proxy with SSL and security headers
- Deploying Nginx in Docker with proper configuration templating
- Implementing fail2ban protection for Nginx against common attack patterns
- Configuring Nginx caching safely for dynamic applications
- Setting up log parsing with Filebeat for extended Nginx access logs
- Managing Nginx configurations across multiple sites with reusable snippets
Not Ideal For
- Projects requiring integration with proprietary or cloud-specific Nginx extensions not covered by standard modules
- Teams using fully automated deployment pipelines that generate Nginx configurations dynamically from infrastructure-as-code tools
- Environments where Nginx serves specialized protocols like RTMP or WebSocket with complex, non-standard settings
Pros & Cons
Pros
Splits core settings into reusable files in `conf.d`, allowing easy customization and maintenance without modifying the main nginx.conf.
Implements SSL configurations based on Mozilla guidelines and includes security headers, providing robust protection out of the box against common vulnerabilities.
Offers Dockerfile and docker-compose examples with custom envsubst templating to handle default values, overcoming limitations of the default GNU envsubst.
Includes templates for CORS, site configuration, and static file serving, based on years of real-world high-traffic experience to avoid pitfalls like cache breaking client content.
Cons
Caching is disabled by default in cache.conf, requiring users to manually enable and configure it, which can be error-prone and complex for dynamic applications.
The configurations and 'Known traps' section require a good understanding of Nginx internals, making it less accessible for beginners or those seeking plug-and-play solutions.
Focuses primarily on Nginx configs; integration with other tools like CDNs or cloud-specific services isn't covered, requiring additional setup.
Frequently Asked Questions
Related Projects
Nginx HTTP server boilerplate configsNginx HTTP server boilerplate configs
Gixy - Nginx configuration static analyzerNginx configuration static analyzer
Nginx Boilerplate - Configuration template and a set of handy must-have snippetsAwesome Nginx configuration template
Avoiding the Top 10 NGINX Configuration MistakesFound a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.