Improve README

This commit is contained in:
Léo Colombaro 2020-04-13 21:42:44 +02:00
parent b727394a54
commit 5ca3aed56c
1 changed files with 12 additions and 10 deletions

View File

@ -19,7 +19,7 @@ Using the Nginx server configs repo directly has a few required steps to be able
### Check `nginx.conf` settings ### Check `nginx.conf` settings
The first thing to check is that the `nginx.conf` file contains appropriate values for The first thing to check is that the `nginx.conf` file contains appropriate values for
your specific install. your specific install.
Most specific variables are: Most specific variables are:
* `user` * `user`
@ -31,7 +31,7 @@ Most specific variables are:
* To verify Nginx config * To verify Nginx config
```shell ```shell
$ nginx -t $ nginx -t
``` ```
* To verify Nginx config with a custom file * To verify Nginx config with a custom file
@ -41,10 +41,9 @@ Most specific variables are:
* To reload Nginx and apply new config * To reload Nginx and apply new config
```shell ```shell
$ nginx -s reload $ nginx -s reload
``` ```
### Basic structure ### Basic structure
This repository has the following structure: This repository has the following structure:
@ -53,7 +52,7 @@ This repository has the following structure:
./ ./
├── conf.d/ ├── conf.d/
│ ├── default.conf │ ├── default.conf
└── templates/ │ └── templates/
├── h5bp/ ├── h5bp/
│ ├── basic.conf │ ├── basic.conf
│ ├── location/ │ ├── location/
@ -64,8 +63,8 @@ This repository has the following structure:
* **`conf.d/`** * **`conf.d/`**
This directory should contain all of the `server` definitions. This directory should contain all the `server` definitions.
Except if they are dot prefixed or non `.conf` extension, all files in this Except if they are dot prefixed or non `.conf` extension, all files in this
folder **are** loaded automatically. folder **are** loaded automatically.
@ -78,12 +77,12 @@ This repository has the following structure:
* **`h5bp/`** * **`h5bp/`**
This directory contains config snippets (mixins) to be included as desired. This directory contains config snippets (mixins) to be included as desired.
There are two types of config files provided, individual config snippets and There are two types of config files provided, individual config snippets and
combined config files which provide convenient defaults. combined config files which provide convenient defaults.
* **`basic.conf`** * **`basic.conf`**
This file loads a small subset of the rules provided by this repository to add This file loads a small subset of the rules provided by this repository to add
expires headers, allow cross domain fonts and protect system files from web expires headers, allow cross domain fonts and protect system files from web
access. access.
@ -113,9 +112,12 @@ To use as reference requires no special installation steps, download/checkout th
repository to a convenient location and adapt your existing Nginx configuration repository to a convenient location and adapt your existing Nginx configuration
incorporating the desired functionality from this repository. incorporating the desired functionality from this repository.
Download the [latest release archive](https://github.com/h5bp/server-configs-nginx/releases/latest).
### Directly ### Directly
To use directly, replace the Nginx config directory with this repository. for example: To use directly, replace the Nginx config directory with this repository.
For example:
```shell ```shell
nginx -s stop nginx -s stop