mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2025-08-30 23:38:13 +02:00
Shortened service- to svc-
This commit is contained in:
38
roles/web-svc-html/README.md
Normal file
38
roles/web-svc-html/README.md
Normal file
@@ -0,0 +1,38 @@
|
||||
# Nginx Static HTML Server
|
||||
|
||||
## 🔥 Description
|
||||
|
||||
This role configures an [Nginx](https://nginx.org/) server to host a static HTML homepage securely over HTTPS. It automates domain configuration, SSL/TLS certificate retrieval using [Let's Encrypt](https://letsencrypt.org/), and ensures your site is ready for production with minimal setup.
|
||||
|
||||
## 📖 Overview
|
||||
|
||||
Optimized for Archlinux environments, this role provides a lightweight, reliable solution for serving static websites. It automatically configures Nginx to serve files from a predefined directory, sets up secure HTTPS connections, and includes support for `.well-known` paths required by ACME challenges.
|
||||
|
||||
### Key Features
|
||||
- **Static Site Hosting:** Serves HTML, CSS, JavaScript, and other static files.
|
||||
- **Let's Encrypt Integration:** Automatically requests and installs SSL/TLS certificates.
|
||||
- **Simple Root Configuration:** Defines a clean webroot with `index.html` support.
|
||||
- **Secure by Default:** Includes modern SSL headers and best practices via Nginx.
|
||||
- **.well-known Support:** Ensures full ACME challenge compatibility.
|
||||
|
||||
## 🎯 Purpose
|
||||
|
||||
The Nginx Static HTML Server role provides a simple and efficient method to publish static websites with HTTPS, perfect for personal homepages, landing pages, or small projects.
|
||||
|
||||
## 🚀 Features
|
||||
|
||||
- **Automatic HTTPS Certificates:** Handles secure certificate issuance via Let's Encrypt.
|
||||
- **Minimal Nginx Setup:** Clean and optimized default configurations.
|
||||
- **Highly Portable:** Works out-of-the-box with minimal variables.
|
||||
- **Local Time Support:** Properly displays directory listing timestamps when needed.
|
||||
|
||||
## 🔗 Learn More
|
||||
|
||||
- [Nginx Official Website](https://nginx.org/)
|
||||
- [Let's Encrypt](https://letsencrypt.org/)
|
||||
- [Static Web Page (Wikipedia)](https://en.wikipedia.org/wiki/Static_web_page)
|
||||
- [HTTPS (Wikipedia)](https://en.wikipedia.org/wiki/HTTPS)
|
||||
|
||||
## 🧑💻 Author Information
|
||||
|
||||
Created in 2023 by [Kevin Veen-Birkenbach](https://www.veen.world/)
|
Reference in New Issue
Block a user