Update readme

This commit is contained in:
2021-12-27 18:34:28 +01:00
parent 174865b71c
commit 6f4cbb6e24

View File

@ -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,23 +23,25 @@ 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)
* `webroot` - path to the root directory * `private_key` - path to SSL private key
* `dir_mode` - specify the behaviour for directories without an `index.html` or `index.php` * `[host <host>]` - begins section for the virtual host `<host>`
* `forbidden` - the server will respond with `403 Forbidden` * `cert` - the name of the certificate to use
* `info` - try passing *path info* to an upper `.php` file. * Local
* `list` - list contents of directory (**not implemented yet**) * `webroot` - path to the root directory
* Reverse proxy * `dir_mode` - specify the behaviour for directories without an `index.html` or `index.php`
* `hostname` - hostname of server to be reverse proxy of * `forbidden` - the server will respond with `403 Forbidden`
* `port` - port to be used * `info` - try passing *path info* to an upper `.php` file.
* `http` - use HTTP to communicate with server * `list` - list contents of directory (**not implemented yet**)
* `https` - use HTTPS to communicate with server * Reverse proxy
* `hostname` - hostname of server to be reverse proxy of
* `port` - port to be used
* `http` - use HTTP to communicate with server
* `https` - use HTTPS to communicate with server