diff --git a/docs/docs/administration/img/customize-delete-user.png b/docs/docs/administration/img/customize-delete-user.png new file mode 100644 index 00000000000..e76212cd557 Binary files /dev/null and b/docs/docs/administration/img/customize-delete-user.png differ diff --git a/docs/docs/administration/img/delete-user.webp b/docs/docs/administration/img/delete-user.webp new file mode 100644 index 00000000000..9d03e5a94a7 Binary files /dev/null and b/docs/docs/administration/img/delete-user.webp differ diff --git a/docs/docs/administration/img/immediately-remove-user.png b/docs/docs/administration/img/immediately-remove-user.png new file mode 100644 index 00000000000..8f558bf7102 Binary files /dev/null and b/docs/docs/administration/img/immediately-remove-user.png differ diff --git a/docs/docs/administration/img/user-management-update.png b/docs/docs/administration/img/user-management-update.png index 428359e5738..f494750edc1 100644 Binary files a/docs/docs/administration/img/user-management-update.png and b/docs/docs/administration/img/user-management-update.png differ diff --git a/docs/docs/administration/img/user-quota-size.png b/docs/docs/administration/img/user-quota-size.png new file mode 100644 index 00000000000..bddaea716d1 Binary files /dev/null and b/docs/docs/administration/img/user-quota-size.png differ diff --git a/docs/docs/administration/img/user-storage-label.png b/docs/docs/administration/img/user-storage-label.png new file mode 100644 index 00000000000..686793c6419 Binary files /dev/null and b/docs/docs/administration/img/user-storage-label.png differ diff --git a/docs/docs/administration/user-management.mdx b/docs/docs/administration/user-management.mdx index 0b32b1ff8a9..47021fd7c0c 100644 --- a/docs/docs/administration/user-management.mdx +++ b/docs/docs/administration/user-management.mdx @@ -13,12 +13,57 @@ Immich supports multiple users, each with their own library. -## Delete a User +## Set Storage Quota For User -If you need to remove a user from Immich, head to "Administration", where users can be scheduled for deletion. The user account will immediately become disabled and their library and all associated data will be removed after 7 days. +Admin can specify the storage quota for the user as the instance's admin; once the limit is reached, the user won't be able to upload to the instance anymore. + +In order to select a storage quota, click on the pencil icon and enter the storage quota in GiB. You can choose an unlimited quota using the value 0 (default). + +:::tip +The system administrator can see the usage quota percentage of all users in Server Stats page. +::: + +:::info +External libraries don't take up space from the storage quota. +::: + + + +## Set Storage Label For User + +The admin can add a custom label for each user, so instead of `upload/{userId}/your-template` it will be `upload/{custom_user_label}/your-template`. +To apply a storage template, go to the Administration page -> click on the pencil button next to the user. +:::note +To apply the Storage Label to previously uploaded assets, run the Storage Migration Job. +::: + + ## Password Reset -To reset a user's password, click the pencil icon to edit a user, then click "Reset Password". The user's password will be reset to "password" and they have to change it next time the sign in. +To reset a user's password, click the pencil icon to edit a user, then click "Reset Password". The user's password will be reset to random password and they have to change it next time the sign in. -![Reset Password](./img/user-management-update.png) + + +## Delete a User + +If you need to remove a user from Immich, head to "Administration", where users can be scheduled for deletion. The user account will immediately become disabled and their library and all associated data will be removed after 7 days by default. + + + +### Delete Delay + +You can customize the time of the deletion of the users from the Administration -> Settings -> User Settings. +:::info user deletion job +The user deletion job runs at midnight to check for users that are ready for deletion. Changes to this setting will be evaluated at the next execution. +::: + + + +### Immediately Remove User + +You can choose to delete a user immediately by checking the box +`Queue user and assets for immediate deletion` in the deletion process, this will immediately remove the user and all assets. +This cannot be undone and the files cannot be recovered. + +