Improve documentation on configurations
Change-Id: I9ea6d4a664e0bd35500dca3d43b01935d764f6d8
diff --git a/README.md b/README.md
index 16dc1c1..1a39dbb 100644
--- a/README.md
+++ b/README.md
@@ -82,9 +82,16 @@
Kalamar will then be available at ```localhost:3000``` in your browser.
By default, Kalamar tries to connect to ```localhost:9999```.
-You may change that endpoint to the KorAP API provider in ```kalamar.conf```.
+You may change that endpoint to the KorAP API provider in in the configuration
+(see [Kustvakt](https://github.com/KorAP/Kustvakt) for further information).
+### Configuration
+
+The basic configuration file is ```kalamar.conf```. To define derivations,
+create a configuration file with the pattern ```kalamar.[MYNAME].conf``` and
+follow the descriptions in ```kalamar.conf```.
+
### Localization
To create a localized version of Kalamar, start the ```localize``` command
diff --git a/kalamar.conf b/kalamar.conf
index f3a51fc..96df587 100644
--- a/kalamar.conf
+++ b/kalamar.conf
@@ -1,4 +1,29 @@
-my $api = 'http://localhost:9999/kustvakt/';
+# This is the base configuration file for Kalamar.
+# Further configurations can override these values.
+# To define a new configuration, create a file in the
+# root folder of your application with the name like
+#
+# kalamar.[MYNAME].conf
+#
+# To load the configuration, start your applikation with
+# the environment variable
+#
+# MOJO_MODE=[MYNAME]
+#
+# Further typical configurations in this file include
+#
+# - hypnotoad
+# See Mojo::Server::Hypnotoad
+# - MailException
+# See Mojolicious::Plugin::MailException
+# - TagHelpers-Pagination
+# See Mojolicious::Plugin::TagHelpers::Pagination
+# - Search
+# See Mojolicious::Plugin::Search
+#
+
+# The default Kustvakt api endpoint
+my $api = 'http://localhost:9999/api/';
{
Search => {
engine => 'Kalamar::API',
@@ -6,14 +31,21 @@
api => $ENV{'KALAMAR_API'} // $api
},
Kalamar => {
+ # Kustvakt server:
api => $ENV{'KALAMAR_API'} // $api,
+
+ # In case, the user management of Kustvakt
+ # is used, make this a true value
auth_support => 0
},
- # Doesn't make much sense when published, but who cares ...
+
+ # See Mojolicious::Plugin::TagHelpers::MailToChiffre
'TagHelpers-MailToChiffre' => {
method_name => 'PArok',
pattern_rotate => 673
},
+
+ # See Mojolicious::Plugin::CHI
CHI => {
default => {
driver => 'FastMmap',