summaryrefslogtreecommitdiff
path: root/config.sample.php
diff options
context:
space:
mode:
Diffstat (limited to 'config.sample.php')
-rw-r--r--config.sample.php68
1 files changed, 21 insertions, 47 deletions
diff --git a/config.sample.php b/config.sample.php
index 59e0613..9c1746a 100644
--- a/config.sample.php
+++ b/config.sample.php
@@ -1,54 +1,28 @@
<?php
/**
- * config.php
+ * Copy this file to config.php.
*
- * Configure the Bridge plugins used by this authentication system.
- *
- * Example 1: Use a Drupal 8 site for all hosts.
- *
- * $config['*'][0] = [
- * 'plugin' => 'drupal8',
- * 'config' => [
- * 'root_path' => '/path/to/drupal8',
- * 'site' => 'default',
- * ],
- * ];
- *
- * Example 2: Add a phpBB and MediaWiki subdomain (exact match):
- *
- * $config['forum.example.com'][0] = [
- * 'plugin' => 'phpbb30',
- * 'config => ['root_path' => '/path/to/phpbb'],
- * ];
- * $config['wiki.example.com'][0] = [
- * 'plugin' => 'mediawiki',
- * 'config' => ['root_path' => '/path/to/mediawiki'],
- * ];
- *
- * Example 3: Allow session authentication (see plugins/session/README.md)
- *
- * $config['*'][0] = [
- * 'plugin' => 'phpbb30',
- * 'config => ['root_path' => '/path/to/phpbb'],
- * ];
- * $config['*'][1] = [
- * 'plugin' => 'session',
- * 'config' => [
- * 'mysql' => [
- * 'dsn' => 'mysql:host=localhost;dbname=DATABASE;charset=utf8',
- * 'username' => 'USER',
- * 'password' => 'PASSWORD',
- * 'table' => 'TABLE',
- * ],
- * 'plugin' => 'phpbb30'
- * ],
- * ];
+ * plugin_conf will always require the `root_path` to the CMS you want to
+ * authenticate with. Some systems require additional information; Drupal
+ * needs the site directory (usually `default`).
*/
-$config['*'][0] = [
- 'plugin' => '',
- 'config' => [
- 'root_path' => '',
- ],
+$config = [
+ 'log_path' => 'logs/',
+ 'plugin' => 'PLUGIN',
+ 'plugin_conf' => [
+ 'root_path' => '</path/to/site>',
+ ],
+
+ // Remove this section if you are not using session authentication.
+ 'session' => [
+ 'mysql' [
+ 'dsn' => 'mysql:host=localhost;dbname=DATABASE;charset=utf8',
+ 'username' => 'USER',
+ 'password' => 'PASSWORD',
+ 'table' => 'TABLE',
+ ],
+ 'timeout' => 60,
+ ],
];