From f02dde909104e48bc226b254743686ef1ed736ef Mon Sep 17 00:00:00 2001 From: Stefan Pejcic Date: Mon, 5 Feb 2024 15:30:34 +0100 Subject: [PATCH] Update openpanel.md --- documentation/docs/admin/users/openpanel.md | 92 +++++++++++++++++++-- 1 file changed, 85 insertions(+), 7 deletions(-) diff --git a/documentation/docs/admin/users/openpanel.md b/documentation/docs/admin/users/openpanel.md index 79de2d7..94f69f0 100644 --- a/documentation/docs/admin/users/openpanel.md +++ b/documentation/docs/admin/users/openpanel.md @@ -9,33 +9,67 @@ OpenPanel currently has only a single user role named **User** that can only man ## List Users + + + + To access all OpenPanel users, navigate to OpenAdmin > Users. The Users page displays a table showcasing each user's Gravatar linked to their email address, username, assigned IP Address, hosting plan name, creation date of the account, a login link enabling user impersonation, and an actions dropdown. In the actions dropdown, you can perform actions such as editing, suspending, or deleting the user. ![openadmin users page](/img/admin/openadmin_users_page.png) -Or from the terminal: [opencli user-list](/docs/admin/scripts/users#list-users) Suspended users are highlighted in red, and no actions can be performed on a suspended user. + + + +From the terminal: [opencli user-list](/docs/admin/scripts/users#list-users) + + + + + ## Create Users + + + + To create a new user, click on the 'New User' button on the Users page. A new section will be displayed with a form where you can set the email address, username, generate a strong password, and assign a hosting plan for the user. ![openadmin users add new](/img/admin/openadmin_add_new_user.png) -Or from the terminal: [opencli user-add](/docs/admin/scripts/users#add-user) + + + +From the terminal: [opencli user-add](/docs/admin/scripts/users#add-user) + + + + + ## Reset User Password + + + To reset password for a user click on the Edit dropdown in table for that user in OpenAdmin > Users or from the individual User page click on "Edit information" and set the new password in the Password field then save. Step 1. | Step 2. :-------------------------:|:-------------------------: ![openadmin users reset password step 1](/img/admin/openadmin_users_edit_information.png) | ![openadmin users reset password step 2](/img/admin/openadmin_users_edit_information_change_password.png) -Or from the terminal: [opencli user-password](/docs/admin/scripts/users#change-password) + + + + +From the terminal: [opencli user-password](/docs/admin/scripts/users#change-password) + + + ## Detailed User Information @@ -158,6 +192,9 @@ The Ports widget displays all ports published in the user's Docker container and ## Suspend User + + + Suspending an account will immediately disable the user's access to the OpenPanel. This action involves pausing the user's Docker container and revoking access to their email, website, and other associated services. Please be aware of the immediate impact before proceeding. To suspend a user click on the Suspend button on that user page and click on 'Suspend' on the confirmation modal. @@ -166,34 +203,75 @@ Step 1. | Step 2. :-------------------------:|:-------------------------: ![openadmin users suspend step 1](/img/admin/openadmin_users_suspend_1.png) | ![openadmin users suspend step 2](/img/admin/openadmin_users_suspend_2.png) -Or from the terminal: [opencli user-suspend](/docs/admin/scripts/users#suspend-user) + + + +From the terminal: [opencli user-suspend](/docs/admin/scripts/users#suspend-user) + + + ## Unsuspend User + + + To unsuspend a user click on the Unsuspend button for that user. ![openadmin users add new](/img/admin/openadmin_users_unsuspend.png) + + + +From the terminal: [opencli user-unsuspend](/docs/admin/scripts/users#unsuspend-user) + + + + ## Change IP address for User + + + To change IP address for a user, click on the 'Edit Information' link for the user, then elect the new IP address and click on 'Save changes'. Step 1. | Step 2. :-------------------------:|:-------------------------: ![openadmin users change ip address step 1](/img/admin/openadmin_users_edit_information.png) | ![openadmin users change ip address step 2](/img/admin/openadmin_users_edit_information_change_ip_address.png) -Or from the terminal: [opencli user-ip](/docs/admin/scripts/users#assign--remove-ip-to-user) + + + +From the terminal: [opencli user-ip](/docs/admin/scripts/users#assign--remove-ip-to-user) + + + + + + + ## Delete User + + + + To delete a user click on the delete button for that user, then type 'delete' in the confirmation modal and finally click on the 'Terminate' button. Step 1. | Step 2. :-------------------------:|:-------------------------: ![openadmin users delete step 1](/img/admin/openadmin_users_delete_1.png) | ![openadmin users deletes step 2](/img/admin/openadmin_users_delete_2.png) -Or from the terminal: [opencli user-delete](/docs/admin/scripts/users#delete-user) + + + +From the terminal: [opencli user-delete](/docs/admin/scripts/users#delete-user) -:::warning + + + + +:::danger This action is irreversible and will permanently delete all user data. :::