.. _tethys_user_pages: ************ Tethys Users ************ **Last Updated:** September 2023 User Settings ============= The User Settings page can be accessed through the drop-down menu located at the top right of the tethys portal window. Through the settings page a user can manage the information stored in their user profile. .. tip:: A non-editable view of the user's information can be accessed by clicking the user avatar icon to the left of the drop-down menu (see Figure 1). .. note:: This icon next to the users name come from `Gravatar `_. This feature requires the ``django-gravatar2`` library to be installed. Starting with Tethys 5.0 or if you are using ``micro-tethys-platform``, you will need to install ``django-gravatar2`` using conda or pip as follows: .. code-block:: bash # conda: conda-forge channel strongly recommended conda install -c conda-forge django-gravatar2 # pip pip install django-gravatar2 .. figure:: ../images/tethys_portal/tethys_portal_user_profile.png :width: 675px **Figure 1.** User profile page. .. _tethys_quotas_user_manage: Manage User Storage =================== Within a user's settings page there is a ``Workspace`` section that provides a summary of the user's workspace storage across all apps and the current quota being enforced on it (see Figure 2). To manage the workspaces click the ``Manage Storage`` button, which will bring you to a table displaying workspace information for each app (see Figure 3). Use the Clear Workspace button next to each app to clear the workspace for that app. .. figure:: ../images/tethys_portal/tethys_portal_user_workspace.png :width: 675px **Figure 2.** User settings page showing Workspace section. .. figure:: ../images/tethys_portal/tethys_portal_manage_storage.png :width: 675px **Figure 3.** User's manage storage page. .. tip:: See :ref:`tethys_quotas_workspace_manage` for information on how to pre/post process the user workspace when it is cleared. Manage User OAuth2 Application Registrations ============================================ .. important:: This feature requires the ``django-oauth-toolkit`` library to be installed. Starting with Tethys 5.0 or if you are using ``micro-tethys-platform``, you will need to install ``django-oauth-toolkit`` using conda or pip as follows: .. code-block:: bash # conda: conda-forge channel strongly recommended conda install -c conda-forge django-oauth-toolkit # pip pip install django-oauth-toolkit This section provides a link to the OAuth2 application management page for the user. This allows a user to register an external application that will use Tethys Portal as the OAuth2 provider. This enables users of the external application to authenticate using Tethys. Customization ============= The Tethys User Profile and Settings pages can be customized by overriding the template used to render them (see the ``Custom Templates`` section in :ref:`tethys_configuration`). When providing a custom template you may just want to extend the default template and override specific blocks. For example: .. code-block:: html+django {% extends "tethys_portal/user/profile.html" %} {% block api_key_override %} {% endblock %} {% block custom_sections %}

Custom Section

{{ custom_user_attribute }}

{% endblock %} The following blocks are defined in the ``profile.html`` file: - ``title`` - ``back_button`` - ``secondary_content`` - ``profile_sections`` - ``name_override`` - ``name_parameters`` - ``email_override`` - ``email_parameters`` - ``credentials_override`` - ``credential_parameters`` - ``sso_override`` - ``social_parameters`` - ``api_key_override`` - ``account_override`` - ``account_parameters`` - ``workspace_override`` - ``storage_parameters`` - ``oauth2_provider_override`` - ``custom_sections`` .. note:: The ``settings.html`` file is what is shown when the user selects the ``Edit`` button on the user profile page. It just extends the ``profile.html`` file and overrides the ``*_parameters`` blocks.