expand description of SELF_URL_PATH, set sanity check (closes #384)

2 files changed, 9 insertions, 3 deletions

diff --git a/config.php-dist b/config.php-dist
index 5052e9573..7ecbad7fe 100644
--- a/config.php-dist
+++ b/config.php-dist
@@ -7,9 +7,11 @@
 	define('DB_PASS', "XXXXXX");
 	//define('DB_PORT', '5432'); // when neeeded, PG-only
 
-	define('SELF_URL_PATH', 'http://local.host/tt-rss');
-	// Full URL of your tt-rss installation. You need to set this option
-	// correctly for tt-rss to function properly.
+	define('SELF_URL_PATH', 'http://yourserver/tt-rss/');
+	// Full URL of your tt-rss installation. This should be set to the
+	// location of tt-rss directory, e.g. http://yourserver/tt-rss/
+	// You need to set this option correctly otherwise several features
+	// including PUSH, bookmarklets and browser integration will not work properly.
 
 	define('SINGLE_USER_MODE', true);
 	// Operate in single user mode, disables all functionality related to
diff --git a/sanity_check.php b/sanity_check.php
index 0c803d883..3e5c09803 100644
--- a/sanity_check.php
+++ b/sanity_check.php
@@ -111,6 +111,10 @@
 		$err_msg = "config: DEFAULT_UPDATE_METHOD should be either 0 or 1.";
 	}
 
+	if (SELF_URL_PATH == "http://yourserver/tt-rss/") {
+		$err_msg = "config: please set SELF_URL_PATH to the correct value.";
+	}
+
 	if (!is_writable(ICONS_DIR)) {
 		$err_msg = "config: your ICONS_DIR (" . ICONS_DIR . ") is not writable.\n";
 	}