Clarify some frequently encountered issues in config.php.

thijskh · thijskh · commit e2fbf1ab906d · 2023-01-19T20:07:47.000Z
Clarify https and baseurlpath even more.

Also mention under logging how this relates to loggingdir above.
diff --git a/config/config.php.dist b/config/config.php.dist
@@ -24,6 +24,8 @@ $config = [
      *
      * The full url format is useful if your SimpleSAMLphp setup is hosted behind
      * a reverse proxy. In that case you can specify the external url here.
+     * Specifying the full URL including https: will let SimpleSAMLphp know
+     * that it runs on HTTPS even if the backend server is plain HTTP.
      *
      * Please note that SimpleSAMLphp will then redirect all queries to the
      * external url, no matter where you come from (direct access or via the
@@ -340,6 +342,9 @@ $config = [
      *
      * Options: [syslog,file,errorlog,stderr]
      *
+     * If you set the handler to 'file', the directory specified in loggingdir above
+     * must exist and be writable for SimpleSAMLphp. If set to something else, set
+     * loggingdir above to 'null'.
      */
     'logging.level' => SimpleSAML\Logger::NOTICE,
     'logging.handler' => 'syslog',

Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,8 @@ $config = [`
`24`	`24`	`*`
`25`	`25`	`* The full url format is useful if your SimpleSAMLphp setup is hosted behind`
`26`	`26`	`* a reverse proxy. In that case you can specify the external url here.`
	`27`	`+ * Specifying the full URL including https: will let SimpleSAMLphp know`
	`28`	`+ * that it runs on HTTPS even if the backend server is plain HTTP.`
`27`	`29`	`*`
`28`	`30`	`* Please note that SimpleSAMLphp will then redirect all queries to the`
`29`	`31`	`* external url, no matter where you come from (direct access or via the`
`@@ -340,6 +342,9 @@ $config = [`
`340`	`342`	`*`
`341`	`343`	`* Options: [syslog,file,errorlog,stderr]`
`342`	`344`	`*`
	`345`	`+ * If you set the handler to 'file', the directory specified in loggingdir above`
	`346`	`+ * must exist and be writable for SimpleSAMLphp. If set to something else, set`
	`347`	`+ * loggingdir above to 'null'.`
`343`	`348`	`*/`
`344`	`349`	`'logging.level' => SimpleSAML\Logger::NOTICE,`
`345`	`350`	`'logging.handler' => 'syslog',`