diff --git a/doc/dashboard.rst b/doc/dashboard.rst index f0d19e17..e355c4ec 100644 --- a/doc/dashboard.rst +++ b/doc/dashboard.rst @@ -6,7 +6,7 @@ Dashboard Overview A dashboard is available at route ``/dashboard``. The dashboard can be enabled by setting :ref:`settings-enable-dashboard` to ``True``, and by setting a -:ref:`settings-login-username` and :ref:`settings-login-pw`. +:ref:`settings-login-username`, :ref:`settings-login-pw`, and :ref:`settings-secret-key`. diff --git a/doc/settings.rst b/doc/settings.rst index d541382d..fdb13f53 100644 --- a/doc/settings.rst +++ b/doc/settings.rst @@ -583,6 +583,8 @@ Whether to enable the dashbaord. If True, then the ``login_username`` and :Type: ``bool`` :Default: False +.. seealso:: :ref:`dashboard-overview` + .. _settings-do-scheduler: @@ -629,6 +631,24 @@ web pages urls/routes. By default if you aren't using them, this is ignored. +.. _settings-secret-key: + +secret_key +~~~~~~~~~~ + +:Type: ``string`` +:Default: None + +This is `required by psiTurk's underlying Flask server`__ for any route +that uses a "Session", such as the :ref:`psiTurk Dashboard `. + +It can be any string. + +__ https://flask.palletsprojects.com/en/1.1.x/quickstart/#sessions + +.. seealso:: :ref:`dashboard-overview` + + .. _settings-threads: threads