summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Friesel <derf@finalrewind.org>2019-04-16 21:13:14 -0400
committerDaniel Friesel <derf@finalrewind.org>2019-04-16 21:13:14 -0400
commit1150021d2e80f08096620c9f294b2401aeb40aa2 (patch)
tree5e3a69f104bd2cc200ae6d34089788076471987c
parente1e07d5811360bec59d2fb63d8cedb96d4091301 (diff)
add comments to example travelynx.conf
-rw-r--r--examples/travelynx.conf29
1 files changed, 29 insertions, 0 deletions
diff --git a/examples/travelynx.conf b/examples/travelynx.conf
index 6e8c4e1..fe3e960 100644
--- a/examples/travelynx.conf
+++ b/examples/travelynx.conf
@@ -1,14 +1,37 @@
+# vim:ft=perl
+# travelynx.conf must be a valid perl hash reference. String values must be
+# quoted and hash items must end with a comma. You can access environment
+# variables via $ENV, e.g. by writing $ENV{TRAVELYNX_DB_HOST} instead of
+# 'localhost'.
+
{
+ # Cache directories for schedule and realtime data. Mandatory. The parent
+ # directory ('/var/cache/travelynx' in this case) must already exist.
cache => {
schedule => '/var/cache/travelynx/iris',
realtime => '/var/cache/travelynx/iris-rt',
},
+
+ # Database configuration. host and port are optional
+ # (defaulting to localhost:5432), the rest is mandatory.
db => {
host => 'localhost',
+ port => 5432,
database => 'travelynx',
user => 'travelynx',
password => die("Changeme!"),
},
+
+ mail => {
+ # If you want to disable outgoing mail for development purposes,
+ # uncomment the following line. Mails will instead be logged as
+ # Mojolicious "info" messages, causing their content to be printed on
+ # stdout.
+ ## disabled => 1,
+ },
+
+ # See the Mojo::Server::Hypnotoad manual for details on the following
+ # settings.
hypnotoad => {
accepts => 100,
clients => 10,
@@ -17,8 +40,14 @@
workers => 2,
spare => 2,
},
+
+ # Secrets used for cookie signing and verification. Must contain at least
+ # one random string. If you specify several strings, the first one will
+ # be used for signing new cookies, and the remaining ones will still be
+ # accepted for cookie validation.
secrets => [
die("Changeme!"),
],
+
version => qx{git describe --dirty} // 'experimental',
};