This repository has been archived by the owner. It is now read-only.
[MOVED] See github.com/lestrrat-go/server-starter
Go Shell
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
cmd/start_server
listener
releng
.gitignore
.travis.yml
Changes
LICENSE
README.md
env.go
env_test.go
starter.go
starter_any.go
starter_test.go
starter_windows.go

README.md

go-server-starter

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

WARNING

This repository has been moved to github.com/lestrrat-go/server-starter. This repository exists so that libraries pointing to this URL will keep functioning, but this repository will NOT be updated in the future. Please use the new import path.

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