You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
139 lines
3.4 KiB
139 lines
3.4 KiB
# static-file-server
|
|
|
|
<a href="https://github.com/sponsors/halverneus">
|
|
<img src="img/sponsor.svg" />
|
|
</a>
|
|
|
|
## Introduction
|
|
|
|
Tiny, simple static file server using environment variables for configuration.
|
|
Install from any of the following locations:
|
|
|
|
- Docker Hub: https://hub.docker.com/r/halverneus/static-file-server/
|
|
- GitHub: https://github.com/halverneus/static-file-server
|
|
|
|
## Configuration
|
|
|
|
### Environment Variables
|
|
|
|
Default values are shown with the associated environment variable.
|
|
|
|
```bash
|
|
# Enables resource access from any domain.
|
|
CORS=false
|
|
|
|
# Enable debugging for troubleshooting. If set to 'true' this prints extra
|
|
# information during execution. IMPORTANT NOTE: The configuration summary is
|
|
# printed to stdout while logs generated during execution are printed to stderr.
|
|
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=
|
|
|
|
# If TLS certificates are set then the minimum TLS version may also be set. If
|
|
# the value isn't set then the default minimum TLS version is 1.0. Allowed
|
|
# values include "TLS10", "TLS11", "TLS12" and "TLS13" for TLS1.0, TLS1.1,
|
|
# TLS1.2 and TLS1.3, respectively. The value is not case-sensitive.
|
|
TLS_MIN_VERS=
|
|
|
|
# List of accepted HTTP referrers. Return 403 if HTTP header `Referer` does not
|
|
# match prefixes provided in the list.
|
|
# Examples:
|
|
# 'REFERRERS=http://localhost,https://...,https://another.name'
|
|
# To accept missing referrer header, add a blank entry (start comma):
|
|
# 'REFERRERS=,http://localhost,https://another.name'
|
|
REFERRERS=
|
|
```
|
|
|
|
### 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').
|
|
|
|
```yaml
|
|
cors: false
|
|
debug: false
|
|
folder: /web
|
|
host: ""
|
|
port: 8080
|
|
referrers: []
|
|
show-listing: true
|
|
tls-cert: ""
|
|
tls-key: ""
|
|
tls-min-vers: ""
|
|
url-prefix: ""
|
|
```
|
|
|
|
Example configuration with possible alternative values:
|
|
|
|
```yaml
|
|
debug: true
|
|
folder: /var/www
|
|
port: 80
|
|
referrers:
|
|
- http://localhost
|
|
- https://mydomain.com
|
|
```
|
|
|
|
## Deployment
|
|
|
|
### Without Docker
|
|
|
|
```bash
|
|
PORT=8888 FOLDER=. ./serve
|
|
```
|
|
|
|
Files can then be accessed by going to http://localhost:8888/my/file.txt
|
|
|
|
### 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
|
|
```
|
|
|
|
### Getting Help
|
|
|
|
```bash
|
|
./serve help
|
|
# OR
|
|
docker run -it halverneus/static-file-server:latest help
|
|
```
|
|
|