Skip to content

Commit

Permalink
Add note about risky performance improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
clarkwinkelmann committed Jul 25, 2022
1 parent e918369 commit 937b517
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,16 @@ php flarum fof:sitemap:build

_Best for larger forums, starting at 10.000 items._

### Risky Performance Improvements

_This setting is meant for large enterprise customers._

The optional "Enable risky performance improvements" option modifies the discussion and user SQL queries to limit the number of columns returned.
By removing those columns, it significantly reduces the size of the database response but might break custom visibility scopes or slug drivers added by extensions.

This setting only brings noticeable improvements if you have millions of discussions or users.
We recommend not enabling it unless the CRON job takes more than an hour to run or that the SQL connection gets saturated by the amount of data.

## Scheduling

Consider setting up the Flarum scheduler, which removes the requirement to setup a cron job as advised above.
Expand Down

0 comments on commit 937b517

Please sign in to comment.