-
-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Created a singular central system requirements page
- Loading branch information
1 parent
60bf8c9
commit 9fe858d
Showing
7 changed files
with
89 additions
and
27 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
--- | ||
title: System Requirements | ||
description: Information on FOSSBilling's system requirements | ||
--- | ||
|
||
import { FontAwesomeIcon } from "@fortawesome/react-fontawesome"; | ||
import { | ||
faCircleInfo, | ||
faPersonDigging, | ||
faServer, | ||
faTriangleExclamation, | ||
} from "@fortawesome/free-solid-svg-icons"; | ||
import { Callout, Tab, Tabs } from "nextra-theme-docs"; | ||
|
||
# <FontAwesomeIcon icon={faServer} /> FOSSBilling's system requirements | ||
|
||
## Web server | ||
|
||
FOSSBilling will work correctly on any of the following web-servers. For the greatest simplicity we suggest either using Apache or Apache behind an NGINX reverse proxy (with NGINX caching static files). | ||
|
||
Most control panels will either come configured like this out-of-the-box or support this configuration. | ||
|
||
- Apache with `mod_rewrite` installed and enabled. | ||
- NGINX running the correct [configuration](https://config.fossbilling.org/). | ||
- The config generator will give you a good starting point, however you may still need to configure items such as SSL and PHP to be correct for your server. | ||
- OpenLiteSpeed. | ||
- Due to how OpenLiteSpeed handles `.htaccess` files, it's typically not suitable for selling web hosting, however FOSSBilling itself will run on it without any issues. | ||
- LiteSpeed. | ||
|
||
If you wish to use a web server that is not listed above, you will need to manually create a configuration for it that implements the URL rewriting FOSSBilling relies on using one of the existing configurations as reference. | ||
|
||
## PHP | ||
|
||
### Version | ||
|
||
FOSSBilling follows the official PHP [supported versions list](https://www.php.net/supported-versions.php). That means that FOSSBilling should function correctly on any PHP version that is still receiving active security and/or feature updates. When a PHP version looses it's official support, we drop support for that PHP version with the next FOSSBilling release | ||
|
||
Strictly following the official supported PHP versions allows us to keep FOSSBilling as secure and stable as possible while also being able to leverage new PHP features for better performance or improved functionality. | ||
|
||
### Required extensions | ||
|
||
At a minimum for correct functionality, you should have the following extensions installed: | ||
|
||
- `intl` | ||
- `openssl` | ||
- `pdo_mysql` | ||
- `xml` | ||
- `xml` | ||
|
||
### Highly recommended extensions | ||
|
||
These extensions may not be needed to make FOSSBilling work, however they are recommended for improved performance, compatibility, and functionality. | ||
|
||
- `curl` | ||
- `mbstring` | ||
- `dom` | ||
- `opcache` (This is PHP's official extension that's used to cache compiled scripts and improve performance. We recommend using this for all PHP applications!) | ||
- `imagick` or `gmagick` | ||
|
||
### Configuration | ||
|
||
- `memory_limit`: Should be at least `64M` | ||
- The more modules and extensions you have installed, the greater this will be. Installations under heavy demand may also need their memory limit increased. | ||
- `max_execution_time`: The default of 30 seconds is typically sufficient, however those with slower servers may consider increasing this to 45 or 60 seconds. | ||
|
||
## Database | ||
|
||
FOSSBilling should function correctly on any MySQL compatible database such as MySQL or MariaDB. | ||
|
||
- `MySQL` >= 8 | ||
- `MariaDB` >= 10.3 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters