Update readme
This commit is contained in:
15
README.md
15
README.md
@ -5,6 +5,7 @@ Necronda web server
|
|||||||
## Features
|
## Features
|
||||||
|
|
||||||
* Full IPv4 and IPv6 support
|
* Full IPv4 and IPv6 support
|
||||||
|
* TLS Server Name Inspection (SNI)
|
||||||
* Serving local files via HTTP and HTTPS
|
* Serving local files via HTTP and HTTPS
|
||||||
* File compression ([gzip](https://www.gzip.org/), [Brotli](https://www.brotli.org/)) and disk cache for compressed files
|
* File compression ([gzip](https://www.gzip.org/), [Brotli](https://www.brotli.org/)) and disk cache for compressed files
|
||||||
* Reverse proxy for other HTTP and HTTPS servers
|
* Reverse proxy for other HTTP and HTTPS servers
|
||||||
@ -22,22 +23,24 @@ See [docs/example.conf](docs/example.conf) for more details.
|
|||||||
|
|
||||||
### Global directives
|
### Global directives
|
||||||
|
|
||||||
* `certificate` - path to SSL certificate (or certificate chain)
|
|
||||||
* `private_key` - path to SSL private key
|
|
||||||
* `geoip_dir` (optional) - path to a directory containing GeoIP databases
|
* `geoip_dir` (optional) - path to a directory containing GeoIP databases
|
||||||
* `dns_server` (optional) - address of a DNS server
|
* `dns_server` (optional) - address of a DNS server
|
||||||
|
|
||||||
|
|
||||||
### Virtual host configuration
|
### Configuration
|
||||||
|
|
||||||
* `[<host>]` - begins section for the virtual host `<host>`
|
* `[cert <cert-name]` - begins section for a certificate
|
||||||
* Local
|
* `certificate` - path to SSL certificate (or certificate chain)
|
||||||
|
* `private_key` - path to SSL private key
|
||||||
|
* `[host <host>]` - begins section for the virtual host `<host>`
|
||||||
|
* `cert` - the name of the certificate to use
|
||||||
|
* Local
|
||||||
* `webroot` - path to the root directory
|
* `webroot` - path to the root directory
|
||||||
* `dir_mode` - specify the behaviour for directories without an `index.html` or `index.php`
|
* `dir_mode` - specify the behaviour for directories without an `index.html` or `index.php`
|
||||||
* `forbidden` - the server will respond with `403 Forbidden`
|
* `forbidden` - the server will respond with `403 Forbidden`
|
||||||
* `info` - try passing *path info* to an upper `.php` file.
|
* `info` - try passing *path info* to an upper `.php` file.
|
||||||
* `list` - list contents of directory (**not implemented yet**)
|
* `list` - list contents of directory (**not implemented yet**)
|
||||||
* Reverse proxy
|
* Reverse proxy
|
||||||
* `hostname` - hostname of server to be reverse proxy of
|
* `hostname` - hostname of server to be reverse proxy of
|
||||||
* `port` - port to be used
|
* `port` - port to be used
|
||||||
* `http` - use HTTP to communicate with server
|
* `http` - use HTTP to communicate with server
|
||||||
|
Reference in New Issue
Block a user