chore(persistent_session): add description for ps db backend

This commit is contained in:
Tobias Lindahl 2021-11-01 10:29:22 +01:00
parent 03309ccd7c
commit 5643eba166
1 changed files with 8 additions and 0 deletions

View File

@ -163,6 +163,14 @@ fields("persistent_session_store") ->
{"db_backend",
sc(hoconsc:union([mnesia_ram, mnesia_disc]),
#{ default => "mnesia_ram"
, desc => """
Which database backend should be used for persistent session storage.<br>
mnesia_ram: Mnesia table, RAM only.<br>
mnesia_disc: Mnesia table, in RAM but also copy to disc.<br>
When running in a single node, it's recommended to have the session states copied to disc.<br>
When clustered, session states are replicated to all the nodes in the cluster,
most of the time, RAM only is good enough.
"""
})},
{"max_retain_undelivered",
sc(duration(),