Skip to content

Commit 5a55774

Browse files
authored
feat: add queue docs (#485)
1 parent bf1c119 commit 5a55774

File tree

2 files changed

+17
-1
lines changed

2 files changed

+17
-1
lines changed

docs/queue.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Queue
2+
3+
If you're just starting out, you won't need a queue. But once you reach a certain scale, you cannot go without one.
4+
5+
## Why should I care?
6+
7+
A Flarum installation that has no queue configured, will process a wide variety of tasks during the request of a user. The best example of such a task are email notifications. Flarum Subscriptions, Friends of Flarum Follow Tags and IanM Follow Users are just a few extensions that trigger email notifications for new activity. It is probably not a mystery that having a community of ten users will not be much of an issue in this regard. However once you have thousands it is far more likely that these notifications will take a long time, and affect the interaction of users on your community.
8+
9+
To resolve this increasing burden, you can run a Queue. A queue runs on your server, it does not interact with the user and their requests. A user request, however, can dispatch tasks to the queue.
10+
11+
## What extensions offer Queue functionality?
12+
13+
The best way currently to identify what extensions add a queue is by looking at the [Extensions directory at Flarum.org](https://flarum.org/extensions?tableSearch=queue). The simplest implementation currently is the [Database Queue](https://flarum.org/extension/blomstra/database-queue) which re-uses the [scheduler](scheduler.md).
14+
15+
Understand that each extension requires some form of configuration before it can work, make sure to read the instructions.

sidebars.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,8 @@ module.exports = {
4949
'themes',
5050
'mail',
5151
'scheduler',
52-
'console'
52+
'console',
53+
'queue'
5354
]
5455
},
5556
{

0 commit comments

Comments
 (0)