phpMyFAQ is an open-source, multilingual, database-driven FAQ web application. It provides a comprehensive content management system for creating and managing FAQs, targeting users who need a robust and customizable solution for organizing and presenting frequently asked questions. The application offers extensive features for content management, user permissions, search, and integration with various backend systems.

How It Works

phpMyFAQ is built with PHP 8.3+ and supports a wide range of databases including MySQL, PostgreSQL, and Microsoft SQL Server. It employs a flexible architecture that allows for real-time search integration with Elasticsearch and OpenSearch. Key features include a WYSIWYG editor, media manager, multi-user support with granular permissions, content negotiation, responsive HTML5/CSS3 templates, PDF generation, and various SEO enhancements.

Quick Start & Requirements

• Installation: Download from phpmyfaq.de, unzip, and navigate to the /setup/ directory in your browser.
• Requirements: PHP 8.3+, a supported database (MySQL, MariaDB, Percona Server, PostgreSQL, Microsoft SQL Server, SQLite3). For Elasticsearch/OpenSearch integration, Elasticsearch v6+ or OpenSearch v1+ is needed.
• Docker: A docker-compose.yml is provided for development, setting up multiple database instances (MariaDB, PostgreSQL, SQL Server) and search engines (Elasticsearch, OpenSearch) along with web servers (Apache, Nginx, FrankenPHP).
• Documentation: https://www.phpmyfaq.de/doc/
• REST API: https://api-docs.phpmyfaq.de/

Highlighted Details

• Supports 40+ languages with enhanced automatic content negotiation.
• Integrates with Microsoft Entra ID, Active Directory, and OpenLDAP for authentication.
• Features a wiki-like revision system for content tracking.
• Includes built-in spam protection and dynamic sitemap generation.

Maintenance & Community

• The project follows Semantic Versioning.
• Community support is available via a Discord server: https://discord.gg/phpmyfaq
• Issue tracking is managed via GitHub issues.

Licensing & Compatibility

• Licensed under the Mozilla Public License 2.0 (MPL 2.0).
• MPL 2.0 is a file-level copyleft license, generally compatible with commercial use and closed-source linking, but modifications to MPL-licensed files must also be made available under MPL 2.0.

Limitations & Caveats

• The provided Dockerfile is for development purposes and does not contain the application code itself, requiring code mounting.
• Elasticsearch/OpenSearch integration requires specific kernel settings (vm.max_map_count) to be configured, particularly for production use.