mirror of
https://github.com/immich-app/immich.git
synced 2026-01-25 19:04:42 -08:00
a244d94ac8
* docs: beginning of the year tune up and updates * darker dark * backup information * promote to table of content * Apply suggestions from code review Co-authored-by: Mert <101130780+mertalev@users.noreply.github.com> Co-authored-by: Mees Frensel <33722705+meesfrensel@users.noreply.github.com> * restore and backup * edit * Apply suggestions from code review Co-authored-by: bo0tzz <git@bo0tzz.me> * feedback * more information on mobile Co-authored-by: https://github.com/aviv926 * more information on free up space > > Co-authored-by: jtagcat <git-12dbd862@jtag.cat> * Update docs/docs/features/mobile-app.mdx Co-authored-by: jtagcat <git-12dbd862@jtag.cat> * screenshot and minor tweaks --------- Co-authored-by: Mert <101130780+mertalev@users.noreply.github.com> Co-authored-by: Mees Frensel <33722705+meesfrensel@users.noreply.github.com> Co-authored-by: bo0tzz <git@bo0tzz.me> Co-authored-by: jtagcat <git-12dbd862@jtag.cat>
80 lines
3.1 KiB
Plaintext
80 lines
3.1 KiB
Plaintext
import RegisterAdminUser from '/docs/partials/_register-admin.md';
|
|
import UserCreate from '/docs/partials/_user-create.md';
|
|
|
|
# User Management
|
|
|
|
Immich supports multiple users, each with their own library.
|
|
|
|
## Register the Admin User
|
|
|
|
<RegisterAdminUser />
|
|
|
|
## Create a New User
|
|
|
|
<UserCreate />
|
|
|
|
## Send new user email notification
|
|
|
|
:::note
|
|
This option is only available if an SMTP server has been configured in the administrator settings.
|
|
:::
|
|
|
|
Admin can send a welcome email if the Email option is set, you can learn here how to set up the SMTP server in Immich.
|
|
|
|
<img
|
|
src={require('./img/send-user-email-notification.webp').default}
|
|
width="40%"
|
|
title="Send user email notification"
|
|
/>
|
|
|
|
## Set Storage Quota For User
|
|
|
|
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 edit user icon and enter the storage quota in GiB. You can choose an unlimited quota by leaving it empty (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.
|
|
:::
|
|
|
|
<img src={require('./img/user-quota-size.webp').default} width="80%" title="Set Quota Size" />
|
|
|
|
## 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 > Users`, then click on the context menu button next to the user.
|
|
:::note
|
|
To apply the Storage Label to previously uploaded assets, run the Storage Migration Job.
|
|
:::
|
|
|
|
<img src={require('./img/user-storage-label.webp').default} width="40%" title="Delete User" />
|
|
|
|
## Password Reset
|
|
|
|
<img src={require('./img/user-edit-menu.webp').default} width="80%" title="Customize Delete User" />
|
|
|
|
To reset a user's password, go to `Administration > Users`, then click on the context menu button next to the user, then click "Reset Password". The user's password will be reset to a random password and they have to change it next time they sign in.
|
|
|
|
## Delete a User
|
|
|
|
If you need to remove a user from Immich, go to `Administration > Users`, then click on the context menu button next to the user. 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 `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.
|
|
|
|
<img src={require('./img/immediately-remove-user.webp').default} width="40%" title="Customize Delete User" />
|