Server configuration for CollabPads

CollabPads is available from BlueSpice 4.5.

Simultaneous editing of pages by multiple users requires some server preparation. For this, MongoDB must be installed.

1. Install MongoDB

Install MongoDB according to the documentation your Linux distribution.

sudo systemctl start mongod
sudo systemctl enable mongod

2. Install php-mongodb

Check the path of your PHP version before you run:

sudo apt install php-devel
sudo pecl install mongodb

echo "extension=mongodb.so" >> /etc/php/8.2/cli/php.ini

3. Install CollabPadsBackendService

cd /opt
wget https://buildservice.bluespice.com/webservices/4.5.x/CollabPadsBackend.tar.gz
tar xzf CollabPadsBackend.tar.gz
cd CollabPadsBackend
cp config.example.php config.php
vim config.php

config.php an:

<?php

return [
	'server-id' => 'mediawiki-collabpads-backend',
	'ping-interval' => 25000,
	'ping-timeout' => 5000,
	'port' => 8099,                //The port you wish to use
	'request-ip' => '127.0.0.1',  //The ip you want to open your service  
	'baseurl' => 'https://yourwikiurl.com', 
	'db-type' => 'mongo',
	'db-host' => '127.0.0.1',   // your MongoDB-Host
	'db-port' => 27017,         // your MongoDB-Port
	'db-name' => 'collabpads',  // your MongoDB-DB-Name
	'db-user' => '',           // MongoDB-Username 
	'db-password' => '',       // MongoDB-Password
	'log-level' => 'INFO',
	'http-client-options' => []
];

sudo vim /etc/systemd/system/collabpad.service

collabpad.service:

[Unit]
Description = BlueSpice-CollabpadsBackend
[Service]
Type = simple
User = www-data
ExecStart =/usr/bin/php /opt/CollabpadsBackend/bin/server.php
StandardOutput = file:/var/log/apache2/collabpad.log
[Install]
WantedBy = default.target

sudo systemctl enable collabpad.service
sudo systemctl start collabpad.service

4. Configure Apache

Add the following lines to your rewrite rules:

RewriteCond %{REQUEST_URI}  ^/_collabpads          [NC]
RewriteCond %{QUERY_STRING} transport=websocket    [NC]
RewriteRule /(.*)           ws://127.0.0.1:8099/$1 [P,L]

Restart apache2:

systemctl restart apache2

You should now be able to choose the editing mode Edit together.

Edit together

---

To submit feedback about this documentation, visit our community forum.