Commit 9b84f5f3 authored by Alejandro Celaya's avatar Alejandro Celaya Committed by Alejandro Celaya

Document configuration options for user profile mini-app

parent 8775ce22
...@@ -10,6 +10,13 @@ build tasks. ...@@ -10,6 +10,13 @@ build tasks.
the notebook app's iframe). the notebook app's iframe).
``https://hypothes.is/notebook`` by default. ``https://hypothes.is/notebook`` by default.
.. envvar:: PROFILE_APP_URL
The default value for the :option:`profileAppUrl` config setting (the URL of
the user profile iframe), used when the host page does not contain a
:option:`profileAppUrl` setting.
``https://hypothes.is/user-profile`` by default.
.. envvar:: SIDEBAR_APP_URL .. envvar:: SIDEBAR_APP_URL
The default value for the :option:`sidebarAppUrl` config setting (the URL of The default value for the :option:`sidebarAppUrl` config setting (the URL of
......
...@@ -475,3 +475,7 @@ These settings configure where the client's assets are loaded from. ...@@ -475,3 +475,7 @@ These settings configure where the client's assets are loaded from.
.. option:: notebookAppUrl .. option:: notebookAppUrl
``String``. The URL for the notebook application (Default: ``"https://hypothes.is/notebook"``). ``String``. The URL for the notebook application (Default: ``"https://hypothes.is/notebook"``).
.. option:: profileAppUrl
``String``. The URL for the user profile application (Default: ``"https://hypothes.is/user-profile"``).
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment