Go to file
2019-01-04 09:07:03 -08:00
bin/serve Added command-line utility packages and integrated. 2018-07-28 17:05:24 -07:00
cli Creating multi-arch building container and consolidated version to Dockerfiles. 2018-12-20 15:15:27 -08:00
config Added the ability to enable debug logging. 2018-10-18 13:45:43 -07:00
handle Added the ability to enable debug logging. 2018-10-18 13:45:43 -07:00
.dockerignore Creating multi-arch building container and consolidated version to Dockerfiles. 2018-12-20 15:15:27 -08:00
.gitignore Refactored and added unit tests for configuration 2018-07-15 00:09:51 -07:00
Dockerfile Rolled fix version number. 2019-01-04 09:07:03 -08:00
Dockerfile.all Rolled fix version number. 2019-01-04 09:07:03 -08:00
go.mod Updated dependencies and version number. Modified Dockerfile to place dependencies in a separate layer to speed development. 2018-12-20 13:37:17 -08:00
go.sum Updated dependencies and version number. Modified Dockerfile to place dependencies in a separate layer to speed development. 2018-12-20 13:37:17 -08:00
LICENSE Initial commit 2017-06-23 07:29:46 -07:00
README.md Updated to use Go 1.11.2. Fixed ENTRYPOINT and CMD in Dockerfile. Cleaned up README. 2018-11-14 16:16:03 -08:00

static-file-server

Introduction

Tiny, simple static file server using environment variables for configuration. Install from any of the following locations:

Configuration

Environment Variables

Default values are shown with the associated environment variable.

# Enable debugging for troubleshooting. If set to 'true' this prints extra
# information during execution.
DEBUG=false
# 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
# Automatically serve the index file for a given directory (default). If set to
# 'false', URLs ending with a '/' will return 'NOT FOUND'.
SHOW_LISTING=true
# Folder with the content to serve.
FOLDER=/web
# URL path prefix. If 'my.file' is in the root of $FOLDER and $URL_PREFIX is
# '/my/place' then file is retrieved with 'http://$HOST:$PORT/my/place/my.file'.
URL_PREFIX=
# Paths to the TLS certificate and key. If one is set then both must be set. If
# both set then files are served using HTTPS. If neither are set then files are
# served using HTTP.
TLS_CERT=
TLS_KEY=

YAML Configuration File

YAML settings are individually overridden by the corresponding environment variable. The following is an example configuration file with defaults. Pass in the path to the configuration file using the command line option ('-c', '-config', '--config').

debug: false
host: ""
port: 8080
show-listing: true
folder: /web
url-prefix: ""
tls-cert: ""
tls-key: ""

Deployment

Without Docker

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 \
    -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:

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

Getting Help

./serve help
# OR
docker run -it halverneus/static-file-server:latest help