1
0
mirror of https://gitlab.com/depesz/explain.depesz.com.git synced 2024-11-30 09:06:42 +02:00
explain.depesz.com/explain-json-notes.txt
Hubert depesz Lubaczewski 930f22b1c6 Editorialization of last merge
- change the secret/secrets code so that it will work in both old and new
  Mojolicious versions.
- Add information that perl modules can be installed from distribution
  package repositories, and not neccessarily from cpan
- Add more description to information on config file
- Revert default config to previous state
- Add tests (to be run by explain.pl test) that check for required perl
  modules
2014-10-31 15:55:59 +01:00

38 lines
1.7 KiB
Plaintext

$Id$
$HeadURL$
This file provides comments and documentation to the file "explain.json".
There are values in explain.json that you need to specify
for the operation of your "explain" server.
Why this file?
Because JSON does not support comments, the specification for
JSON format specifically excludes comments,
JSON files may only to contain data. See
http://stackoverflow.com/questions/244777/can-i-comment-a-json-file
title => This is not used, as far as I recall.
secret => This is used to encrypt cookie with
username/password. So it should be long, random
string.
database.dsn => the standard connection information
A) database name (case sensitive),
B) server or host
C) port - standard port for postgresql is 5432
database.username => you created this when you set up a role in
postgresql for this explain server
database.password => the password for database.username (optional)
mail_sender.from => From to be used by mails sent by contact form
mail_sender.to => Address which should receive mails sent by
contact form
mail_sender.subject => Subject for mails from contact form
hypnotoad.pid_file => /var/run is the standard place to store your pid
files; if you do not have access to /var/run,
then create in your home directory a branch
var/run and place it there. Example
~/var/run/explain.pid. Make sure you create the
directories, ~/var/run, before specifying this
alternate location.