README.md

Knowledge Base

A knowledge base for phpBB: categorised articles in Markdown or BBCode, with revisions, an approval workflow, search, and RSS and Atom feeds.

Features

• Articles in categories, shown as one flat index with a category dropdown (the default) or as a category tree, in each member's board style, with an optional colour stylesheet.
• Articles written in BBCode or Markdown, with attachments, custom fields (a dropdown, radio buttons or a checkbox list, each optionally required) and a plain-text description.
• Private drafts, revisions, and an approval queue where moderators assign, review, approve or reject articles and edits; authors get notifications and, by default, private messages.
• Co-authors, and Change author to hand an article to another member or a Knowledge Base team. Every transfer is logged.
• Article status (draft, pending, pending revision) on article pages, category lists and queues, without showing what a draft says.
• Search with phpBB-style native, MySQL fulltext or PostgreSQL fulltext backends, and a Knowledge Base block in the board's own search results.
• A recent changes page with RSS and Atom feeds, optional comment topics, and an optional changelog forum.
• Its own per-category permissions, managed with the rest of the settings in the ACP.
• An optional introduction above the article index, in BBCode or Markdown.
• Takes over the data of the original sheer/knowledgebase extension, and imports kinerity/knowledgebase.

Screenshots

The flat article index (the default)	Hierarchical category browsing
An article	Knowledge Base block in the board search

More screenshots, including the article form, the approval queue and the ACP settings: docs/images/screenshots.

Requirements

• phpBB 3.3.19 or later; phpBB 4.0 works too (tested with its development version)
• PHP 8.1 or later
• MySQL/MariaDB, PostgreSQL, SQLite or MSSQL

Installation

1. Copy the extension to: /ext/phpbbmodders/knowledgebase
2. In the Administration Control Panel, navigate to: Customise → Manage extensions
3. Enable the Knowledge Base extension
4. Configure it under Extensions → Knowledge Base

The Knowledge Base follows each member's board style. It starts as a flat article index (one list of every article, with a category dropdown); hierarchical category browsing and an optional colour stylesheet (a bundled one, or your own CSS file) are set on the same ACP page; see the styling guide. The same page can switch on a short introduction above the article index, written in BBCode or Markdown; it is off until you switch it on.

A search of the board also shows the matching articles in a Knowledge Base block above the forum results, with an Also search the Knowledge Base option in the advanced search. Switch the block off, or set how many articles it lists, under Extensions > Knowledge Base > Search.

Upgrading from the original sheer/knowledgebase extension? See Upgrading from the original: your data carries over.

Moving from the kinerity/knowledgebase extension? See Moving from kinerity/knowledgebase: enabling this extension imports its categories, articles and permissions.

Attachments are stored under store/phpbbmodders_knowledgebase/files/ in the board's own folder, with the rest of phpBB's data, so they stay when the extension's folder is replaced to upgrade it. The folder is made when the extension is enabled and has its own .htaccess. That only works on Apache - nginx ignores .htaccess entirely, and phpBB's installation notes already ask nginx users to block the store/ folder. If yours does not, add an explicit deny rule for it in your server config, e.g.:

location ~ ^/store/ {
	deny all;
	return 403;
}

Common problems

"The Knowledge Base's upload folders ... could not be made writable automatically"

A red message at the top of Extensions > Knowledge Base > Configuration. The extension keeps attachments, and uploads that are still in progress, in store/phpbbmodders_knowledgebase/files/ and its plupload/ folder, inside phpBB's own store/ folder. It makes them when it is enabled, and again whenever that page opens. It cannot when the web server's user is not allowed to write in store/, which phpBB needs on every board, or in store/phpbbmodders_knowledgebase/ when someone else made that folder first (for example to put a custom stylesheet in it).

Give store/ to the user your web server or PHP runs as (www-data on Debian and Ubuntu, apache on Fedora and CentOS, nginx on some nginx setups), from the board's root folder:

sudo chown -R www-data:www-data store
sudo chmod -R 775 store

Without shell access, set the store folder and everything in it to 775 with your FTP program (777 only if your host allows nothing else). Reload the Configuration page: the message goes away as soon as the folders can be made. Attachments that earlier versions kept in ext/phpbbmodders/knowledgebase/files/ are moved across when the extension is updated; any that could not be moved stay in that folder and keep the old problem, so run the commands above and disable and enable the extension again.

TODO

Ideas not yet built, practical and speculative alike: docs/TODO.md.

Contributing

Contributions are welcome!

• Bug reports: Open an issue.
• Everything else (questions, feature requests, ideas, general discussion): Use Discussions, or the community forum.
• Pull requests are welcome for bug fixes or discussed features. See Testing for the PHPUnit suite and the browser checks.

Acknowledgments

Based on the original knowledgebase extension by sutrus (Zdenek Kamenik), itself building on earlier work by Sheer's Knowledge Base extension.

• Code review, bug fixes, and documentation assisted by Claude.
• Code review, bug fixes, and documentation assisted by Codex.

License

Licensed under the GNU General Public License v2