phpMyFAQ 3.0.0-dev

What is phpMyFAQ?

phpMyFAQ is a multilingual, completely database-driven FAQ-system. It supports various databases to store all data, PHP 5.4.4+ or HHVM 3.4.2+ is needed in order to access this data. phpMyFAQ also offers a multi-language Content Management System with a WYSIWYG editor and an Image Manager, 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 templates, PDF-support, a backup-system, a dynamic sitemap, related FAQs, tagging, RSS feeds, built-in spam protection systems, OpenLDAP and Microsoft Active Directory support, and an easy to use installation script.

Requirements

phpMyFAQ is only supported on PHP 5.4.4 and up, you need a database as well. Supported databases are MySQL, PostgreSQL, Microsoft SQL Server, SQLite and MariaDB. Check our detailed requirements on phpmyfaq.de for more information.

Installation

Package for end-users

The best way to install phpMyFAQ is to download it on phpmyfaq.de, unzip the package and open http://www.example.org/phpmyfaq/setup/index.php in your browser.

Git for developers

If you are behind a proxy, run following:

git config --global url.http://git.code.sf.net/p/tcpdf/code.insteadOf git://git.code.sf.net/p/tcpdf/code

or add the following to your ~/.gitconfig:

[url "http://git.code.sf.net/p/tcpdf/code"]
    insteadOf = git://git.code.sf.net/p/tcpdf/code

To install run:

$ git clone git://github.com/thorsten/phpMyFAQ.git
$ cd phpMyFAQ
$ curl -s https://getcomposer.org/installer | php
$ php composer.phar install
# Don't run the following commands as root, otherwise they fail
$ npm install
$ bower install
$ grunt

Then just open http://www.example.org/phpmyfaq/setup/index.php in your browser.

Testing

To run our unittest via PHPUnit v4.x, just execute this command on your CLI

$ bin/phpunit

Please note that phpMyFAQ needs to be installed via Composer.

Versioning

For transparency and insight into our release cycle, and for striving to maintain backward compatibility, phpMyFAQ will be maintained under the Semantic Versioning guidelines as much as possible.

Releases will be numbered with the following format:

<major>.<minor>.<patch>

And constructed with the following guidelines:

Breaking backward compatibility bumps the major (and resets the minor and patch)
New additions without breaking backward compatibility bumps the minor (and resets the patch)
Bug fixes and misc changes bumps the patch

For more information on SemVer, please visit http://semver.org/.