Redis configureren in phpBB 3.3.x

[Maxstar]

1. Maak een back-up
Voordat je iets gaat wijzigen, dan maak je uiteraard altijd eerst een back-up. Raadpleeg deze handleiding hoe je handmatig een back-up kunt maken en in geval van nood kunt herstellen. Maak tussentijds ook een back-up van het originele bestand dat je gaat wijzigen, zo kan je snel een gewijzigd bestand herstellen zonder een volledige back-up terug te hoeven zetten.

2. Gebruik Notepad++ om bestanden aan te pasen
Kladblok, Wordpad of andere tekstverwerkers zijn niet geschikt om 'script-bestanden' aan te passen, gebruik altijd Notepad++ of vergelijkbare broncode-editor. Mijn favoriet is Notepad++, ik denk dat menigeen die met regelmaat knutselt aan script-bestanden zal dit beamen.

3. Config.php (phpBB)
Het bestand config.php van een phpBB-installatie ziet er als volgt uit. Echter kan het voorkomen dat twee regels afwijken, dit komt met name voor bij phpBB-installaties die al langere tijd draaien en config.php niet is aangepast. Hieronder het verschil tussen een config.php van phpBB 3.0.x en phpBB 3.3.x.

Onder andere $dbms en $acm_type zijn anders gedefinieerd, ook is $phpbb_adm_relative_path toegevoegd. Werk dit bestand gerust eerst bij met de PATH-vermeldingen zoals gedefinieerd in het config.php bestand behorende tot phpBB3.3.x.

Config.php - phpBB 3.0.x

<?php
// phpBB 3.0.x auto-generated configuration file
// Do not change anything in this file!
$dbms = 'mysqli';
$dbhost = 'localhost';
$dbport = '';
$dbname = 'deb*****_phpbb';
$dbuser = 'deb*****_phpbb';
$dbpasswd = '**pass**;
$table_prefix = 'phpbb_';
$acm_type = 'file';

@define('PHPBB_INSTALLED', true);
// @define('DEBUG', true);
// @define('DEBUG_EXTRA', true);
?>

Config.php - phpBB 3.3.x

<?php
// phpBB 3.3.x auto-generated configuration file
// Do not change anything in this file!
$dbms = 'phpbb\\db\\driver\\mysqli';
$dbhost = 'localhost';
$dbport = '';
$dbname = 'deb*****_phpbb';
$dbuser = 'deb*****_phpbb';
$dbpasswd = '**pass**';
$table_prefix = 'phpbb_';
$phpbb_adm_relative_path = 'adm/';
$acm_type = 'phpbb\\cache\\driver\\file';

@define('PHPBB_INSTALLED', true);
@define('PHPBB_ENVIRONMENT', 'production');
// @define('DEBUG_CONTAINER', true);
?>

4. Config.php (phpBB) aanpassen voor Redis
Heb je een up-to-date config.php bestand, dan gaan we deze nu aanpassen. Afhankelijk van de hostingprovider is dit op meerdere manieren in te stellen. Controleer dus vooraf hoe Redis is te configureren, dit kan namelijk via een plugin in DirectAdmin of zonder.

Config.php aanpassen zonder DirectAdmin plugin

Vervang de onderstaande regel in config.php:

$acm_type = 'phpbb\\cache\\driver\\file';

door: (of vervang 'file' in 'redis')

$acm_type = 'phpbb\\cache\\driver\\redis';

Nu verwijst config.php naar de redis-driver in phpBB (../root/phpbb/cache/driver/redis.php)

Voeg nu de onderstaande regels toe aan het config.php-bestand toe.

Pas de 'REDIS_DB' waarde aan als er reeds een een ander Redis-database aanwezig is. (0 - default. Stel je Redis voor meerdere websites (CMS-Systemen) binnen hetzelfde pakket in, dan kun je het beste per website een andere Redis-database aanspreken. Je hebt de keuze uit 0 t/m 15. De gegevens bij REDIS_HOST kunnen per hostingomgeving verschillen, voor de exacte gegevens dien je contact op te nemen met je hostingleverancier.

@define('PHPBB_ACM_REDIS_HOST', '/tmp/redis.sock');
@define('PHPBB_ACM_REDIS_PORT', '0');
@define('PHPBB_ACM_REDIS_DB','0');

1. Kopieer het opgeslagen config.php bestand naar de hostingomgeving via FTP in de 'root' van phpBB.
2. Leeg de cache via het beheerderspaneel van phpBB.

Config.php aanpassen via DirectAdmin plugin

Login bij DirectAdmin en klik bij Advanced Features op RedisCache,
Klik vervolgens op Create RedisCache DB.
Selecteer nu de aangemaakte Redis-server en klik op Get RedisCache DB.



Indien de Redis-configuratie een port en wachtwoord vereist dien je de volgende gegevens aan config.php toe te voegen met de juiste gegeven. Zie bovenstaande afbeelding.

$acm_type = 'phpbb\\cache\\driver\\redis';
@define('PHPBB_ACM_REDIS_HOST', '127.0.0.1');
@define('PHPBB_ACM_REDIS_PORT', '0');
@define('PHPBB_ACM_REDIS_DB','0');
@define('PHPBB_ACM_REDIS_PASSWORD','wachtwoord');

1. Kopieer het opgeslagen config.php bestand naar de hostingomgeving via FTP in de 'root' van phpBB.
2. Leeg de cache via het beheerderspaneel van phpBB.

5. Redis statistieken
Na al het voorgaande is gedaan kan je dit script via githib gebruiken om Redis te monitoren. Pas wel eerst het config gedeelte aan, zie het onderstaande voorbeeld. De juiste setting kan mogelijk afhankelijk zijn van de gebruikte hostingomgeving.

// CONFIG
$servers = array(
    array('Local', 'unix:///tmp/redis.sock', -1),
    // array('Local', '127.0.0.1', 6379),
);
// END CONFIG

• Download redis-stats.php en plaats deze via FTP in 'public_html' of andere locatie in het pakket.
• Raadpleeg dit bestand via: //domeinnaam.nl/redis-stats.php

Indien de Redis-configuratie is ingesteld met een port en wachtwoord kan je ook deze versie van Redis-stats.php gebruiken. Pas in deze versie het config gedeelte als volgt aan met de juiste gegevens.

// Default config
$servers = [
    [ 'Local', '127.0.0.1', 6379 ],
    [ 'Local socket', 'unix:///var/run/redis.sock', -1 ],
    [ 'Local with password', '127.0.0.1', 6379, 'password_here' ],
    [ 'Local with user and password', '127.0.0.1', 6379, ['username', 'password_here'] ],
];