From 83ded2aab92a2d2773d03bce311b76f8bc51ceef Mon Sep 17 00:00:00 2001 From: Jeromy Streets Date: Fri, 23 Jun 2017 08:49:41 -0700 Subject: [PATCH] Updated README.md --- README.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 30842ff..c844049 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,12 @@ Tiny, simple static file server using environment variables for configuration Available on Docker Hub at https://hub.docker.com/r/halverneus/static-file-server/ Environment variables with defaults: -``` +```bash +# Optional Hostname for binding. Leave black to accept any incoming HTTP request on the prescribed port. HOST= +# If assigned, must be a valid port number. PORT=8080 +# Folder with the content to serve. FOLDER=/web ``` @@ -17,6 +20,14 @@ PORT=8888 FOLDER=. ./serve Files can then be accessed by going to http://localhost:8888/my/file.txt ### With Docker -docker run -d -v /my/folder:/web -e PORT=9090 -p 9090:9090 halverneus/static-file-server:latest - +``` +docker run -d -v /my/folder:/web -p 8080:8080 halverneus/static-file-server:latest +``` This will serve the folder "/my/folder" over http://localhost:9090/my/file.txt + +Any of the variables can also be modified: +``` +docker run -d -v /home/me/dev/source:/content/html -v /home/me/dev/files:/content/more/files -e FOLDER=/content -p 8080:8080 halverneus/static-file-server:latest +``` + +This maybe a cheesy program, but it is convenient and less than 6MB in size.