Go port of start_server utility (Server::Starter)
Go Shell
Latest commit f9cb0b0 Dec 26, 2016 @lestrrat committed on GitHub Merge pull request #12 from syohex/typo
Fix typo
Permalink
Failed to load latest commit information.
cmd/start_server Fix typo Dec 26, 2016
listener gofmt May 29, 2015
releng Add releng files Jan 5, 2015
.gitignore Initial commit Dec 1, 2014
.travis.yml
Changes version++ Jan 5, 2015
LICENSE
README.md Fix typo Dec 26, 2016
env.go refactor some more May 29, 2015
env_test.go
starter.go
starter_any.go gofmt May 29, 2015
starter_test.go Make to normalize signal names like "SIGTERM" or "term". Nov 24, 2016
starter_windows.go Add status file support, rework signals Jan 4, 2015

README.md

go-server-starter

Go port of start_server utility (a.k.a. Server::Starter).

DESCRIPTION

note: this description is almost entirely taken from the original Server::Starter module

The start_server utility is a superdaemon for hot-deploying server programs.

It is often a pain to write a server program that supports graceful restarts, with no resource leaks. Server::Starter solves the problem by splitting the task into two: start_server works as a superdaemon that binds to zero or more TCP ports or unix sockets, and repeatedly spawns the server program that actually handles the necessary tasks (for example, responding to incoming connections). The spawned server programs under start_server call accept(2) and handle the requests.

To gracefully restart the server program, send SIGHUP to the superdaemon. The superdaemon spawns a new server program, and if (and only if) it starts up successfully, sends SIGTERM to the old server program.

By using start_server it is much easier to write a hot-deployable server. Following are the only requirements a server program to be run under start_server should conform to:

  • receive file descriptors to listen to through an environment variable - perform a graceful shutdown when receiving SIGTERM

Many PSGI servers support this. If you want your Go program to support it, you can look under the listener directory for an implementation that also fills the net.Listener interface.

INSTALLATION

go get github.com/lestrrat/go-server-starter/cmd/start_server