yujunjun/strapi
1
0
Fork 0
mirror of https://github.com/strapi/strapi.git synced 2025-11-01 18:33:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #21060 from strapi/v5/readme

Browse Source 
Update Readme and Security docs for Strapi 5
This commit is contained in:
DMehaffy 2024-08-24 09:38:56 -07:00 committed by GitHub
commit 7c7716e05e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 28 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -80,11 +80,15 @@ Complete installation requirements can be found in the documentation under <a hr
**Supported operating systems**:
- Ubuntu LTS/Debian 9.x
- CentOS/RHEL 8
- macOS Mojave
- Windows 10
- Docker
| OS | Recommended | Minimum |
|-----------------|-------------|------------|
| Ubuntu | 24.04 | LTS |
| Debian | 11 | LTS |
| RHEL | 9 | LTS |
| macOS | 14 | 12 |
| Windows Desktop | 11 | 10 |
| Windows Server | No Support | No Support |
| Docker | N/A | N/A |
(Please note that Strapi may work on other operating systems, but these are not tested nor officially supported at this time.)
@ -93,7 +97,7 @@ Complete installation requirements can be found in the documentation under <a hr
Strapi only supports maintenance and LTS versions of Node.js. Please refer to the <a href="https://nodejs.org/en/about/releases/">Node.js release schedule</a> for more information. NPM versions installed by default with Node.js are supported. Generally it's recommended to use yarn over npm where possible.
| Strapi Version | Recommended | Minimum |
| --------------- | ----------- | ------- |
|-----------------|-------------|---------|
| 5.0.0 and up | 20.x | 18.x |
| 4.14.5 and up | 20.x | 18.x |
| 4.11.0 and up | 18.x | 16.x |
@ -103,10 +107,10 @@ Strapi only supports maintenance and LTS versions of Node.js. Please refer to th
**Database:**
| Database | Recommended | Minimum |
| ---------- | ----------- | ------- |
|------------|-------------|---------|
| MySQL | 8.0 | 8.0 |
| MariaDB | 10.6 | 10.3 |
| PostgreSQL | 14.0 | 11.0 |
| MariaDB | 11.2 | 10.3 |
| PostgreSQL | 16.0 | 14.0 |
| SQLite | 3 | 3 |
**We recommend always using the latest version of Strapi stable to start your new projects**.
@ -153,6 +157,7 @@ See our dedicated [repository](https://github.com/strapi/documentation) for the
- [Developer docs](https://docs.strapi.io/developer-docs/latest/getting-started/introduction.html)
- [User guide](https://docs.strapi.io/user-docs/latest/getting-started/introduction.html)
- [Cloud guide](https://docs.strapi.io/cloud/intro)
## Try live demo

21
SECURITY.md
View File

@ -4,17 +4,26 @@
As of April 2024 (and until this document is updated), only the v4.x.x _GA_ or _STABLE_ releases of Strapi are supported for updates and bug fixes. Any previous versions are currently not supported and users are advised to use them "at their own risk".
- v5.x.x **Beta** is considered unstable is only supported during the beta period for **NON-PRODUCTION** usage
- v4.x.x **Stable** is considered LTS until further notice
- v4.x.x **Beta** is considered unstable and not supported
- v4.x.x **Alpha** is considered unstable and not supported
- v3.x.x is considered deprecated and not supported
| Version | Release Tag | Support Starts | Support Ends | Security Updates Until | Notes |
|---------|-------------|----------------|----------------|------------------------|----------------------|
| 5.x.x | GA | October 2024 | Further Notice | Further Notice | LTS (Future) |
| 5.x.x | RC | N/A | October 2024 | N/A | Non-Production Usage |
| 5.x.x | Beta | N/A | N/A | N/A | Not Supported |
| 5.x.x | Alpha | N/A | N/A | N/A | Not Supported |
| 4.x.x | GA | November 2021 | October 2025 | April 2026 | LTS |
| 4.x.x | Beta | N/A | N/A | N/A | Not Supported |
| 4.x.x | Alpha | N/A | N/A | N/A | Not Supported |
| 3.x.x | N/A | N/A | N/A | N/A | End Of Life |
## Reporting a Vulnerability
Please report (suspected) security vulnerabilities via GitHub's security advisory reporting system:
Submit your vulnerability via [this link](https://github.com/strapi/strapi/security/advisories/new)
**Strapi does not currently and has no plans to offer any bug bounties, swag, or any other reward for reporting vulnerabilities.**
During our public disclosure, we can give credit to the reporter and link to any social accounts you wish to have us add, including linking to your own blog post detailing the vulnerability.
Please note the following requirements (all are required):
- Summary of the suspected vulnerability
@ -60,5 +69,3 @@ List of some (though not all) platforms **we do not support**:
- huntr.dev
- Direct email or communication to Strapi employees (Discord, Slack, or Email)
- Stack Overflow
**Strapi does not currently and has no plans to offer any bug bounties, swag, or any other reward for reporting vulnerabilities.** At most during our public disclosure we can give credit to the reporter and link to any social accounts you wish to have us add including linking to your own blog post detailing the vulnerability if you wish.