From bacc57d6ee494ef18351d5b5c9206b2d87b796fe Mon Sep 17 00:00:00 2001 From: allan Date: Mon, 1 Dec 2025 23:19:43 +0100 Subject: [PATCH] Because reading the README is faster than debugging --- README.md | 30 ++++++++++++++++++++++-------- 1 file changed, 22 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index e9cbdf5..ef8c6a8 100644 --- a/README.md +++ b/README.md @@ -4,14 +4,28 @@ [![WebServer](https://img.shields.io/badge/server-nginx-009639)](#) [![License](https://img.shields.io/badge/License-MIT-green)](./LICENSE) -Reusable, modular and production-focused **Nginx configuration snippets** -for high-performance Ubuntu 24.04 web servers. +Install modular Nginx snippet library for Ubuntu 24.04. -These are drop-in blocks — not theory, not examples — real configs for real servers. +This is not a demo and not an experiment. +This is reusable security, caching, TLS and performance building blocks — no clutter, no spaghetti config. + +## Why this exists +Editing one long config file scales poorly. Snippets make Nginx structured and maintainable. + +## What this installer does +✔ Drop-in security modules +✔ Cloudflare Real-IP support +✔ Caching bundles +✔ Hardened baseline templates included +✔ Hostfile examples provided + +## What this installer does *NOT* do +It won’t stop you from running the script without reading the documentation like there’s no tomorrow. +Skip the README, and whatever happens next is your headache, not a bug report. --- -## 📦 Install +## Install ``` git clone https://git.x-files.dk/webserver/nginx-snippets.git /etc/nginx/nginx-snippets @@ -21,7 +35,7 @@ If you used the **nginx-ubuntu installer**, these are already installed. --- -## 📁 Directory Structure +## Directory Structure ``` nginx-snippets/ @@ -45,7 +59,7 @@ nginx-snippets/ --- -## 🔧 How to use a snippet +## How to use a snippet In any server block: @@ -64,7 +78,7 @@ sudo nginx -t && sudo systemctl reload nginx --- -## 🚀 Snippet Index & Purpose +## Snippet Index & Purpose | File | Purpose | |---|---| @@ -78,7 +92,7 @@ sudo nginx -t && sudo systemctl reload nginx --- -## 💡 Recommended Bundles +## Recommended Bundles ### Performance stack ```