phpbb / quickinstall

QuickInstall is a tool to quickly install and manage multiple phpBB installations for use in the development of Extensions.

QuickInstall

QuickInstall is a tool we built to support the community of phpBB extension developers (and previously MOD authors). It simplifies and accelerates the process of creating and configuring local phpBB3 forum installations. These boards can then be used to safely install, develop and test extensions in isolation without having to worry about external conflicts.

⚠️ QuickInstall is not intended for use on a live production website.

QuickInstall stores all board and database passwords in a plain text file. They are hidden in the user interface, but can be read by anyone with access to the QuickInstall directory. Therefore, if you do use QuickInstall on a public server, you do so at your own risk and must protect access to the directory where it resides from unauthorised users. No support is provided for QuickInstall other than local use.

📦 Installation

1. Get the latest version of QuickInstall.

2. Extract it and copy the quickinstall folder to your local web server.

3. Download a copy of phpBB3. Extract it and copy the phpBB3 folder to quickinstall/sources/.

4. Point your web browser to the QuickInstall directory (http://localhost/quickinstall for instance) and follow the setup instructions.

Alternate phpBB Profiles:
You can store additional versions of phpBB and boards with alternate styles or language packs in sources/phpBB3_alt/ . You can name these alternate phpBB folders whatever you want, e.g.: sources/phpBB3_alt/phpBB-3.0.12, sources/phpBB3_alt/phpBB-sv, etc. They will then be available as alternative phpBB3 boards you can choose to install or save as Profiles. Past releases of phpBB can be downloaded here.

Adding phpBB Extras:
If you want additional files/folders, such as extensions, to be copied to your boards when they are created, you can put them in the sources/extra/ directory. By using the same directory structure in sources/extra/ as phpBB, the files/folders should be mapped to the correct locations in your boards. For example: sources/extra/ext/phpbb/pages.

🛠 Upgrading

1. Get the latest version of QuickInstall and extract it.

2. Copy everything into your existing QuickInstall directory except for the 📁boards/, 📁sources/ and 📁settings/ directories.

If you are upgrading from QuickInstall 1.1.8 (or older) you MUST review and re-save your old Profile settings.

💻 Requirements

Browsers

QuickInstall is designed to run on all modern browsers. Please don't use old stuff anymore...seriously.

Desktop:	60+	60+	12+	80+	40+
Mobile:	12+	6+

phpBB Requirements

phpBB boards require a web server running PHP and one of the following database management systems.

phpBB	PHP	MySQL	MariaDB	PostgreSQL	SQLite	MS SQL
4.0.x (alpha)	7.3.0 - 8.x	4.1.3+	5.1+	8.3+	SQLite 3.6.15+	Server 2000+
3.3.x	7.1.3 - 8.x	4.1.3+	5.1+	8.3+	SQLite 3.6.15+	Server 2000+
3.2.2 - 3.2.x	5.4.7 - 7.2.x	3.23+	5.1+	8.3+	SQLite 3.6.15+	Server 2000+
3.2.0 - 3.2.1	5.4.7 - 7.1.x	3.23+	5.1+	8.3+	SQLite 3.6.15+	Server 2000+
3.1.x	5.4.7 - 5.6.x	3.23+	5.1+	8.3+	SQLite 2 or 3	Server 2000+
3.0.x	5.4.7 - 5.6.x	3.23+	-	7.x	SQLite 2	Server 2000

🐞 Support

You can receive support at the phpBB3 QuickInstall Discussion/Support forum.

Please report all bugs to our Issues Tracker. Even reports for small bugs are welcome to help make QuickInstall even better than it is now.

👋 Contributing

Feel free to contribute to this project. Please read our Contributing Guidelines before submitting Pull Requests with any bug fixes or feature enhancements to this repository.

💖 Credits

The project is maintained by the phpBB Extensions Team.

• Credits go to the phpBB team, especially the development team which created such a wonderful piece of software.
• Originally created by Igor “igorw” Wiedler in the summer of 2007.
• Maintained by Jari “tumba25” Kanerva from March 2010 to March 2015.
• Thanks to the phpBB.com MOD team (especially Josh, aka “A_Jelly_Doughnut”) for AutoMOD.
• Thanks to the beta testers!
• Thanks to the phpBB community including phpBB.com, startrekguide.com and phpBBModders.net!

📜 License

phpBB QuickInstall is distributed under the terms of the GNU General Public License 2 (GPL).

quickinstall's Issues

Error installing 3.2.0-b2 - /quickinstall/index.php?page=create

[QI Debug] PHP Warning: in file C:/EasyPHP-DevServer-14.1VC11/data/localweb/quickinstall/includes/functions_install.php on line 166: file_get_contents(boards/302b2pl1/install/schemas/schema_data.sql): failed to open stream: No such file or directory
[QI Debug] PHP Notice: in file C:/EasyPHP-DevServer-14.1VC11/data/localweb/quickinstall/sources/phpBB3_alt/302b2-pl1/phpbb/textformatter/s9e/factory.php on line 491: Undefined index: attachment

Catchable fatal error: Argument 1 passed to phpbb\textformatter\s9e\factory::merge_templates() must be of the type array, null given, called in C:\EasyPHP-DevServer-14.1VC11\data\localweb\quickinstall\sources\phpBB3_alt\302b2-pl1\phpbb\textformatter\s9e\factory.php on line 491 and defined in C:\EasyPHP-DevServer-14.1VC11\data\localweb\quickinstall\sources\phpBB3_alt\302b2-pl1\phpbb\textformatter\s9e\factory.php on line 583

Note: i called

302b2-pl1

the source for my conveniences.
it is a 3.2.0-b2 source (download package).

I am using the release 1.2.2 - (https://github.com/phpbb/quickinstall/releases/latest)

No connection to postgreSQL database

As described in Broken install with postgreSQL, unable to view documents, no connection with postgreSQL can be established.

My localhost environment is running postgreSQL with phpBB 3.1.10 and 3.2.0, there are no issues. This problem is isolated to quickinstall.

Here is the stack trace:

The pgsql dbms is either not supported, or the php extension for it could not be loaded.

BACKTRACE

FILE: [ROOT]/includes/qi_functions.php
LINE: 533
CALL: trigger_error()

FILE: [ROOT]/modules/qi_manage.php
LINE: 75
CALL: db_connect()

FILE: [ROOT]/includes/functions_module.php
LINE: 52
CALL: qi_manage->__construct()

FILE: [ROOT]/index.php
LINE: 296
CALL: module_handler->load()

Environment:

PostgreSQL 9.5.6 on x86_64-redhat-linux-gnu, compiled by gcc (GCC) 6.3.1 20161221 (Red Hat 6.3.1-1), 64-bit
PHP Version 5.6.29

4.0.0 compatibility

Argument 2 passed to phpbb\finder::__construct() must be an instance of phpbb\cache\service or null, string given

PHP closing tag into config.php

Not so important, nitpicking here.
QI puts a PHP closing tag instead of a blank new line into the config.php file.

AutoMOD install sets colums types as blob instead of text

mediumtext => mediumblob
text => blob
varchar => varbinary

Layout issue on tab "boards"

Hi,

In some screen resolution, the "Note" will not display as expected...
See screenshot below, it's better than my English :)

Regards.

Error with full text native

On fresh install of 3.2.5

Fatal error: Uncaught Error: Call to a member function trigger_event() on null in F:\xampp7\htdocs\qi\sources\phpBB3_alt\phpBB325\phpbb\search\fulltext_native.php:1466 Stack trace: #0 F:\xampp7\htdocs\qi\modules\qi_create.php(574): phpbb\search\fulltext_native->index('post', '1', 'This is an exam...', 'Welcome to phpB...', '2', '2') #1 F:\xampp7\htdocs\qi\includes\functions_module.php(52): qi_create->__construct() #2 F:\xampp7\htdocs\qi\index.php(296): module_handler->load('create', 'qi_main') #3 {main} thrown in F:\xampp7\htdocs\qi\sources\phpBB3_alt\phpBB325\phpbb\search\fulltext_native.php on line 1466

[Rhea] config.php creation doesn't correctly handle backslashes

https://www.phpbb.com/community/viewtopic.php?p=14581876#p14581876

FOUNDER should be the first joined

As per the title, the founder is known to be.... the founder. ;)

PHP Warning: in file /includes/qi_functions.php on line 247: Undefined array key ""

PHP 8.0.2

The image speaks books. Just launch QI without having a copy of the phpBB3 folder into the QuickInstall‘s sources directory.

[1.3.x] lang keys unused?

Hi,

Some lang keys don't seem to be used.

DELETE_PROFILE_EXPLAIN
QI_MANAGE_ABOUT
RETURN_MAIN
RETURN_MANAGE

PHP 8 support

Because I'm an early adopter I'm trying this out on a CentOS Linux release 7.9.2009 (Core) server that has PHP 8.0.2 installed via https://rpms.remirepo.net/wizard/

php -v shows:

PHP 8.0.2 (cli) (built: Feb  2 2021 19:28:42) ( NTS gcc x86_64 )
Copyright (c) The PHP Group
Zend Engine v4.0.2, Copyright (c) Zend Technologies

QuickInstall installed properly and generally seems to work with PHP 8 but I'm running into one PHP Warning consistently.

[QI Debug] PHP Warning: in file /var/www/html/qi/includes/settings.php on line 144: Undefined array key "no_dbpasswd"

I can use QI to create a phpBB 3.3.3 board but it won't redirect to the board, the error is:

[QI Debug] PHP Warning: in file /var/www/html/qi/includes/settings.php on line 144: Undefined array key "no_dbpasswd"
{"redirect":"boards\/Test\/"}

If I reload the QI main page I can see the new board and the link to it works. Deleting the board also works.

Otherwise so far so good.

Directory name missing letters

I'm using 1.2.1-RC1 since today, downloaded the master from here. There is some strange behavior, I give up a directory name like FriendsFoes but QI makes it like riendsoes. I made some other boards as well where QI missed/leaved some letters in the directory name.

Compatibility with phpBB 4 / Doctrine

Quickinstall is no longer working with phpBB 4 because of the switch to using Doctrine as the DBAL.

The problems arise during the qi_create module. Currently the install container seems to have a NULL connection to the DBAL.

Chunk settings - sytle issue

@ Manage board Tab

/index.php?page=main

» Populate options » see:

Warning php 7.2

I got this on quickinstall index:

[QI Debug] PHP Warning: in file C:/xampp72/htdocs/quickinstall/cache/tpl_qi_overall_header.html.php on line 70: sizeof(): Parameter must be an array or an object that implements Countable

phpBB 3.2.11 and PHP 7.2.34 install goes in loop forever.

Using the master branch.

---

Attempting to install phpBB 3.2.11 with PHP 7.2.34.

After 10 minutes (with win10-64 and SSD HD) still keeps loading something, no error logs.

Quick Install Incompatible with phpBB 3.1.5

phpBB 3.1.5 added $phpbb_dispatcher to \phpbb\search\fulltext_native
https://github.com/phpbb/phpbb/blob/3.1.x/phpBB/phpbb/search/fulltext_native.php#L107

So Quickinstall dies on installing a 3.1.5 board with an error about missing the $phpbb_dispatcher argument here:
https://github.com/phpbb/quickinstall/blob/master/modules/qi_create.php#L536

QuickInstall 1.6.7 and 1.6.8 loops infinitely

Both versions do not end installation of a new QI installation with phpBB3.3.7 (not tested with other versions).
"We’re working on it...
This may take a few minutes.
loops infinitely, with default settings and also with custom settings.

The new board is made correctly and is populated as intended but the QI process has to be terminated manually. The QI made boards are 100% functional.

Inspector shows
Uncaught TypeError: xhr.response is null
ajaxSubmit http://localhost/QI/style/assets/js/scripts.js?v=1.6.8:55

and there's also

scripts.js:55:11
Cookie “phpbb3_zxlnr_u” has been rejected because it is already expired. index.php
Cookie “phpbb3_zxlnr_sid” has been rejected because it is already expired. index.php

js is not blocked on my system
php version = 8.0.3

Feature request - Board's start date

If possible, to add the option to decide the board's start date and while being populated to random fill the user post time according to that.
Thanks.

[Minor-Bug] Displaying Error when no boards are installed.

This is a minor bug produced when no boards are installed hence displaying an Err0r :

[QI Debug] PHP Warning: in file   
S:/xampp/htdocs/quickinstall/cache/tpl_qi_overall_header.html.php  on line  70 :   
sizeof(): Parameter must be an array or an object that implements Countable    

ScreenShot :

EDIT: Forgot to mention the version which is quickinstall-1.3.3 .

Thank you for the valuable Tool. 😍

Best regards 👍

Wrong posts count on index

Despite the statistic and the total posts of members are right, the one displayed on index is not.

Creating a phpBB 3.3.1 board on QI 1.5.0 with php >7.2 fails

QI starts up seemingly without problems but when starting the creation of a 3.3.1 board it errors out.
Standard creation of a 3.3.1 board using the phpBB install interface works without any problem
Tried with USBWebserver 8.6.5 (php 7.4.3) and Wampserver (php 7.3.21 and 7.4.9)

example of error message:
Fatal error: Uncaught Error: Call to undefined function can_load_dll() in E:\USBW74\root\QI\modules\qi_create.php:403 Stack trace: #0 E:\USBW74\root\QI\includes\functions_module.php(52): qi_create->__construct() #1 E:\USBW74\root\QI\index.php(248): module_handler->load('create', 'qi_main') #2 {main} thrown in E:\USBW74\root\QI\modules\qi_create.php on line 403

Edit: reinstalled Wampserver and now creation of a 331 board with php 7.3.21 work flawlessly (with MySQL 8.0.21 - still needs further testing as I forgot to install earlier version of MySQL

NRUsers - INACTIVE - are missing

I have never been able to get some NRU into my multiple installations (3.0, 3.1, 3.2 now too).

I sat ie.: 10 users total (with admins and mods) but 3 NRU, always.
edit: those 3 are in NRU but I do not have INACTIVE users.

Any clue? Has been also this tested?

General Error when attempting to instal PHPBB 3.2.2 through EasyPHP

First time trying anything like is.
Attempting to create a board and keep getting this.

General Error
SQL ERROR [ mysql_41 ]

Access denied for user 'AdminQI'@'localhost' (using password: YES) [1045]

BACKTRACE

FILE: [ROOT]/sources/phpBB3/phpbb/db/driver/driver.php
LINE: 996
CALL: trigger_error()

FILE: [ROOT]/includes/db/31/mysqli.php
LINE: 46
CALL: phpbb\db\driver\driver->sql_error()

FILE: [ROOT]/includes/qi_functions.php
LINE: 561
CALL: dbal_mysqli_qi->sql_connect()

FILE: [ROOT]/modules/qi_create.php
LINE: 239
CALL: db_connect()

FILE: [ROOT]/includes/functions_module.php
LINE: 52
CALL: qi_create->__construct()

FILE: [ROOT]/index.php
LINE: 296
CALL: module_handler->load()

.git directories not deleted

As per the title, the .git directories are not being deleted while using the "delete board" button.
Results in the board still present in the main page and also the DB related.

I.E.: "...boards/tpotm/ext/threedi/tpotm/.git/objects/pack/pack-10d5387e64..etc...."

Being I guess this Tool used mosly by developers should do that, IMHO.
I will look in the code if I can be of any help, when I get some spare time.

created NRU group has more members than board settings

When creating a board with QI, members of the NRU are created with more posts than the threshold for removal from the NRU.

[1.3.x] "is required" on Boards tab

Hi,

The mention "(!) is required" should be displayed on sidebar of the Boards tab.

The settings "Install subsilver2" are not supported when creating a phpBB 3.1

Hi,

When we create a phpBB 3.1.x board with the settings "Install Subsilver2" defined to "Yes" or "Yes, default", the Subsilver2 style is always defined as uninstalled.

It works fine with phpBB 3.0.x.

PHPBB_DISPLAY_LOAD_TIME has been removed in 3.3

Still is present in 3.3 installs, see: config.php

quickinstall/modules/qi_create.php

Lines 223 to 236 in 5db582d

	if (defined('PHPBB_32'))
	{
	$config_data .= "@define('PHPBB_ENVIRONMENT', 'production');\n";
	}
	if (defined('PHPBB_31'))
	{
	$config_data .= "//@define('DEBUG_CONTAINER', true);\n";
	$config_data .= "@define('PHPBB_DISPLAY_LOAD_TIME', true);\n";
	}
	else
	{
	$config_data .= "@define('DEBUG_EXTRA', true);\n";
	$config_data .= '?' . '>'; // Done this to prevent highlighting editors getting confused!
	}

incorrect "Script path" in "Server settings"

Hi tumba,

In ACP >> General >> Server settings, there is a double / at the beginning of the script path.
eg : //boards/testing instead of /boards/testing

3.3.0 compatibility

Tried with the current branch 3.3.0-dev, just to test.

Uncaught Error: Class 'phpbb\db\driver\sqlite' not found in C:\wamp64\www\QI\includes\functions_install.php on line 143

Additional board config settings

Latest master branch in use here

Only the first entry is working.

I used

session_length;888888
load_birthdays;0

and the last line is being ignored.

PHP 7 compatibility

Got some warnings running QI on PHP 7 that will need to be tended to at some point:

Deprecated: Methods with the same name as their class will not be constructors in a future version of PHP; settings has a deprecated constructor in C:\xampp\htdocs\qi\includes\class_qi_settings.php on line 22

Deprecated: Methods with the same name as their class will not be constructors in a future version of PHP; template_compile has a deprecated constructor in C:\xampp\htdocs\qi\includes\template.php on line 637

Documentation tab broken

Somewhere along the way, readme.txt was moved/renamed to readme.md. This means breaks the Documentation (qi/index.php?page=docs) page.

Search index deletion fails on phpBB Native Fulltext

Although the message claims that it has been deleted, this is not true. All other types work.

Tested on 3.2, 3.3, 4.0

Win10-64
Wampserver the latest
PHP version = those appropriated to the phpBB under test.
MySql 8.0.23

PHP 8 - The new board is not populated

Quick install 1.6.2

It works using PHP 7.4.x.
Using the same options and just clicking on quick install with PHP 8.0.6 fails creating a forum with only the founder and 1 post.

• PHP 8.0.6
• MySQL(i) 8.0.23
• Win10 - 64
• Wampserver 3.2.5 - 64

Error logs are empty.

---

[1.3.x] Lang key "INSTALL_STYLES_EXPLAIN" bad directory reference.

Hi,

The directory sources/styles/ quoted in the lang key INSTALL_STYLES_EXPLAIN doesn't exist.

Does it should be sources/phpBB3/styles/?

Error installing 3.2.0-RC1

[QI Debug] PHP Notice: in file C:/easyphp161/eds-www/QI/includes/functions_populate.php on line 531: Undefined index: TEST_FORUM_NAME
[QI Debug] PHP Notice: in file /includes/message_parser.php on line 1198: Undefined index: TOO_FEW_CHARS
[QI Debug] PHP Notice: in file /includes/acp/acp_forums.php on line 970: Undefined index: FORUM_NAME_EMPTY

BACKTRACE

FILE: [ROOT]/includes/functions_populate.php
LINE: 583
CALL: trigger_error()

FILE: [ROOT]/includes/functions_populate.php
LINE: 515
CALL: populate->_create_forums()

FILE: [ROOT]/includes/functions_populate.php
LINE: 172
CALL: populate->create_forums()

FILE: [ROOT]/modules/qi_create.php
LINE: 840
CALL: populate->populate()

FILE: [ROOT]/includes/functions_module.php
LINE: 52
CALL: qi_create->__construct()

FILE: [ROOT]/index.php
LINE: 296
CALL: module_handler->load()

Search problems

Not sure why but posts generated by QI are malformed when searched for:

note <t> and <br>.

Distinct use of the extra folder

Hello, first off thx for the new release.. looks really modern/nice and fast. 👍

One question: I use the extra folder to add extensions to the newly created boards as usual
(see: extra/ext/... extensions here ..)

Is it already available an option/shortcut which allows me to use that folder based on the phpBB version?

See..
(extra/language/ ... extra langs for 3.1/3.2)
or
(extra/styles/ .. extra styles for 3.1/3.2)

Broken Manage Profiles layout

Cosmethical issue here..