Skip to content
Back to search

phpMyFAQ

phpMyFAQ - Open Source FAQ web application for PHP 8.4+ and MySQL, PostgreSQL and other databases

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today

Check it deeper on your machine

It has changed since its scan on 11 Nov 2026.

As a Claude Code plugin, install it and then ask Claude Code:

/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/thorsten/phpMyFAQ with scanskillsafety

Or from a terminal, clone it and run it:

git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/thorsten/phpMyFAQ'

It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.

Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/thorsten--phpmyfaq/badge.svg)](/listings/thorsten--phpmyfaq)

HTML

<a href="/listings/thorsten--phpmyfaq"><img src="/api/listings/thorsten--phpmyfaq/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

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

Production images

Every release is published to the GitHub Container Registry as `ghcr.io/thorsten/phpmyfaq:<version>` (Apache) and `ghcr.io/thorsten/phpmyfaq:<version>-frankenphp`. `docker-compose.prod.yml` together with `.env.production.example` runs them with MariaDB or PostgreSQL and an optional search engine; see [docs/deployment.md](docs/deployment.md).

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 run your current phpMyFAQ source code from your local repo. Every service is gated behind a [Compose profile](https://docs.docker.com/compose/profiles/), so you pick exactly the combination you need (one web server + the databases and search engines you want to test against).

The easiest way is the `bin/dev` helper, which maps friendly names to profiles and adds guardrails (it refuses to start two web servers on the same port, auto-adds Redis, generates self-signed dev TLS certificates, and installs dependencies on first run):

$ bin/dev up nginx mariadb opensearch # exactly these (Redis added automatically) $ bin/dev up apache postgres elasticsearch --tools $ bin/dev preset default # nginx + mariadb + opensearch + redis $ bin/dev preset full # one web server + every backing service $ bin/dev down # stop and remove the running stack $ bin/dev ps | logs [service] | shell <service>

Run `bin/dev help`, `bin/dev presets`, or `bin/dev profiles` for the full list. The same commands are available through pnpm: `pnpm dev:up`, `pnpm dev:down`, `pnpm dev:default`, `pnpm dev:full`, etc.

If you prefer raw Compose, pass the profiles yourself — a bare `docker compose up` now starts nothing, because no service is in the default profile:

$ docker compose --profile nginx --profile mariadb --profile opensearch --profile redis up

The available services (grouped by their profile) are:

_Web servers — pick one (all bind `:443`), each with PHP 8.5 support:_

- **nginx** (`nginx`): mounts `phpmyfaq` as `/var/www/html`, served via the **php-fpm** container. - **apache** (`apache`): mounts `phpmyfaq` as `/var/www/html`. - **frankenphp** (`frankenphp`): mounts `phpmyfaq` as `/var/www/html`, with HTTP/3 support.

_Databases — pick any:_

- **mariadb** (`mariadb`): MariaDB database (reachable under the `db` network alias). - **postgres** (`postgres`): PostgreSQL database. - **sqlserver** (`mssql`): Azure SQL Edge image (runs natively on Apple Silicon and x86).

_Search engines — pick any:_

- **elasticsearch** (`elasticsearch`): Open Source Software image (no XPack installed). - **opensearch** (`opensearch`): OpenSearch image (no XPack installed).

_Cache:_

- **redis** (`redis`): Redis database (added automatically by `bin/dev` unless `--no-redis`).

_Admin tools (`--tools`, or the `phpmyadmin` / `pgadmin` profiles):_

- **phpmyadmin** (`phpmyadmin`): a PHP tool to inspect your MariaDB database. - **pgadmin** (`pgadmin`): a PHP tool to inspect your PostgreSQL database.

_Dependency bootstrap (`build` profile, run once via `bin/dev build`):_

- **composer**: installs the Composer (PHP) dependencies. - **pnpm**: installs the pnpm (TypeScript) dependencies and builds the assets.

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)

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 253 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.

  1. # phpMyFAQ
  2. ![Packagist PHP Version Support](https://img.shields.io/packagist/php-v/thorsten/phpMyFAQ)
  3. ![GitHub](https://img.shields.io/github/license/thorsten/phpMyFAQ)
  4. ![GitHub commit activity](https://img.shields.io/github/commit-activity/m/thorsten/phpMyFAQ)
  5. [![Documentation Status](https://readthedocs.org/projects/phpmyfaq/badge/?version=latest)](https://phpmyfaq.readthedocs.io/en/latest/?badge=latest)
  6. ## What is phpMyFAQ?
  7. phpMyFAQ is a multilingual, AI-ready, and scalable FAQ platform built for modern knowledge management.
  8. Powered by PHP 8.4+ and a fully database-driven architecture, it delivers fast search with Elasticsearch/OpenSearch,
  9. flexible multi-user permissions, and a powerful content management system with revision history and WYSIWYG editing.
  10. With 40+ languages, responsive Twig-based templates, a REST API, 2FA security, enterprise authentication
  11. (LDAP, Active Directory, Entra ID), and a built-in plugin system, phpMyFAQ integrates seamlessly into almost any
  12. environment.
  13. Deploy it on traditional hosting or run it in the cloud via Docker.
  14. ## Requirements
  15. phpMyFAQ requires PHP 8.4 or higher and a supported database system.
  16. Supported databases include MySQL, MariaDB, Percona Server, PostgreSQL, Microsoft SQL Server, and SQLite3.
  17. For enhanced search capabilities using Elasticsearch or OpenSearch, Elasticsearch 8.x or later or OpenSearch 2.x or
  18. later is required.
  19. For a complete and up-to-date list of system requirements, please refer to the official documentation at
  20. [phpmyfaq.de](https://www.phpmyfaq.de/requirements).
  21. ## Installation
  22. ### phpMyFAQ installation package for end-users
  23. The best way to install phpMyFAQ is to download it on [phpmyfaq.de](https://www.phpmyfaq.de/download), unzip the package,
  24. and open http://www.example.org/phpmyfaq/setup/ in your preferred browser.
  25. ### phpMyFAQ installation with Docker
  26. #### Production images
  27. Every release is published to the GitHub Container Registry as `ghcr.io/thorsten/phpmyfaq:<version>` (Apache)
  28. and `ghcr.io/thorsten/phpmyfaq:<version>-frankenphp`.
  29. `docker-compose.prod.yml` together with `.env.production.example` runs them with MariaDB or PostgreSQL and an
  30. optional search engine; see [docs/deployment.md](docs/deployment.md).
  31. #### Dockerfile
  32. The Dockerfile provided in this repo only builds an environment to run any release for development purpose.
  33. It does not contain any code
  34. as the phpmyfaq folder is meant to be mounted as the `/var/www/html` folder in the container.
  35. #### docker-compose.yml
  36. For development purposes, you can run your current phpMyFAQ source code from your local repo. Every service is
  37. gated behind a [Compose profile](https://docs.docker.com/compose/profiles/), so you pick exactly the combination
  38. you need (one web server + the databases and search engines you want to test against).
  39. The easiest way is the `bin/dev` helper, which maps friendly names to profiles and adds guardrails (it refuses to
  40. start two web servers on the same port, auto-adds Redis, generates self-signed dev TLS certificates, and
  41. installs dependencies on first run):
  42. $ bin/dev up nginx mariadb opensearch # exactly these (Redis added automatically)
  43. $ bin/dev up apache postgres elasticsearch --tools
  44. $ bin/dev preset default # nginx + mariadb + opensearch + redis
  45. $ bin/dev preset full # one web server + every backing service
  46. $ bin/dev down # stop and remove the running stack
  47. $ bin/dev ps | logs [service] | shell <service>
  48. Run `bin/dev help`, `bin/dev presets`, or `bin/dev profiles` for the full list. The same commands are available
  49. through pnpm: `pnpm dev:up`, `pnpm dev:down`, `pnpm dev:default`, `pnpm dev:full`, etc.
  50. If you prefer raw Compose, pass the profiles yourself — a bare `docker compose up` now starts nothing, because no
  51. service is in the default profile:
  52. $ docker compose --profile nginx --profile mariadb --profile opensearch --profile redis up
  53. The available services (grouped by their profile) are:
  54. _Web servers — pick one (all bind `:443`), each with PHP 8.5 support:_
  55. - **nginx** (`nginx`): mounts `phpmyfaq` as `/var/www/html`, served via the **php-fpm** container.
  56. - **apache** (`apache`): mounts `phpmyfaq` as `/var/www/html`.
  57. - **frankenphp** (`frankenphp`): mounts `phpmyfaq` as `/var/www/html`, with HTTP/3 support.
  58. _Databases — pick any:_
  59. - **mariadb** (`mariadb`): MariaDB database (reachable under the `db` network alias).
  60. - **postgres** (`postgres`): PostgreSQL database.
  61. - **sqlserver** (`mssql`): Azure SQL Edge image (runs natively on Apple Silicon and x86).
  62. _Search engines — pick any:_
  63. - **elasticsearch** (`elasticsearch`): Open Source Software image (no XPack installed).
  64. - **opensearch** (`opensearch`): OpenSearch image (no XPack installed).
  65. _Cache:_
  66. - **redis** (`redis`): Redis database (added automatically by `bin/dev` unless `--no-redis`).
  67. _Admin tools (`--tools`, or the `phpmyadmin` / `pgadmin` profiles):_
  68. - **phpmyadmin** (`phpmyadmin`): a PHP tool to inspect your MariaDB database.
  69. - **pgadmin** (`pgadmin`): a PHP tool to inspect your PostgreSQL database.
  70. _Dependency bootstrap (`build` profile, run once via `bin/dev build`):_
  71. - **composer**: installs the Composer (PHP) dependencies.
  72. - **pnpm**: installs the pnpm (TypeScript) dependencies and builds the assets.
  73. Then services will be available at the following addresses:
  74. - phpMyFAQ: (https://localhost:443 or http://localhost:8080 as fallback)
  75. - phpMyAdmin: (http://localhost:8000)
  76. - pgAdmin: (http://localhost:8008)
  77. #### Running tests
  78. To run the test using Docker, you have to install the Composer development dependencies
  79. $ docker build -t phpmyfaq-test . && docker run --rm -it docker.io/library/phpmyfaq-test:latest
  80. #### Quote from Elasticsearch documentation
  81. The vm.max_map_count kernel setting needs to be set to at least 262144 for production use. Depending on your platform:
  82. ##### Linux
  83. The vm.max*map_count setting should be set permanently in */etc/sysctl.conf\_:
  84. $ grep vm.max_map_count /etc/sysctl.conf
  85. vm.max_map_count=262144
  86. To apply the setting on a live system type: `sysctl -w vm.max_map_count=262144`
  87. ##### macOS and Windows with Docker Desktop
  88. Docker Desktop runs containers inside a managed Linux VM. Open a shell in that VM and apply the setting there:
  89. $ docker run --rm --privileged --pid=host alpine nsenter -t 1 -m -u -n -i sysctl -w vm.max_map_count=262144
  90. This change is not persistent and must be reapplied after restarting Docker Desktop.
  91. ### phpMyFAQ local installation from Github
  92. To run phpMyFAQ locally, you need at least a running web server with PHP support and a database.
  93. $ git clone git://github.com/thorsten/phpMyFAQ.git
  94. $ cd phpMyFAQ
  95. $ git checkout main
  96. $ curl -s https://getcomposer.org/installer | php
  97. $ php composer.phar install
  98. $ curl -fsSL https://get.pnpm.io/install.sh | sh -
  99. $ pnpm install
  100. $ pnpm build
  101. Then open http://www.example.org/phpmyfaq/setup/ in your browser.
  102. ## Testing
  103. ### PHP
  104. To run our unit tests via PHPUnit v13.x, execute this command on your CLI
  105. $ curl -s https://getcomposer.org/installer | php
  106. $ php composer.phar install
  107. $ composer test
  108. Please note that phpMyFAQ needs to be installed via Composer.
  109. ### TypeScript
  110. To run our TypeScript tests via Vitest, execute this command on your CLI
  111. $ curl -fsSL https://get.pnpm.io/install.sh | sh -
  112. $ pnpm install
  113. $ pnpm test
  114. ### End-to-end (Playwright)
  115. The end-to-end suite drives a real browser against a freshly installed instance
  116. that is seeded with bilingual (German + English) test data. Provisioning,
  117. serving, and teardown are fully automated by the `bin/e2e` helper, so no manual
  118. setup or existing installation is required — your local configuration is backed
  119. up and restored automatically.
  120. Install the browser once, then run the suite:
  121. $ pnpm install
  122. $ pnpm e2e:install # downloads the Chromium browser
  123. $ pnpm e2e:local # SQLite + built-in PHP server (fast)
  124. $ pnpm e2e:docker # dedicated MariaDB container (production-like)
  125. `bin/e2e` installs phpMyFAQ headlessly via `php bin/console phpmyfaq:install`,
  126. seeds the test data with `php bin/console phpmyfaq:seed-testdata`, serves the
  127. app, and runs Playwright. Pass extra arguments through to Playwright after `--`,
  128. for example `./bin/e2e local -- tests/e2e/search.spec.ts`. The specs live in
  129. `tests/e2e/` and cover bilingual content, search, admin login, and basic
  130. accessibility.
  131. The suite also runs on every pull request and nightly in CI
  132. (`.github/workflows/e2e.yml`) using the SQLite path, uploading the Playwright
  133. HTML report and failure traces as build artifacts.
  134. ## Versioning
  135. For transparency and insight into our release cycle, and for striving to maintain backward compatibility, phpMyFAQ will
  136. be maintained under the Semantic Versioning guidelines as much as possible.
  137. Releases will be numbered with the following format:
  138. `<major>.<minor>.<patch>`
  139. And constructed with the following guidelines:
  140. - Breaking backward compatibility bumps the major (and resets the minor and patch)
  141. - New additions without breaking backward compatibility bump the minor (and reset the patch)
  142. - Bug fixes and misc changes bump the patch
  143. For more information on SemVer, please visit http://semver.org/.
  144. ## Issue tracker
  145. Found a bug, or do you have a feature request? [Please open a new issue](https://github.com/thorsten/phpMyFAQ/issues).
  146. Before opening any issue, please search for existing issues.
  147. ## Contributing
  148. Please check out our page about contributing on [phpmyfaq.de](https://www.phpmyfaq.de/contribute).
  149. ## Documentation
  150. You can read the complete documentation on [here](https://phpmyfaq.readthedocs.io/en/latest/).
  151. ## REST API documentation
  152. The REST API documentation is available as an OpenAPI 3.1 specification:
  153. - [JSON](docs/openapi.json)
  154. - [YAML](docs/openapi.yaml)
  155. The Swagger UI is available at [https://api-docs.phpmyfaq.de/](https://api-docs.phpmyfaq.de/).
  156. ## Discord server
  157. If you like to chat with the phpMyFAQ team, please join our [Discord server](https://discord.gg/wszhTceuNM).
  158. We're happy to help you with your questions!
  159. ## License
  160. Mozilla Public License 2.0, see LICENSE for more information.
  161. Copyright © 2001–2026 Thorsten Rinne and the phpMyFAQ Team

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.