|
1 | | -# phpMyFAQ 4.1-dev |
| 1 | +# phpMyFAQ 4.2-dev |
2 | 2 |
|
3 | 3 |  |
4 | 4 |  |
|
7 | 7 |
|
8 | 8 | ## What is phpMyFAQ? |
9 | 9 |
|
10 | | -phpMyFAQ is a multilingual, completely database-driven FAQ system. |
11 | | -It supports various databases to store all data; PHP 8.3+ is needed to access this data. |
12 | | -phpMyFAQ also offers a multi-language Content Management System with a WYSIWYG editor and a media manager, real time |
13 | | -search support with Elasticsearch and OpenSearch, flexible multi-user support with user and group based permissions on |
14 | | -categories and records, a wiki-like revision feature, a news system, user-tracking, 40+ supported languages, enhanced |
15 | | -automatic content negotiation, HTML5/CSS3 based responsive templates, PDF-support, a backup and restore system, a |
16 | | -dynamic sitemap, related FAQs, tagging, enhanced SEO features, built-in spam protection systems, Microsoft Entra ID, |
17 | | -Microsoft Active Directory and OpenLDAP support, a experimental MCP server, and an easy-to-use installation. |
18 | | -It's possible to update your phpMyFAQ installation via the web interface or on the command line. |
| 10 | +phpMyFAQ is a comprehensive, multilingual FAQ system that is entirely database-driven. |
| 11 | +It is compatible with a variety of databases for data storage and requires PHP 8.4+ for data access. |
| 12 | +The system features a multi-language Content Management System equipped with a WYSIWYG editor and an Image Manager. |
| 13 | +It also provides real-time search capabilities with Elasticsearch or OpenSearch. |
| 14 | + |
| 15 | +phpMyFAQ supports flexible multi-user functionality, offering user and group-based permissions on categories and FAQs. |
| 16 | +It includes a wiki-like revision feature, a news system, and configurable user-tracking. |
| 17 | +Administrators can monitor user activities through detailed log files. |
| 18 | +Additionally, phpMyFAQ supports adding its own custom pages to the FAQ system. |
| 19 | +With support for over 40 languages, it also boasts enhanced automatic content negotiation and HTML5- / CSS3-based |
| 20 | +responsive templates. |
| 21 | +These Twig-based templates allow for the inclusion of your own text and HTML snippets. There's also a built-in plugin |
| 22 | +system for further customization. |
| 23 | + |
| 24 | +Additional features include PDF support, a backup system, a dynamic sitemap, related FAQs, tagging, a plugin system, |
| 25 | +and built-in spam protection systems. |
| 26 | +phpMyFAQ also supports two-factor authentication (2FA) for enhanced security. |
| 27 | +A REST API is available for integration with other systems. |
| 28 | +It also supports OpenLDAP, Microsoft Active Directory, Microsoft Entra ID, and an MCP Server for AI agents. |
| 29 | +The system is easy to install, thanks to its user-friendly installation script. |
| 30 | + |
| 31 | +phpMyFAQ is versatile |
| 32 | +and can be run on almost any web hosting provider or deployed in the cloud using a Docker container. |
19 | 33 |
|
20 | 34 | ## Requirements |
21 | 35 |
|
22 | 36 | phpMyFAQ is only supported on PHP 8.3 and up, you need a database as well. Supported databases are MySQL, MariaDB, |
23 | | -Percona Server, PostgreSQL, Microsoft SQL Server and SQLite3. If you want to use Elasticsearch or Opensearch as the main |
24 | | -search engine, you need Elasticsearch v6+ or OpenSearch v1+. Check our detailed requirements on |
| 37 | +Percona Server, PostgreSQL, Microsoft SQL Server, and SQLite3. If you want to use Elasticsearch or Opensearch as the |
| 38 | +main search engine, you need Elasticsearch v6+ or OpenSearch v1+. Check our detailed requirements on |
25 | 39 | [phpmyfaq.de](https://www.phpmyfaq.de/requirements) for more information. |
26 | 40 |
|
27 | 41 | ## Installation |
28 | 42 |
|
29 | 43 | ### phpMyFAQ installation package for end-users |
30 | 44 |
|
31 | | -The best way to install phpMyFAQ is to download it on [phpmyfaq.de](https://www.phpmyfaq.de/download), unzip the package |
| 45 | +The best way to install phpMyFAQ is to download it on [phpmyfaq.de](https://www.phpmyfaq.de/download), unzip the package, |
32 | 46 | and open http://www.example.org/phpmyfaq/setup/ in your preferred browser. |
33 | 47 |
|
34 | 48 | ### phpMyFAQ installation with Docker |
@@ -165,7 +179,7 @@ And constructed with the following guidelines: |
165 | 179 |
|
166 | 180 | - Breaking backward compatibility bumps the major (and resets the minor and patch) |
167 | 181 | - New additions without breaking backward compatibility bump the minor (and reset the patch) |
168 | | -- Bug fixes and misc changes bumps the patch |
| 182 | +- Bug fixes and misc changes bump the patch |
169 | 183 |
|
170 | 184 | For more information on SemVer, please visit http://semver.org/. |
171 | 185 |
|
|
0 commit comments