Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Tool to generate complex configuration files from simple syntax, especially with multiple different servers.

branch: master
README.md

Webconfig

Description

Webconfig is a tool to generate Virtual Host configuration files for web servers. I use it to manage Apache and Nginx, but I'm sure you could find additional uses for it. It parses a vhost specification file and generates the appropriate server configuration files based on the templates you define (or use mine).

Helpful Diagram

Installation

Basically, just unpack this wherever you want. I like to keep it in /opt/webconfig.

How to use

Have a look at all the files in ./config/. templates.yml specifies all the different configuration templates you'll be plugging data into. It should make a whole lot of sense once you look at the file. Every template will have one or more "content_for_FOO" keys. When you run Webconfig, it concatenates all the content_for_FOO template content, with domain info interpolated, into gen/FOO.gen.conf.

The domain info is pulled from config.yml. I've provided config.sample.yml, which is a configuration I was using on my server at one point. Domains are listed with a number of parameters, each of which is translated into an instance variable before parsing the requested template for the domain.

defaults.yml contains values that should be included as instance variables every time a template is parsed. These will typically be things like server port numbers, etc., but again, you can use it for whatever seems useful.

Note that there's very little or no syntax checking on any of these config files. Be careful.

How to make your servers use the new configuration

For apache, find your httpd.conf. There's very likely a line that says something along the lines of "Include vhosts/*.conf". You can replace that with "Include /opt/webconfig/gen/apache.gen.conf".

For nginx, find your nginx.conf, and add a line somewhere in the http{ } block: "include /opt/webconfig/gen/nginx.gen.conf".

For other servers, you're on your own. Most configuration file syntaxes have some sort of include directive.

License

Released under MIT License by Burke Libbey / Chromium 53.

Something went wrong with that request. Please try again.