phpMyFAQ

# phpMyFAQ 4.1-dev    [](https://phpmyfaq.readthedocs.io/en/latest/?badge=latest) ## What is phpMyFAQ? phpMyFAQ is a multilingual, completely database-driven FAQ system. It supports various databases to store all data; PHP 8.3+ is needed to access this data. phpMyFAQ also offers a multi-language Content Management System with a WYSIWYG editor and a media manager, real time search support with Elasticsearch and OpenSearch, flexible multi-user support with user and group based permissions on categories and records, a wiki-like revision feature, a news system, user-tracking, 40+ supported languages, enhanced automatic content negotiation, HTML5/CSS3 based responsive templates, PDF-support, a backup and restore system, a dynamic sitemap, related FAQs, tagging, enhanced SEO features, built-in spam protection systems, Microsoft Entra ID, Microsoft Active Directory and OpenLDAP support, a experimental MCP server, and an easy-to-use installation. It's possible to update your phpMyFAQ installation via the web interface or on the command line. ## Requirements phpMyFAQ is only supported on PHP 8.3 and up, you need a database as well. Supported databases are MySQL, MariaDB, Percona Server, PostgreSQL, Microsoft SQL Server and SQLite3. If you want to use Elasticsearch or Opensearch as the main search engine, you need Elasticsearch v6+ or OpenSearch v1+. Check our detailed requirements on [phpmyfaq.de](https://www.phpmyfaq.de/requirements) for more information. ## Installation ### phpMyFAQ installation package for end-users The best way to install phpMyFAQ is to download it on [phpmyfaq.de](https://www.phpmyfaq.de/download), unzip the package and open http://www.example.org/phpmyfaq/setup/ in your preferred browser. ### phpMyFAQ installation with Docker #### Dockerfile The Dockerfile provided in this repo only builds an environment to run any release for development purpose. It does not contain any code as the phpmyfaq folder is meant to be mounted as the `/var/www/html` folder in the container. #### docker-compose.yml For development purposes, you can start a full stack to run your current PhpMyFAQ source code from your local repo. $ docker-compose up The command above starts nine containers for multi-database development as follows. _Specific images started at once to prepare the project:_ - **composer**: update composer dependencies - **pnpm**: update pnpm dependencies _Running using named volumes:_ - **mariadb**: image with MariaDB database with xtrabackup support - **phpmyadmin**: a PHP tool to have a look at your MariaDB database. - **postgres**: image with PostgreSQL database - **pgadmin**: a PHP tool to have a look at your PostgreSQL database. - **sqlserver**: image with Microsoft SQL Server for Linux - **elasticsearch**: Open Source Software image (it means it does not have XPack installed) - **opensearch**: OpenSearch image (it means it does not have XPack installed) _Running apache web server with PHP 8.4 support:_ - **apache**: mounts the `phpmyfaq` folder in place of `/var/www/html`. _Running nginx web server with PHP 8.4 support:_ - **nginx**: mounts the `phpmyfaq` folder in place of `/var/www/html`. - **php-fpm**: PHP-FPM image with PHP 8.4 support _Running FrankenPHP web server with PHP 8.4 support:_ - **frankenphp**: mounts the `phpmyfaq` folder in place of `/var/www/html`. Then services will be available at the following addresses: - phpMyFAQ: (https://localhost:443 or http://localhost:8080 as fallback) - phpMyAdmin: (http://localhost:8000) - pgAdmin: (http://localhost:8008) #### Running tests To run the test using Docker, you have to install the Composer development dependencies $ docker build -t phpmyfaq-test . && docker run --rm -it docker.io/library/phpmyfaq-test:latest #### Quote from Elasticsearch documentation The vm.max_map_count kernel setting needs to be set to at least 262144 for production use. Depending on your platform: ##### Linux The vm.max*map_count setting should be set permanently in */etc/sysctl.conf\_: $ grep vm.max_map_count /etc/sysctl.conf vm.max_map_count=262144 To apply the setting on a live system type: `sysctl -w vm.max_map_count=262144` ##### macOS with Docker for Mac The vm.max_map_count setting must be set within the xhyve virtual machine: $ screen ~/Library/Containers/com.docker.docker/Data/com.docker.driver.amd64-linux/tty Log in with root and no password. Then configure the sysctl setting as you would for Linux: $ sysctl -w vm.max_map_count=262144 ##### Windows and macOS with Docker Toolbox The vm.max_map_count setting must be set via docker-machine: $ docker-ma