Merge pull request #2738 from fractal-analytics-platform/2721-update-docs-about-users

Update docs about users

Author: tcompa

CHANGELOG.md

@@ -1,7 +1,9 @@
 **Note**: Numbers like (\#1234) point to closed Pull Requests on the fractal-server repository.
 
-# 2.15.8 (unreleased)
+# 2.15.8 (Unreleased)
 
+* Documentation:
+    * Fix `Fractal Users` documentation page (\#2738).
 * Internal
     * Improve type hints (\#2739).
 

docs/internals/users.md

@@ -5,7 +5,7 @@ Fractal Server's user model and authentication/authorization systems are powered
 ## User Model
 <a name="user-model"></a>
 
-A Fractal user corresponds to an instance of the [`UserOAuth`](..//reference/fractal_server/app/models/security.md/#fractal_server.app.models.security.UserOAuth) class, with the following attributes:
+A Fractal user corresponds to an instance of the [`UserOAuth`](../reference/fractal_server/app/models/security.md#fractal_server.app.models.security.UserOAuth) class, with the following attributes:
 
 | Attribute | Type | Nullable | Default |
 | :--- | :---: | :---: | :---: |
@@ -15,13 +15,11 @@ A Fractal user corresponds to an instance of the [`UserOAuth`](..//reference/fra
 | is_active | bool | | true |
 | is_superuser | bool | | false |
 | is_verified | bool | | false |
-| <span style="background-color:teal;color:white">&nbsp;slurm_user&nbsp;</span> | string | * | null |
 | <span style="background-color:teal;color:white">&nbsp;username&nbsp;</span> | string | * | null |
-| <span style="background-color:teal;color:white">&nbsp;cache_dir&nbsp;</span> | string | * | null |
 
-The colored attributes are specific for Fractal users, while the other attributes are [provided](https://github.com/fastapi-users/fastapi-users-db-sqlmodel/blob/main/fastapi_users_db_sqlmodel/__init__.py) by FastAPI Users.
+The colored attribute (`username`) is specific for Fractal users, while the other attributes are [the default ones from `fastapi-users`](https://fastapi-users.github.io/fastapi-users/latest/configuration/schemas/).
 
-In the startup phase, `fractal-server` always creates a default user, who also has the superuser privileges that are necessary for managing other users.
+In the startup phase, `fractal-server` creates a default user, who also has the superuser privileges that are necessary for managing other users.
 The credentials for this user are defined via the environment variables
 [`FRACTAL_ADMIN_DEFAULT_EMAIL`](../configuration.md/#fractal_server.config.Settings.FRACTAL_DEFAULT_ADMIN_EMAIL) (default: `[email protected]`)
 and
@@ -34,7 +32,7 @@ and
 The most common use cases for `fractal-server` are:
 
 1. The server is used by a single user (e.g. on their own machine, with the [local backend](runners/local.md)); in this case you may simply customize and use the default user.
-2. The server has multiple users; in this case the admin may use the default user (or another user with superuser privileges) to create additional users (with no superuser privileges). For `fractal-server` to execute jobs on a SLURM cluster (through the corresponding [SLURM backend](runners/slurm.md)), each Fractal must be associated to a cluster user via the `slurm_user` attribute (see [here](runners/slurm.md/#user-impersonation) for more details about SLURM users).
+2. The server has multiple users, and it is connected to a SLURM cluster. For `fractal-server` to execute jobs on the SLURM cluster each Fractal must be associated to a cluster user via additional properties defined in the [`UserSettings` table](../reference/fractal_server/app/models/user_settings.md). See [here](runners/slurm.md/#user-impersonation) for more details about SLURM users.
 
 More details about user management are provided in the [User Management section](#user-management) below.
 

fractal_server/app/models/security.py

@@ -73,10 +73,9 @@ class UserOAuth(SQLModel, table=True):
         is_active:
         is_superuser:
         is_verified:
-        slurm_user:
-        slurm_accounts:
         username:
         oauth_accounts:
+        settings:
     """
 
     __tablename__ = "user_oauth"