diff --git a/docs_manual/source/admin_commands.rst b/docs_manual/source/admin_commands.rst index cc59b702..5c90c997 100644 --- a/docs_manual/source/admin_commands.rst +++ b/docs_manual/source/admin_commands.rst @@ -19,6 +19,9 @@ These commands originate in SODAR Core. More information can be found in the Add remote site for remote project synchronization. ``batchupdateroles`` Batch update project roles and send invites. +``checkusers`` + Check the status of LDAP users. Returns info on users whose accounts are + disabled or removed on an LDAP server. ``cleanappsettings`` Clean up unused application settings. ``deletecache`` diff --git a/docs_manual/source/introduction.rst b/docs_manual/source/introduction.rst index 2bc1cee6..d09c4f4e 100644 --- a/docs_manual/source/introduction.rst +++ b/docs_manual/source/introduction.rst @@ -68,8 +68,7 @@ Notable Features ================ - Accessibility - * User access via one or multiple LDAP/AD services, Single Sign-On via SAML - and/or local accounts + * User access via one or multiple LDAP/AD services and/or local accounts * Access tokens can be can be generated for REST API use * UUIDs and permanent URLs for all relevant objects in the system - iRODS Integration diff --git a/docs_manual/source/ui_project_update.rst b/docs_manual/source/ui_project_update.rst index 24f0ab5b..55754c13 100644 --- a/docs_manual/source/ui_project_update.rst +++ b/docs_manual/source/ui_project_update.rst @@ -23,7 +23,8 @@ Project Metadata The following project metadata and settings are available for updating: Title - Update the project title. + Update the project title. The title must be unique within the parent + category. Parent Move the project to another category. Options only contain categories for which you have sufficient access. @@ -32,23 +33,29 @@ Description ReadMe Set an optional ReadMe document with for the project. MarkDown notation can be used. -Public Guest Access +Public guest access Enable public guest access to the project for anyone using SODAR. This should be used with caution and is generally intended for demonstration projects. If your SODAR server allows anonymous users, this will grant guest access to anyone browsing the site. -Notify Members of Landing Zone Uploads +Enable project on {target remote site} + Enable access to project for project members on the selected target site. + Target sites for which project owner/delegation modifying is enabled by an + administrator are listed here. Deselecting a previously selected site will + revoke access on the target site. For more information, see + `Remote Site Access documentation `_. +Notify members of landing zone uploads Send project members email updates for file uploads using landing zones. For more information, see the :ref:`Landing Zones app documentation `. -Allow Sample Sheet Editing +Allow sample sheet editing Enable or disable editability of sample sheets in the project. -Enable Sheet Synchronization +Enable sheet synchronization Enable sample sheet synchronization. For more information, see :ref:`app_samplesheets_sync`. -URL for Sheet Synchronization +URL for sheet synchronization REST API URL of remote project for sample sheet synchronization. -Token for Sheet Synchronization +Token for sheet synchronization Token string for sample sheet synchronization. IGV session genome Genome used in generating IGV session files for the project. The name needs @@ -69,9 +76,9 @@ VCF paths to omit from IGV sessions cancer and germline projects. Behaves similarly to the related BAM/CRAM setting. You need to run :guilabel:`Update Sheet Cache` in the Sample Sheet application for changes to take effect. -IP Restrict +IP restrict Restrict project access to specific IP addresses if this is set. -IP Allow List +IP allow list List of accepted IP addresses for the IP Restrict setting. When creating a new project, the following fields are included: diff --git a/docs_manual/source/ui_user_profile.rst b/docs_manual/source/ui_user_profile.rst index f3e426a0..5d54cf73 100644 --- a/docs_manual/source/ui_user_profile.rst +++ b/docs_manual/source/ui_user_profile.rst @@ -75,4 +75,4 @@ Update User Details If local users are enabled on the site and you have a local SODAR account, the profile also includes the :guilabel:`Update User` button. This opens a form in which you can update your details and password. This form is **not** available -for users authenticating with an existing user account via LDAP or OIDC. +for users authenticating with an existing user account via LDAP.