Cleaned up README.

pull/7/head
Jeromy Streets 6 years ago
parent 7800eb86e1
commit 48bf7cdadd
  1. 16
      README.md

@ -1,9 +1,12 @@
# static-file-server # static-file-server
Tiny, simple static file server using environment variables for configuration Tiny, simple static file server using environment variables for configuration
Available on Docker Hub at https://hub.docker.com/r/halverneus/static-file-server/ Available on Docker Hub at https://hub.docker.com/r/halverneus/static-file-server/
Available on GitHub at https://github.com/halverneus/static-file-server
Environment variables with defaults: Environment variables with defaults:
```bash ```bash
# 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.
@ -40,27 +43,34 @@ tls-cert: ""
tls-key: "" tls-key: ""
``` ```
### Without Docker ## Without Docker
```bash ```bash
PORT=8888 FOLDER=. ./serve PORT=8888 FOLDER=. ./serve
``` ```
Files can then be accessed by going to http://localhost:8888/my/file.txt Files can then be accessed by going to http://localhost:8888/my/file.txt
### With Docker ## With Docker
```bash ```bash
docker run -d -v /my/folder:/web -p 8080:8080 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:8080/my/file.txt This will serve the folder "/my/folder" over http://localhost:8080/my/file.txt
Any of the variables can also be modified: Any of the variables can also be modified:
```bash ```bash
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 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
``` ```
### Also try... ## Also try...
```bash ```bash
./serve help ./serve help
# OR # OR
docker run -it halverneus/static-file-server:latest help docker run -it halverneus/static-file-server:latest help
``` ```
This maybe a cheesy program, but it is convenient and less than 6MB in size. This maybe a cheesy program, but it is convenient and less than 6MB in size.

Loading…
Cancel
Save