mirror of
https://github.com/halverneus/static-file-server.git
synced 2024-11-24 09:05:30 +00:00
Cleaned up README.
This commit is contained in:
parent
7800eb86e1
commit
48bf7cdadd
16
README.md
16
README.md
@ -1,9 +1,12 @@
|
||||
# static-file-server
|
||||
|
||||
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 GitHub at https://github.com/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.
|
||||
@ -40,27 +43,34 @@ tls-cert: ""
|
||||
tls-key: ""
|
||||
```
|
||||
|
||||
### Without Docker
|
||||
## Without Docker
|
||||
|
||||
```bash
|
||||
PORT=8888 FOLDER=. ./serve
|
||||
```
|
||||
|
||||
Files can then be accessed by going to http://localhost:8888/my/file.txt
|
||||
|
||||
### With Docker
|
||||
## With Docker
|
||||
|
||||
```bash
|
||||
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
|
||||
|
||||
Any of the variables can also be modified:
|
||||
|
||||
```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
|
||||
```
|
||||
|
||||
### Also try...
|
||||
## Also try...
|
||||
|
||||
```bash
|
||||
./serve help
|
||||
# OR
|
||||
docker run -it halverneus/static-file-server:latest help
|
||||
```
|
||||
|
||||
This maybe a cheesy program, but it is convenient and less than 6MB in size.
|
||||
|
Loading…
Reference in New Issue
Block a user