modern-server

KO | EN

gitlite — search

#react #python #javascript #nodejs #css #swift #c #web #tutorial #jupyter-notebook #node #php

★ 76 Open GitHub ↗

Basic web server framework with HTTP/2 and Let's Encrypt.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# `modern-server`
[![GoDoc](https://img.shields.io/badge/api-reference-blue.svg?style=flat-square)](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
```

modern-server

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README