AIR/static-file-server
1
0
Fork 0
mirror of https://github.com/halverneus/static-file-server.git synced 2025-02-05 15:55:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated README.md

Browse Source
This commit is contained in:
Jeromy Streets 2017-06-23 08:49:41 -07:00 committed by GitHub
parent 68bcc664f3
commit 83ded2aab9
1 changed files with 14 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -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.