summaryrefslogtreecommitdiff
path: root/config.sample.php
diff options
context:
space:
mode:
Diffstat (limited to 'config.sample.php')
-rw-r--r--config.sample.php76
1 files changed, 51 insertions, 25 deletions
diff --git a/config.sample.php b/config.sample.php
index 14c6153..59e0613 100644
--- a/config.sample.php
+++ b/config.sample.php
@@ -1,28 +1,54 @@
<?php
-/* copy this file to config.php */
+/**
+ * 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'
+ * ],
+ * ];
+ */
-$config['plugin'] = '';
-$config['log_path'] = __DIR__ . '/logs/';
-
-$config['phpbb30'] = array(
- 'root_path' => '' /* path to your phpBB30 installation */,
-);
-
-$config['phpbb31'] = array(
- 'root_path' => '' /* path to your phpBB31 installation */,
-);
-
-$config['drupal7'] = array(
- 'root_path' => '' /* path to your Drupal 7 installation */,
- 'site' => 'default' /* site directory */,
-);
-
-$config['drupal8'] = array(
- 'root_path' => '' /* path to your Drupal 8 installation */,
- 'site' => 'default' /* site directory */,
-);
-
-$config['smf2'] = array(
- 'root_path' => '' /* path to your SMF 2.x installation */,
-);
+$config['*'][0] = [
+ 'plugin' => '',
+ 'config' => [
+ 'root_path' => '',
+ ],
+];