serv

README

Serv

A server that easily lets you serve over HTTPS, clone and serve git repositories, static files, setup redirects, execute commands, and create reverse proxies, use multiple subdomains. Once installed (go install github.com/minond/serv), create a Servfile file that is made up of server declaration with its paths, handlers, and any information needed to create the handler.

Example configuration

# Define ssl information, like Let's Encrypt cache location and domains to
# whitelist. This is required when subdomains are in use.
def cache ./cache

def domains [ minond.co www.minond.co
              minond.xyz www.minond.xyz
              dearme.minond.xyz cp.minond.xyz txtimg.minond.xyz ]

# Handle incoming requests to txtimg.*.*
case Host(txtimg, _, _) =>
  path /             proxy(http://localhost:3002)

# Handle incoming requests to dearme.*.*
case Host(dearme, _, _) =>
  path /             proxy(http://localhost:3003)

# Handle incoming requests to cp.*.*
case Host(cp, _, _) =>
  path /             proxy(http://localhost:3004)

# Handle any incoming request
case Host(_, _, _) =>
  path /             git(https://github.com/minond/minond.github.io.git)
  path /brainfuck    git(https://github.com/minond/brainfuck.git)
  path /brainloller  git(https://github.com/minond/brainloller.git)
  path /servies      git(https://github.com/minond/servies.git)

With this configuration, serv will checkout all repositories and serve them along with serving or proxying anything else you tell it to. Run serv in a directory with your Servfile and you're done.

Additional options

-certCache string
      Path to Let's Encrypt cache file. Use this along with the cache definition.
-certDomain value
      Domain(s) whitelist. Use this along with the domains definition.
-config string
      Path to Servfile file. (default "./Servfile")
-listen string
      Host and port to listen on. (default ":3002")
-pullInterval duration
      Interval git repos are pulled at. (default 15m0s)

Updates to configuration file

The configuration file is checked for updates every 60 seconds. On updates to handlers and their paths, the supervisor is re-created with the updated configuration. Note that a restart is required if new domains are added to the TLS whitelist (domains variable) or a new cache is used (cache variable).

Listening on privileged ports

Instead of running server as root (in order to bind to a privileged port, like 80 and 443) one could give the serv binary permission to bind to those ports using the setcap command:

sudo setcap 'cap_net_bind_service=+ep' $(which serv)

Editors and plugins

I created a vim plugin for Serv, https://github.com/minond/vim-serv. Right now it only offers syntax highlighting.