Skip to content

Commit cd8a124

Browse files
authored
feat(docs): User management new options (#8029)
* User Management * Add photo
1 parent 148428a commit cd8a124

7 files changed

+49
-4
lines changed
24.7 KB
Loading

Diff for: docs/docs/administration/img/delete-user.webp

7.13 KB
Binary file not shown.
34.4 KB
Loading
25 KB
Loading

Diff for: docs/docs/administration/img/user-quota-size.png

35.3 KB
Loading

Diff for: docs/docs/administration/img/user-storage-label.png

36 KB
Loading

Diff for: docs/docs/administration/user-management.mdx

+49-4
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,57 @@ Immich supports multiple users, each with their own library.
1313

1414
<UserCreate />
1515

16-
## Delete a User
16+
## Set Storage Quota For User
17+
18+
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.
19+
20+
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).
21+
22+
:::tip
23+
The system administrator can see the usage quota percentage of all users in Server Stats page.
24+
:::
25+
26+
:::info
27+
External libraries don't take up space from the storage quota.
28+
:::
1729

18-
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.
30+
<img src={require('./img/user-quota-size.png').default} width="40%" title="Set Quota Size" />
31+
32+
## Set Storage Label For User
33+
34+
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`.
35+
To apply a storage template, go to the Administration page -> click on the pencil button next to the user.
36+
:::note
37+
To apply the Storage Label to previously uploaded assets, run the Storage Migration Job.
38+
:::
39+
40+
<img src={require('./img/user-storage-label.png').default} width="40%" title="Delete User" />
1941

2042
## Password Reset
2143

22-
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.
44+
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.
45+
46+
<img src={require('./img/user-management-update.png').default} width="40%" title="Reset Password" />
47+
48+
## Delete a User
49+
50+
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.
51+
52+
<img src={require('./img/delete-user.webp').default} width="40%" title="Delete User" />
53+
54+
### Delete Delay
55+
56+
You can customize the time of the deletion of the users from the Administration -> Settings -> User Settings.
57+
:::info user deletion job
58+
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.
59+
:::
60+
61+
<img src={require('./img/customize-delete-user.png').default} width="80%" title="Customize Delete User" />
62+
63+
### Immediately Remove User
64+
65+
You can choose to delete a user immediately by checking the box
66+
`Queue user and assets for immediate deletion` in the deletion process, this will immediately remove the user and all assets.
67+
This cannot be undone and the files cannot be recovered.
2368

24-
![Reset Password](./img/user-management-update.png)
69+
<img src={require('./img/immediately-remove-user.png').default} width="40%" title="Customize Delete User" />

0 commit comments

Comments
 (0)