aboutsummaryrefslogtreecommitdiff
path: root/doc/configuration.rst
diff options
context:
space:
mode:
authorChristian Weiske <cweiske@cweiske.de>2011-08-06 10:38:44 +0200
committerChristian Weiske <cweiske@cweiske.de>2011-08-06 10:38:44 +0200
commitd2e437b4db84300e2b543c5827d8f517a81afaef (patch)
tree7863a0a733514684bef0917ccf3ebf3b2a0aac5a /doc/configuration.rst
parent5743a34a6c7757d3030479f96326f09fe5dce0b2 (diff)
parent097ecf9c510e1435d02be7843bc7e865570338ac (diff)
downloadsemanticscuttle-d2e437b4db84300e2b543c5827d8f517a81afaef.tar.gz
semanticscuttle-d2e437b4db84300e2b543c5827d8f517a81afaef.tar.bz2
Merge branch '0.98'
Diffstat (limited to 'doc/configuration.rst')
-rw-r--r--doc/configuration.rst23
1 files changed, 23 insertions, 0 deletions
diff --git a/doc/configuration.rst b/doc/configuration.rst
index f457ebb..c8a8bd9 100644
--- a/doc/configuration.rst
+++ b/doc/configuration.rst
@@ -2,6 +2,8 @@
Configuration files
===================
+.. contents::
+
SemanticScuttle uses at least two configuration files:
1. Default configuration file ``config.default.php``
@@ -56,3 +58,24 @@ per-host configuration files:
- ``data/config.$hostname.php``
- ``/etc/semanticscuttle/config.$hostname.php``
+
+
+Configuration options
+=====================
+``$root`` URL
+-------------
+Normally, this configuration setting is detected automatically and will
+work for both HTTP and HTTPS installations.
+
+If your installation is available on **HTTP only**, then you need to configure
+it.
+
+The value is the full URL to your installation, including a trailing
+slash::
+
+ $root = "http://homepage.example.org/semanticscuttle/";
+
+or::
+
+ $root = "http://bookmarks.example.org/";
+