https://github.com/leelow/serve
📄 🐳 Static file serving and directory listing.
https://github.com/leelow/serve
docker index micro serve server
Last synced: about 2 months ago
JSON representation
📄 🐳 Static file serving and directory listing.
- Host: GitHub
- URL: https://github.com/leelow/serve
- Owner: Leelow
- License: mit
- Created: 2017-10-30T19:39:39.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-10-31T19:24:48.000Z (over 8 years ago)
- Last Synced: 2025-01-15T07:03:34.509Z (over 1 year ago)
- Topics: docker, index, micro, serve, server
- Language: JavaScript
- Homepage:
- Size: 18.6 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# serve
[![Travis Status][travis-image]][travis-url]
[![Docker Status][docker-image]][docker-url]
## Usage
### Pull image
```bash
docker pull leelow29/serve
```
### Options
The default credentials are `user:password`. There are several options to custom with environment variables:
* `SERVE_USER` Redefine login (`user` by default).
* `SERVE_PASSWORD` Redefine password (`password` by default).
* `SERVE_INDEX` Display index page (enabled by default).
* `SERVE_CORS` Setup * CORS headers to allow requests from any origin (enabled by default).
* `SERVE_DELAY` Define a delay (in seconds) to stop the container (disabled by default).
For instance, to disable CORS, set `SERVE_CORS` to `0`.
### Examples
A container which serves directory `/dir/files` with default credentials (user:password).
```bash
docker run --name serve -d -p 443:443 -v /dir/files:/app/files leelow29/serve:latest
```
A container with custom credentials:
```bash
docker run --name serve -d -p 443:443 -v /dir/files:/app/files -e SERVE_USER=admin -e SERVE_PASSWORD=pass leelow29/serve:latest
```
A container which will stop after 5 minutes:
```bash
docker run --name serve -d -p 443:443 -v /dir/files:/app/files -e SERVE_DELAY=300 leelow29/serve:latest
```
## Build
```bash
git clone https://github.com/Leelow/serve.git
cd serve
docker build -t serve .
```
## Credits
This docker image is based on awesome [@leo](https://github.com/leo) work: [https://github.com/zeit/serve](https://github.com/zeit/serve).
## License
[MIT](LICENSE)
[travis-image]: https://travis-ci.org/Leelow/serve.svg?branch=master
[travis-url]: https://travis-ci.org/Leelow/serve
[docker-image]: https://img.shields.io/docker/build/leelow29/serve.svg
[docker-url]: https://hub.docker.com/r/leelow29/serve/