https://github.com/tidwall/modern-server
Basic web server framework with HTTP/2 and Let's Encrypt.
https://github.com/tidwall/modern-server
Last synced: 9 months ago
JSON representation
Basic web server framework with HTTP/2 and Let's Encrypt.
- Host: GitHub
- URL: https://github.com/tidwall/modern-server
- Owner: tidwall
- License: apache-2.0
- Created: 2018-01-31T01:29:18.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2022-06-23T13:36:37.000Z (over 3 years ago)
- Last Synced: 2025-04-05T03:12:12.279Z (9 months ago)
- Language: Go
- Homepage:
- Size: 26.4 KB
- Stars: 76
- Watchers: 6
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# `modern-server`
[](https://godoc.org/github.com/tidwall/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](https://github.com/briandowns/simple-httpd) project by [@briandowns](https://github.com/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
```go
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:
```go
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](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
```