Skip to content

Commit

Permalink
Updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
halverneus authored Jun 23, 2017
1 parent 68bcc66 commit 83ded2a
Showing 1 changed file with 14 additions and 3 deletions.
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

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

0 comments on commit 83ded2a

Please sign in to comment.