README
¶
modern-server
Just a basic http server with some auto config junk that makes spinning up a web server super easy... for me at least. Because like 99% of the time all I want is A) HTTPS with Let's Encrypt B) some custom API handling C) access to static files.
Based on the codez from the simple-httpd project by @briandowns. If you like this project then be a good sport and buy Brian a beer.
Installing
To start using modern-server, install Go and run go get:
$ go get -u github.com/tidwall/modern-server
This will retrieve the library.
Usage
func main() {
server.Main(func(w http.ResponseWriter, r *http.Request) {
fmt.Fprintf(w, "Hello world, it's %s\n", time.Now())
}, nil)
}
Static File Handler
If you want to serve static files:
func main() {
server.Main(func(w http.ResponseWriter, r *http.Request) {
if strings.HasPrefix(r.URL.Path, "/api/"){
// do some custom magic
w.Write([]byte("API command result"))
} else {
// otherwise fallback to handling files
server.HandleFiles(w, r)
}
}, nil)
}
Example
Run the built-in example:
$ go run example/main.go
Then visit http://localhost:8000.
See all the command line options:
$ go run example/main.go --help
example-server version: 0.0.1
Usage: example-server [-p port] [-l domain]
Options:
-h : this help
-v : show version and exit
-g : enable TLS/HTTPS generate and use a self signed certificate
-p port : bind HTTP port (default: 8000)
-l domain : enable TLS/HTTPS with Let's Encrypt for the given domain name.
-c path : enable TLS/HTTPS use a predefined HTTPS certificate
-t port : bind HTTPS port (default: 443, 4433 for -g)
Examples: example-server start example-server. http://localhost:8000
or: example-server -p 80 use HTTP port 80. http://localhost
or: example-server -g enable HTTPS generated certificate. https://localhost:4433
or: example-server -l example.com enable HTTPS with Let's Encrypt. https://example.com
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func HandleFiles ¶
func HandleFiles(w http.ResponseWriter, r *http.Request)
HandleFiles is handler for ... wait for it ... handling files. It just handles static files from your current directory.
Types ¶
type Options ¶
type Options struct {
// Name gives the server binary a name.
Name string
// Version is the version of the server.
Version string
// Init is an optional function that fires after the server is listening
// but before allowing incoming requests.
Init func()
// Flags is an optional function that allows for adding command line flags.
Flags func()
// FlagsParsed is an optional function that fires immediately after flags are parsed.
FlagsParsed func()
// Usage is an optional function that allows for altering the usage text.
Usage func(usage string) string
// Logger is a custom logger
Logger *log.Logger
// Dir is the directory static files. Default is "."
Dir string
// NoFlags disables automated flags and the the help menu
NoFlags bool
// Port bind HTTP port. default is 8000.
Port int
// LetsEncryptDomain enable TLS/HTTPS with Let's Encrypt for the given
// domain name.
LetsEncryptDomain string
}
Options are server options
Source Files
Directories