forkbb/readme.md

44 lines
1.4 KiB
Markdown
Raw Normal View History

2021-11-30 12:43:56 +00:00
# ForkBB rev.41 Pre-Alpha Readme
## About
2020-08-14 09:48:41 +00:00
ForkBB is a free and open source forum software. The project is based on [FluxBB_by_Visman](https://github.com/MioVisman/FluxBB_by_Visman)
2018-02-25 04:29:42 +00:00
## Note
2020-11-18 13:18:44 +00:00
### Please DO NOT use this revision in production, it is for test only.
2019-12-28 09:16:23 +00:00
Many functions of the forum are not implemented.
2021-11-27 05:26:01 +00:00
No: plugins/extensions system, ...
2018-02-25 04:29:42 +00:00
## Requirements
2020-07-14 15:39:33 +00:00
* PHP 7.3+
2021-11-27 14:28:57 +00:00
* PHP extensions: pdo, intl, json, mbstring, fileinfo
* PHP extensions (desirable): gd or imagick (for upload avatars and other images)
2018-02-25 04:29:42 +00:00
* A database such as MySQL 5.5.3 or later (_Drivers for other databases are not realized now_)
2018-09-12 13:54:51 +00:00
## Install
2021-01-12 16:35:42 +00:00
### For Apache:
2018-09-12 13:54:51 +00:00
* Document Root == **public** folder (recommended):
1. Rename public/**.dist.htaccess** to public/**.htaccess**,
2. Rename public/**index.dist.php** to public/**index.php**;
* Document Root != **public** folder:
1. Rename **.dist.htaccess** to **.htaccess**,
2. Rename **index.dist.php** to **index.php**.
2021-01-12 16:35:42 +00:00
### For NGINX:
* [Example](https://github.com/forkbb/forkbb/blob/master/nginx.dist.conf) nginx configuration.
2021-01-13 07:29:55 +00:00
* Note: Root must point to the [**public/**](https://github.com/forkbb/forkbb/tree/master/public) directory.
2021-01-12 16:35:42 +00:00
* Note: The **index.dist.php** file does not need to be renamed.
## Links
2017-01-05 05:49:39 +00:00
* Development: https://github.com/forkbb/forkbb
2018-02-25 04:48:25 +00:00
## License
This project is under MIT license. Please see the [license file](LICENSE) for details.