clarify [general] host usage a bit

This commit is contained in:
Martin Zimmermann 2014-03-29 12:58:41 +01:00
parent 765a91fefb
commit 0509e15f67
2 changed files with 26 additions and 18 deletions

View File

@ -41,7 +41,7 @@ session key and hostname. Here are the default values for this section:
[general] [general]
dbpath = /tmp/isso.db dbpath = /tmp/isso.db
name = name =
host = http://localhost:8080/ host =
max-age = 15m max-age = 15m
notify = notify =
@ -54,21 +54,22 @@ name
not used otherwise. not used otherwise.
host host
URL to your website. When you start Isso, it will probe your website with Your website(s). If Isso is unable to connect to at least on site, you'll
a simple ``GET /`` request to see if it can reach the webserver. If this get a warning during startup and comments are most likely non-functional.
fails, Isso may not be able check if a web page exists, thus fails to
accept new comments.
You can supply more than one host: You'll need at least one host/website to run Isso. This is due to security
reasons: Isso uses CORS_ to embed comments and to restrict comments only to
your website, you have to "whitelist" your website(s).
I recommend the first value to be a non-SSL website that is used as fallback
if Firefox users (and only those) supress their HTTP referer completely.
.. code-block:: ini .. code-block:: ini
[general] [general]
host = host =
http://localhost/ http://example.tld/
https://localhost/ https://example.tld/
This is useful, when your website is available on HTTP and HTTPS.
max-age max-age
time range that allows users to edit/remove their own comments. See time range that allows users to edit/remove their own comments. See
@ -79,6 +80,9 @@ notify
is available. is available.
.. _CORS: https://developer.mozilla.org/en/docs/HTTP/Access_control_CORS
Moderation Moderation
---------- ----------

View File

@ -10,14 +10,18 @@ dbpath = /tmp/comments.db
# required to dispatch multiple websites, not used otherwise. # required to dispatch multiple websites, not used otherwise.
name = name =
# URL to your website. When you start Isso, it will probe your website with a # Your website(s). If Isso is unable to connect to at least on site, you'll
# simple GET / request to see if it can reach the webserver. If this fails, Isso # get a warning during startup and comments are most likely non-functional.
# may not be able check if a web page exists, thus fails to accept new comments. #
# You can supply more than one host: # You'll need at least one host/website to run Isso. This is due to security
# host = # reasons: Isso uses CORS_ to embed comments and to restrict comments only to
# http://localhost/ # your website, you have to "whitelist" your website(s).
# https://localhost/ #
host = http://localhost/ # I recommend the first value to be a non-SSL website that is used as fallback
# if Firefox users (and only those) supress their HTTP referer completely.
host =
http://example.tld/
https://example.tld/
# time range that allows users to edit/remove their own comments. # time range that allows users to edit/remove their own comments.
# It supports years, weeks, days, hours, minutes, seconds. # It supports years, weeks, days, hours, minutes, seconds.