Configuration

Ecstatic has a single configuration file whose location is given via an environment variable “ECSTATIC_EXPORTS”. The file is parsed using Python3’s configparser module, with each section being processed from top to bottom.

Whenever a request comes in, a section is checked for whether or not it matches. If a match is found, no further sections are examined and the configuration in said section is used to serve the request.

A section matches a request if it

1. Has a match key with a regular expression that matches the request’s path or

2. Has a root section with no match present.

Any other section is ignored.

Examples

A simple configuration that serves content from users public_html-directories (which are assumed to all be inside /home) and /var/www otherwise:

[homes]
# exposes /home/bob/public_html/ on http://example.org/~bob/
match = ^~([a-zA-Z0-9]+)(/.*)?$
fspath = /home/{0}/public_html{1}
root = /home/{0}
dirindex = on

[www]
root = /var/www