https://github.com/ernestbuffington/phpmyfaq.coders.exchange
This is the ACTIVE phpMyFaq CodersExchange Website!
https://github.com/ernestbuffington/phpmyfaq.coders.exchange
Last synced: 20 days ago
JSON representation
This is the ACTIVE phpMyFaq CodersExchange Website!
- Host: GitHub
- URL: https://github.com/ernestbuffington/phpmyfaq.coders.exchange
- Owner: ernestbuffington
- License: mpl-2.0
- Created: 2023-02-15T13:44:17.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-02-15T14:22:26.000Z (about 2 years ago)
- Last Synced: 2025-04-13T22:57:34.688Z (20 days ago)
- Language: PHP
- Homepage:
- Size: 9.43 MB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# CodersExchange - phpMyFAQ 3.1
## What is phpMyFAQ?
phpMyFAQ is a multilingual, completely database-driven FAQ-system. It supports various databases to store all data, PHP
7.4+ is needed in order 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, 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, OpenLDAP and Microsoft Active Directory support, and an easy-to-use installation and update script.
## Requirements
phpMyFAQ is only supported on PHP 7.4 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 as main search
engine, you need Elasticsearch 6.x or later. 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/index.php in your preferred browser.
### phpMyFAQ installation with Docker
#### Dockerfile
The Dockerfile provided in this repo only build an environment to run any release it's 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.
To build a production release please use the [docker-hub](https://github.com/phpMyFAQ/docker-hub) repository or use
images provided on [docker.io](https://hub.docker.com/r/phpmyfaq/phpmyfaq/).
#### 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 8 containers for multi database development as following.
_Specific images started once to prepare the project:_
- **composer**: update composer dependencies
- **yarn**: update yarn dependencies
_Running using named volumes:_
- **mariadb**: image with MariaDB database with xtrabackup support
- **phpmyadmin**: a PHP tool to have a look on your MariaDB database.
- **postgres**: image with PostgreSQL database
- **pgadmin**: a PHP tool to have a look on your PostgreSQL database.
- **sqlserver**: image with Microsoft SQL Server for Linux
- **elasticsearch**: Open Source Software image (it means it does not have XPack installed)
_Running apache web server with PHP 8.1 support:_
- **phpmyfaq**: mounts the `phpmyfaq` folder in place of `/var/www/html`.
Then services will be available at following addresses:
- phpMyFAQ: (http://localhost:8080)
- phpMyAdmin: (http://localhost:8000)
- pgAdmin: (http://localhost:8008)
#### Running tests
To run the test using Docker you have to install the Composer development dependencies
$ curl -s https://getcomposer.org/installer | php
$ php composer.phar install
#### 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-machine ssh
$ sudo sysctl -w vm.max_map_count=262144
### phpMyFAQ local installation from Github
To run phpMyFAQ locally you need at least a running web server with PHP support and a database.
$ git clone git://github.com/thorsten/phpMyFAQ.git
$ cd phpMyFAQ
$ git checkout 3.1
$ curl -s https://getcomposer.org/installer | php
$ php composer.phar install
$ curl -o- -L https://yarnpkg.com/install.sh | bash
$ yarn install
$ yarn build
Then just open http://www.example.org/phpmyfaq/setup/index.php in your browser.
## Testing
To run our unit tests via PHPUnit v9.x, just execute this command on your CLI
$ curl -s https://getcomposer.org/installer | php
$ php composer.phar install
$ ./vendor/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:
`..`
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/.
## Bug tracker
Found a bug, or do you have a feature request? [Please open a new issue](https://github.com/thorsten/phpMyFAQ/issues).
Before opening any issue, please search for existing issues.
## Contributing
Please check out our page about contributing on [phpmyfaq.de](https://www.phpmyfaq.de/contribute).
## Documentation
You can find the full documentation on [phpmyfaq.de](https://www.phpmyfaq.de/documentation).
## REST API v2.1
The REST API v2.1 documentation is located [here in this repository](API.md) and on
[phpmyfaq.de](https://www.phpmyfaq.de/documentation).
## License
Mozilla Public License 2.0, see LICENSE for more information.
Copyright © 2001 - 2023 Thorsten Rinne and the phpMyFAQ Team