a static http server anywhere you need one.
serveis a static http server anywhere you need one.
It's basically
python -m SimpleHTTPServer 8080written in Go, because who can remember that many letters?
net/httpcompatible
servecan be installed in a handful of ways:
If you are using Homebrew on macOS, you can install
servewith the following command:
brew install syntaqx/tap/serve
The official syntaqx/serve image is available on Docker Hub.
To get started, try hosting a directory from your docker host:
docker run -v .:/var/www:ro -d syntaqx/serve
Alternatively, a simple
Dockerfilecan be used to generate a new image that includes the necessary content:
FROM syntaqx/serve COPY . /var/www
Place this in the same directory as your content, then
buildand
runthe container:
docker build -t some-content-serve . docker run --name some-serve -d some-content-serve
docker run --name some-serve -d -p 8080:8080 some-content-serve
Then you can navigate to http://localhost:8080/ or http://host-ip:8080/ in your browser.
Currently,
serveonly supports using the
PORTenvironment variable for setting the listening port. All other configurations are available as CLI flags.
In future releases, most configurations will be settable from both the CLI flag as well as a compatible environment variable, aligning with the expectations of a 12factor app. But, that will require a fair amount of work before the functionality is made available.
Here's an example using
docker-compose.ymlto configure
serveto use HTTPS:
version: '3' services: web: image: syntaqx/serve volumes: - ./static:/var/www - ./fixtures:/etc/ssl environment: - PORT=1234 ports: - 1234 command: serve -ssl -cert=/etc/ssl/cert.pem -key=/etc/ssl/key.pem -dir=/var/www
The project repository provides an example docker-compose that implements a variety of common use-cases for
serve. Feel free to use those to help you get started.
Quickly download install the latest release:
curl -sfL https://install.goreleaser.com/github.com/syntaqx/serve.sh | sh
Or manually download the latest release binary for your system and architecture and install it into your
$PATH.
To build from source, check out the instructions on getting started with development.
serve [options] [path]
[path]defaults to.(relative path to the current directory)
Then simply open your browser to http://localhost:8080 to view your server.
The following configuration options are available:
--hosthost address to bind to (defaults to
0.0.0.0)
--portlistening port (defaults to
8080)
--sslenable https (defaults to
false)
--certpath to the ssl cert file (defaults to
cert.pem)
--keypath to the ssl key file (defaults to
key.pem)
--dirdirectory path to serve (defaults to
., also configurable by
arg[0])
--userspath to users file (defaults to
users.dat); file should contain lines of username:password in plain text
To develop
serveor interact with its source code in any meaningful way, be sure you have the following installed:
Note: While the tooling isn't explicitly required in order to build and run the project, it's for everyone's benefit that you leverage it.
You can download and install the project from GitHub by simply running:
git clone [email protected]:syntaqx/serve.git && cd $(basename $_ .git) make install
This will install
serveinto your
$GOPATH/bindirectory, which assuming is properly appended to your
$PATH, can now be used:
$ serve version serve version v0.0.6-8-g5074d63 windows/amd64
servemanually
Besides running
serveusing the provided binary, you can also embed a
serve.FileServerinto your own Go program:
package mainimport ( "log" "net/http"
"github.com/syntaqx/serve"
)
func main() { fs := serve.NewFileServer() log.Fatal(http.ListenAndServe(":8080", fs)) }
serveis open source software released under the MIT license.
As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained).
As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.