Skip to content

Commit a1da0f0

Browse files
committed
docs(config): document activity_db* keys for dedicated Activity database
The Activity app's ConnectionFactory call with the 'activity_' prefix has been undocumented in config.sample.php, making the dedicated-DB feature invisible to admins. Add entries for activity_dbhost, _dbname, _dbuser, _dbpassword and _dbdriveroptions with usage notes. AI-Assisted-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 99e960b commit a1da0f0

1 file changed

Lines changed: 55 additions & 0 deletions

File tree

config/config.sample.php

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1439,6 +1439,61 @@
14391439
*/
14401440
'activity_use_cached_mountpoints' => false,
14411441

1442+
/**
1443+
* Dedicated database connection for the Activity app.
1444+
*
1445+
* On busy installations the ``*_activity`` table is often the fastest-growing
1446+
* table in the database. Offloading it to a separate database server or
1447+
* instance reduces I/O contention on the main database.
1448+
*
1449+
* When any of the ``activity_db*`` keys below is present, the Activity app
1450+
* opens a second connection using those values, falling back to the
1451+
* corresponding main-connection value for any key that is omitted. The
1452+
* database type (``dbtype``) and table prefix (``dbtableprefix``) are always
1453+
* inherited from the main connection and cannot be overridden.
1454+
*
1455+
* All four keys must point to a database that already contains the activity
1456+
* tables; run ``occ db:migrate activity`` after setting up the new database.
1457+
*/
1458+
1459+
/**
1460+
* Hostname (and optional port) of the dedicated Activity database server.
1461+
* Port can be appended with a colon, e.g. ``db-activity.example.com:3306``.
1462+
* Defaults to the value of ``dbhost``.
1463+
*/
1464+
// 'activity_dbhost' => '',
1465+
1466+
/**
1467+
* Name of the dedicated Activity database.
1468+
* Defaults to the value of ``dbname``.
1469+
*/
1470+
// 'activity_dbname' => '',
1471+
1472+
/**
1473+
* Username for the dedicated Activity database connection.
1474+
* Defaults to the value of ``dbuser``.
1475+
*/
1476+
// 'activity_dbuser' => '',
1477+
1478+
/**
1479+
* Password for the dedicated Activity database connection.
1480+
* Defaults to the value of ``dbpassword``.
1481+
*/
1482+
// 'activity_dbpassword' => '',
1483+
1484+
/**
1485+
* Low-level PDO driver options for the dedicated Activity database connection,
1486+
* e.g. TLS/SSL parameters for MySQL. Defaults to the value of ``dbdriveroptions``.
1487+
*
1488+
* Example for MySQL with TLS::
1489+
*
1490+
* 'activity_dbdriveroptions' => [
1491+
* PDO::MYSQL_ATTR_SSL_CA => '/etc/ssl/certs/ca-certificates.crt',
1492+
* PDO::MYSQL_ATTR_SSL_VERIFY_SERVER_CERT => true,
1493+
* ],
1494+
*/
1495+
// 'activity_dbdriveroptions' => [],
1496+
14421497
/**
14431498
* Apps
14441499
*

0 commit comments

Comments
 (0)