Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initial requirements for 3.0 #8303

Open
wants to merge 1 commit into
base: release-3.0
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 57 additions & 0 deletions other/requirements.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# SMF Miniumn Requirements

## PHP
### PHP Version Support
| MIN SMF VERSION | MAX SMF VERSION | MIN PHP VERSION | MAX PHP VERSION |
| ------ | ------ | ------ | ------ |
| 3.0 | LATEST | 8.0.0 | LATEST |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we also include 2.1 here? Thoughts?

Suggested change
| 3.0 | LATEST | 8.0.0 | LATEST |
| 2.1 | LATEST | 7.0.0 | LATEST |
| 3.0 | LATEST | 8.0.0 | LATEST |

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can, but the 2.1 branch can also hold it.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are the branches mentioned somewhere? This may cause confusion since different projects tend to do one repo per version thus making it non-trivial unless you previously contributed to 2.1 or you check the branches.


### Undocumented Version Support
- Versions below miniumn listed above are not supported
- Versions above the maxiumn listed above:
- Will be supported in a future date unless this version has reached End of Life
- Support is limited until then and provided as best effort
- Git Repo may contain code testing support

### PHP INI
- engine directive must be set to On
- session.save_path directive must be set to a valid directory or empty
- file_uploads directive must be set to On
- upload_tmp_dir directive must be set to a valid directory or empty

### Additional PHP Libraires
- mbstring extension
- fileinfo extension

## Database Engine
### [MySQL](http://www.mysql.com)
- MySQL 8.0.35

### [PostgreSQL](http://www.postgresql.org)
- PostgreSQL 12.17
- standard_conforming_strings must be set to on

## Web Server
### Apache
- Apache Web Server 2.2 or 2.4 with mod_php

### FastCGI/FPM
- Any Web server capable of FastCGI supporting PHP FPM


# Recommenations

## PHP Recommenations
### Recommended PHP INI
- max_input_time set to a value of at least 30.
- post_max_size and upload_max_filesize set to the size of the largest attachments you wish to be able to - upload.
- memory_limit set to at least 512M.
- max_execution_time set to at least 15.
- session.use_trans_sid set to Off.

### Recommended PHP Libraires
- GD Graphics Library 2.0 or higher.

## Web Server
### Apache
- mod_security disabled (please see Mod security for more information).