AIR/static-file-server
1
0
Fork 0
mirror of https://github.com/halverneus/static-file-server.git synced 2024-11-24 09:05:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Minor README.md clean-up.

Browse Source
This commit is contained in:
Jeromy Streets 2019-02-05 00:41:15 -08:00
parent 09c6403168
commit 0290049e9e
1 changed files with 20 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -17,24 +17,31 @@ Default values are shown with the associated environment variable.
# Enable debugging for troubleshooting. If set to 'true' this prints extra # Enable debugging for troubleshooting. If set to 'true' this prints extra
# information during execution. # information during execution.
DEBUG=false DEBUG=false
# Optional Hostname for binding. Leave black to accept any incoming HTTP request # Optional Hostname for binding. Leave black to accept any incoming HTTP request
# on the prescribed port. # on the prescribed port.
HOST= HOST=
# If assigned, must be a valid port number. # If assigned, must be a valid port number.
PORT=8080 PORT=8080
# Automatically serve the index file for a given directory (default). If set to # Automatically serve the index file for a given directory (default). If set to
# 'false', URLs ending with a '/' will return 'NOT FOUND'. # 'false', URLs ending with a '/' will return 'NOT FOUND'.
SHOW_LISTING=true SHOW_LISTING=true
# Folder with the content to serve. # Folder with the content to serve.
FOLDER=/web FOLDER=/web
# URL path prefix. If 'my.file' is in the root of $FOLDER and $URL_PREFIX is # URL path prefix. If 'my.file' is in the root of $FOLDER and $URL_PREFIX is
# '/my/place' then file is retrieved with 'http://$HOST:$PORT/my/place/my.file'. # '/my/place' then file is retrieved with 'http://$HOST:$PORT/my/place/my.file'.
URL_PREFIX= URL_PREFIX=
# Paths to the TLS certificate and key. If one is set then both must be set. If # Paths to the TLS certificate and key. If one is set then both must be set. If
# both set then files are served using HTTPS. If neither are set then files are # both set then files are served using HTTPS. If neither are set then files are
# served using HTTP. # served using HTTP.
TLS_CERT= TLS_CERT=
TLS_KEY= TLS_KEY=
# List of accepted HTTP referrers. Return 403 if HTTP header `Referer` does not # List of accepted HTTP referrers. Return 403 if HTTP header `Referer` does not
# match prefixes provided in the list. # match prefixes provided in the list.
# Examples: # Examples:
@ -53,16 +60,25 @@ the path to the configuration file using the command line option
```yaml ```yaml
debug: false debug: false
folder: /web
host: "" host: ""
port: 8080 port: 8080
referrers: []
show-listing: true show-listing: true
folder: /web
url-prefix: ""
tls-cert: "" tls-cert: ""
tls-key: "" tls-key: ""
url-prefix: ""
```
Example configuration with possible alternative values:
```yaml
debug: true
folder: /var/www
port: 80
referrers: referrers:
- http://localhost - http://localhost
- https://my.site - https://mydomain.com
``` ```
## Deployment ## Deployment