UniqueSoft/openpanel
2
0
Fork 0
mirror of https://github.com/stefanpejcic/openpanel synced 2025-06-26 18:28:26 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Update users.md

Browse Source
This commit is contained in:
Radovan Ječmenica 2025-05-15 15:02:55 +02:00 committed by GitHub
parent b82157be20
commit dbed2bd339
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 3 additions and 101 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

104
website/docs/admin/accounts/users.md
View File

@ -68,8 +68,6 @@ curl -X GET http://PANEL:2087/api/users -H "Authorization: Bearer JWT_TOKEN_HERE
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.gif)
</TabItem>
<TabItem value="CLI-users-new" label="OpenCLI">
@ -125,10 +123,6 @@ Example response:
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)
</TabItem>
<TabItem value="CLI-users-reset" label="OpenCLI">
@ -163,19 +157,12 @@ curl -X PATCH http://PANEL:2087/api/users/USERNAME_HERE -H "Content-Type: applic
To view detailed information about a user, click on their Gravatar, username or the *Manage* button in the users table.
![openadmin manage user button](/img/admin/openadmin_manage_button.png)
This page shows detailed information about the account and provides tools to manage it.
![openadmin users single user view](/img/admin/openadmin_users_single_user_view.png)
The username is displayed at the top, along with the status of the Docker container for the user. Colors indicate whether the user is suspended or if the Docker container has encountered an error. Next to the username, there are buttons that allow you to suspend/unsuspend the user, delete the user, a configure button to edit user settings inside their Docker container, and a 'Login as user' button that automatically logs you into their OpenPanel interface.
![openadmin users single user buttons](/img/admin/manage_single_user_btns.png)
There are 4 widgets on top of the page:
![openadmin users single user view 2](/img/admin/user_2.png)
- **CPU Usage:** Shows the current CPU usage of all processes by the user, represented in percentage with color indicators.
- **Memory Usage:** Displays the current memory usage of the Docker container, represented in percentage with color indicators.
@ -190,8 +177,6 @@ There are 6 tabs that allow you to view relevant information about the user's Do
### Docker
![openadmin users single user view docker_tab](/img/admin/docker_tab.png)
The Docker tab displays information about the Docker container for the user, including:
- **Server:** Server on which the container is running.
@ -217,7 +202,6 @@ The Docker tab displays information about the Docker container for the user, inc
- `/home/username` is used for all website files that user uploads to their home directory.
- `/var/lib/docker/devicemapper/mnt/..` is the total file system that the user's Docker container is limited to; this includes the OS itself, system services, databases, logs, etc.
![openadmin users single user view du](/img/admin/du_tab.png)
</TabItem>
<TabItem value="CLI-user-du" label="With OpenCLI">
@ -297,20 +281,12 @@ The Websites tab will display all domains and websites that the user has inside
- **Domains table** showcases information such as domain name, root directory, and links to view the access log for the domain, edit DNS records, and edit the VirtualHost file for Nginx associated with the domain.
- **Websites table** displays the website URL, type (WordPress, Node.js, or Python), CMS version, and the time when the user installed or added it to the Site Manager interface.
![openadmin users single user view websites tab](/img/admin/websites_tab.png)
To view access log for a domain click on the 'View Access Log' link:
To view access log for a domain click on the 'View Access Log' link.
![openadmin users single user view domain access log](/img/admin/admin_single_user_access.png)
To view and edit DNS zone for a domain, click on the 'DNS Zone' link.
To view and edit DNS zone for a domain, click on the 'DNS Zone' link:
![openadmin users single user view domain dns zone](/img/admin/admin_single_user_dns.png)
To view and edit Nginx configuration for a domain, click on the 'VirtualHosts' link:
![openadmin users single user view domain vhosts file](/img/admin/admin_single_user_vhosts.png)
To view and edit Nginx configuration for a domain, click on the 'VirtualHosts' link.
----
@ -318,9 +294,6 @@ To view and edit Nginx configuration for a domain, click on the 'VirtualHosts' l
The Services tab displays a list of all services installed inside the user's Docker container, along with their current status. You have options to start, stop, or restart a service.
![openadmin users single user view services tab](/img/admin/services_tab.png)
Services can be [pre-installed in a Docker image](https://dev.openpanel.co/images/), which is recommended for production to reduce the disk usage required for idle user accounts. Alternatively, they can be [installed later by an administrator](#) or by a user.
@ -330,32 +303,24 @@ Services can be [pre-installed in a Docker image](https://dev.openpanel.co/image
The Backups tab displays a list of all available backups for the user account, showcasing backup content and sizes.
![openadmin users single user view backups tab](/img/admin/backups_tab.png)
----
### Usage
The Usage tab will display Docker container stats for the user, including CPU usage, memory percentage used at that moment, network I/O, and total block I/O. This information is the same to what users can view from [OpenPanel > Resource Usage](/docs/panel/analytics/resource_usage/).
![openadmin users single user view usage tab](/img/admin/usage_tab.png)
----
### Activity
The Activity tab shows the user's account activity log, providing the same information users can view from OpenPanel > Account Activity page.
![openadmin users single user view activity tab](/img/admin/activity_tab.png)
----
### General information
General information widget displays the general information about the user and their container:
![openadmin users single user view general info](/img/admin/general_info_tab.png)
- **User ID:** Unique ID for the user account.
- **Email Address:** Current email address for the user.
- **Two Factor:** Indicates whether 2FA is enabled by the user.
@ -369,16 +334,12 @@ General information widget displays the general information about the user and t
To edit any information for the user, click on the 'Edit Information' link, and a new modal will be displayed where you can change the username, email, plan, IP, or password.
![openadmin users single user edit_info_tab](/img/admin/edit_info_tab.png)
----
### Ports
The Ports widget displays all ports published in the user's Docker container and corresponding randomly generated ports for the user on the host server machine.
![openadmin users single user ports_tab](/img/admin/ports_tab.png)
## Suspend User
@ -389,9 +350,6 @@ Suspending an account will immediately disable the user's access to the OpenPane
To suspend a user click on the Suspend button on that user page and click on 'Suspend' on the confirmation modal.
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)
</TabItem>
<TabItem value="CLI-user-suspend" label="With OpenCLI">
@ -418,8 +376,6 @@ opencli user-suspend filip
To unsuspend a user click on the Unsuspend button for that user.
![openadmin users add new](/img/admin/openadmin_users_unsuspend.png)
</TabItem>
<TabItem value="CLI-user-unsuspend" label="With OpenCLI">
@ -446,9 +402,6 @@ opencli user-unsuspend filip
To Rename a user, click on the 'Edit Information' link for the user, then change the address in 'Username' field and click on 'Save changes'.
Step 1. | Step 2.
:-------------------------:|:-------------------------:
![openadmin users change username step 1](/img/admin/openadmin_users_edit_information.png) | ![openadmin users change username step 2](/img/admin/openadmin_user_change_username.png)
</TabItem>
<TabItem value="CLI-user-email" label="With OpenCLI">
@ -477,10 +430,6 @@ User 'stefan' successfully renamed to 'pejcic'.
To change email address for a user, click on the 'Edit Information' link for the user, then change the address in 'Email address' field and click on 'Save changes'.
Step 1. | Step 2.
:-------------------------:|:-------------------------:
![openadmin users change email step 1](/img/admin/openadmin_users_edit_information.png) | ![openadmin users change email step 2](/img/admin/openadmin_user_change_email.png)
</TabItem>
<TabItem value="CLI-user-email" label="With OpenCLI">
@ -502,50 +451,6 @@ Email for user stefan updated to stefan@pejcic.rs.
## Change IP address for User
<Tabs>
<TabItem value="openadmin-user-ip" label="With OpenAdmin" default>
To change IP address for a user, click on the 'Edit Information' link for the user, then select 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)
</TabItem>
<TabItem value="CLI-user-ip" label="With OpenCLI">
To assign unused IP address to a user run the following command:
```bash
opencli user-ip <USERNAME> <IP_ADDRESS>
```
To assign IP address **that is currently used by another user** to this user, use the `--y` flag.
Example:
```bash
opencli user-ip filip 11.128.23.89 --y
```
To remove dedicated IP address from a user run:
```bash
opencli user-ip <USERNAME> delete
```
Example:
```bash
opencli user-ip filip delete
```
</TabItem>
</Tabs>
## Delete User
@ -554,9 +459,6 @@ opencli user-ip filip delete
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)
</TabItem>
<TabItem value="CLI-user-delete" label="With OpenCLI">