// File: admin/000_intro

# Get Started

The OpenAdmin offers an administrator-level interface where you can efficiently handle tasks such as creating and managing users, setting up hosting plans, enabling features, and editing OpenPanel settings.

## Requirements

Minimum Requirements:

- A blank full virtual machine or bare metal server
- Minimum of 1GB RAM and 5GB storage (4GB RAM and 50GB is recommended)
- AMD64(x86_64) or ARM(AArch64) architecture
- IPv4 address

Supported operating systems:
- **Ubuntu 22, 24, 26** (24.04 is recommended)
- **Debian 10, 11, 12, 13**
- **AlmaLinux 9.5 and 10** (9.5 is recommended for ARM CPU, 10 has a known issue [#744](https://github.com/stefanpejcic/OpenPanel/issues/744))
- **RockyLinux 9.6, 10**
- **CentOS 9.5**

On AlmaLinux 10 and RockyLinux 10, you must switch from `nftables` to `iptables`. See [#1472](https://github.com/docker/for-linux/issues/1472) and [#745](https://github.com/stefanpejcic/OpenPanel/issues/745#issuecomment-3451272947).

:::info
If you are using external firewall, the following ports should be opened: 
- for dns: `53`
- for email: `25` `465` `993`
- for websites: `80` `443`
- for panels: `2083` `2087` 
- for phpmyadmin: `2053` `8888`
- for user services:  `32768:60999`
:::

## Installation

OpenPanel can be installed on both VPS and bare-metal servers. 

The installation process takes about 5 minutes. To install openpanel follow these steps: 

<Tabs>
  <TabItem value="openpanel-install-on-dedicated" label="Install script" default>

1. Log in to your new server;
- as root via SSH or
- as a user with sudo privileges and type "sudo -i"
2. Copy and paste openpanel installation command into the terminal
```shell
bash <(curl -sSL https://openpanel.org)
```

The installation script supports [optional flags](/install) that can be used to configure openpanel, skip certain installation steps or simply display debugging information.

If you encountered any errors while running the installation script, please copy & paste the installation log file to [the community forums](https://community.openpanel.org).

  </TabItem>
  <TabItem value="openpanel-install-on-cloud" label="Cloud">

[Amazon Web Services (AWS)](/docs/articles/install-update/install-on-aws)

[DigitalOcean](/docs/articles/install-update/install-on-digitalocean)

[Google Cloud Platform (GCP)](/docs/articles/install-update/install-on-google-cloud)

[Microsoft Azure](/docs/articles/install-update/install-on-microsoft-azure)

[Vultr](/docs/articles/install-update/install-on-vultr)
    
  </TabItem>
  <TabItem value="openpanel-install-on-other" label="Other">

[CloudInit](/docs/articles/install-update/install-using-cloudinit)

[Ansible](/docs/articles/install-update/install-using-ansible)

[Virtualizor](/docs/articles/install-update/install-on-virtualizor)

  </TabItem>  
</Tabs>


## Post Install Steps

Recommended steps after installing OpenPanel:
- [Access the OpenAdmin panel](/docs/articles/dev-experience/how-to-access-openadmin)
- [Configure Domain and SSL for OpenPanel](/docs/admin/settings/general/#set-domain-for-openpanel)
- [Enable Modules (features) in OpenPanel UI](/docs/admin/settings/modules/)
- [Configure Custom Nameservers](/docs/articles/domains/how-to-configure-nameservers-in-openpanel/)
- [Create Hosting Packages](/docs/admin/plans/hosting_plans#create-a-plan)
- [Create New User Accounts](/docs/admin/accounts/users/#create-users)
- [Set Email address to receive Alerts](/docs/admin/notifications/#email-alerts)
- [Change Update Preferences](/docs/admin/settings/updates)
- [Secure OpenPanel for Production Use](/docs/articles/security/securing-openpanel/)

---

// File: admin/001_dashboard

# Dashboard

The dashboard page is the hub of the OpenAdmin interface and provides the overview of the current server performance and usage.

The dashboard page contains widgets:

- **User Activity** widget: Displays real-time combined activity log of all OpenPanel users.
- **Latest News** widget: Displays blog articles from the OpenPanel blog.
- **System Information** widget: Displays Information about your server configuration: Hostname, OS, OpenPanel version, Kernel, CPU type, Uptime, NUmber of Running Processes and available Package Updates.

## Usage

In the top-right corner of every page in **OpenAdmin**, administrators can monitor real-time resource usage, including **Load**, **Memory**, **CPU**, and **Disk**.

Hovering over each metric provides detailed information:

* **Load** – Average system load over 1, 5, and 15 minutes
* **Memory** – Usage of physical memory and SWAP
* **CPU** – Usage per CPU core
* **Disk** – Usage per disk partition

![SSE Widget](/img/docs-content/9Q9DMPH0-openadmin-sse.gif)

## User Activity

The **User Activity** widget provides a combined list of latest actions from all OpenPanel users (their activity logs).

## Latest News

The **Latest News** widget displays news from [OpenPanel Blog](https://openpanel.com/blog).

## System Information

The **System Information** widget displays information about your server:

- Hostname
- OS
- OpenPanel version
- Server Time
- Kernel version
- CPU model
- Uptime
- Number of running processes
- Available Package updates

## Try Enterprise

The **Try Enterprise** widget is displayed on Community Edition only and displays features for Enterprise edition and options to upgrade.

## Found a Bug

By default, every page in both the OpenPanel and OpenAdmin UIs includes a **"Found a bug? Let us know"** link at the bottom. This link allows users to report issues directly to our [GitHub Issues](https://github.com/stefanpejcic/OpenPanel/issues) page and includes basic information to help reproduce the problem.

For the OpenPanel UI, administrators can disable this link by going to **OpenAdmin > Settings > OpenPanel** and toggling off the **"Display link to report bugs"** option.

## Dark Mode

To enable Dark Mode, click your username in the bottom-left corner and select the Moon icon. To switch back to Light Mode, click the Sun icon.

![openadmin dark mode](/img/admin/dashboard/openadmin_dark_mode_toggle.gif)

## Menu

OpenAdmin menu lists all available options in the OpenAdmin interface. Simply click on a menu item to open it.

## Search

Search returns:

- OpenPanel users with login link for their OpenPanel
- Website/Domains of users
- Features/pages in the Admin interface

## Keyboard Shortcuts

OpenAdmin UI can be navigated using keyboard shortcuts: [view documentation](/docs/articles/dev-experience/openadmin-keyboard-shortcuts/).

## Logout

To log out of the OpenAdmin account, click your username in the bottom-left corner and select 'Sign out' option.

---

// File: admin/002_notifications

# Notifications

Notifications are accessible via the 'Notifications' menu item in OpenAdmin.

![notifications center](/img/admin/notifications_center.png)

OpenPanel tracks and notifies you of these events:

* Server reboot
* Service inactivity
* Available updates
* Admin login from a new IP address
* SSH login from a new IP address
* High memory usage
* High average load
* High CPU usage
* High disk usage
* High swap usage
* DNS changes

Each notification type can be individually disabled, and admins can set custom threshold limits.

To manage notification settings, click the **Settings** button on the Notifications page or navigate to: [Settings > Notifications](/docs/admin/settings/notifications).

---

// File: admin/license

# License

Add your OpenPanel Enterprise license key to unlock premium features.

## License Key

Enter your [OpenPanel Enterprise edition](https://my.openpanel.com/clientarea.php?action=products) license key here. Activating the license enables advanced capabilities such as:

* Email and FTP account management
* Reseller management
* API access
* Billing integrations with WHMCS, FOSSBilling, and more

For a step-by-step activation process, see the [Upgrading to OpenPanel Enterprise and activating License guide](/docs/articles/license/upgrade_to_openpanel_enterprise_and-activate_license/).

## Contact Support

When reaching out to support, generate a system report to provide detailed information about your setup.

---

// File: admin/accounts/users

# Users

OpenPanel has a single user role named **User** that can only manage their docker container and inherits settings specified by the Admin user.


## List Users


<Tabs>
  <TabItem value="openadmin-users" label="OpenAdmin" default>
  
  To access all OpenPanel users, navigate to  Users.
  
  The Users page displays a table with user information and buttons to manage it.
  
  ![openadmin users page](/img/admin/openadmin_users_list.gif)
  
  Additional Columns can be displayed using the 'Show Columns' button.

  Suspended users are highlighted in red, and no actions can be performed on a suspended user.

  </TabItem>
  <TabItem value="CLI-users" label="OpenCLI">

To list all users, use the following command:

```bash
opencli user-list
```

Example output:
```bash
opencli user-list
+----+----------------------------------+----------------------+----------------+------------------+-------+---------------------+
| id | username                         | email                | plan_name      | server           | owner | registered_date     |
+----+----------------------------------+----------------------+----------------+------------------+-------+---------------------+
|  3 | forums                           | stefan@openpanel.com | Standard plan  | forums           | NULL  | 2025-05-08 19:25:47 |
|  7 | pcx3                             | stefan@pejcic.rs     | Developer Plus | pcx3             | NULL  | 2025-05-09 12:26:20 |
|  9 | openpanelwebsite                 | info@openpanel.com   | Standard plan  | openpanelwebsite | NULL  | 2025-05-09 14:47:27 |
| 19 | SUSPENDED_20250529173435_radovan | radovan@jecmenica.rs | Standard plan  | radovan          | NULL  | 2025-05-29 07:47:15 |
+----+----------------------------------+----------------------+----------------+------------------+-------+---------------------+
```

You can also format the data as JSON:

```bash
opencli user-list --json
```
  </TabItem>
  <TabItem value="API-users" label="API">

To list all users, use the following api endpoint:

```bash
curl -X GET http://PANEL:2087/api/users -H "Authorization: Bearer JWT_TOKEN_HERE"
```

  </TabItem>
</Tabs>


## Create Users


<Tabs>
  <TabItem value="openadmin-users-new" label="OpenAdmin" default>

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.

![add new user openadmin](/img/admin/2025-06-09_08-20.png)

  </TabItem>
  <TabItem value="CLI-users-new" label="OpenCLI">

To create a new user run the following command:

```bash
opencli user-add <USERNAME> <PASSWORD> <EMAIL> <PLAN_NAME>
```
Example: 
```bash
opencli user-add filip password1234 filip@openadmin.com default_plan_apache
```

:::tip
Provide `generate` as password to generate a strong random password.
:::
  </TabItem>
  <TabItem value="API-users-new" label="API">

To create a new user use the following api call:

```bash
curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer JWT_TOKEN_HERE" -d '{"email": "EMAIL_HERE", "username": "USERNAME_HERE", "password": "PASSWORD_HERE", "plan_name": "PLAN_NAME_HERE"}' http://PANEL:2087/api/users
```

Example:
```bash
curl -X POST "http://PANEL:2087/api/users" -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGcBns" -H "Content-Type: application/json" -d '{"username":"stefan","password":"strongishpassword1234","email":"stefan@pejcic.rs","plan_name":"default_plan_nginx"}'
```

Example response:

```json
{
  "response": {
    "message": "Successfully added user stefan password: strongishpassword1234"
  },
  "success": true
}
```
  
  </TabItem>
</Tabs>

- The OpenPanel username must be 3 to 16 characters long and can only contain letters and numbers.
- The OpenPanel password must be 6 to 30 characters long and can include any characters except for single quotes (`'`) and double quotes (`"`).


## Single User

To view detailed information about a user, and edit their settings, click on their username in the users table.


### Statistics 

Statistics is the default tab, displays current usage statistics:

- Storage used
- Inodes used
- CPU usage
- Memory usage
- Number of running containers
- Disk I/O
- Network I/O
- Number of PIDs
- Time statistics usage was last update
- Historical usage

Clicking on 'Load Docker Usage History' will display a table with past resource usage for the user: Date, number of running containers, CPU% and Memory%, Net I/O and Block I/O.

![user statistics](/img/admin/user_usage.png)


### Services

Services tab displays all user services (docker containers):

- Service name
- Docker Image name and tag
- Current CPU usage
- Allocated CPU for the service
- Current Memory usage
- Allocated Memory for the service
- Current status: Enabled or Disabled
- Terminal link to run docker exec commands in that service.

![docker services](/img/admin/docker_services.png)

### Storage

Storage tab displays data from the [docker system df](https://docs.docker.com/reference/cli/docker/system/df/) command.

- Volumes
- Containers
- Images

### Overview

Overview page displays detailed user information and allows Administrator to set a custom message specifically for this user.

![user overview](/img/admin/2025-06-09_08-34.png)

Displayed information:

- User ID
- Email Address
- IP Address
- Geo Location for the IP
- Server Name
- Docker Context
- 2FA status
- Setup Time
- Custom Message for user


### Activity

Displays [users activity log](/docs/panel/account/account_activity/).

- Date
- Action performed
- IP Address

![user activity](/img/admin/login_log.png)

### Edit
From the Edit tab, Administrators can edit user information:

- Username
- Email address
- Password
- IP address
- Hosting Package

![user edit](/img/admin/edit_user.png)

### Suspend

<Tabs>
  <TabItem value="openadmin-user-suspend" label="With OpenAdmin" default>

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 link on that user page and type the username to confirm, then click on 'Suspend account' button.

![suspend user](/img/admin/openadmin_suspend_user.gif)

  </TabItem>
  <TabItem value="CLI-user-suspend" label="With OpenCLI">

To suspend (temporary disable access) to user, run the following command:

```bash
opencli user-suspend <USERNAME>
```
Example:

```bash
opencli user-suspend filip
```


  </TabItem>
</Tabs>

### Unsuspend

<Tabs>
  <TabItem value="openadmin-user-unsuspend" label="With OpenAdmin" default>

To unsuspend a user click on the Unsuspend button for that user.

  </TabItem>
  <TabItem value="CLI-user-unsuspend" label="With OpenCLI">
    
To unsuspend (enable access) to user, run the following command:

```bash
opencli user-unsuspend <USERNAME>
```

Example:
```bash
opencli user-unsuspend filip
```

  </TabItem>
</Tabs>


### Reset Password

<Tabs>
  <TabItem value="openadmin-users-reset" label="OpenAdmin" default>

To reset password for a user, click on "Edit" tab and set the new password in the Password field then click Save.

![add new user openadmin](/img/admin/reset_password.png)


  </TabItem>
  <TabItem value="CLI-users-reset" label="OpenCLI">

To reset the password for a OpenPanel user, you can use the `user-password` command:

```bash
opencli user-password <USERNAME> <NEW_PASSWORD>
```

Use the `--ssh` flag to also change the password for the SSH user in the container.

Example:

```bash
opencli user-password filip Ty7_K8_M2 --ssh
```

  </TabItem>
  <TabItem value="API-users-reset" label="API">

To reset password for an OpenPanel user, use the following api call:

```bash
curl -X PATCH http://PANEL:2087/api/users/USERNAME_HERE -H "Content-Type: application/json" -H "Authorization: Bearer JWT_TOKEN_HERE" -d '{"password": "NEW_PASSWORD_HERE"}'
```
  </TabItem>
</Tabs>



### Rename

<Tabs>
  <TabItem value="openadmin-user-username" label="With OpenAdmin" default>

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'.


  </TabItem>
  <TabItem value="CLI-user-email" label="With OpenCLI">

To change username for a user run the following command:

```bash
opencli user-rename <old_username> <new_username>
```

Example:

```bash
#opencli user-rename stefan pejcic
User 'stefan' successfully renamed to 'pejcic'.
```
  </TabItem>
</Tabs>


### Change Package

<Tabs>
  <TabItem value="openadmin-user-plan" label="With OpenAdmin" default>

To change a package for a user, click on the 'Edit' link for the user, then select the new package and click on 'Save changes'.

  </TabItem>
  <TabItem value="CLI-user-plan" label="With OpenCLI">

To change a package for a user run the following command:

```bash
opencli user-change_plan <USERNAME> '<NEW_PLAN_NAME>'
```
  </TabItem>
</Tabs>


### Change Email

<Tabs>
  <TabItem value="openadmin-user-email" label="With OpenAdmin" default>

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'.

  </TabItem>
  <TabItem value="CLI-user-email" label="With OpenCLI">

To change email address for a user run the following command:

```bash
opencli user-email <USERNAME> <NEW_EMAIL>
```

Example:

```bash
#opencli user-email stefan stefan@pejcic.rs
Email for user stefan updated to stefan@pejcic.rs.
```
  </TabItem>
</Tabs>



### Login to OpenPanel

To auto-login to a OpenPanel account, click on the **OpenPanel** button in top-right corner of the page.
 

### Delete User


<Tabs>
  <TabItem value="openadmin-user-delete" label="With OpenAdmin" default>

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.


  </TabItem>
  <TabItem value="CLI-user-delete" label="With OpenCLI">
    
To delete a user and all his data run the following command:

```bash
opencli user-delete <USERNAME>
```

add `-y` flag to disable prompt.

Example:
```bash
opencli user-delete filip -y
```

  </TabItem>
</Tabs>


:::danger
This action is irreversible and will permanently delete all user data.
:::

---

// File: admin/accounts/resellers

# Resellers

The **Resellers** feature allows administrators to create and manage Reseller users within OpenPanel. Resellers can act as sub-administrators, managing their own set of user accounts within the limits defined by the root administrator.

This feature is useful for hosting providers who want to delegate control to third-party resellers, while still maintaining overall control and isolation.

---

## Reseller Management Interface

The interface displays a table of existing reseller users with the following columns:

- **Username**  
  The unique identifier of the reseller user.

- **Status**  
  Indicates whether the reseller account is active or suspended.

- **Last Login IP**  
  The IP address from which the reseller last accessed the panel.

- **Last Login Time**  
  Timestamp of the last successful login by the reseller.

- **Current Accounts**  
  The number of user accounts currently managed by the reseller.

- **Max Accounts**  
  The maximum number of user accounts the reseller is allowed to create.

- **Allowed Plans**  
  Lists the hosting plans available to the reseller for assigning to their users.

---

Reseller users have access only to the features and account management tools assigned to them by the root administrator. They cannot exceed the limits defined in their reseller settings.

---

// File: admin/accounts/administrators

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';


# Administrators

The admin panel has three user roles:


| Role              | Description                                                               |
| ------------------ | ------------------------------------------------------------------------- |
| **Super Admin**    | Has unrestricted privileges, created on OpenPanel installation. |
| **Admin**          | Has restricted privileges, can not access all OpenAdmin UI pages and can not edit the SuperAdmin user. |
| **Reseller**       | Has restricted privileges. |


## Manage Admin users


<Tabs>
  <TabItem value="openadmin-admin-users" label="With OpenAdmin" default>
  
  Manage administrative users with access to the OpenAdmin interface via the **Administrators** page.
  
  For each admin user, you can view and manage the following details: Username, Status Role, Last Login IP, Last Login Time, Actions.

  </TabItem>

  <TabItem value="CLI" label="With OpenCLI">

To list admin users use command:

```bash
opencli admin list
```

  </TabItem>
</Tabs>

## Reset Admin Password


<Tabs>
  <TabItem value="openadmin-admin-reset" label="With OpenAdmin" default>

To reset admin password click on the Edit for that user from *Settings > Accounts > Administrators* page, then set the new password.

  </TabItem>
  <TabItem value="cli-reset" label="With OpenCLI">

To reset the password for an admin user:

```bash
opencli admin password <username> <new_password>
```

Example, reset password for and Admin user:
```bash
opencli admin password admin Pyl7_L2M1
```

  </TabItem>
</Tabs>


## Create new Admin

<Tabs>
  <TabItem value="openadmin-admin-new" label="With OpenAdmin" default>

To create new admin user click on the 'Create New' button in *Settings > Accounts > Administrators* page, set the username and password and click on *Save*.


  </TabItem>
  <TabItem value="cli-new" label="With OpenCLI">

To create new admin accounts:

```bash
opencli admin new <username> <password>
```

Example:
```bash
opencli admin new filip Pyl7_L2M1
```

  </TabItem>
</Tabs>





## Rename Admin user

<Tabs>
  <TabItem value="openadmin-admin-rename" label="With OpenAdmin" default>

To rename an Admin user, select it on **Settings > Accounts > Administrators** page and click on the Edit button and set new username.

![openadmin admin rename](/img/admin/openadmin_admin_rename.png)


  </TabItem>
  <TabItem value="cli-rename" label="With OpenCLI">

To rename admin user:

```bash
opencli admin rename <username> <new_username>
```

Example:
```bash
opencli admin rename filip filip2
```
  </TabItem>
</Tabs>


## Suspend Admin user

<Tabs>
  <TabItem value="openadmin-admin-suspend" label="With OpenAdmin" default>

To unsuspend an Admin user, select the user on **Settings > Accounts > Administrators** page and click on the Edit button, then **Unsuspend**.

  </TabItem>
  <TabItem value="cli-suspend" label="With OpenCLI">

```bash
opencli admin suspend <username>
```

Example:
```bash
opencli admin suspend filip
```
---

To unsuspend admin user:
```bash
opencli admin unsuspend <username>
```

Example:
```bash
opencli admin unsuspend filip
```

  </TabItem>
</Tabs>


## Delete Admin user

<Tabs>
  <TabItem value="openadmin-admin-delete" label="With OpenAdmin" default>

Select the user on **Settings > Accounts > Administrators** page and click on the delete button then confirm.

  </TabItem>
  <TabItem value="cli-delete" label="With OpenCLI">

From the terminal:

To delete admin user:
```bash
opencli admin delete <username>
```

Example:
```bash
opencli admin delete filip
```

  </TabItem>
</Tabs>


:::info
The Super Admin user can not be deleted.
:::

---

// File: admin/advanced/processes

# Process Manager

The Process Manager allows you to view and manage running system processes directly from the OpenPanel interface. It's a powerful tool for monitoring system activity and taking quick action when needed.

The process table includes the following details:

- **PID** – Process ID. Options are available to trace the process or kill it directly.
- **Owner** – The user that owns the process.
- **Priority** – The process's current scheduling priority.
- **CPU** – Percentage of CPU usage.
- **Memory** – Percentage of Memory usage.
- **Command** – The command or service that launched the process.

Use this tool to identify resource-heavy or suspicious processes, manage system load, or terminate unresponsive services.

---

// File: admin/advanced/terminal

# Terminal

The Web Terminal is available in **OpenAdmin**, allowing Super Administrators to manage their server environments directly from the browser.

1. Log in to your OpenAdmin panel.
2. Navigate to **Advanced > Terminal**.
3. Use the dropdown menu or selector to choose your preferred shell type: `sh` or `bash`.
4. The terminal interface will load, and you can begin typing commands immediately.

:::info 
The web terminal is available only to the Super Admin. Other Admin users will see a 403 error on this page.

To disable web terminal for Super Admin also, refer to [How to disable the Terminal feature in OpenAdmin](/docs/articles/dev-experience/disable-openadmin-web-terminal/)
:::

---

// File: admin/advanced/root-password

# Change Root Password

Use this section to securely update the SSH password for the root user.

To ensure strong security, your new password must meet the following requirements:

- Length: 8–20 characters

- Must include both letters and numbers

- No spaces, special characters, or emoji are allowed

This action updates the root user's credentials used for direct SSH access to the server. Always store your new password securely and avoid using easily guessable combinations.

---

// File: admin/advanced/ssh

# SSH Access

*OpenAdmin > Server >  SSH Access* allows Administrators to view and modify current server SSH configuration.

### Basic SSH Settings

![screenshot](/img/admin/ssh_access.png)

This page displays:

- **Port** - current SSH port
- **PermitRootLogin** - allow login for *root* user
- **PasswordAuthentication** - enable usage of passwords for ssh
- **PubkeyAuthentication** - enable usage of ssh keys

You can change any value and click on the save button to apply.

### Advanced SSH Settings

Here you can edit the SSH configuration file: `/etc/ssh/sshd_config`

### Authorized SSH Keys

Here you can view current authorized ssh keys, remove them or add new key.

---

// File: admin/advanced/crons

# Cron jobs

**OpenAdmin > Advanced > System Cron Jobs** lets Administrators view the scheduled cron tasks used by OpenPanel, modify their schedules, or enable/disable logging to the file `/etc/openpanel/openadmin/cron.log`.

![screenshot](/img/admin/openadmin_cronjobs.png)


Changing schedules may cause some OpenPanel features to stop working correctly. Only adjust these settings if:

- You need to fine-tune execution on servers with limited resources, or
- You have been advised to do so by OpenPanel support.

These cron jobs are essential for OpenPanel’s internal operations.

If you want to add your own custom cron jobs, use the root user’s crontab.

---

// File: admin/advanced/reboot

# Server Reboot

Initiate a reboot of the server. Depending on the situation, you can perform either a **graceful reboot** or a **forceful reboot**.

- **Graceful Server Reboot** attempts to safely stop running processes and allow the operating system to cleanly shut down services before restarting.
- **Forceful Server Reboot** immediately restarts the system at the kernel level and should only be used if the server is unresponsive.

## Graceful

A graceful reboot tells the operating system to restart normally. Services and user processes are given a chance to shut down cleanly.

Command used:

```bash
reboot
```

## Forceful

A forceful reboot bypasses the normal shutdown procedure and immediately reboots the kernel. This may result in **data loss** or **filesystem inconsistencies**, so it should only be used when the server is completely unresponsive.

Command used:
```bash
echo b > /proc/sysrq-trigger
```

:::danger
⚠️ Use with caution. This command forces an immediate reboot without syncing disks or safely stopping processes.
:::

---

// File: admin/advanced/timezone

# Server Time

Use the Server Time section to update the system-wide timezone for both the host operating system and the OpenPanel user interface.

Changing the timezone ensures that logs, scheduled tasks, and UI timestamps align with your desired regional time settings.

:::info
After changing timezone, we recommend to restart the server or at least the OpenAdmin and Cron services: `systemctl restart admin cron`.
:::

---

// File: admin/advanced/cpanel

# Import cPanel Account

Use **OpenAdmin > Advanced > Import cPanel Account** to create an OpenPanel account from a full cpanel account backup.

For detailed instructions, see the [Import cPanel backup guide](https://openpanel.com/docs/articles/transfers/import-cpanel-backup-to-openpanel/)

---

// File: admin/advanced/demo-mode

# Demo Mode

Enable Demo Mode to lock both the OpenPanel and OpenAdmin interfaces in read-only mode.

This mode is ideal for hosting providers who want to showcase OpenPanel in a secure, public demo environment. Users will be able to explore the UI, but no changes can be made—all actions are disabled across both the admin and user panels.

Once enabled, Demo Mode cannot be turned off via the admin panel.
To disable it, run the following command in your terminal:
```
opencli config update demo_mode off
```

Make sure to configure your demo content and secure the server before enabling this mode. 📘 [Learn more](https://dev.openpanel.com/cli/config.html#Demo-mode)

---

// File: admin/domains/domains

# Manage Domains

Domains page displays all domains currently hosted on server.


## List domains

<Tabs>
  <TabItem value="openadmin-domains-list" label="With OpenAdmin" default>


To list all current domains navigate to Domains page:


| Field           | Description                                                       |
|-----------------|-------------------------------------------------------------------|
| **Domain**      | The domain name.                                                  |
| **Status**      | Indicates whether the domain is active or suspended.              |
| **PHP Version** | The PHP version configured for the domain.                        |
| **SSL**         | Shows whether SSL is enabled for the domain.                      |
| **WAF**         | Indicates if Coraza WAF is enabled or disabled for the domain.    |
| **Owner**       | The user who added or owns the domain.                            |
| **Analytics**   | View analytics data and reports for the domain.                   |


  </TabItem>
  <TabItem value="CLI-domains-list" label="With OpenCLI">

To list all current domains  run:

```bash
opencli domains-all
```

Example output:
```bash
opencli domains-all
stefan.openpanel.org
pejcic.rs
nesto.com
```

  </TabItem>
</Tabs>

## Add domain


<Tabs>
  <TabItem value="openadmin-domain-new" label="With OpenAdmin" default>

  Click on 'Add Domain' button, insert the domain and select the user to add it, then click on 'Add Domain'.

  </TabItem>
  <TabItem value="CLI-domain-new" label="With OpenCLI">
    
To create a new plan run the following command:

```bash
opencli domains-add <DOMAIN_NAME> <USERNAME> [--debug]
```

Example:
```bash
root@stefan:/usr/local/admin# opencli domains-add pejcci.rs wzs11p2i --debug
Checking if domain already exists on the server
Adding pejcci.rs to the domains database
Purging cached list of domains for the account
Creating document root directory /home/wzs11p2i/pejcci.rs
Checking webserver configuration
Checking if default vhosts file exists for Nginx
Checking IPv4 address for the account
Creating /etc/nginx/sites-available/pejcci.rs.conf
Restarting nginx to apply changes
Creating vhosts proxy file for Nginx
Webserver is running, reloading configuration
Creating DNS zone file: /etc/bind/zones/pejcci.rs.zone
DNS service is running, adding the zone
Adding the newly created zone file to the DNS server
Checking and setting nginx service to automatically start on reboot
Starting service for the default PHP version 8.2
Checking and setting PHP service to automatically start on reboot
Checking and starting the ssl generation service
Starting Let'sEncrypt SSL generation in background
Domain pejcci.rs added successfully
```
  </TabItem>
</Tabs>


## Move domain

This is currently not possible.

## Delete domain

Domains can currently be deleted only [from the user interface](/docs/panel/domains/#delete-a-domain).

---

// File: admin/domains/dns

# DNS Zone Editor

Edit the DNS zone for any domain hosted on the server.

1. Navigate to **OpenAdmin > Domains > DNS Zone Editor**.
2. Select the domain whose zone you want to edit.
3. Make your changes in the editor and click **Save** when done.

The DNS zone is reloaded immediately, and propagation begins.  
> ⚠️ If there are syntax errors, the zone file will be excluded.  
> ✅ Always create a backup before making changes and validate the file to avoid misconfiguration.

---

// File: admin/domains/dns-cluster

# DNS Cluster

DNS clustering allows you to synchronize DNS records from one OpenPanel server to other machines.

To use this feature, **all machines in the cluster must be running BIND9** — either through the OpenPanel installation or as a standalone service/container.

---

## Enable Clustering

Click **Enable DNS Clustering** to activate the feature.

---

### Add Slave Servers

To set up a slave BIND9 server, follow the instructions in [How-to Guides > DNS Clustering](/docs/articles/domains/how-to-setup-dns-cluster-in-openpanel/).

Once the slave is ready:

1. Enter the slave server's IP address in the form on master server.
2. OpenAdmin will attempt to connect and immediately sync DNS zones.
3. All future domains and DNS changes made by users will be automatically propagated to the slave server.

> To confirm the setup is working, check that the DNS zones appear on the slave server.

---

### Remove Slave Server

Currently, slave servers can **only be removed via the terminal**.

---

## Disable Clustering

Click **Disable DNS Clustering** to turn off the feature.

---

// File: admin/domains/dns_templates

# Edit Zone Templates

This interface allows you to edit the DNS zone file templates that OpenPanel uses when creating zones for new domains.  
It is useful if you require custom DNS configurations.

![edit zone screenshot](/img/admin/dns_templates_admin.png)

- **IPv4 Template** – Used for new domains assigned IPv4 addresses.
- **IPv6 Template** – Used for new domains assigned IPv6 addresses.

---

## Available Template Variables

You can include the following variables in your DNS zone templates:

| Variable        | Description                                                                 |
|----------------|-----------------------------------------------------------------------------|
| `{ns1}`         | Hostname of the primary nameserver (used in the NS record).                |
| `{ns2}`         | Hostname of the secondary nameserver.                                      |
| `{ns3}`         | Hostname of the tertiary nameserver.                                       |
| `{ns4}`         | Hostname of the quaternary nameserver.                                     |
| `{server_ip}`   | IP address of the domain (either IPv4 or IPv6, depending on the template). |
| `{rpemail}`     | Contact email address from OpenAdmin, or `root@domain`.                    |

---

## Restore Defaults

To reset a template to its default version:

1. Click **Restore Default** for the corresponding section.
2. Then click **Save Files** to apply the changes.

> ⚠️ Defaults are pulled from the official GitHub repository. Always review before saving.

---

// File: admin/domains/file_templates

# Edit Domain Templates

This interface allows you to edit the VirtualHosts templates and default landing pages used for new domains.

- Default Page: Template displayed on new domains without any content.
- Suspended Website: Template displayed on websites (domains) that user suspends.
- Suspended User: Template displayed on all websites (domains) that suspended user owns.
- Apache VirtualHost: Template used for creating VirtualHosts of domains added by users with Apache webserver.
- Nginx VirtualHost: Template used for creating VirtualHosts of domains added by users with Nginx webserver.
- OpenResty VirtualHost: Template used for creating VirtualHosts of domains added by users with OpenResty webserver.

## Default Page

This is the HTML page shown on new domains that do **not** have `index.html` or `index.php` in their document root.

```html
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta name="robots" content="noindex">
    <title>No website yet</title>
    <style>body {display: flex;justify-content: center;align-items: center;min-height: 100vh;margin: 0;font-family: Arial, sans-serif;background-color: #f9f9f9;color: #333;}.container {text-align: center;padding: 20px;border: 1px solid #ddd;border-radius: 8px;background-color: #fff;box-shadow: 0 4px 8px rgba(0, 0, 0, 0.1);}h1 {font-size: 24px;margin-bottom: 10px;}p {font-size: 16px;color: #666;}</style>
</head>
<body>
    <div class="container">
        <h1>Reaaady, set, internet 🎉</h1>
        <p>This domain currently has no website. Please check back later.</p>
    </div>
</body>
</html>
```

- Edit the code on the **left side** of the editor.
- Preview live changes on the **right side**.
- When finished, click **Save Files** to apply your changes.

To revert to the original template:

1. Click **Restore Default** to reload the version from GitHub.
2. Don’t forget to click **Save Files** afterward to confirm the reset.

## Suspended Website

This is the HTML page shown on all domains that users suspend **manually**.

```html
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta name="robots" content="noindex">
    <title>Website Suspended</title>
    <style>body {display: flex;justify-content: center;align-items: center;min-height: 100vh;margin: 0;font-family: Arial, sans-serif;background-color: #ffecec;color: #333;}.container {text-align: center;padding: 20px;border: 1px solid #f5c2c2;border-radius: 8px;background-color: #fff;box-shadow: 0 4px 8px rgba(0, 0, 0, 0.1);}h1 {font-size: 24px;margin-bottom: 10px;color: #d9534f;}p {font-size: 16px;color: #666;}</style>
</head>
<body>
    <div class="container">
        <h1>Website Suspended</h1>
        <p>This website has been suspended. Please contact the administrator for more details.</p>
    </div>
</body>
</html>
```

- Edit the code on the **left side** of the editor.
- Preview live changes on the **right side**.
- When finished, click **Save Files** to apply your changes.

To revert to the original template:

1. Click **Restore Default** to reload the version from GitHub.
2. Don’t forget to click **Save Files** afterward to confirm the reset.



## Suspended User

This is the HTML page shown on all domains owned by the user when their account is suspended **by the Administrator**.

```html
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta name="robots" content="noindex">
    <title>Account Suspended</title>
    <style>body {display: flex;justify-content: center;align-items: center;min-height: 100vh;margin: 0;font-family: Arial, sans-serif;background-color: #ffefef;color: #333;}.container {text-align: center;padding: 20px;border: 1px solid #ffcccc;border-radius: 8px;background-color: #fff;box-shadow: 0 4px 8px rgba(0, 0, 0, 0.1);}h1 {font-size: 24px;margin-bottom: 10px;color: #d9534f;}p {font-size: 16px;color: #666;}</style>
</head>
<body>
    <div class="container">
        <h1>Account Suspended</h1>
        <p>This account has been suspended. If you believe this is a mistake, please contact support.</p>
    </div>
</body>
</html>
```

- Edit the code on the **left side** of the editor.
- Preview live changes on the **right side**.
- When finished, click **Save Files** to apply your changes.

To revert to the original template:

1. Click **Restore Default** to reload the version from GitHub.
2. Don’t forget to click **Save Files** afterward to confirm the reset.


## Apache VirtualHost

This is the template used for creating VirtualHosts of domains added by users **when using the Apache webserver**.

```bash
<VirtualHost *:80>
    ServerName <DOMAIN_NAME>
    ServerAlias www.<DOMAIN_NAME>
    DocumentRoot <DOCUMENT_ROOT>

    # <!-- BEGIN EXPOSED RESOURCES PROTECTION -->
    <Directory <DOCUMENT_ROOT>>
        <FilesMatch "\.(git|composer\.(json|lock)|auth\.json|config\.php|wp-config\.php|vendor)">
            Require all denied
        </FilesMatch>
    </Directory>
    # <!-- END EXPOSED RESOURCES PROTECTION -->

    <Directory <DOCUMENT_ROOT>>
        Options Indexes FollowSymLinks
        AllowOverride All
        Require all granted
    </Directory>

    DirectoryIndex index.php index.html default_page.html

    # Alias for default_page.html
    Alias /default_page.html /etc/apache2/default_page.html
    <Directory "/etc/apache2">
        <FilesMatch "^default_page.html$">
            Require all granted
            Options -Indexes
            SetEnvIf Request_URI ^/default_page.html allow_default_page
        </FilesMatch>
    </Directory>

    <FilesMatch \.php$>
        SetHandler "proxy:fcgi://php-fpm-<PHP>:9000"
    </FilesMatch>

</VirtualHost>


<VirtualHost *:443>
    ServerName <DOMAIN_NAME>
    ServerAlias www.<DOMAIN_NAME>
    DocumentRoot <DOCUMENT_ROOT>
    SSLEngine on
    SSLCertificateFile /etc/apache2/ssl/cert.crt
    SSLCertificateKeyFile /etc/apache2/ssl/cert.key

    <Directory <DOCUMENT_ROOT>>
        Options Indexes FollowSymLinks
        AllowOverride All
        Require all granted
    </Directory>

    DirectoryIndex index.php index.html default_page.html

    # Alias for default_page.html
    Alias /default_page.html /etc/apache2/default_page.html
    <Directory "/etc/apache2">
        <FilesMatch "^default_page.html$">
            Require all granted
            Options -Indexes
            SetEnvIf Request_URI ^/default_page.html allow_default_page
        </FilesMatch>
    </Directory>

    <FilesMatch \.php$>
        SetHandler "proxy:fcgi://php-fpm-<PHP>:9000"
    </FilesMatch>

</VirtualHost>
```

- Edit the code in the editor.
- When finished, click **Save Files** to apply your changes.

To revert to the original Apache template:

1. Click **Restore Default** to reload the version from GitHub.
2. Don’t forget to click **Save Files** afterward to confirm the reset.

## Nginx VirtualHost

This is the template used for creating VirtualHosts of domains added by users **when using the Nginx webserver**.

```bash
# content
server {
    listen 80;
    server_name <DOMAIN_NAME> www.<DOMAIN_NAME>;
    access_log off;

    # <!-- BEGIN EXPOSED RESOURCES PROTECTION -->
     location ~* ^/(\.git|composer\.(json|lock)|auth\.json|config\.php|wp-config\.php|vendor) {
       deny all;
       return 403;
     }
    # <!-- END EXPOSED RESOURCES PROTECTION -->

    root <DOCUMENT_ROOT>;

    location / {
        real_ip_header    X-Forwarded-For;
        set_real_ip_from   172.17.0.0/16;
        try_files $uri $uri/ /index.php$is_args?$args;
        index index.php index.html /default_page.html;
        autoindex on;
    }

    location = /default_page.html {
        alias /etc/nginx/default_page.html;
        default_type text/html;
        access_log off;
        log_not_found off;
    }

    location ~ \.php$ {
        include fastcgi_params;
        fastcgi_pass php-fpm-<PHP>:9000;
        fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
        include fastcgi_params;
    }

    location ~* \.(js|css|png|jpg|jpeg|gif|ico)$ {
        expires max;
        log_not_found off;
    }

    location = /favicon.ico {
        log_not_found off;
        access_log off;
    }

    location = /robots.txt {
        allow all;
        log_not_found off;
        access_log off;
    }
    
}


server {
    listen 443 ssl;
    http2 on; #nginx >= 1.25.1
    server_name <DOMAIN_NAME> www.<DOMAIN_NAME>;
    access_log off;
    
    root <DOCUMENT_ROOT>;

    # SSL Configuration
    ssl_certificate /etc/nginx/ssl/cert.crt;
    ssl_certificate_key /etc/nginx/ssl/cert.key;
    ssl_protocols TLSv1.2 TLSv1.3;
    ssl_prefer_server_ciphers on;
    ssl_ciphers "EECDH+AESGCM:EDH+AESGCM:AES256+EECDH:AES256+EDH";

    location / {
        real_ip_header    X-Forwarded-For;
        set_real_ip_from   172.17.0.0/16;
        try_files $uri $uri/ /index.php$is_args?$args;
        index index.php index.html /default_page.html;
        autoindex on;
    }

    
    location = /default_page.html {
        alias /etc/nginx/default_page.html;
        default_type text/html;
        access_log off;
        log_not_found off;
    }

    
    location ~ \.php$ {
        include fastcgi_params;
        fastcgi_pass php-fpm-<PHP>:9000;
        fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
        include fastcgi_params;
    }

    location ~* \.(js|css|png|jpg|jpeg|gif|ico)$ {
        expires max;
        log_not_found off;
    }

    location = /favicon.ico {
        log_not_found off;
        access_log off;
    }

    location = /robots.txt {
        allow all;
        log_not_found off;
        access_log off;
    }

}

```

- Edit the code in the editor.
- When finished, click **Save Files** to apply your changes.

To revert to the original Nginx template:

1. Click **Restore Default** to reload the version from GitHub.
2. Don’t forget to click **Save Files** afterward to confirm the reset.


## OpenResty VirtualHost

This is the template used for creating VirtualHosts of domains added by users **when using the OpenResty webserver**.

```bash
# content
server {
    listen 80;
    server_name <DOMAIN_NAME> www.<DOMAIN_NAME>;
    access_log off;

    # <!-- BEGIN EXPOSED RESOURCES PROTECTION -->
     location ~* ^/(\.git|composer\.(json|lock)|auth\.json|config\.php|wp-config\.php|vendor) {
       deny all;
       return 403;
     }
    # <!-- END EXPOSED RESOURCES PROTECTION -->

    root <DOCUMENT_ROOT>;

    location /hello {
        default_type 'text/plain';
        content_by_lua_block {
            ngx.say("Hello from OpenResty!")
        }
    }

    location / {
        real_ip_header    X-Forwarded-For;
        set_real_ip_from   172.17.0.0/16;
        try_files $uri $uri/ /index.php$is_args?$args;
        index index.php index.html /default_page.html;
        autoindex on;
    }

    location = /default_page.html {
        alias /etc/nginx/default_page.html;
        default_type text/html;
        access_log off;
        log_not_found off;
    }

    location ~ \.php$ {
        include fastcgi_params;
        fastcgi_pass php-fpm-<PHP>:9000;
        fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
        include fastcgi_params;
    }

    location ~* \.(js|css|png|jpg|jpeg|gif|ico)$ {
        expires max;
        log_not_found off;
    }

    location = /favicon.ico {
        log_not_found off;
        access_log off;
    }

    location = /robots.txt {
        allow all;
        log_not_found off;
        access_log off;
    }
    
}


server {
    listen 443 ssl;
    http2 on; #nginx >= 1.25.1
    server_name <DOMAIN_NAME> www.<DOMAIN_NAME>;
    access_log off;
    
    root <DOCUMENT_ROOT>;

    # SSL Configuration
    ssl_certificate /etc/nginx/ssl/cert.crt;
    ssl_certificate_key /etc/nginx/ssl/cert.key;
    ssl_protocols TLSv1.2 TLSv1.3;
    ssl_prefer_server_ciphers on;
    ssl_ciphers "EECDH+AESGCM:EDH+AESGCM:AES256+EECDH:AES256+EDH";

    location /hello {
        default_type 'text/plain';
        content_by_lua_block {
            ngx.say("Hello from OpenResty!")
        }
    }

    location / {
        real_ip_header    X-Forwarded-For;
        set_real_ip_from   172.17.0.0/16;
        try_files $uri $uri/ /index.php$is_args?$args;
        index index.php index.html /default_page.html;
        autoindex on;
    }

    location = /default_page.html {
        alias /etc/nginx/default_page.html;
        default_type text/html;
        access_log off;
        log_not_found off;
    }

    location ~ \.php$ {
        include fastcgi_params;
        fastcgi_pass php-fpm-<PHP>:9000;
        fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
        include fastcgi_params;
    }

    location ~* \.(js|css|png|jpg|jpeg|gif|ico)$ {
        expires max;
        log_not_found off;
    }

    location = /favicon.ico {
        log_not_found off;
        access_log off;
    }

    location = /robots.txt {
        allow all;
        log_not_found off;
        access_log off;
    }

}

```

- Edit the code in the editor.
- When finished, click **Save Files** to apply your changes.

To revert to the original OpenResty template:

1. Click **Restore Default** to reload the version from GitHub.
2. Don’t forget to click **Save Files** afterward to confirm the reset.

## Varnish Template

This is the template used for creating `default.vcl` file for users **when using the Varnish Caching**.

The placeholder `VARNISH_BACKEND_HOST` is automatically replaced with the user's actual web server - Nginx, Apache, or OpenResty. 

```bash
vcl 4.1;

backend default {
    .host = "VARNISH_BACKEND_HOST";
    .port = "80";
    .max_connections = 2048;
}

# Define an access control list to restrict cache purging.
acl purge {
    "localhost";
    "172.17.0.0/16";
}

sub vcl_hit {
    if (req.http.X-Forwarded-Proto == "https") {
        set req.http.X-Forwarded-Proto = "https";
    } else {
        set req.http.X-Forwarded-Proto = "http";
    }

    if (obj.ttl > 0s) {
        return (deliver);
    }
    if (obj.ttl + obj.grace > 0s) {
        return (deliver);
    }

    return (miss);  # Use "miss" instead of "fetch"
}

sub vcl_recv {

    # Remove empty query string parameters
    # e.g.: www.example.com/index.html?
    if (req.url ~ "\?$") {
        set req.url = regsub(req.url, "\?$", "");
    }

    # Remove port number from host header
    set req.http.Host = regsub(req.http.Host, ":[0-9]+", "");

    # Remove the proxy header to mitigate the httpoxy vulnerability
    # See https://httpoxy.org/
    unset req.http.proxy;

    # Purge logic to remove objects from the cache.
    # Tailored to the Proxy Cache Purge WordPress plugin
    # See https://wordpress.org/plugins/varnish-http-purge/
    if(req.method == "PURGE") {
        if(!client.ip ~ purge) {
            return(synth(405,"PURGE not allowed for this IP address"));
        }
        if (req.http.X-Purge-Method == "regex") {
            ban("obj.http.x-url ~ " + req.url + " && obj.http.x-host == " + req.http.host);
            return(synth(200, "Purged"));
        }
        ban("obj.http.x-url == " + req.url + " && obj.http.x-host == " + req.http.host);
        return(synth(200, "Purged"));
    }

   # Only handle relevant HTTP request methods
    if (
        req.method != "GET" &&
        req.method != "HEAD" &&
        req.method != "PUT" &&
        req.method != "POST" &&
        req.method != "PATCH" &&
        req.method != "TRACE" &&
        req.method != "OPTIONS" &&
        req.method != "DELETE"
    ) {
        return (pipe);
    }

    # Remove tracking query string parameters used by analytics tools
    if (req.url ~ "(\?|&)(_branch_match_id|_bta_[a-z]+|_bta_c|_bta_tid|_ga|_gl|_ke|_kx|campid|cof|customid|cx|dclid|dm_i|ef_id|epik|fbclid|gad_source|gbraid|gclid|gclsrc|gdffi|gdfms|gdftrk|hsa_acc|hsa_ad|hsa_cam|hsa_grp|hsa_kw|hsa_mt|hsa_net|hsa_src|hsa_tgt|hsa_ver|ie|igshid|irclickid|matomo_campaign|matomo_cid|matomo_content|matomo_group|matomo_keyword|matomo_medium|matomo_placement|matomo_source|mc_[a-z]+|mc_cid|mc_eid|mkcid|mkevt|mkrid|mkwid|msclkid|mtm_campaign|mtm_cid|mtm_content|mtm_group|mtm_keyword|mtm_medium|mtm_placement|mtm_source|nb_klid|ndclid|origin|pcrid|piwik_campaign|piwik_keyword|piwik_kwd|pk_campaign|pk_keyword|pk_kwd|redirect_log_mongo_id|redirect_mongo_id|rtid|s_kwcid|sb_referer_host|sccid|si|siteurl|sms_click|sms_source|sms_uph|srsltid|toolid|trk_contact|trk_module|trk_msg|trk_sid|ttclid|twclid|utm_[a-z]+|utm_campaign|utm_content|utm_creative_format|utm_id|utm_marketing_tactic|utm_medium|utm_source|utm_source_platform|utm_term|vmcid|wbraid|yclid|zanpid)=") {
        set req.url = regsuball(req.url, "(_branch_match_id|_bta_[a-z]+|_bta_c|_bta_tid|_ga|_gl|_ke|_kx|campid|cof|customid|cx|dclid|dm_i|ef_id|epik|fbclid|gad_source|gbraid|gclid|gclsrc|gdffi|gdfms|gdftrk|hsa_acc|hsa_ad|hsa_cam|hsa_grp|hsa_kw|hsa_mt|hsa_net|hsa_src|hsa_tgt|hsa_ver|ie|igshid|irclickid|matomo_campaign|matomo_cid|matomo_content|matomo_group|matomo_keyword|matomo_medium|matomo_placement|matomo_source|mc_[a-z]+|mc_cid|mc_eid|mkcid|mkevt|mkrid|mkwid|msclkid|mtm_campaign|mtm_cid|mtm_content|mtm_group|mtm_keyword|mtm_medium|mtm_placement|mtm_source|nb_klid|ndclid|origin|pcrid|piwik_campaign|piwik_keyword|piwik_kwd|pk_campaign|pk_keyword|pk_kwd|redirect_log_mongo_id|redirect_mongo_id|rtid|s_kwcid|sb_referer_host|sccid|si|siteurl|sms_click|sms_source|sms_uph|srsltid|toolid|trk_contact|trk_module|trk_msg|trk_sid|ttclid|twclid|utm_[a-z]+|utm_campaign|utm_content|utm_creative_format|utm_id|utm_marketing_tactic|utm_medium|utm_source|utm_source_platform|utm_term|vmcid|wbraid|yclid|zanpid)=[-_A-z0-9+(){}%.*]+&?", "");
        set req.url = regsub(req.url, "[?|&]+$", "");
    }

    # Only cache GET and HEAD requests
    if (req.method != "GET" && req.method != "HEAD") {
        set req.http.X-Cacheable = "NO:REQUEST-METHOD";
        return(pass);
    }

    # Mark static files with the X-Static-File header, and remove any cookies
    # X-Static-File is also used in vcl_backend_response to identify static files
    if (req.url ~ "^[^?]*\.(7z|avi|bmp|bz2|css|csv|doc|docx|eot|flac|flv|gif|gz|ico|jpeg|jpg|js|less|mka|mkv|mov|mp3|mp4|mpeg|mpg|odt|ogg|ogm|opus|otf|pdf|png|ppt|pptx|rar|rtf|svg|svgz|swf|tar|tbz|tgz|ttf|txt|txz|wav|webm|webp|woff|woff2|xls|xlsx|xml|xz|zip)(\?.*)?$") {
        set req.http.X-Static-File = "true";
        unset req.http.Cookie;
        return(hash);
    }

    # No caching of special URLs, logged in users and some plugins
    if (
        req.http.Cookie ~ "wordpress_(?!test_)[a-zA-Z0-9_]+|wp-postpass|comment_author_[a-zA-Z0-9_]+|woocommerce_cart_hash|woocommerce_items_in_cart|wp_woocommerce_session_[a-zA-Z0-9]+|wordpress_logged_in_|comment_author|PHPSESSID" ||
        req.http.Authorization ||
        req.url ~ "add_to_cart" ||
        req.url ~ "edd_action" ||
        req.url ~ "nocache" ||
        req.url ~ "^/addons" ||
        req.url ~ "^/bb-admin" ||
        req.url ~ "^/bb-login.php" ||
        req.url ~ "^/bb-reset-password.php" ||
        req.url ~ "^/cart" ||
        req.url ~ "^/checkout" ||
        req.url ~ "^/control.php" ||
        req.url ~ "^/login" ||
        req.url ~ "^/logout" ||
        req.url ~ "^/lost-password" ||
        req.url ~ "^/my-account" ||
        req.url ~ "^/product" ||
        req.url ~ "^/register" ||
        req.url ~ "^/register.php" ||
        req.url ~ "^/server-status" ||
        req.url ~ "^/signin" ||
        req.url ~ "^/signup" ||
        req.url ~ "^/stats" ||
        req.url ~ "^/wc-api" ||
        req.url ~ "^/wp-admin" ||
        req.url ~ "^/wp-comments-post.php" ||
        req.url ~ "^/wp-cron.php" ||
        req.url ~ "^/wp-login.php" ||
        req.url ~ "^/wp-activate.php" ||
        req.url ~ "^/wp-mail.php" ||
        req.url ~ "^/wp-login.php" ||
        req.url ~ "^\?add-to-cart=" ||
        req.url ~ "^\?wc-api=" ||
        req.url ~ "^/preview=" ||
        req.url ~ "^/\.well-known/acme-challenge/"
    ) {
	     set req.http.X-Cacheable = "NO:Logged in/Got Sessions";
	     if(req.http.X-Requested-With == "XMLHttpRequest") {
		     set req.http.X-Cacheable = "NO:Ajax";
	     }
        return(pass);
    }

    # Remove any cookies left
    unset req.http.Cookie;
    return(hash);
}


sub vcl_hash {
    if(req.http.X-Forwarded-Proto) {
        # Create cache variations depending on the request protocol
        hash_data(req.http.X-Forwarded-Proto);
    }
}

sub vcl_pipe {
  if (req.http.upgrade) {
    set bereq.http.upgrade = req.http.upgrade;
  }
  return (pipe);
}

sub vcl_backend_response {
    # Inject URL & Host header into the object for asynchronous banning purposes
    set beresp.http.x-url = bereq.url;
    set beresp.http.x-host = bereq.http.host;

    # If we dont get a Cache-Control header from the backend
    # we default to 1h cache for all objects
    if (!beresp.http.Cache-Control) {
        set beresp.ttl = 1h;
        set beresp.http.X-Cacheable = "YES:Forced";
    }

    # If the file is marked as static we cache it for 1 day
    if (bereq.http.X-Static-File == "true") {
        unset beresp.http.Set-Cookie;
        set beresp.http.X-Cacheable = "YES:Forced";
        set beresp.ttl = 1d;
    }

	# Remove the Set-Cookie header when a specific Wordfence cookie is set
    if (beresp.http.Set-Cookie ~ "wfvt_|wordfence_verifiedHuman") {
	    unset beresp.http.Set-Cookie;
	 }

    if (beresp.http.Set-Cookie) {
        set beresp.http.X-Cacheable = "NO:Got Cookies";
    } elseif(beresp.http.Cache-Control ~ "private") {
        set beresp.http.X-Cacheable = "NO:Cache-Control=private";
    }
}


sub vcl_deliver {
    # Debug header
    if(req.http.X-Cacheable) {
        set resp.http.X-Cacheable = req.http.X-Cacheable;
    } elseif(obj.uncacheable) {
        if(!resp.http.X-Cacheable) {
            set resp.http.X-Cacheable = "NO:UNCACHEABLE";
        }
    } elseif(!resp.http.X-Cacheable) {
        set resp.http.X-Cacheable = "YES";
    }

### uncomment to remove from responses ###
#  unset resp.http.X-Powered-By;
#  unset resp.http.Server;
#  unset resp.http.server;
#  unset resp.http.via;
#  unset resp.http.x-powered-by;
#  unset resp.http.x-runtime;
#  unset resp.http.x-varnish;
    unset resp.http.x-url;
    unset resp.http.x-host;

  return (deliver);
}
```

- Edit the code in the editor.
- When finished, click **Save Files** to apply your changes.

To revert to the original Varnish template:

1. Click **Restore Default** to reload the version from GitHub.
2. Don’t forget to click **Save Files** afterward to confirm the reset.

---

// File: admin/emails/emails

# Email Accounts

The Emails section provides an overview of all email accounts managed through OpenPanel.

Use this interface to review usage, access webmail, and manage user-level email settings.

The table includes the following information:

- **Email** – The full email address of the account.
- **Quota** – The storage limit assigned to the account.
- **Webmail** – A quick-access button to log in directly to the webmail interface for that account.

This section is useful for monitoring email resource usage and offering users easy access to their inbox.

:::info
Emails are only available on [OpenPanel Enterprise edition](/enterprise)
:::

---

// File: admin/emails/summary

# Summary Reports

Email Summary Reports show daily and monthly reports for all outgoing emails on the server.

:::info
Emails are only available on [OpenPanel Enterprise edition](/enterprise)
:::

---

// File: admin/emails/settings

# Email Settings

The Email Settings section allows you to configure various parameters for the MailServer stack to ensure efficient and secure email management. 

:::info
Emails are only available on [OpenPanel Enterprise edition](/enterprise)
:::


## MailServer Status

The status of the Mail Server service is displayed at the top of the page, where administrators can start, stop, or restart the service as needed.

## Accounts

Displays the total number of email accounts currently active on the server. This includes all accounts across all domains configured on the system.


## Webmail

- Status - displays current webmail service status
- Current Software - displays current selected client
- Select Webmail Client - Choose the webmail client your users will interact with. The service will be restarted to apply any changes made.
- Set Webmail domain - Configure domain to be used for webmail service. Webmail will be available on this domain and /webmail on every user domain will redirect to this domain.


## Enable Services

Administrators can set and configure different services based on their needs.

Configure services for the MailServer stack:

| Service                                | Description                                                                 |
|----------------------------------------|-----------------------------------------------------------------------------|
| **Amavis**                             | Amavis content filter (used for ClamAV & SpamAssassin).                      |
| **DNS block lists**                    | Enables DNS block lists in Postscreen.                                       |
| **Rspamd**                              | Enable or disable Rspamd.                                                    |
| **SpamAssassin**                        | Analyzes incoming mail and assigns a spam score.                            |
| **MTA-STS**                            | Enables MTA-STS support for outbound mail.                                  |
| **OpenDKIM service**                   | Enables the OpenDKIM service for email signing.                             |
| **OpenDMARC service**                  | Enables the OpenDMARC service for email domain-based message authentication. |
| **POP3**                               | Enables the POP3 service for email retrieval.                               |
| **IMAP**                               | Enables the IMAP service for email retrieval.                               |
| **ClamAV**                             | Enables the ClamAV antivirus service.                                       |
| **fail2ban**                           | Enables the fail2ban service to ban IPs based on suspicious activity.       |
| **Only SMTP**                          | If enabled, only the Postfix service is started, and users cannot receive incoming email. |
| **Sender Rewriting Scheme**            | Enables the Sender Rewriting Scheme, needed for email forwarding (see [postsrsd](https://github.com/roehling/postsrsd/blob/main/README.rst) for explanation). |


Changes to this service will interrupt current email traffic and restart the mailserver.




## Relay Hosts

The **Relay Hosts** feature allows you to configure an SMTP relay service (also known as a relay host or smarthost) for relaying (forwarding) outbound email on behalf of third parties. This service does not manage mail domains but helps in routing emails through an external SMTP server.

This feature is useful for organizations that need to route their outgoing email traffic through a trusted third-party service or SMTP server for better deliverability and security.

The following parameters are used to configure the relay host settings:

- **DEFAULT_RELAY_HOST**  
  Default relay host for outgoing emails. This should match the **RELAY_HOST**.
  - Example: `mail.example.com`

- **RELAY_HOST**  
  The SMTP relay host that all outbound emails will be routed through.
  - Example: `mail.example.com`

- **RELAY_PORT**  
  The port to be used for connecting to the SMTP relay host.
  - Example: `25`

- **RELAY_USER (optional)**  
  The username for authenticating with the relay host. If this is set, secure connections will be required for outbound mail traffic.
  - Example: `relay_user`

- **RELAY_PASSWORD**  
  The password for authenticating with the relay host, used alongside the **RELAY_USER**.
  - Example: `relay_password`

When both **RELAY_USER** and **RELAY_PASSWORD** are configured, all outbound mail traffic will require a secure connection and the credentials will be mandatory.

Once configured, click the **Save Relay** button to apply the settings and begin routing outbound emails through the specified relay host.

---

// File: admin/plans/hosting_plans

# User Packages

Hosting plans set limits for users. 

## List hosting plans

<Tabs>
  <TabItem value="openadmin-plan-list" label="With OpenAdmin" default>


To list existing plans navigate to Plans page:

![openadmin plans](/img/admin/tremor/plans_list.png)


| Field              | Description                                                               |
| ------------------ | ------------------------------------------------------------------------- |
| **Plan Name**      | Display name that users will see in their OpenPanel dashboards.            |
| **Memory**            | Physical Memory (RAM) in GB allocated to the user on this hosting plan.     |
| **CPU**            | Number of CPU cores dedicated to the user on this hosting plan.             |
| **Disk**     | Disk space in GB allocated for all user files.           |
| **Inodes**   | Limits the total number of files allowed for the user.   |
| **Port Speed**            | Maximum post speed for users in mbit/s.     |
| **Domains**  | Total number of domain names allowed per user on the plan.                  |
| **Websites** | Total number of websites (WordPress, NodeJS, Python) per user on the plan.   |
| **Databases** | Total number of MySQL/MariaDB databases allowed per user on the plan.              |
| **Email accounts** | Total number of email accounts that user can create on the plan.              |
| **Mailbox quota** | Max mailbox size for email accounts that user can set on this plan.              |
| **Max hourly emails** | Max number of emails that all addresses under this account can send within one hour.              |
| **FTP accounts** | Total number of ftp accounts that user can create on the plan.             |
| **Feature Set** | [Feature Sets](/docs/admin/settings/openpanel/#enable-features) determine which pages users can access from the OpenPanel interface.               |



  </TabItem>
  <TabItem value="CLI-plan-list" label="With OpenCLI">

To list all current hosting packages (plans) run:

```bash
opencli plan-list
```

Example output:
```bash
[root@fajlovi ~]# opencli plan-list
+----+----------------+------------------------+---------------+----------------+-------------+-----------+------------+--------------+----------+------+------+-----------+-------------+-----------------+------------------+
| id | name           | description            | domains_limit | websites_limit | email_limit | ftp_limit | disk_limit | inodes_limit | db_limit | cpu  | ram  | bandwidth | feature_set | max_email_quota | max_hourly_email |
+----+----------------+------------------------+---------------+----------------+-------------+-----------+------------+--------------+----------+------+------+-----------+-------------+-----------------+------------------+
|  1 | Standard plan  | Small plan for testing |             0 |             10 |           0 |         0 | 5 GB       |      1000000 |        0 | 2    | 2g   |        10 | basic       | 0               | 0                |
|  2 | Developer Plus | 4 cores, 6G ram        |             0 |             10 |           0 |         0 | 20 GB      |      2500000 |        0 | 4    | 6g   |       100 | default     | 0               | 1000             |
+----+----------------+------------------------+---------------+----------------+-------------+-----------+------------+--------------+----------+------+------+-----------+-------------+-----------------+------------------+

```

You can also format the data as JSON:

```bash
opencli plan-list --json
```

  </TabItem>
</Tabs>

## Create a plan

<Tabs>
  <TabItem value="openadmin-plan-new" label="With OpenAdmin" default>

To create a new hosting package, click the **'Create New'** button and configure the desired limits:

![openadmin plans create](/img/admin/tremor/plans_create.png)


* **Name** – Can include any characters.
* **Description** – Internal note for admins, visible only in OpenAdmin.
* **Disk** – Storage in GB. Use `0` for unlimited.
* **Inodes** – Number of inodes. Use `0` for unlimited.
* **CPU** – Number of CPU cores allocated across all user services. Set to `0` for unlimited. Cannot exceed total server cores.
* **Memory** – Amount of physical memory in GB allocated across all user services. Set to `0` for unlimited. Cannot exceed total server memory.
* **Port Speed** – Maximum speed in Mbit/s for user services *(Deprecated and not enforced)*.
* **Databases** – Max number of databases (MySQL, MariaDB, PostgreSQL). Use `0` for unlimited.
* **Websites** – Max number of websites in Site Manager (WordPress, WebsiteBuilder, NodeJS/Python). Use `0` for unlimited.
* **FTP accounts** – Max number of FTP sub-accounts. Use `0` for unlimited.
* **Email accounts** – Max number of email sub-accounts. Use `0` for unlimited.
* **Max hourly emails** – Max number of emails that can be sent within one hour. Use `0` for unlimited.
* **Mailbox quota** – Max mailbox size for email accounts that user can set on this plan.
* **Feature Set** – Name of the feature set that defines available services in the OpenPanel UI.


  </TabItem>
  <TabItem value="CLI-plan-new" label="With OpenCLI">
    
To create a new plan run the following command:

```bash
pencli plan-create name"<TEXT>" description="<TEXT>" emails=<COUNT> ftp=<COUNT> domains=<COUNT> websites=<COUNT> disk=<COUNT> inodes=<COUNT> databases=<COUNT> cpu=<COUNT> ram=<COUNT> bandwidth=<COUNT> feature_set=<NAME> max_email_quota=<COUNT> max_hourly_email=<COUNT>
```

Example:
```bash
opencli plan-create name="New Plan" description="This is a new plan" emails=100 ftp=50 domains=20 websites=30 disk=100 inodes=100000 databases=10 cpu=4 ram=8 bandwidth=100 feature_set=default max_email_quota=2G max_hourly_email=1000
```

  </TabItem>
</Tabs>


## Modify plan

To change plan limits click on the **Edit** button for the plan in **OpenAdmin > User Packages** and set the new limits.

![openadmin plans edit](/img/admin/tremor/plans_edit_1.png)

![openadmin plans edit limits](/img/admin/tremor/plans_edit_2.png)


The new limits will be applied immediately to all accounts using the package.

## List Users on Plan

<Tabs>
  <TabItem value="openadmin-plan-usage" label="With OpenAdmin" default>

To view all users that are currently using a hosting package, simply sort the users table by that package name, or in the search field type the package name.

![openadmin plans usage](/img/admin/tremor/plans_usage_1.png)

![openadmin plans usage](/img/admin/tremor/plans_usage_2.png)

  </TabItem>
  <TabItem value="CLI-plan-usage" label="With OpenCLI">
    
List all users that are currently using a plan:

```bash
opencli plan-usage
```

Example:
```bash
[root@fajlovi ~]# opencli plan-usage 'Standard plan'
+----+----------------------------------+----------------------+---------------+---------------------+
| id | username                         | email                | plan_name     | registered_date     |
+----+----------------------------------+----------------------+---------------+---------------------+
|  3 | forums                           | stefan@openpanel.com | Standard plan | 2025-05-08 19:25:47 |
| 19 | radovan                          | radovan@jecmenica.rs | Standard plan | 2025-05-29 07:47:15 |
+----+----------------------------------+----------------------+---------------+---------------------+
```

You can also format the data as JSON:

```bash
opencli plan-usage --json
```
  </TabItem>
</Tabs>

## Delete Plan

<Tabs>
  <TabItem value="openadmin-plan-delete" label="With OpenAdmin" default>
    
To delete a hosting package click on the **Delete** link for the desired package.

![openadmin plans delete](/img/admin/tremor/plans_delete.png)


  </TabItem>
  <TabItem value="CLI-plan-delete" label="With OpenCLI">

To delete a hosting plan: 

```bash
opencli plan-delete <PLAN_NAME> 
```

Example:
```bash
opencli plan-delete 'Standard plan'
```
  </TabItem>
</Tabs>

Note: A package cannot be deleted if it has users assigned to it.

---

// File: admin/plans/feature-manager

# Feature Manager

The Feature Manager allows administrators to enable or disable specific features (pages) within the OpenPanel UI. This is useful for customizing the control panel experience based on user roles, security policies, or hosting plans.

Each feature can be toggled individually via the interface. Once activated, the feature becomes visible and accessible to all users. Deactivating a feature hides it from the panel and disables its functionality.

![openadmin features](/img/admin/tremor/features.png)

![openadmin features](/img/admin/tremor/features_edit.png)

---

## Available Features
Here is the rewritten information in a table format with the requested columns:

| **Name**                   | **Link**                 | **Description**                                          | **Note**                                       |
| -------------------------- | ------------------------ | -------------------------------------------------------- | ---------------------------------------------- |
| Email Notifications        | `/account/notifications` | Manage email notification preferences.                   | Emails are sent based on selected preferences. |
| Locales (Language Change)  | `/account/languages`     | Change the panel interface language.                     |                                                |
| Favorites (Bookmarks)      | `/account/favorites`     | Bookmark frequently used pages.                          |                                                |
| Varnish Caching            | `/cache/varnish`         | Manage Varnish caching per domain.                       |                                                |
| Docker (Containers)        | `/containers`            | Allocate resources and manage container lifecycles.      |                                                |
| FTP Accounts               | `/ftp`                   | Create and manage FTP accounts.                          | Requires separate FTP server configuration.    |
| Email Accounts             | `/emails`                | Manage email accounts.                                   | Requires separate mail server configuration.   |
| Remote MySQL               | `/mysql/remote-mysql`    | Allow or block remote MySQL connections.                 |                                                |
| MySQL Configuration        | `/mysql/configuration`   | Modify MySQL settings from the panel.                    |                                                |
| PHP Options                | `/php/options`           | Edit PHP directives via a user-friendly page.            |                                                |
| PHP.INI Editor             | `/php/ini`               | Directly edit the `php.ini` file.                        | Applies to any configured PHP version.         |
| phpMyAdmin                 | `/mysql/phpmyadmin`      | Manage databases with phpMyAdmin.                        |                                                |
| Cronjobs                   | `/cronjobs`              | Create, edit, and schedule cron jobs.                    |                                                |
| WordPress                  | `/wordpress`             | Install and manage WordPress sites.                      | Managed via WP Manager.                        |
| Disk Usage Explorer        | `/disk-usage`            | Visually explore disk usage across directories.          |                                                |
| Inodes Explorer            | `/inodes-explorer`       | View inode usage per directory.                          |                                                |
| Resources Usage            | `/usage`                 | View Docker container resource usage.                    |                                                |
| Server Info                | `/server/info`           | View hosting limits and server details.                  |                                                |
| Apache/Nginx Configuration | `/server/webserver_conf` | Modify webserver (Apache/Nginx) container configuration. |                                                |
| Change Timezone            | `/server/timezone`       | Update system timezone settings for containers.          |                                                |
| Coraza WAF                 | `/waf`                   | Manage Coraza WAF per domain.                            | Enabled by default for new domains.            |
| Fix Permissions            | `/fix-permissions`       | Fix file ownership and permissions for websites.         |                                                |
| DNS                        | `/dns`                   | Manage DNS records with a zone editor.                   | Requires BIND9 server.                         |
| Domain Redirects           | `/domains/redirects`     | Manage domain-level redirects.                           |                                                |
| Malware Scanner            | `/malware-scanner`       | Scan for malware using ClamAV.                           | Directory exclusions can be configured.        |
| GoAccess                   | `/domains/logs`          | View GoAccess-generated log reports.                     |                                                |
| Process Manager            | `/process-manager`       | View and terminate system processes.                     |                                                |
| Redis                      | `/cache/redis`           | Configure Redis per user.                                |                                                |
| Memcached                  | `/cache/memcached`       | Configure Memcached per user.                            |                                                |
| Elasticsearch              | `/cache/elasticsearch`   | Configure Elasticsearch from the panel.                  |                                                |
| Opensearch                 | `/cache/opensearch`      | Configure Opensearch from the panel.                     |                                                |
| Temporary Links            | `/websites`              | Test websites using temporary OpenPanel subdomains.      | Links expire after 15 minutes.                 |
| Login History              | `/account/loginlog`      | View history of the last 20 IP logins.                   |                                                |
| 2FA                        | `/account/2fa`           | Enable Two-Factor Authentication.                        |                                                |
| Activity Log               | `/account/activity`      | Review all recorded account actions.                     |                                                |

## Use Cases

**Feature Sets** are used to control which UI features users can access based on their assigned hosting package. This allows for clear separation between user types and service levels.

### Example 1: Database-Only Plans

Create a feature set named **"MySQL Only"** and enable only MySQL-related features within it.
Assign this feature set to all database-focused hosting packages. For instance:

* One package allows up to **10 databases**.
* Another package allows **unlimited databases** (`0` for no limit).

Despite the difference in limits, all users under these plans will see **only MySQL-related pages** in the UI.

### Example 2: Beginner vs. Advanced Users

Create two separate feature sets:

* **Advanced Users Set**:
  Enable features like **Docker** and **PHP.INI Editor** to give experienced users full control—such as setting custom resource limits, restarting services, etc.

* **Beginner Users Set**:
  Do **not** enable advanced features. Instead, allow access to a **PHP selector** with limited options. This keeps the UI simple and safe for users with minimal technical experience.


## Feature not showing?

Features are accessible to users [only if the corresponding **Module** is active](/docs/admin/settings/modules/). Modules control which OpenPanel features are available, while **Feature Sets** determine access based on the user's hosting package.

For example, adding the "Docker" feature to a plan does **not** grant access to the Docker (Containers) pages in the UI unless the **Docker module** is also activated under **OpenAdmin > Settings > Modules**.

---

// File: admin/security/basic_auth

# Basic Auth

Enable [Basic Access Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication) as an additional security layer for the OpenAdmin interface.

![basic_auth settings openadmin](/img/admin/basic_auth.png)

## Enable

To enable Basic Auth, select **Yes** under **Enable** and click **Save Setting**.

To disable Basic Auth, select **No** under **Enable** and click **Save Setting**.

## Logins

When Basic Auth is enabled, a username and password are required.

Configure the username and password fields, then click **Save Changes** to apply.

---

// File: admin/security/waf

# WAF

The WAF section allows you to manage CorazaWAF, a powerful Web Application Firewall integrated into OpenPanel.

Use this interface to enhance security by enabling protection against common web threats such as SQL injection, XSS, and other malicious behavior.

## Enable
Toggle the Web Application Firewall (WAF) on or off.

When enabled, CorazaWAF inspects incoming requests in real time and blocks suspicious activity according to the configured rules.

- **Enabled**: Executes the command `opencli waf enable`, activating [the WAF module](/docs/admin/settings/modules/#waf). This makes WAF manageable by users and automatically enables it for any new domains.
- **Disabled**: Executes the command `opencli waf disable -y`, deactivating [the WAF module](/docs/admin/settings/modules/#waf). This disables WAF management for users and turns off WAF for all existing and new domains.

## Rule Sets
Manage the rule sets that CorazaWAF uses to protect your applications.

**Active:** Displays the number of currently active rule sets (e.g., 21 / 23).

Click **Manage Rules** to enable or disable individual WAF rule sets according to your security needs.

The rule set table includes the following columns:

- **Name** – The name or identifier of the rule set.

- **Number of Rules** – Total number of rules contained within the set.

- **Status** – Indicates whether the rule set is currently enabled or disabled.

- **Actions** – Options to View rule details or Disable the rule set.

Properly configuring WAF rules helps maintain a balance between strong protection and minimizing false positives.

---

// File: admin/security/firewall

# Firewall

OpenPanel supports [Sentinel Firewall](https://sentinelfirewall.org/) - a fork of the *ConfigServer Security and Firewall* (CSF).

## CSF

Firewall (CSF) UI is displayed on **OpenAdmin > Firewall**.

For instructions on how to use the CSF UI, please refer to [Sentinel Firewall official documentation](https://sentinelfirewall.org/docs/usage/introduction/).

![csf firewall](/img/admin/firewall_csf.png)


## External Firewall

Some cloud providers, like [Hetzner](https://docs.hetzner.com/robot/dedicated-server/firewall/), offer their own external firewalls. If you are using an external firewall, ensure the following ports are open for OpenPanel services to be accessible: `53` `80` `443` `2083` `2087` `32768:60999`

If you are [using a custom port for OpenPanel instead of the default 2083](/docs/admin/settings/general/#change-openpanel-port), ensure that port is open as well.

---

// File: admin/security/imunify

# ImunifyAV

[ImunifyAV](https://cloudlinux.zendesk.com/hc/en-us/articles/4716287786396-Imunify360-Standalone-installation-guide-with-integration-conf-examples) enhances your server’s security by allowing you to scan user website files for malicious content.

> Note: Imunify, its trademarks, and all related assets are the property of [CloudLinux Zug GmbH](https://cloudlinux.com/).

## Install

Starting version 1.5.4 - ImunifyAV is included with OpenPanel by default.

If you are using an older version, to install, run:

```bash
opencli imunify install
```

This command installs the latest PHP version, the *imunify360-agent*, and configures access through OpenAdmin.

## Start

To start the Imunify graphical interface, use:

```bash
opencli imunify start
```

## Login

Access the Imunify GUI from **OpenAdmin > Security > Imunify**.

## Manage

Imunify allows you to scan user files and detect any malicious content.

----

> For more usage examples refer to [How-to Guides > Setting Up ImunifyAV](/docs/articles/security/setup-imunifyav/).

---

// File: admin/security/disable-admin

# Disable OpenAdmin

As an advanced security measure, OpenPanel allows you to completely disable the OpenAdmin interface and its related admin service.

By enabling this option, access to OpenAdmin will be blocked, preventing any further administrative changes through the UI. This is particularly useful for hardened production environments where direct UI access is unnecessary or unwanted.

Use this feature with caution — re-enabling OpenAdmin access will require manual intervention via server-side configuration. To enable access to the OpenAdmin: `opencli admin on`

---

// File: admin/services/status

# Service Status

The Service Status section allows you to view and control the status of system services and containers running on your server.

This table provides key details for each service:

* **Service** – Display name of the service.
* **Status** – Indicates if the service is active or inactive.
* **Version** – Current version (if available).
* **Real Name** – Internal service name or container name (e.g., admin for OpenAdmin).
* **Type** – Identifies whether the service is a system process or a container.
* **Port** – Lists the ports used by the service.
* **Monitoring** – Shows whether the service is actively being monitored and logged.
* **Action** – Options to start, stop, or restart the service.

## Edit Services

You can customize which services appear and are manageable from this section by clicking the **Edit Services** button.

Services are configured in JSON format:

* **name** – Display name for the service.
* **type** – Either `system` or `container`.
* **real_name** – Internal service or container identifier.

Default OpenPanel services are actively monitored by SentinelAI, which will try to diagnose and restart failed services automatically. If you manually stop a service, remember to disable this monitoring feature via the [OpenAdmin Notifications](/docs/admin/notifications/) page.

---

// File: admin/services/ftp

# FTP Accounts

The FTP Accounts section allows you to view and manage all FTP sub-accounts associated with OpenPanel users.

Use this tool to create, review, or remove FTP access for specific directories, ensuring secure and controlled file transfers.

The FTP service must be running for accounts to function properly.

The table includes the following details:
- **Account** – Username of the FTP account.
- **Owner** – The OpenPanel user account that owns the FTP account.
- **Path** – The file system path to which the FTP account has access.
- **Action** – Options to manage each account (e.g., delete or edit access).

The list of FTP sub-accounts is periodically refreshed in line with the `opencli ftp-users` cronjob schedule.

---

// File: admin/services/logs

# View Log Files

The *OpenAdmin > Services > View Log Files* feature enables Administrators to access and monitor logs for both OpenPanel and system services.

![log viewer page](/img/admin/openadmin_services_logs.png)

## How to View Log Files

Navigate to *Services > View Log Files*

Select the log file you would like to view and optionally number of lines from the file.

After selecting a log file, two new buttons appear under the log content: 
- *Delete* - will empty the file contents
- *Download* - will download the entire log file to your browser.


## Settings

This functionality supports modularity by allowing customization of the log files displayed in the viewer.

List of default log files: https://raw.githubusercontent.com/stefanpejcic/openpanel-configuration/main/openadmin/config/log_paths.json

To define custom log files for the viewer, click on the 'Settings' link next ot the heading. IN the form edit the json and click on 'Save'.

---

// File: admin/services/limits

# Service Limits

The **Service Limits** section allows Administrators to view and adjust the allocated CPU and Memory resources for system services.

---

To update limits, enter new values in the fields for the appropriate service.  

> **Note:** The service must be stopped and restarted for the new limits to take effect.

**Available Services**:

- openpanel
- caddy
- mysql
- clamav
- redis
- bind9
- ftp

---

To edit limits via the terminal, modify the `/root/.env` file directly.

---

// File: admin/settings/general

# General Settings

From this page Administrators can configure the domain to access both OpenPanel and OpenAdmin interfaces, as well as ports for those services.

![openadmin general panel settings](/img/admin/adminpanel_general_settings.png)

## Domain

To enable access to both OpenAdmin and OpenPanel through a domain name, such as srv.your-domain.com:2083, follow these three steps:

1. Set hostname:
   Set the desired subdomain as server hostname:
   ```
   hostnamectl set-hostname server.example.net
   ```
2. Configure DNS:
   Point the subdomain to the public IP of the server.
   Use a tool such as https://www.whatsmydns.net/ to check that domain is pointed to server ip.
   
3. Set in General Settings
   Set the domain name in *OpenAdmin > Settings > General Settings*.

:::info
You can also [set a separate domain just for OpenPanel UI](/docs/articles/dev-experience/separate-domain-for-openpanel-access)
:::

## Set IP address for OpenPanel

To access OpenPanel and OpenAdmin via server public IP address, set IP address in *OpenAdmin > Settings > General Settings*.

## Ports

Port configurations for OpenAdmin and OpenPanel interfaces can be modified from their default settings (`2087` for OpenAdmin and `2083` for OpenPanel). 

- To change the port for the OpenPanel from the default `2083` to another value, set the desired port in the "OpenPanel Port" field.
- To change the port for the OpenAdmin from the default `2087` to another value, set the desired port in the "OpenAdmin Port" field.

## Redirect

By default, when users add a domain, the addition of "/openpanel" to the domain URL will redirect them to the OpenPanel interface. However, you have the flexibility to customize this, such as changing it to "/awesome," allowing users to access their OpenPanel via "their-domain.com/awesome".

To change the "/openpanel" to something else, simply set the value for the "OpenPanel is also available on:" field and click on save. Changes take effect instantly without service interruption.

---

// File: admin/settings/openpanel

# OpenPanel

Configure nameservers, branding, and UI display settings for the OpenPanel interface.

---

## Branding

Customize the appearance of OpenPanel to match your brand:

- **Brand Name**  
  Set a custom name to appear in the OpenPanel sidebar and on login pages by entering it in the **"Brand name"** field.

- **Logo**  
  Display a logo instead of the brand name by providing a URL to the image in the **"Logo image"** field.  
  Supported formats: `.png` or `.svg`  
  **Recommended size:** `200px × 36px`

- **Logout URL**  
  Specify the URL users are redirected to after logging out from the panel (typically your main website).

## Nameservers

- ns1
- ns2
- ns3
- ns4

[Guide on how to properly configure nameservers](/docs/articles/domains/how-to-configure-nameservers-in-openpanel)

## Display

Additional display settings include:

- **Avatar Type:** Choose between Gravatar, Letter, or Icon for user avatars.
- **Charts Mode for Resource Usage:** Select to show 1 chart, 2 charts, or no charts on the Resource Usage page.
- **Check Passwords Against Weakpass.com:** When enabled, user passwords during account creation and reset are verified against Weakpass.com’s list of compromised passwords.
- **Enable Password Reset:** Allow users to reset passwords via the login form (not recommended for security reasons).
- **Display 2FA Widget:** Show a message on users' dashboards encouraging them to enable Two-Factor Authentication for enhanced security.
- **Enforce 2FA:** On login redirects users to 2FA setup page and prevents them from accessing other pages until 2FA is configured.
- **Display How-to Guides Widget:** Display helpful how-to articles on users’ dashboard pages.
- **Display Link to Report Bugs:** Show a “Found a bug? Let us know” link at the bottom of all user pages for easy bug reporting.
- **Display Country Flag Icons:** Show country flags next to the last login IP in the OpenPanel dashboard.

## File Manager

Configure the following settings for the File Manager:

- **Max File Size for Viewer:** Maximum file size (in MB) allowed to be opened in the Viewer. Recommended maximum is 20 MB.
- **Max File Size for Editor:** Maximum file size (in MB) allowed to be opened in the Code Editor. Recommended maximum is 10 MB.
- **Max File Size for Upload:** Maximum file size (in MB) allowed to be uploaded via the File Manager. Recommended maximum is 2000 MB.
- **Max File Size for Download:** Maximum file size (in MB) allowed to be downloaded via the File Manager. Recommended maximum is 2000 MB.
- **Auto-Purge Trash After:** Number of days files remain in the user’s trash bin before automatic deletion. Setting to 0 disables auto-purge. Recommended setting is 30 days.
- **Max Time for Compress Process:** Maximum number of minutes before aborting archive compression processes. Recommended to keep this to a few minutes.
- **Max Time for Extract Process:** Maximum number of minutes before aborting archive extraction processes. Recommended to keep this to a few minutes.
- **Enable View and Edit Options for (textual) Extensions:** Specify file extensions allowed to be opened and edited in the File Manager (should be textual file types).
- **Enable View Option for (base64 image) Extensions:** Specify image file extensions that can be displayed using base64 encoding in the Viewer.
- **Enable Extract and Archive Options for (archives) Extensions:** Specify archive file extensions that can be extracted using the File Manager.

## Statistics

Configure the following settings related to user login attempts, session management, and data retention:

- **Failed Logins per Minute Before User is Rate-Limited:** Number of failed login attempts allowed per minute from a single IP before that IP is temporarily rate-limited to prevent brute-force attacks.
- **Failed Logins per Minute Before User is Blocked for 1 Hour:** Threshold of failed login attempts per minute that triggers a 1-hour block for the offending IP address.
- **Session Duration (in Minutes):** Length of time a user session remains active before requiring re-authentication.
- **Session Lifetime (in Minutes):** Total maximum lifetime of a session, after which the user will be logged out regardless of activity.
- **Login Records to Keep per User:** Number of recent login attempts stored per user for audit and security tracking purposes.
- **Activity Records to Store per User:** Maximum number of user activity logs retained for reviewing past actions within the panel.
- **Activity Items per Page:** Number of activity log entries displayed per page in the user interface.
- **Resource Usage Items to Display per Page:** Number of resource usage records shown per page when viewing user or system resource statistics.
- **Resource Usage Items to Log per User:** Number of resource usage entries recorded and stored per user for historical analysis.
- **Domains per Page:** Number of domain entries displayed per page in domain management lists.

---

// File: admin/settings/api

# API Access

Use the API Access page to test API calls, view request/response examples, monitor API logs, and experiment with endpoints in a simple interface.

To begin:

1. **Enable API Access**

   Toggle the Enable API Access option to activate the interface for testing API requests.

3. **Fill the Request Form**

   Once enabled, you will see a form with the following fields:

    - **Method** – Choose the HTTP method.
    - **URL** – Enter the API endpoint you wish to call.
    - **USERNAME** - Enter admin username.
    - **PASSWORD** - Enter admin password.
    - **TOKEN** – token that was generated with username and password combination.
    - **DATA** – (Optional) Provide any data or parameters required by the endpoint.

5. **Send Request**

   Click the Send Request button to execute the API call.

7. **View API Logs and Curl command**

   After making a request, the response, curl command and log details will appear at the bottom. This includes request info, server response, status codes, and any error messages.

For full API reference and additional endpoints, please refer to [OpenAdmin API Specification](/docs/articles/dev-experience/openadmin-api).

---

// File: admin/settings/defaults

# Defaults

From **OpenAdmin > Settings > Defaults** Administrators can edit values for the `docker-compose.yml` and `.env` files used for new users.

![defaults basic](/img/docs-content/KFRzLrGY-admin-defaults.png)

These files determine services and limits for new users.

> [How to setup Apache, Nginx, OpenResty, OpenLiteSpeed, and Varnish as default webserver](/docs/articles/docker/how-to-set-nginx-apache-varnish-per-user-in-openpanel/)
> [How to setup MySQL, MariaDB or Percona for default database type](/docs/articles/docker/how-to-set-mysql-mariadb-per-user-in-openpanel/)

---

Using the 'Advanced' option you can directly edit the files.

![defaults advanced](/img/docs-content/74BhfQyc-admin-defaults-advanced.png)

In these files you can configure additional services (docker containers) and change defaults for existing services.

Keep in mind that this is intended for advanced users and misconfiguration can cause exposed system ports, user hogging resources or exceeding disk limits.

For more information refer to [How to add custom docker images](/docs/articles/docker/how-to-add-custom-docker-image-for-openpanel-user)

---

// File: admin/settings/modules

# Modules

Modules extend the OpenPanel UI by adding new features and pages. To make a feature available to a user or plan, it must first be activated as a module.

- Modules are **core features** that are already available on installation and are developed by OpenPanel.
- Plugins are custom features that need to be installed and are developed by third-party developers.

Available Modules:

## Notifications

The **`notifications`** module is required to send email notifications to users.

When enabled:
* Emails are sent according to each user’s notification preferences.
* Users can manage their preferences through the OpenPanel UI at: [**Accounts > Email Notifications**](/docs/panel/account/notifications/).

When disabled:
* No emails will be sent, regardless of user preferences.

Customize email notifications:
* To **set default preferences for new users** edit the [`/etc/openpanel/skeleton/notifications.yaml`](https://github.com/stefanpejcic/openpanel-configuration/blob/main/skeleton/notifications.yaml) file.
* To **customize email templates** refer to [Customizing OpenPanel Email Templates](https://community.openpanel.org/d/214-customizing-openpanel-email-templates).
* To **configure custom SMTP** use [OpenAdmin > Settings > Notifications page](/docs/admin/settings/notifications/).



## Account

The **`account`** module is required for users to change their email, password or username.

When enabled:
* Users can change their email, password and username through the OpenPanel UI at: [**Accounts > Settings**](/docs/panel/account/).

When disabled:
* Users can not change their passwords from OpenPanel UI, only from 'Password Reset' on login form, if this option is enabled.

Customize password and username changes:
* To **enable or disable password reset on login forms** edit 'Enable password reset on login' setting from [OpenAdmin > Settings > OpenPanel](/docs/admin/settings/openpanel/).
* To **prevent users from changing their username** edit 'Allow users to change username' setting from  [OpenAdmin > Settings > OpenPanel](/docs/admin/settings/openpanel/).


## Sessions

The **`sessions`** module allows users to view and manage their active sessions.

When enabled:
* Users can view all their active sessions, logs and terminate any session through the OpenPanel UI at: [**Accounts > Active Sessions**](/docs/panel/account/active_sessions/).

When disabled:
* Users can not access the *Accounts > Active Sessions* page.

Customize sessions duration:
* To **control session duration** edit 'Session duration' setting from [OpenAdmin > Settings > OpenPanel](/docs/admin/settings/openpanel/#Statistics).
* To **control session lifetime** edit 'Session lifetime' setting from [OpenAdmin > Settings > OpenPanel](/docs/admin/settings/openpanel/#Statistics).

## Locale

The **`locale`** (Languages) module allows users to change panel language.

When enabled:
* Users can change their preferred language for OpenPanel UI from the login page and [**Accounts > Change Language** page](/docs/panel/account/language/).

When disabled:
* Users can not access the *Accounts > Change Language* page to change their locale.
* Users are forced to the Admin defined default locale.

Customize locales:
* To **set the default locale** use [OpenAdmin > Settings > Locales](/docs/articles/accounts/default-user-locales/).
* To **install new locales for users** use the [OpenAdmin > Settings > Locales](/docs/admin/settings/locales/#install-locale).
* To **create a new translation** please see [How to Create a New Locale](/docs/admin/settings/locales/#edit-locale)


## Favorites

The **`favorites`** module allows users to *pin* items in their sidebar menu for quick navigation.

When enabled:
* Users can add pages to favorites with **left-click** on ⭐ icon in top-right corner of the page.
* Users can remove pages from favorites with **right-click** on ⭐ icon in top-right corner of the page.
* Users can access favorites from sidebar menu.
* Users can access the [**Accounts > Favorites** page](/docs/panel/account/favorites/).

When disabled:
* Users can not access the *Accounts > Favorites* page to manage favorites.
* Users are not see favorites in the sidebar nor the ⭐ icon in top-right corner of pages.

Customize favorites:
* To **control the total number of favorites for user** (default is 10) use [`favorites-items` config](https://dev.openpanel.com/cli/config.html#favorites-items).
* To **edit user's favorites from terminal** edit their: `/etc/openpanel/openpanel/core/users/{current_username}/favorites.json` file.


## Varnish

The **`varnish`** module allows users to control varnish caching for their domains.

When enabled:
* Varnish server starts for user and proxies traffic back to their webserver. 
* Users can access the [**Caching > Varnish** page](/docs/panel/caching/varnish/).
* Users can enable/disable Varnish service.
* Users can enable/disable Varnish caching per domain.
* Users can view logs for the Varnish service.

When disabled:
* Users do not have access to the *Caching > Varnish* page.
* Varnish is used only if Administrator enabled it for user when creating the account. 

Customize options:
* To **enable/disable Varnish for all new users** use [*OpenAdmin > Settings > User Defaults* page and *Enable Varnish Proxy* option](/docs/admin/settings/defaults/).
* To **enable/disable Varnish for a single user** when creating their account use the [**Enable Varnish Cache** option](/docs/articles/docker/how-to-set-nginx-apache-varnish-per-user-in-openpanel/).
* To **change default CPU/RAM for service** use the [*OpenAdmin > Settings > User Defaults* page](/docs/admin/settings/defaults/).
* To **edit the default.vcl file for Varnish** use the [*OpenAdmin > Domains > Edit Domain Templates* page](/docs/admin/settings/defaults/) or edit file: [`/etc/openpanel/varnish/default.vcl`](https://github.com/stefanpejcic/openpanel-configuration/blob/main/varnish/default.vcl).
* To **purge Varnish cache** refer to [How-to Guides > Purging Varnish Cache](/docs/articles/websites/purge-varnish-cache-from-terminal/)
* To **check if Varnish is enabled for domain** refer to [How to check if Varnish Caching is enabled for a domain in OpenPanel?](https://community.openpanel.org/d/207-how-to-check-if-varnish-caching-is-enabled-for-a-domain-in-openpanel)


## Docker

The **`docker`** module allows users to manage and add new docker containers.

When enabled:
* Users can access [**Docker > Containers**](/docs/panel/containers/) page to view and manage services.
* Users can access [**Docker > Containers > New**](/docs/panel/containers/#adding-new-services) page to add new services.
* Users can access [**Docker > Terminal**](/docs/panel/containers/terminal/) page to run docker exec commands.
* Users can access [**Docker > Image Updates**](/docs/panel/containers/image/) page to check for available image updates.
* Users can access [**Docker > Logs**](/docs/panel/containers/logs/) page to view service logs.
* Users can access [**Docker > Change Image Tag**](/docs/panel/containers/change/) page to change images tag.
* Users can access [**Docker > Switch Web Server**](/docs/panel/containers/webserver/) page to switch webservers.
* Users can access [**Docker > Switch MySQL Type**](/docs/panel/containers/mysql/) page to switch mysql/mariadb.

When disabled:
* Users can not access any of the *Docker* pages.

Customize options:
* [Disable the Terminal](/docs/articles/dev-experience/disable-openpanel-web-terminal/)


## Fix Permissions

The **`fix_permissions`** module allows users to reset file/folder permissions.

When enabled:
* Users can access the [**Files > Fix Permissions** page](/docs/panel/files/fix_permissions/).

When disabled:
* Users can not access the *Files > Fix Permissions* page.


## FTP

The **`ftp`** module allows users to create and manage FTP sub-accounts.

When enabled:
* Users can access the [**Files > FTP** page](/docs/panel/files/FTP/) to manage FTP accounts.

When disabled:
* Users can not create and manage FTP accounts.

Customize options:
* To **configure FTP server** refer to [*How-to Guides > Setup FTP](/docs/articles/user-experience/how-to-setup-ftp-in-openpanel/).
* To **edit VSFTPD configuration** edit the [`/etc/openpanel/ftp/vsftpd.conf` file](https://github.com/stefanpejcic/openpanel-configuration/blob/main/ftp/vsftpd.conf).
* To **view all ftp accounts on a server** use the [*OpenAdmin > Services > FTP* page](/docs/admin/services/ftp/).
* To **limit number of ftp accounts per user** edit the ftp accounts limit when creating/editing hosting packages.

## Emails

The **`emails`** module allows users to create and manage Email accounts.

When enabled:
* Users can access the [**Emails** pages](/docs/panel/emails/) to manage Email accounts.

When disabled:
* Users can not create and manage Email accounts.

Customize options:
* To **configure email server** refer to [*How-to Guides > Configure Email Server*](/docs/articles/user-experience/how-to-setup-email-in-openpanel/).
* To **configure email client** refer to [*How-to Guides > How to setup your email client*](/docs/articles/email/how-to-setup-your-email-client/).
* To **view all email accounts on a server** use the [*OpenAdmin > Emails > Email Accounts* page](/docs/admin/emails/).
* To **set up fail2ban** refer to [*How-to Guides > Setup Fail2ban](/docs/articles/email/how-to-setup-fail2ban-mailserver-openpanel/).
* To **set up Rspamd** refer to [*How-to Guides > RSPAMD GUI](/docs/articles/email/rspamd-gui-port-11334/).
* To **set up DKIM for a domain** refer to [*How-to Guides > Setup DKIM](/docs/articles/email/how-to-setup-dkim-for-mailserver/).
* To **limit number of email accounts per user** edit the email accounts limit when creating/editing hosting packages.


## Webmail

The **`webmail`** module allows users to auto-login to Roundcube webmail for their Email accounts.

When enabled:
* Users can access the [**Webmail**](/docs/panel/emails/webmail/) button.

When disabled:
* Users can not auto-login to webmail.

Customize options:
* To **set webmail domain or relay hosts** use the [*OpenAdmin > Emails > Email Settings* page](/docs/admin/emails/settings/).


## Email Filters

The **`email_filters`** module allows users to configure filters and forwarders for their emails.

When enabled:
* Users can access the [**Email Filters** page](/docs/panel/emails/filters/)

When disabled:
* Users can not access the Email Filters page.



## Email Aliases

The **`email_import`** module allows users to forwards mail from a non-existing address to one or more destinations.

When enabled:
* Users can access the [**Email Aliases** page](/docs/panel/emails/aliases/)

When disabled:
* Users can not access the Email Aliases page.


## Address Importer

The **`email_import`** module allows users to import email addresses from a CSV file.

When enabled:
* Users can access the [**Address Importer** page](/docs/panel/emails/import/)

When disabled:
* Users can not access the Address Importer page.


## Address Exporter

The **`email_export`** module allows users to export to CSV file all their email addresses.

When enabled:
* Users can export email addresses by visiting: `/emails/export`

When disabled:
* Users can not access the Address Exporter page.



## Default Address

The **`email_default`** module allows users to create default (catch-all) email addresses.

When enabled:
* Users can access the [**Default Email Address** page](/docs/panel/emails/default_address/)

When disabled:
* Users can not access the Default Email Address page.



## Email Deliverability

The **`email_deliverability`** module allows users to check and validate SPF, DKIM and DMARC records for their domains.

When enabled:
* Users can access the [**Email Deliverability** page](/docs/panel/emails/email_deliverability/) to view DNS records.

When disabled:
* Users can not access the Email Deliverability page.


## MySQL

The **`mysql`** module allows users to create and manage mysql databases.

When enabled:
* MySQL/MariaDB auto-starts when user accesses Databases section, opens phpMyAdmin or installs WordPress.
* Users can access the [**MySQL > Databases** page](/docs/panel/mysql/databases/) to manage databases.
* Users can access the [**MySQL > New Database** page](/docs/panel/mysql/new_db/) to create databases.
* Users can access the [**MySQL > Database Wizard** page](/docs/panel/mysql/wizard/) to create database, user and assign privileges.
* Users can access the [**MySQL > Users** page](/docs/panel/mysql/users/) to manage users.
* Users can access the [**MySQL > New User** page](/docs/panel/mysql/new_user/) to create users.
* Users can access the [**MySQL > Change Password** page](#) to change password for a user.
* Users can access the [**MySQL > Assign User to DB** page](/docs/panel/mysql/assign/) to assign all privileges to user over a database.
* Users can access the [**MySQL > Remove User from DB** page](/docs/panel/mysql/remove/) to revoke all privileges to user over a database.

When disabled:
* Users do not have access to the *MySQL* section.

Customize options:
* To **set mysql or mariadb for all new users** use [*OpenAdmin > Settings > User Defaults* page and *MySQL type* option](/docs/admin/settings/defaults/).
* To **set mysql, percona or mariadb for a single user** when creating their account use the [**MySQL Type** option](/docs/articles/docker/how-to-set-mysql-mariadb-per-user-in-openpanel/).
* To **change default CPU/RAM for service** use the [*OpenAdmin > Settings > User Defaults* page](/docs/admin/settings/defaults/).
* To **restrict access to system users** edit the [`mysql_restricted_usernames`](https://dev.openpanel.com/cli/config.html#mysql-restricted-usernames) setting.
* To **restrict access to system databases** edit the [`mysql_restricted_databases`](https://dev.openpanel.com/cli/config.html#mysql-restricted-databases) setting.
* To **increase the startup time allowed for waiting MySQL to initalize** increase [`mysql_startup_time`](https://dev.openpanel.com/cli/config.html#mysql-startup-time).


How-to guides:
* To **connect to a database** refer to [*How-to Guides > Connecting to MySQL Server from Applications in OpenPanel](/docs/articles/databases/how-to-connect-to-mysql-from-php-applications-in-openpanel/).
* To **troubleshoot errors** refer to [*How-to Guides > How to troubleshoot: Error establishing a database connection](/docs/articles/databases/how-to-troubleshoot-error-establishing-a-database-connection/).


## MySQL Root Password

The **`mysql_root_password`** module allows users to change password for their MySQL root user from the user panel.

When enabled:
* Users can access the [**MySQL > Root Password** page](#) to change root user password.

When disabled:
* Users do not have access to the *MySQL Root Password* page.



## MySQL Show Processes

The **`mysql`** module allows users to create and manage mysql databases.

When enabled:
* Users can access the [**MySQL > Process List** page](/docs/panel/mysql/processlist/) to view all active processes.

When disabled:
* Users do not have access to the *MySQL Process List* page.


## Remote MySQL

The **`remote_mysql`** module allows users to enable/disable remote access to mysql.

When enabled:
* Remote access is disabled by default.
* Random port is allocated per user for their mysql instances.
* Users can access the [**MySQL > Remote Access** page](/docs/panel/mysql/remote/) to enable/disable remote access.
* Users can connect to any database from remote location once the option is enabled.

When disabled:
* Remote access is disabled.

Customize options:
* None


## phpMyAdmin

The **`phpmyadmin`** module allows users to manage phpMyAdmin service.

When enabled:
* phpMyAdmin can be accessed by the user.
* phpMyAdmin is available on a `https://DOMAIN:2053` when domain is set, or `http://IP:8888` when IP is set for panel access.

When disabled:
* Users do not have access to the *phpMyAdmin* service.

Customize options:
* To **change CPU/RAM for phpMyAdmin service** or values: **php_max_execution_time, php_memory_limit, php_upload_limit** use [*OpenAdmin > Services > Service Limits](/docs/admin/services/limits/).

How-to guides:
* To **import tables into a database** refer to [**the Documentation**](/docs/panel/mysql/phpmyadmin/#import-sql-files).

## MySQL Import

The **`mysql_import`** module allows users to import files into their databases.

When enabled:
* Users can access the [**MySQL > Import Database** page](/docs/panel/mysql/import/) to import files into a database.

When disabled:
* Users can not access the *MySQL > Import Database* page.

Customize options:
* To **set the max file size allowed for import** increase [`mysql_import_max_size_gb`](https://dev.openpanel.com/cli/config.html#mysql-import-max-size-gb) value.

How-to guides:
* To **import into a database** refer to [*How-to Guides > Importing a Database](/docs/articles/docker/import-database/).


## MySQL Conf

The **`mysql_conf`** module allows users to edit mysql server configuration.

When enabled:
* Users can access the [**MySQL > Edit Configuration** page](#) to edit service .cnf file.

When disabled:
* Users can not access the *MySQL > Edit Configuration* page.

Customize options:
* To **set available options for configuration** edit file: [`/etc/openpanel/mysql/keys.txt`](https://github.com/stefanpejcic/openpanel-configuration/blob/main/mysql/keys.txt).
* To **edit the mysql.cnf file for a single user** edit file: `/home/${username}/custom.cnf`.
* To **edit the mysql.cnf file for all new users** edit file: [`/etc/openpanel/mysql/user.cnf`](https://github.com/stefanpejcic/openpanel-configuration/blob/main/mysql/user.cnf).




## Remote PostgreSQL

The **`remote_postgresql`** module allows users to enable/disable remote access to PostgreSQL.

When enabled:
* Remote access is disabled by default.
* Random port is allocated per user for their PostgreSQL instances.
* Users can access the [**PostgreSQL > Remote Access** page](#) to enable/disable remote access.
* Users can connect to any database from remote location once the option is enabled.

When disabled:
* Remote access is disabled.

Customize options:
* None


## pgAdmin

The **`pgadmin`** module allows users to manage pgAdmin service.

When enabled:
* pgAdmin can be managed by the user.
* Users have access to the *pgAdmin* section.
* pgAdmin is available on a custom per-user port.

When disabled:
* Users do not have access to the *pgAdmin* section.

Customize options:
* To **change default CPU/RAM for pgAdmin** use the 'manage' button in top-rgiht corner.


## PostgreSQL Import

The **`postgresql_import`** module allows users to import files into their databases.

When enabled:
* Users can access the [**PostgreSQL > Import Database** page](#) to import files into a database.

When disabled:
* Users can not access the *PostgreSQL > Import Database* page.

Customize options:
* None


## PostgreSQL Conf

The **`postgresql_conf`** module allows users to edit PostgreSQL server configuration.

When enabled:
* Users can access the [**PostgreSQL > Edit Configuration** page](#) to edit service .cnf file.

When disabled:
* Users can not access the *PostgreSQL > Edit Configuration* page.


## Crons

The **`crons`** module allows users to schedule [Ofelia](https://hub.docker.com/r/mcuadros/ofelia) cron jobs.

When enabled:
* Users can access the [**Advanced > Cron Jobs** page](/docs/panel/advanced/cronjobs/).
* Users can [add cronjobs](/docs/panel/advanced/cronjobs/#add)
* Users can [edit cronjobs](/docs/panel/advanced/cronjobs/#edit)
* Users can [view logs for cronjobs](/docs/panel/advanced/cronjobs/#logs)
* Users can [edit crons file](/docs/panel/advanced/cronjobs/#file-editor)
* Users can [import and export cronjobs](/docs/panel/advanced/cronjobs/#import--export)

When disabled:
* Users can not access the *Advanced > Cron Jobs* page nor modify crons.

Customize options:
* To **pre-set cronjobs for new users** edit the `/etc/openpanel/ofelia/users.ini` file.
* To **set max file size for the cron file to be editable via OpenPanel UI** set the [`cron_max_file_size_kb`](https://dev.openpanel.com/cli/config.html#cron-max-file-size-kb) value.



## Process Manager

The **`process_manager`** module allows users to view and terminate processes from all running services.

When enabled:
* Users can access the [**Advanced > Process Manager** page](/docs/panel/advanced/process_manager/).

When disabled:
* Users can not access the *Advanced > Process Manager* page.

Customize options:
* None


## Server Info

The **`info`** module allows users to view server information, hosting plan information and OpenPanel information.

When enabled:
* Users can access the [**Advanced > Server Information** page](/docs/panel/advanced/server_info/).

When disabled:
* Users can not access the *Advanced > Server Information* page.

Customize options:
* None



## Temporary Links

The **`temporary_links`** module allows users to test their websites using temporary subdomains (links are valid for 15 minutes).

When enabled:
* Users can access the [**Live Preview** button on the Site Manager](/docs/panel/applications/wordpress/#temporary-link).

When disabled:
* Users can not access the *Live Preview* button on the Site Manager page.

Customize options:
* To **self-host a proxy service** - refer to [How-to Guides > Temporary Links API](/docs/articles/dev-experience/selfhosted-temporary-links-api/).
* To **configure a custom domain** - update the [`temporary_links` option](https://dev.openpanel.com/cli/config.html#temporary-links).

## Login History

The **`login_history`** module allows users to view login history for their account.

When enabled:
* Users can access the [**Account > Login History** page](/docs/panel/account/login_history/).

When disabled:
* Users can not access the *Account > Login History* page.

Customize options:
* To **control number of logins stored per user** edit 'Login records to keep per user' setting from [OpenAdmin > Settings > OpenPanel](/docs/admin/settings/openpanel/#Statistics).


## 2FA

The **`twofa`** module allows users to enable 2 factor authentication for their account.

When enabled:
* Users can access the [**Account > Two-Factor Authentication** page](/docs/panel/account/2fa).
* 2FA is required on login page if account has enabled it.

When disabled:
* Users can not access the *Advanced > Two-Factor Authentication* page nor manage 2FA.

Customize options:
* To **enable 2FA widget** use [*OpenAdmin > Settings > OpenPanel* page and *Display 2FA widget* option](/docs/admin/settings/openpanel/).
* To **enforce 2FA for all users** use [*OpenAdmin > Settings > OpenPanel* page and *Enforce 2FA* option](/docs/admin/settings/openpanel/).
* To **check 2FA status for a user** refer to [How to check if 2FA is active for OpenPanel user account?](https://community.openpanel.org/d/220-how-to-check-if-2fa-is-active-for-openpanel-user-account).

## Passkeys

The **`passkeys`** module allows users to seup [Passkeys](https://safety.google/intl/en_in/safety/authentication/passkey/) for their account.

NOTE: Passkeys require that a domain name is used for panel access.

When enabled:
* Users can access the [**Account > Passkeys** page](/docs/panel/account/passkeys).
* 'Sign up with Passkey' is shown on login page.

When disabled:
* Users can not login using Passkeys.

## Activity

The **`activity`** module allows users to view their activity logs.

When enabled:
* Users can access the [**Account > Activity Log** page](/docs/panel/account/account_activity).

When disabled:
* Users can not access the *Account > Activity Log* page.

Customize options:
* To **edit activity log from terminal** open file: `/etc/openpanel/openpanel/core/users/{username}/activity.log`.
* To **set total number of lines per user** edit `activity_lines_retention` setting.
* To **set total size of log per user** edit `activity_max_size_bytes` setting.
* To **log actions from 3rd-party plugin** refer to: [*How to log actions from Custom Plugins in user Activity Log*](https://community.openpanel.org/d/218-how-to-log-actions-from-custom-plugins-in-user-activity-log)


## Backups

The **`backups`** module allows users to m=configure their own backups: what to backup, destination, retention, schedule, etc.

When enabled:
* Users can access the [**Files > Backups** page](/docs/panel/files/backups/).
* Users can configure backup schedule, encryption, retention and destination.

When disabled:
* Users do not have access to the *Files > Backups* page.
* [Administrators need to configure backups for the user](/docs/articles/backups/configuring-backups/#1-admin-configured).



## Services

The **`services`** module allows users to enable/disable services without the Docker module.

When enabled:
* Users can access the [**Advanced > Services** page](/docs/panel/advanced/services/).
* Users can enable/disable services.
* User view current service status, resource usage (CPU%, Memory%, Disk I/O, PIDs..), container name (to be used to connect to service from other containers).
* Users can view logs for services.

When disabled:
* Users do not have access to the *Advanced > Services* page.


## Memcached

The **`memcached`** module allows users to enable/disable Memcached service.

When enabled:
* Users can access the [**Caching > Memcached** page](/docs/panel/caching/memcached/).
* Users can enable/disable Memcached service.
* User can connect to the instance from other containers using: `elasticsearch:11211`
* Users can view logs for the Memcached service.

When disabled:
* Users do not have access to the *Caching > Memcached* page.

## Redis

The **`redis`** module allows users to enable/disable Redis service.

When enabled:
* Users can access the [**Caching > Redis** page](/docs/panel/caching/redis/).
* Users can enable/disable Redis service.
* User can connect to the instance from other containers using: `redis:6379`
* Users can view logs for the Redis service.

When disabled:
* Users do not have access to the *Caching > Redis* page.

## Valkey

The **`valkey`** module allows users to enable/disable Valkey service.

When enabled:
* Users can access the [**Caching > Valkey** page](/docs/panel/caching/valkey/).
* Users can enable/disable Valkey service.
* User can connect to the instance from other containers using: `valkey:6379`
* Users can view logs for the Valkey service.

When disabled:
* Users do not have access to the *Caching > Valkey* page.


## ElasticSearch

The **`elasticsearch`** module allows users to enable/disable ElasticSearch service.

When enabled:
* Users can access the [**Caching > ElasticSearch** page](/docs/panel/caching/elasticsearch/).
* Users can enable/disable ElasticSearch service.
* User can connect to the instance from other containers using: `elasticsearch:9200`
* Users can view logs for the ElasticSearch service.

When disabled:
* Users do not have access to the *Caching > ElasticSearch* page.



## OpenSearch

The **`opensearch`** module allows users to enable/disable OpenSearch service.

When enabled:
* Users can access the [**Caching > OpenSearch** page](/docs/panel/caching/opensearch/).
* Users can enable/disable OpenSearch service.
* User can connect to the instance from other containers using: `opensearch:9200`
* Users can view logs for the OpenSearch service.

When disabled:
* Users do not have access to the *Caching > OpenSearch* page.


## Disk Usage Explorer

The **`disk_usage`** module allows users to view disk usage per-directory.

When enabled:
* Users can access the [**Files > Disk Usage** page](/docs/panel/files/disk_usage/).

When disabled:
* Users do not have access to the *Files > Disk Usage* page.


## Inodes Explorer

The **`disk_usage`** module allows users to view disk usage per-directory.

When enabled:
* Users can access the [**Files > Inodes Explorer** page](/docs/panel/files/inodes/).

When disabled:
* Users do not have access to the *Files > Inodes Explorer* page.





## AutoInstaller
The **`autoinstaller`** module allows users to autoinstall WordPress, website Builder, Mautic, Python/NodeJS applications, etc.

When enabled:
* Users can access the [**Websites > Auto Installer** page](/docs/panel/applications/autoinstaller/).

When disabled:
* Users do not have access to the *Websites > Auto Installer* page.


## PHP.INI Editor
The **`php_ini`** module allows users to edit the PNP.INI files using a text editor.

When enabled:
* Users can access the [**PHP > PHP.INI Editor** page](/docs/panel/php/php_ini_editor/).

When disabled:
* Users do not have access to the *PHP > PHP.INI Editor* page.


## WordPress

The **`wordpress`** module allows users to install and manage WordPress websites.

When enabled:
* Users can access the [**Websites > WP Manager** page](/docs/panel/applications/wordpress/).
* Users can [manage WordPress websites using WP Manager](/docs/panel/applications/wordpress/#site-manager).
* WordPress is available on the Autoinstaller page.
* Users can [install WordPress using Auto Installer](/docs/panel/applications/wordpress/#install-wordpress).
* Users can [scan and import existing installations](/docs/panel/applications/wordpress/#scanning-importing-installations).
* Users can [set themes and plugins to auto-install](/docs/panel/applications/wordpress/#themes-and-plugins-sets).

When disabled:
* Users can not access the *Websites > WP Manager* page.
* WordPress is not available in Autoinstaller.
* WordPress websites can not be managed via Openpanel.

Customize options:
* To **auto install themes or plugins on new installations** refer to: [*WordPress Themes and Plugins Sets*](/docs/articles/websites/wordpress-plugins-themes-sets-in-openpanel/)
* To **add a custom Google PageSpeed Insights API Key** refer to: [*How-to Guides > Google PageSpeed Insights API Key*](/docs/articles/websites/google-pagespeed-insights-api-key/)
* To **setup a mu-plugin on all new websites** edit `/etc/openpanel/wordpress/mu-plugin.php` file.
* To **set a custom WP-CLI for all websites** replace the `/etc/openpanel/wordpress/wp-cli.phar` file.
* To **customize .htaccess files used for new websites** edit files in `/etc/openpanel/wordpress/htaccess/` folder.

## Website Builder

The **`website_builder`** module allows users to create simple websites using the HTML Drag & Drop Website Builder.

When enabled:
* Users can access the [**Websites > Website Builder** page](/docs/panel/applications/builder/).
* Users can [manage static websites using Site Manager](/docs/panel/applications/builder/#edit-website).
* Website Builder is available on the Autoinstaller page.
* Users can [create static websites using Auto Installer](/docs/panel/applications/builder/#create-a-website).

When disabled:
* Users can not access the *Websites > Website Builder* page.
* Website Builder is not available in Autoinstaller.
* Static websites can not be managed via Openpanel.

## Mautic

The **`mautic`** module allows users to install and manage Mautic from OpenPanel. 

> **NOTE:** This module is no longer actively maintained and should not be used in production (*BETA* tag).

When enabled:
* Users can [manage Mautic websites using Site Manager](/docs/panel/applications/).
* Mautic is available on the AutoInstaller page.
* Users can [install Mautic using the AutoInstaller](/docs/articles/websites/how-to-install-mautic-with-openpanel/).

When disabled:
* Mautic is not available in Autoinstaller.

## ClamAV

The **`malware_scanner`** module starts a ClamAV service and allows users to scan files. 

> **NOTE:** This module is no longer actively maintained and should not be used in production (*DEPRECATED* tag).

When enabled:
* Users can access the [**Files > Malware Scanner** page](/docs/panel/files/malware-scanner/).
* ClamAV service is started on the server.

When disabled:
* Users can not access the *Files > Malware Scanner* page.
* ClamAV service is not started on the server.

Customize options:
* To **customize the cpu/memory limits for the ClamAV service** refer to: [*OpenAdmin > Services > Service Limits*](/docs/admin/services/limits/).



## Files

The **`filemanager`** module allows users to manage files and folders using the File Manager.

When enabled:
* Users can access the [**Files > File Manager** page](/docs/panel/files/).
* File Manager links are available on other pages: Domains, WP Manager, etc.

When disabled:
* Users can not access the *Files > File Manager* page.
* No links to manage files are shown on other pages.


## Trash

The **`trash`** module allows users to manage their Trash folder.

When enabled:
* Users can access the [**Files > Trash** page](/docs/panel/files/).
* User can delete to trash instead of permanently deleting files.

When disabled:
* Users can not access the *Files > Trash* page.


## Domains

The **`domains`** module allows users to add and manage domains.

When enabled:
* Users can access the [**Domains** page](/docs/panel/domains/).
* Users can manage domains.
* Users can access the 'Domains' sub-pages in the menu.

When disabled:
* Users can not access the *Domains* page.
* Users can not manage domains.

Customize options:
* To **enable HSTS for a domain** refer to:  [*How-to Guides > How to Enable HSTS on a Domain in OpenPanel*](/docs/articles/domains/how-to-enable-hsts-on-a-domain-in-openpanel/)
* To **customize default pages** refer to: [*OpenAdmin > Domains > Edit Domain Templates*](/docs/admin/domains/file_templates/)


## Suspend Domains

The **`domain_suspend`** module allows users to suspend/unsuspend website access.

When enabled:
* Users can access the [**Suspend a Domain** page](/docs/panel/domains/suspend/).
* Users can access the [**Unsuspend a Domain** page](/docs/panel/domains/unsuspend/).

When disabled:
* Users can not suspend/unsuspend domains.

Customize options:
* To **customize the suspended domain template** use:  [*OpenAdmin > Domains > Edit Domain Templates*](/docs/admin/domains/file_templates/#suspended-website)

## Raw Access Logs

The **`domain_logs`** module allows users to view the raw access log for their domains.

When enabled:
* Users can access the [**Domains > Raw Access Logs** page](/docs/panel/domains/docroot/).

When disabled:
* Users can not access the *Domains > Raw Access Logs* page.



## GoAccess

The **`goaccess`** module runs the GoAccess service on a scheduled basis to process raw domain logs and produce HTML reports accessible through the OpenPanel UI.

When enabled:
* GoAccess service is run on the server.
* Users can access the [**Domains > GoAccess** page](/docs/panel/domains/goaccess/).

When disabled:
* Users can not access the *Domains > GoAccess* page.

Customize options:
* To **disable GoACcess report generation** update the: [*`goaccess_enable` value*](https://dev.openpanel.com/cli/config.html#goaccess-enable)
* To **change how often the reports are generated (default = @daily)** edit the schedule for `domains-stats` cron and the [`goaccess_schedule` value](https://dev.openpanel.com/cli/config.html#goaccess-schedule).
* To **generate the data manually** execute `domains-stats` cron.
* To **force regeneration of the reports* refer to: [*OpenCLI Documentation > Parse domain access logs*](https://dev.openpanel.com/cli/domains.html#Parse-domain-access-logs).


## Docroot

The **`docroot`** module allows users to set a custom docroot (folder) when adding domains, and later change the path.

When enabled:
* Users can access the [**Domains > Change Docroot** page](/docs/panel/domains/docroot/).
* Users can set a custom docroot when adding a domain.

When disabled:
* Users can not set a custom docroot when adding a domaina, and can not later change the docroot.

## Redirects

The **`redirects`** module allows users to create redirects for domains.

When enabled:
* Users can access the [**Domains > Redirects** page](/docs/panel/domains/redirects/).

When disabled:
* Users can not access the *Domains > Redirects* page.



## Capitalize Domains

The **`capitalize_domains`** module allows users to set a capitalized version fo the domain for dispaly in the OpenPanel.

When enabled:
* Users can access the [**Domains > Capitalize Domains** page](/docs/panel/domains/capitalize/).

When disabled:
* Users can not access the *Domains > Capitalize Domains* page.


## Edit VirtualHosts

The **`edit_vhost`** module allows users to edit the VirtualHosts files for their domains.

When enabled:
* Users can access the [**Domains > Edit VHosts File** page](/docs/panel/domains/vhosts/).

When disabled:
* Users can not access the *Domains > Edit VHosts File* page.

Customize options:
* To **customize the vhost files for Apache/Nginx/OpenLiteSpeed** refer to: [*OpenAdmin > Domains > Edit Domain Templates*](/docs/admin/domains/file_templates/#apache-virtualhost)


## Webserver

The **`webserver_conf`** module allows users to edit the main configuration files for their webservers.

When enabled:
* Users can access the [**Advanced > WebServer Settings** page](/docs/panel/advanced/webserver_settings/).
* Users can edit the `httpd.conf` file for Apache.
* Users can edit the `nginx.conf` file for Nginx/OpenResty.
* Users can edit the `openlitespeed.conf` file for OpenLiteSpeed.

When disabled:
* Users can not access the *Advanced > WebServer Settings* page.

Customize options:
* To **customize the default `httpd.conf` file for Apache** edit `/etc/openpanel/apache/httpd.conf` file.
* To **customize the default `nginx.conf` file for Nginx** edit `/etc/openpanel/nginx/nginx.conf` file.
* To **customize the default `openlitespeed.conf` file for OpenLiteSpeed** edit `/etc/openpanel/openlitespeed/httpd_config.conf` file.
* To **customize the default `nginx.conf` file for OpenResty** edit `/etc/openpanel/openresty/nginx.conf` file.

## DNS

The **`dns`** module runs a local BIND9 service, creates zone files for domains and allows users to manage DNS records.

When enabled:
* BIND9 service is run on the server.
* Users can access the [**Domains > DNS Zone Editor** page](/docs/panel/domains/dns/).
* DNS zone files are created for new domains.
* Users can manage DNS records.
* 'Edit Zone' links are available for domains under the *OpenPanel > Domains* page.
* Administrators can access the [**OpenAdmin > Domains > DNS Cluster** page](/docs/admin/domains/dns-cluster/).
* Administrators can access the [**OpenAdmin > Domains > Edit Zone Templates** page](/docs/admin/domains/dns_templates/).
* Administrators can access the [**OpenAdmin > Domains > DNS Zone Editor** page](/docs/admin/domains/dns/).

When disabled:
* Users can not access the *Domains > DNS Zone Editor* page.
* Administrators can not access the *DNS Zone Editor*, *Edit Zone Templates*, and *DNS Cluster* pages in OpenAdmin.

Customize options:
* To **configure nameservers** refer to: [*How-to Guides > Configure Nameservers*](/docs/articles/domains/how-to-configure-nameservers-in-openpanel/)
* To **customize DNS zone templates** refer to: [OpenAdmin > Domains > Edit Zone Templates](/docs/admin/domains/dns_templates/)
* To **configure a DNS cluster** refer to:  [*How-to Guides > DNS Clustering*](/docs/articles/domains/how-to-setup-dns-cluster-in-openpanel/)


## Dynamic DNS

The **`dynamic_dns`** module allows users to create subdomains that will be updated via webhooks.

When enabled:
* Users can access the [**Domains > Dynamic DNS** page](/docs/panel/domains/dynamic-dns/).

When disabled:
* Users can not access the *Domains > Dynamic DNS* page.


## IP Blocker

The **`ip_blocker`** module allows users to block IP addresses from accessing their websites.

When enabled:
* Users can access the [**Advanced > IP Blocker** page](/docs/panel/advanced/ip-blocker/).

When disabled:
* Users can not access the *Advanced > IP Blocker* page.

## WAF

The **`waf`** module runs a custom Caddy image with CorazaWAF and allows users to manage WAF rules and on/off protection per domain.

When enabled:
* `SecRuleEngine On` is set for new domains.
* Users can access the [**Advanced > WAF** page](/docs/panel/advanced/waf/).
* [OWASP CRS](https://github.com/coreruleset/coreruleset) is setup on installation.
* Users can edit WAF rules and enable/disable protection per domain.
* ['Firewall' widget is displayed in Site Manager](/docs/panel/applications/wordpress/#firewall).

When disabled:
* `SecRuleEngine Off` is set for new domains.
* `SecRuleEngine On` is replaced with `SecRuleEngine Off` for all existing domains.
* Users can not access the *Advanced > WAF* page.
* 'Firewall' widget is not displayed in Site Manager.

Customize options:
* [**WAF commmands**](https://dev.openpanel.com/cli/waf.html#CorazaWAF)

## PHP

The **`php`** module allows users to manage PHP versions and settings.

When enabled:
* Users can access the [**PHP > Select PHP Version** page](/docs/panel/php/domains/).
* Users can access the [**PHP > Default Version** page](/docs/panel/php/default/).
* Users can access the [**PHP > Extensions** page](/docs/panel/php/extensions/).
* Users can set PHP version per domain, set default version for new domains, edit options and view installed extensions.

When disabled:
* Users can not access the *Select PHP Version*, *Default Version*, *Options*, *Extensions* pages.
* Users can not set PHP version per domain, set default version for new domains, edit options and view installed extensions.

Customize options:
* To **set the default PHP version to be used for new users** refer to: [*OpenAdmin > Settings > Edit User Defaults > Default PHP version*](/docs/panel/php/options/#available-options)
* To **set default cpu/memory limits for PHP versions and additional PHP options** refer to: [*OpenAdmin > Settings > Edit User Defaults > Services*](/docs/panel/php/options/#available-options)
* To **install a PHP extension** refer to: [*How-to Guides > How to install a PHP extension in OpenPanel*](/docs/articles/websites/how-to-install-php-extensions-in-openpanel/).
* To **increase PHP INI memory_limit** refer to: [*How-to Guides > How to set or increase PHP INI memory_limit or other values?*](/docs/articles/websites/how-to-set-or-increase-PHP-INI-memory-limit-or-other-values/).
* To **set PHP settings per website** refer to: [*How-to Guides > PHP settings per website (folder)*](/docs/articles/websites/php-user-ini-files/).
* To **edit default .INI files** refer to: **OpenAdmin > Settings > PHP Settings > Default PHP.INI Files** or edit files in `/etc/openpanel/php/ini` folder.

## PHP Options

The **`php_options`** module allows users to manage options (limits) for their PHP versions.

When enabled:
* Users can access the [**PHP > Options** page](/docs/panel/php/options/).

When disabled:
* Users can not access the *PHP Options* page.

Customize options:
* To **customize PHP options available to users** refer to: **OpenAdmin > Settings > PHP Settings > Available Options** or edit */etc/openpanel/php/options.txt* file.



## Applications

The **`pm2`** module allows users to setup and manage containerized Python and NodeJS applications.

When enabled:
* Users can access the [**Websites > WP Manager** page](/docs/panel/applications/wordpress/).
* Users can [manage Python and NodeJS applications using Site Manager](/docs/panel/applications/pm2/#manage-applications).
* NodeJS and Python are available on the Autoinstaller page.
* Users can [setup NodeJS and Python applications using Auto Installer](/docs/panel/applications/pm2/#create-an-application).

When disabled:
* NodeJS and Python are not available on the Autoinstaller page.
* NodeJS and Python applications can not be managed via Openpanel.

Customize options:
* To **customize docker service template for new Python applications** edit `/etc/openpanel/docker/compose/python.yml` file.
* To **customize docker service template for new Node.JS applications** edit `/etc/openpanel/docker/compose/nodejs.yml` file.
* To **customize headers for Nginx proxy of new python/node application** edit `/etc/openpanel/nginx/vhosts/1.1/nginx_proxy_headers.txt` file.
* To **add a custom Google PageSpeed Insights API Key** refer to: [*How-to Guides > Google PageSpeed Insights API Key*](/docs/articles/websites/google-pagespeed-insights-api-key/)




## Resources Usage

The **`usage`** module allows users to view resource usage for their services.

When enabled:
* Users can access the [**Advanced > Resource Usage** page](/docs/panel/advanced/resource_usage/).
* Users can [manage Python and NodeJS applications using Site Manager](/docs/panel/applications/pm2/#manage-applications).
* NodeJS and Python are available on the Autoinstaller page.
* Users can [setup NodeJS and Python applications using Auto Installer](/docs/panel/applications/pm2/#create-an-application).

When disabled:
* Users can not access the *Advanced > Resource Usage* page.

Customize options:
* To **edit page settings** refer to: [**OpenAdmin > Settings > OpenPanel > Statistics** page](/docs/admin/settings/openpanel/#statistics).
* To **change how often the stats are collected (default = @hourly)** edit the schedule for `docker-collect_stats --all` cron.
* To **display one combined or separate charts for cpu/ram** edit [`resource_usage_charts_mode` value](https://dev.openpanel.com/cli/config.html#resource-usage-charts-mode).
* To **change the number of items per page** edit [`resource_usage_items_per_page` value](https://dev.openpanel.com/cli/config.html#resource-usage-items-per-page).
* To **rotate the** edit [`resource_usage_retention` value](https://dev.openpanel.com/cli/config.html#resource-usage-retention).


## API

The **`api`** module allows users to access the OpenPanel API using JWT tokens.

When enabled:
* Users can access the [*Account > API Reference* page](/docs/panel/account/api/).
* Users can use the [OpenPanel API](/docs/panel/api/).

When disabled:
* Users can not use the OpenPanel API.

---

// File: admin/settings/updates

# Update Preferences


The Update Preferences page in OpenPanel allows you to manage and control how updates are applied. It is organized into three sections: Current Version, Auto Updates, and Update Logs.

## Current Version
This section displays information about the version of OpenPanel currently installed on your system, as well as the latest available version.

- **Installed Version:** Shows the version of OpenPanel currently running.

- **Latest Version:** Shows the most recent version available for update.

If the installed version matches the latest version, OpenPanel is fully up to date. If not, you can initiate a manual update via a button to upgrade to the latest version.

## Auto Updates
The Auto Updates section lets you configure how OpenPanel should handle updates automatically.
You can select the update policy that best fits your needs:

- **Minor Versions Only:** Automatically apply updates that include only bug fixes and security patches. Major feature updates must be installed manually.

- **Both Minor and Major Versions:** Automatically apply all updates, including new features, bug fixes, and security enhancements.

- **Major Versions Only:** Automatically apply updates that introduce major new features. Bug fixes and security patches will require manual updates.

- **Never:** Disable automatic updates. You will need to manually check for and install all updates.

Choosing the appropriate auto-update setting ensures that OpenPanel remains as stable, secure, and feature-rich as you need it to be.

## Update Logs
The Update Logs section provides a record of all updates that have been applied to OpenPanel.

## Control Updates
For more information about updates, check:
- [How to Enable Automatic Updates for OpenPanel](/docs/articles/install-update/how-to-enable-auto-update-openpanel/)
- [How to Disable Automatic Updates for OpenPanel](/docs/articles/install-update/how-to-disable-auto-update-openpanel/)
- [How to Manually Update OpenPanel](/docs/articles/install-update/how-to-enable-auto-update-openpanel/)
- [How to Skip a Specific OpenPanel Version Update](/docs/articles/install-update/skip-specific-openpanel-version-update)
- [How to Check OpenPanel Version from Terminal](/docs/articles/install-update/how-to-check-openpanel-version)

---

// File: admin/settings/locales

# Locales (Languages)

Manage the languages available to OpenPanel users.

![openadmin admin panel locales](/img/admin/locales.png)

## Install Locale

By default, only the **EN** locale is installed. To enable other locales, they must be installed first.

<Tabs>
  <TabItem value="openadmin-install-locale" label="With OpenAdmin" default>

To install a locale, go to **OpenAdmin > Settings > Locales** and click the **Install** button next to the desired locale.

  </TabItem>
  <TabItem value="CLI-install-locale" label="With OpenCLI">

To install a locale from the terminal, use its locale prefix from [Github](https://github.com/stefanpejcic/openpanel-translations/tree/main) and run:

```bash
opencli locale <LOCALE_HERE>
```

Example: Install Turkish locale:

```bash
opencli locale tr-tr
```

Example: Install multiple locales:

```bash
opencli locale sr-sr tr-tr zh-cn
```

Example: Install all available locales:

```bash
opencli locale $(curl -s "https://api.github.com/repos/stefanpejcic/openpanel-translations/contents" | jq -r '.[] | select(.type=="dir") | .name' | tr '\n' ' ')
```

  </TabItem>
</Tabs>


## Default Locale


<Tabs>
  <TabItem value="openadmin-default-locale" label="With OpenAdmin" default>

To make a specific locale the default, go to **OpenAdmin > Settings > Locales** and click the **Set Default** button next to the desired locale.

  </TabItem>
  <TabItem value="CLI-default-locale" label="From Terminal">

To set a default locale from the terminal:

```bash
echo <LOCALE_HERE> > /etc/openpanel/openpanel/default_locale
```

Example: Set Turkish as the default:

```bash
echo tr > /etc/openpanel/openpanel/default_locale
```

  </TabItem>
</Tabs>

:::info
Changing the default will **not** automatically update existing users’ settings; their browser preferences and account configurations will take precedence.
For more details, see [How-to Guides > Setting the Default Locale](/docs/articles/accounts/default-user-locales/#setting-the-default-locale).
:::

## Edit Locale

To edit a locale, click the GitHub icon next to it in the table. This opens the source on GitHub, where you can fork the repository and edit the translation file.

## Create a Locale

To create a new locale:

1. Fork [the translations repository](https://github.com/stefanpejcic/openpanel-translations/).
2. Copy the `en_us` folder to a new locale folder, e.g., `es_es`.
3. Translate the `messages.pot` file.
4. Submit a pull request.

---

// File: admin/settings/custom_code

# Custom Code

The Custom Code section, accessible via OpenAdmin > Settings > Custom Code, allows you to inject and manage custom code that extends or modifies the behavior and appearance of the OpenPanel UI.

## Custom CSS
Inject your own CSS styles that will be applied across all pages of the OpenPanel UI. 

Stored in `/etc/openpanel/openpanel/custom_code/custom.css` file.

## Custom JS
Add custom JavaScript to all pages. This is ideal for extending UI functionality, adding widgets, or integrating third-party tools.

Stored in `/etc/openpanel/openpanel/custom_code/custom.js` file.

## Code in Header
Insert custom code directly into the head tag of every page. Useful for meta tags, analytics scripts, and global settings.

Stored in `/etc/openpanel/openpanel/custom_code/in_header.html` file.

## Code in Footer
Insert custom code directly into the footer section of all pages. This is commonly used for tracking scripts, analytics, or deferred JavaScript.

Stored in `/etc/openpanel/openpanel/custom_code/in_footer.html` file.

## How-to Articles
Edit Knowledge Base articles displayed in *OpenPanel > Dashboard* page.

Default:
```json
{
    "how_to_topics": [
        {"title": "How to install WordPress", "link": "https://openpanel.com/docs/panel/applications/wordpress#install-wordpress"},
        {"title": "How to enable REDIS Caching", "link": "https://openpanel.com/docs/panel/caching/Redis/#connect-to-redis"},
        {"title": "How to create DNS records", "link": "https://openpanel.com/docs/panel/domains/dns/#create-record"},
        {"title": "How to create a new MySQL database", "link": "https://openpanel.com/docs/panel/databases/#create-a-mysql-database"},
        {"title": "How to add a Cron Job", "link": "https://openpanel.com/docs/panel/advanced/cronjobs#add-a-cronjob"},
        {"title": "How to add a custom SSL Certificate", "link": "https://openpanel.com/docs/panel/domains/ssl/#custom-ssl"}
    ],
    "knowledge_base_link": "https://openpanel.com/docs/panel/intro/?source=openpanel_server"
}
```

## Custom Section

You can add a **custom section** with icon-based items to the *Dashboard* in **OpenPanel**.

custom section supports the following fields:

* **`section_title`** *(string)*:
  The title displayed at the top of your custom section.

* **`section_position`** *(string)*:
  Determines where your section appears relative to other built-in sections.
  Acceptable values:

  * `before_files`
  * `before_domains`
  * `before_mysql`
  * `before_postgresql`
  * `before_applications`
  * `before_emails`
  * `before_cache`
  * `before_php`
  * `before_docker`
  * `before_advanced`
  * `before_account`

* **`items`** *(array of objects)*:
  A list of clickable items shown as cards with icons. Each item has:

  * **`label`** *(string)* – The text shown on the card.
  * **`icon`** *(string)* – The icon class from [Bootstrap Icons](https://icons.getbootstrap.com/). Example: `bi bi-person-fill-gear`.
  * **`url`** *(string)* – The link to navigate to when the item is clicked.

Example:
```json
{
  "section_title": "Billing Account",
  "section_position": "before_domains",
  "items": [
    {
      "label": "Manage Profile",
      "icon": "bi bi-person-fill-gear",
      "url": "https://panel.hostio.rs/clientarea.php?action=details"
    },
    {
      "label": "Manage Billing Information",
      "icon": "bi bi-credit-card",
      "url": "https://panel.unlimited.rs/clientarea.php?action=details"
    },
    {
      "label": "View Email History",
      "icon": "bi bi-envelope-open",
      "url": "https://panel.unlimited.rs/clientarea.php?action=emails"
    },
    {
      "label": "News & Announcements",
      "icon": "bi bi-megaphone-fill",
      "url": "https://panel.unlimited.rs/index.php?rp=/announcements"
    },
    {
      "label": "Knowledgebase",
      "icon": "bi bi-book-half",
      "url": "https://panel.unlimited.rs/index.php?rp=/knowledgebase"
    },
    {
      "label": "Server Status",
      "icon": "bi bi-hdd-network",
      "url": "https://panel.unlimited.rs/serverstatus.php"
    },
    {
      "label": "Invoices",
      "icon": "bi bi-receipt",
      "url": "https://panel.unlimited.rs/clientarea.php?action=invoices"
    },
    {
      "label": "Support Tickets",
      "icon": "bi bi-life-preserver",
      "url": "https://panel.unlimited.rs/supporttickets.php"
    },
    {
      "label": "Open Ticket",
      "icon": "bi bi-journal-plus",
      "url": "https://panel.unlimited.rs/submitticket.php"
    },
    {
      "label": "Register New Domain",
      "icon": "bi bi-globe",
      "url": "https://panel.unlimited.rs/cart.php?a=add&domain=register"
    },
    {
      "label": "Transfer Domain",
      "icon": "bi bi-arrow-repeat",
      "url": "https://panel.unlimited.rs/cart.php?a=add&domain=transfer"
    }
  ]
}

```

## PageSpeed API Key

If set, this API key will be used to fetch data from Google PageSpeed Insights.
---

## WordPress Plugins Set

List the WordPress plugins you want to automatically install on all new WordPress sites.
Enter one item per row. Supported formats:

* **wp\_org\_slug** — the plugin slug from the WordPress.org plugin page
* **URL** — a direct link to a `.zip` plugin file hosted online

## WordPress Themes Set

List the WordPress themes to automatically install for all new WordPress sites.
Enter one item per row. Supported formats:

* **wp\_org\_slug** — the theme slug from the WordPress.org themes page
* **URL** — a direct link to a `.zip` theme file hosted online

## Forbidden Usernames

List of usernames that can not be used.

## Restricted Domains

Administrators can restrict the usage of specific domains by adding one domain per line.

Example:

```bash
facebook.com
openpanel.com
pejcic.rs
openpanel.org
demo.openpanel.org
```

Stored in `/etc/openpanel/openpanel/conf/domain_restriction.txt` file.

## After Update
Define custom bash commands that will automatically run after each OpenPanel update. Ideal for restoring customizations or triggering automation scripts.

![openadmin custom code](/img/admin/custom_code.png)

This powerful customization layer helps ensure OpenPanel fits seamlessly into your environment.

Examples:

- [Custom email templates](https://community.openpanel.org/d/214-customizing-openpanel-email-templates)
- [Custom OpenAdmin color scheme](https://community.openpanel.org/d/216-customizing-openadmin-color-scheme)


Stored in `/root/openpanel_run_after_update` file.

## Before Startup

Add custom bash code to be executed before starting OpenPanel.

Stored in `/root/openpanel_run_on_startup` file.

---

// File: admin/settings/php

# PHP Settings

Manage the default PHP version and configuration files for new user accounts.

### Available Options

These options determine which PHP settings users can modify from their **OpenPanel > PHP Options** page.

The default editable options include:

```
allow_url_fopen
date.timezone
disable_functions
display_errors
error_reporting
file_uploads
log_errors
max_execution_time
max_input_time
max_input_vars
memory_limit
open_basedir
output_buffering
post_max_size
short_open_tag
upload_max_filesize
zlib.output_compression
```

### Default PHP.INI Files

Here you can edit the PHP.INI configuration files that will be applied to new user accounts.

Select a PHP version to open its php.ini file for editing. After making changes, click **Save** to apply them.

To revert to the original PHP.INI settings, click **Restore Default**, then click **Save**.

---

// File: admin/settings/notifications

# Notifications

Configure OpenAdmin notifications and Email alerts settings.

<Tabs>
  <TabItem value="openadmin-notifications-view" label="With OpenAdmin" default>

  To view or edit current notification settings, go to **OpenAdmin > Settings > Notifications** or click the 'Edit Settings' button on the Notification page.
  
  ![openadmin notifications settings](/img/admin/openadmin_notifications_settings.png)

  </TabItem>
  <TabItem value="CLI-notifications-view" label="With OpenCLI">

To view notification settings, run:

```bash
opencli admin notifications get <OPTION>
```

Example:

```bash
# opencli admin notifications get reboot
yes
```

To update notification settings, run:

```bash
opencli admin notifications update <OPTION> <NEW-VALUE>
```

Example:

```bash
opencli admin notifications update load 10
Updated load to 10
```

  </TabItem>
</Tabs>

---

## Email

Configure email address to be used for receiving system notifications and alerts.

Enter your email address in the **Email for notifications** field. Leave it empty to disable email alerts.

If email address is set, daily usage report will be sent to the address, schedule is configurable from 'Advanced > System Cron Jobs'.

![report example](/img/admin/daily_report.png)


---

## Webhook

Send notifications to a webhook URL (discord or any other).

---

## Services

Receive notifications when services are down or unresponsive. Services are checked every 5 minutes.

- **OpenPanel:** Notification if OpenPanel UI fails.
- **OpenAdmin:** Notification if OpenAdmin UI fails.
- **Caddy:** Notification if webserver is not responding.
- **MySQL:** Notification if database is unreachable.
- **Docker:** Notification if Docker service is down.
- **BIND9:** Notification if DNS service is down or unresponsive.
- **Sentinel Firewall:** Notification if Sentinel (CSF) is disabled.

---

## Resource Usage

Get alerts when resource usage exceeds thresholds (checked every 5 minutes):

* Load Average
* CPU %
* RAM %
* Disk Usage %
* SWAP %

---

## Server actions

Receive notifications when specific server-level actions are detected:

* Server rebooted
* Website under attack
* User reaches plan limit
* OpenAdmin accessed from a new IP address
* New OpenPanel update available

---

## User Actions

Get notified whenever an action occurs in the admin or user panels.

- OpenAdmin enabled/disabled
- API access enabled/disabled
- Admin account created
- Reseller account created
- Admin password changed
- Admin/Reseller renamed
- Admin/Reseller suspended
- Admin/Reseller unsuspended
- WAF enabled/disabled for a domain
- WAF enabled/disabled on the server
- User added
- User deleted
- User suspended/unsuspended
- User email changed
- User IP changed
- User password changed
- User renamed
- FTP account created
- FTP account deleted
- FTP account password change
- Domain added
- Domain deleted
- Domain suspended/unsuspended
- SSL type changed
- HSTS enabled/disabled

---

## SSH Allowlist

Specify IP addresses (or CIDRs) that will be exempt from SSH login checks.

---

## SMTP Settings

By default, email alerts are sent from `noreply@openpanel.com`.

To use your own SMTP server for email delivery, configure the following:

<Tabs>
  <TabItem value="openadmin-notifications-smtp" label="With OpenAdmin" default>
    Set server port, TLS or SSL, Username and Password to use for authentication.
  </TabItem>
  <TabItem value="CLI-notifications-smtp" label="With OpenCLI">

Configure each value via `opencli config update` commands, for example:

```bash
opencli config update mail_server example.net
```

```bash
opencli config update mail_port 465
```

```bash
opencli config update mail_use_tls False
```

```bash
opencli config update mail_use_ssl True
```

```bash
opencli config update mail_username user@example.net
```

```bash
opencli config update mail_password strongpassword123
```

```bash
opencli config update mail_default_sender user@example.net
```

  </TabItem>
</Tabs>

---

// File: articles/000_intro

# Start Here
- [Test OpenPanel Demo](/docs/articles/support/how-to-access-openpanel-demo/)
- [How to access OpenAdmin](/docs/articles/dev-experience/how-to-access-openadmin/)
- [How to access Openpanel](/docs/articles/dev-experience/how-to-access-openpanel/)
- [How to Reset a OpenPanel Account Password](/docs/articles/accounts/how-to-reset-openpanel-account-password)

# Billing Integrations
- [FOSSBilling](/docs/articles/extensions/openpanel-and-fossbilling/)
- [WHMCS](/docs/articles/extensions/openpanel-and-whmcs/)
- [Blesta](/docs/articles/extensions/openpanel-and-blesta/)

# Transfers
- [Import account from cPanel backup](/docs/articles/transfers/import-cpanel-backup-to-openpanel/)
- [Transfer OpenPanel accounts to another server](/docs/articles/transfers/transfer-openpanel-account-to-another-server/)
- [Migrate all data to another server](/docs/articles/transfers/migrate-openadmin-to-new-server/)

# Websites
- [Hosting a Static Website with OpenPanel](/docs/articles/websites/hosting-a-static-website-with-openpanel/)
- [How to Install WordPress® With OpenPanel](/docs/articles/websites/how-to-install-wordpress-with-openpanel/)
- [Hosting a PHP Website with OpenPanel](/docs/articles/websites/hosting-a-php-website-with-openpanel/)
- [How to Migrate a WordPress® Installation to OpenPanel](/docs/articles/websites/how-to-upload-wordpress-website-to-openpanel)
- [How to install a PHP extension in OpenPanel](/docs/articles/websites/how-to-install-php-extensions-in-openpanel)
- [Connecting to MySQL Server from Applications in OpenPanel](/docs/articles/databases/how-to-connect-to-mysql-from-php-applications-in-openpanel/)
- [How to set or increase PHP INI memory_limit or other values?](/docs/articles/websites/how-to-set-or-increase-PHP-INI-memory-limit-or-other-values/)
- [403 Error Troubleshooting Guide](/docs/articles/domains/error-on-website-disable-coraza-waf/)
- [404 Error Troubleshooting Guide](/docs/articles/domains/not-found-404-error-troubleshooting)
- [502 Error Troubleshooting Guide](/docs/articles/domains/bad-gateway-502-error-troubleshooting)
- [504 Error Troubleshooting Guide](/docs/articles/domains/gateway-timeout-504-error-troubleshooting)
- [WordPress Themes and Plugins Sets](/docs/articles/websites/wordpress-plugins-themes-sets-in-openpanel)
- [Configure Apache, Nginx, OpenLitespeed per user](/docs/articles/docker/how-to-set-nginx-apache-varnish-per-user-in-openpanel/)
- [Purging Varnish Cache for a Website](/docs/articles/websites/purge-varnish-cache-from-terminal/)
- [WordPress HTTPS behind Varnish Cache](/docs/articles/docker/https-wordpress-behind-varnish-proxy/)

# Databases
- [Configure MySQL, MariaDB or Percona per user](/docs/articles/docker/how-to-set-mysql-mariadb-per-user-in-openpanel/)
- [Set Custom Domain for phpMyAdmin](/docs/articles/databases/phpmyadmin-domain/)
- [Import MySQL Database](/docs/articles/docker/import-database)
- [Use `mysql` or `mariadb` as DB_HOST instead of *localhost*](/docs/articles/databases/how-to-connect-to-mysql-from-php-applications-in-openpanel/)
- [Troubleshooting: Error establishing a database connection](/docs/articles/databases/how-to-troubleshoot-error-establishing-a-database-connection/)

# Configuration
- [Branding and White-Label](/docs/articles/dev-experience/customizing-openpanel-user-interface/)
- [Add a Custom Message for OpenPanel User](/docs/articles/accounts/how-to-add-custom-message-in-openpanel/)
- [Add Custom section with icons in Dashboard](/docs/articles/dev-experience/add-custom-icons-in-openpanel-dashboard/)
- [Troubleshooting OpenPanel UI Errors](/docs/articles/support/how-to-troubleshoot-openpanel-error)
- [Troubleshooting OpenAdmin UI Errors](/docs/articles/support/how-to-troubleshoot-openadmin-error)

# Enterprise
- [Pricing](/docs/articles/license/pricing/)
- [Upgrading license](/docs/articles/license/upgrade_to_openpanel_enterprise_and-activate_license/)
- [Downgrading license](/docs/articles/license/how_to_downgrade_openpanel_license/)
- [How license expiration affects OpenPanel](/docs/articles/license/what_happens_when_openpanel_enterprise_license_expires/)
- [How to cancel a license](/docs/articles/license/hot_to_cancel_openpanel_license/)
- [Refund Policy](/docs/articles/license/openpanel-refund-policy/)
- [Licenses for educational or non-profit organizations](/docs/articles/license/openpanel_enterprise_for_nonprofits/)

# Domains
- [Domain Shows Default Page](/docs/articles/domains/domain-shows-default-page/)
- [How to configure Nameservers](/docs/articles/domains/how-to-configure-nameservers-in-openpanel)
- [How to configure a DNS Cluster](/docs/articles/domains/how-to-setup-dns-cluster-in-openpanel)
- [How to Enable HSTS on a Domain in OpenPanel](/docs/articles/domains/how-to-enable-hsts-on-a-domain-in-openpanel)
- [Troubleshooting DNS](/docs/articles/domains/troubleshooting-dns)
- [Troubleshooting Caddy Webserver](/docs/articles/docker/troubleshooting-caddy-webserver)


# Files
- [How to configure FTP server](/docs/articles/user-experience/how-to-setup-ftp-in-openpanel/)
- [How to configure TLS for the FTP server](/docs/articles/user-experience/how-to-setup-tls-ftp-in-openpanel/)

# Security
- [Configuring ImunifyAV](/docs/articles/security/setup-imunifyav/)
- [Rate-limiting access to OpenPanel or OpenAdmin](/docs/articles/dev-experience/rate_limiting_for_openpanel/)
- [Restrict access to OpenAdmin](/docs/articles/dev-experience/limit_access_to_openadmin/)
- [Disable the Terminal feature in OpenPanel](/docs/articles/dev-experience/disable-openpanel-web-terminal/)
- [Disable the Terminal feature in OpenAdmin](/docs/articles/dev-experience/disable-openadmin-web-terminal/)
- [Disable the Server Reboot feature in OpenAdmin](/docs/articles/dev-experience/disable-openadmin-server-reboot/)
- [Limiting Connections with CSF](/docs/articles/security/how-to-limit-connections-csf)
- [CSF Blocklists](/docs/articles/security/csf-blocklists/)

# Emails
- [How to setup email on iPhone](/docs/articles/email/how-to-setup-email-on-iphone)
- [How to setup email on Android](/docs/articles/email/how-to-setup-email-on-android)
- [How to setup email on Apple Mail app](/docs/articles/email/how-to-setup-email-on-apple-mail-app)
- [How to setup email on Thunderbird](/docs/articles/email/how-to-setup-email-on-thunderbird)
- [How to setup email on Outlook 365 desktop app](/docs/articles/email/how-to-setup-email-on-outlook-365-desktop-app)
- [How to setup email on Gmail using desktop / browser](/docs/articles/email/how-to-setup-email-in-gmail)
- [IMAP vs POP3 - which to use?](/docs/articles/email/imap-vs-pop)
- [How to configure Email server](/docs/articles/user-experience/how-to-setup-email-in-openpanel/)
- [How to enable and access RSPAMD GUI](/docs/articles/email/rspamd-gui-port-11334/)
- [Setup DKIM for Mailserver](/docs/articles/email/how-to-setup-dkim-for-mailserver/)
- [Setup Fail2ban for Mailserver](/docs/articles/email/how-to-setup-fail2ban-mailserver-openpanel/)
- [Offload Email Storage to a Remote NFS Server](/docs/articles/email/how-to-use-remote-server-for-emails-in-openpanel/)
- [Troubleshooting Email Errors](/docs/articles/email/troubleshooting-email-errors/)

# Updates
- [Check Installed Version](/docs/articles/install-update/how-to-check-openpanel-version/)
- [Enable Automatic Updates](/docs/articles/install-update/how-to-enable-auto-update-openpanel/)
- [Disable Automatic Updates](/docs/articles/install-update/how-to-disable-auto-update-openpanel/)
- [Update Manually](/docs/articles/install-update/how-to-manually-update-openpanel/)
- [Skip a specific version](/docs/articles/install-update/skip-specific-openpanel-version-update/)

# Advanced
- [Set Default User Locale](/docs/articles/accounts/default-user-locales/)
- [Configure unlimited CPU and Memory for user](/docs/articles/docker/how-to-remove-resource-limits-for-user-service-containers/)
- [Auto-start Services](/docs/articles/dev-experience/autostart-services/)
- [Restricted Usernames for services](/docs/articles/accounts/forbidden-usernames/)
- [Create a custom plugin](/docs/articles/dev-experience/custom-plugins/)
- [Network Isolation in OpenPanel](/docs/articles/docker/network-isolation-openpanel/)
- [Volume Management in OpenPanel](/docs/articles/docker/volume-management-openpanel/)
- [Keyboard Shortcuts for OpenAdmin UI](/docs/articles/dev-experience/openadmin-keyboard-shortcuts/)
- [Uninstall OpenPanel](/docs/articles/support/how-to-unlinstall-openpanel/)

---

// File: articles/accounts/default-user-locales

# Default Locale

**OpenPanel** is fully localization-ready, but currently ships only with English (`en`) as the default language.
Additional languages can be installed by the System Administrator from ***OpenAdmin → Settings → Locales***, and they will become immediately available in the user interface.

If your preferred locale isn’t available yet, you can help by contributing a translation: 👉 [OpenPanel Translations on GitHub](https://github.com/stefanpejcic/openPanel-translations)

---

## Setting the Default Locale

In OpenPanel, there are **five** different sources that determine which locale is applied to a user.
They are checked in the following priority order:

| Priority | Source                        | Example Path / Data                                   |
| -------- | ----------------------------- | ----------------------------------------------------- |
| 1️⃣      | Session (`session['locale']`) | `'fr'`                                                |
| 2️⃣      | User-specific file            | `/home/<context>/locale`                              |
| 3️⃣      | Browser best match            | `Accept-Language: es-ES,es;q=0.9`                     |
| 4️⃣      | Default locale file           | `/etc/openpanel/openpanel/default_locale` → e.g. `de` |
| 5️⃣      | Hardcoded final fallback      | `'en'`                                                |

---

### 1. Session Locale

When a user visits OpenPanel, the system first checks the session for a stored locale.
A session locale is created when the user logs in.
For example, if the user selects `'de'` (German) on the login page, that locale is set for the current session.

> **Note:** This setting overrides all other locale sources.

---

### 2. User-Specific File

After logging in, users can change their preferred language — if the `locale` module and feature are enabled for them.
Navigate to: ***OpenPanel → Account → Change Language*** ([Docs link](/docs/panel/account/language/)) - this view lists all languages installed by the Administrator.
The user’s chosen locale overrides their browser settings and the system default.

The user’s preference is stored in a per-user file:

```
/home/<context>/locale
```

---

### 3. Browser Best Match

If the user hasn’t set a locale yet, OpenPanel checks the browser’s [`Accept-Language` header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Accept-Language).
If the preferred language is installed on the server, it will be temporarily applied for that session.

> **NOTE**: This only affects the **current session** and does not persist as a user preference.
> It overrides the Administrator’s default locale for that session only.

Example header:

```
Accept-Language: es-ES,es;q=0.9
```

---

### 4. Default Locale

The Administrator can set a global default locale by creating a configuration file at:

```
/etc/openpanel/openpanel/default_locale
```

For example, to set Spanish (`es`) as the default:

```bash
echo 'es' > /etc/openpanel/openpanel/default_locale
```

---

### 5. Fallback Locale

If no other locale setting is found, OpenPanel defaults to English (`en`), which is included by default.

---

## Checking Which Locale Is Active

To verify which locale is being used for a user, you can temporarily enable developer mode and check the logs.

1. Enable `dev_mode`:

   ```bash
   opencli config update dev_mode on
   ```

2. Repeat the user action in the browser.

3. Tail the logs:

   ```bash
   docker logs -f openpanel
   ```

Look for log lines similar to:

```
APP - Using locale..
```

---

// File: articles/accounts/forbidden-usernames

# Reserved Usernames

## Basic restrictions


### OpenPanel

OpenPanel applies the following rules when you create or modify a OpenPanel username:

Usernames may **only** use lowercase letters (`a–z`) and digits (`0–9`).
- Usernames cannot contain less than **3** characters.
- Usernames cannot contain more than **20** characters.

### OpenAdmin
OpenAdmin applies the following rules when you create or modify an admin username:

Usernames may **only** use lowercase letters (`a–z`) and digits (`0–9`).
- Usernames cannot contain less than **5** characters.
- Usernames cannot contain more than **30** characters.

Passwords may **only** use lowercase letters (`a–z`) and digits (`0–9`).
- Passwords cannot contain less than **6** characters.
- Passwords cannot contain more than **30** characters.

:::info
If admin or reseller accounts are created via OpenAdmin, passwords can contain all characters except space.
:::

### SSH
OpenAdmin applies the following rules when you modify an SSH password:

Passwords may **only** use lowercase letters (`a–z`) and digits (`0–9`).
- Passwords cannot contain less than **8** characters.
- Passwords cannot contain more than **20** characters.

### MySQL / MariaDB
OpenPanel applies the following rules when you create databases and users:

Database names may **only** use lowercase letters (`a–z`) and digits (`0–9`).
- Database name cannot contain less than **1** character.
- Database name cannot contain more than **64** characters.


Database users may **only** use lowercase letters (`a–z`) and digits (`0–9`).
- Usernames cannot contain less than **1** characters.
- Usernames cannot contain more than **32** characters.


Database User's Passwords may contain **any** characters.
- Passwords cannot contain less than **8** characters.
- Passwords cannot contain more than **32** characters.


### FTP
OpenPanel applies the following rules when you create FTP sub-accounts:

FTP sub-users **must end** with dot (`.`) followed by the OpenPanel username - example: `ftpuser.openpaneluser`.
- Usernames cannot contain less than **3** characters.
- Usernames cannot contain more than **32** characters.


FTP User's Passwords must contain **at least one** uppercase letters (`A-Z`), lowercase letters (`a–z`), digits (`0–9`) and special symbols (`!`, `.`, `,`, `@`, `#`, `_`, `-`).
- Passwords cannot contain less than **8** characters.
- Passwords cannot contain more than **32** characters.

### Emails

OpenPanel applies the following rules when you create email accounts:

Email accounts may **only** use lowercase letters (`a–z`), dashes (`-`), underscores (`_`) and digits (`0–9`).
Email accounts **must contain** `@` symbol followed by the domain name - example: `account@example.net`.
- Usernames cannot contain less than **1** character.
- Usernames cannot contain more than **32** characters.

Email accounts passwords can contain **only** uppercase letters (`A-Z`), lowercase letters (`a–z`), underscores (`_`) and digits (`0–9`).
- Passwords cannot contain less than **8** characters.
- Passwords cannot contain more than **32** characters.


##  Reserved usernames

OpenPanel reserves some usernames for the system’s use, and you cannot use them for OpenPanel accounts. This list of reserved usernames can grow over time, and new versions of OpenPanel may add to this list.

OpenPanel checks the following file to determine whether to reserve or restrict a username:

```bash
/etc/openpanel/openadmin/config/forbidden_usernames.txt
```

Currently reserved usernames:



- 1000
- admin
- apache
- apache2
- backup
- busybox
- cron
- docker
- elasticsearch
- exec
- filebrowser
- ftp
- httpd
- litespeed
- openlitespeed
- lsws
- mariadb
- memcached
- minecraft
- mssql
- mysql
- mysqld
- nginx
- openadmin
- openpanel
- openresty
- opensearch
- pgadmin
- php
- php-fpm-5.6
- php-fpm-7.0
- php-fpm-7.1
- php-fpm-7.2
- php-fpm-7.3
- php-fpm-7.4
- php-fpm-8.0
- php-fpm-8.1
- php-fpm-8.2
- php-fpm-8.3
- php-fpm-8.4
- php-fpm-8.5
- phpmyadmin
- podman
- postgres
- reboot
- redis
- restart
- root
- shutdown
- test
- user_service
- varnish
- vsftpd
- www-data

To reserve a certain username, simply add it to the forbidden_usernames.txt file.

---

// File: articles/accounts/how-to-add-custom-message-in-openpanel

# How to display a custom message

OpenPanel supports both **per-user** and **global** custom messages that can be displayed in your users’ OpenPanel interfaces.

![example message](/img/docs-content/QN0XSW0t-2025-08-14-14-49.png)

## Custom Message for a Specific User

To display a custom message in **OpenPanel > Dashboard** for a specific user:

1. Navigate to **OpenAdmin > Users > *username* > Overview**.

   ![add message](/img/docs-content/KZBxwWJC-2025-08-14-14-50.png)

2. Enter the message — either plain text or HTML — in the **'Custom message for user'** area.

3. Click **Save**.

The message will appear immediately in the user’s Dashboard.

### Adding a Message via Terminal

You can also add a custom message by creating a file:

```bash
/etc/openpanel/openpanel/core/users/USERNAME/custom_message.html
```

Replace `USERNAME` with the actual user’s username.

---

## Global Message for All Users

To display a message for **all users**, copy or create a symbolic link of the custom message file in each user’s directory: `/etc/openpanel/openpanel/core/users/USERNAME/custom_message.html`.

---

// File: articles/accounts/how-to-delete-accounts

# Delete Multiple Accounts

The `opencli user-delete` command lets you delete OpenPanel user accounts in bulk. **Use caution**-it's easy to accidentally delete the wrong users.

### Delete a Single User

```bash
opencli user-delete USERNAME
```

You’ll be prompted for confirmation. To skip confirmation, use the `-y` flag:

```bash
opencli user-delete USERNAME -y
```

### Delete All Users

To delete **all** users on the server:

```bash
opencli user-delete -all
```

By default, you'll be prompted to confirm each deletion. To skip all confirmations, use the `-y` flag:

```bash
opencli user-delete -all -y
```

---

// File: articles/accounts/how-to-reset-openpanel-account-password

# How to Reset a OpenPanel Account Password

If you forget your Openpanel account password, follow these steps:

1. Click the **Forgot password?** link on the login page.  

   ![password reset link](/img/docs-content/rpCvZ1VP-2025-08-14-13-47.png)


   > **NOTE:** If the **Forgot Password?** link does not appear on the login form, email-based password reset is disabled by your hosting provider. In this case, you must either:
   >
   > 1. Auto-login to OpenPanel through their billing panel and reset your password via [Account > Settings](/docs/panel/account/#changing-password), or
   > 2. Contact your hosting provider to reset the password for you.

2. Enter your **email address** and click **Send Reset Link**.  

   ![password reset form](/img/docs-content/rV9kfkzw-2025-08-14-13-48.png)

3. If your email is associated with an account, you will receive a password reset email (link valid for 15 minutes).  

   ![password reset sent](/img/docs-content/DvhhQZvN-2025-08-14-13-49.png)

4. Open the email and click the reset link.  

   ![password reset email](/img/docs-content/KZBFgL2L-2025-08-14-13-50.png)

5. Enter your **new password**, confirm it, and click **Change Password**.  

   ![set new password form](/img/docs-content/9XFjSnqt-2025-08-14-13-50-1.png)

You can now log in using your newly set password.

---

// File: articles/accounts/set-dedicated-ip-address-for-user

# Assigning a Dedicated IP Address to a User

A dedicated IP address can then be assigned to a user through **OpenAdmin** or **OpenCLI**.

Changing IP updates all related configuration files — including DNS zones and Caddy VirtualHosts — ensuring that the user’s all current and newly added domains are bound to the new IP address.
The updated IP address will also be reflected immediately in the user’s OpenPanel interface.

## Using OpenAdmin

The OpenAdmin interface lists all IP addresses currently assigned to the server — these can also be viewed using the `hostname -I` command.
If you need to add additional IP addresses to the server, **follow the official network configuration documentation for your operating system distribution**.
No special configuration is required from the OpenPanel side — newly added IPs will appear automatically in the interface.

To change IP address for a user from OpenAdmin:

1. Navigate to **OpenAdmin → Users → *username* → Edit**.

2. Update the **IP Address** field with the desired dedicated IP.

   ![image](/img/docs-content/65f9Jcsf-slika.png)

3. Click **Save** to apply the changes.

## Using OpenCLI

To change a user’s IP address from the command line, use the [`opencli user-ip`](https://dev.openpanel.com/cli/users.html#Assign-Remove-IP-to-User) command:

```bash
opencli user-ip <USERNAME> <NEW_IP_ADDRESS>
```

If the specified IP address is already assigned to another user, the command will abort with a warning.
To override this behavior and force the reassignment, include the `-y` flag:

```bash
opencli user-ip <USERNAME> <NEW_IP_ADDRESS> -y
```

To remove a dedicated IP from a user and restore them to the [main (shared) IP](/docs/articles/install-update/openpanel-main-ip-address), use:

```bash
opencli user-ip <USERNAME> delete
```

---

// File: articles/accounts/troubleshooting-openpanel-login-errors

# Login Errors

The following error messages may appear on the OpenPanel login page. Here's what each one means and how to resolve it:


### `Username and password are required.`

This error indicates that one or both of the login fields were left empty. 

**Solution:** Please enter both your username and password.

---

### `Unable to connect to database.`

This suggests that the MySQL service is not running, or the `users` table may be corrupted.

**Solution:** Check the database service status in **OpenAdmin > Services** and ensure MySQL is running correctly.

---

### `Your account is suspended. Please contact support.`

Your OpenPanel user account has been suspended, and login is currently disabled.

**Solution:** Contact your hosting provider to reactivate your account.

---

### `Unrecognized account. Please check username.`

The username you entered does not exist on the server.

**Solution:** Verify that you're using the correct login link and username. If the issue persists, contact your hosting provider’s support team.

---

### `Invalid password. Please try again.`

The password entered is incorrect.

**Solution:** If you’ve forgotten your password or continue to have issues, contact your hosting provider to request a password reset.

---

### `Invalid 2FA code. Please try again.`

The Two-Factor Authentication (2FA) code provided is not valid.

**Solution:** Generate a new 2FA code using your authentication app and try again.

---

### `Too many failed login attempts. Please try again later.`

Too many incorrect login attempts have been made from your IP address.

**Solution:** Contact your server administrator to review the log file at `/var/log/openpanel/user/failed_login.log`. They can unblock your IP or adjust the failed login attempt limits.

---

// File: articles/backups/configuring-backups

# Configuring OpenPanel Backups

OpenPanel has a unique feature where end-users can configure their remote backups. This provides users with more freedom and control over the schedule, what to backup and finally more privacy as Admin does not have access to their destination.

Backups can be configured either by the system administrator (admin-configured) or by end users (user-configured). Each mode has distinct setup and restore procedures.

---

## Configuration Options

| Feature                    | Admin-Configured Backups       | User-Configured Backups               |
| -------------------------- | ------------------------------ | ------------------------------------- |
| Backup configuration       | Admin edits `backups.env`      | Users configure via Backups page      |
| Backup module status       | Must be disabled for users     | Must be enabled for users             |
| Who sets backup schedule   | Admin                          | User                                  |
| Backup destination control | Admin                          | User                                  |
| Restore performed by       | Admin                          | User                                  |
| Admin access to backups    | Full                           | None                                  |


### 1. Admin-Configured

In this mode, the **admin has full control** over backup scheduling, retention, and destination settings. End users are **not allowed** to modify any backup configurations.

---

#### 1: Disable Backups Module

To prevent users from changing backup settings, disable the **Backups** module from the admin interface.

**Path:**
`OpenAdmin > Settings > Modules`
**Action:** Deactivate the **Backups** module.

---

#### 2: Edit Template

Modify the backup configuration template that applies to new accounts. This file defines default backup settings, such as remote storage destinations.

**File path:**
`/etc/openpanel/backups/backups.env`

To enable and configure a remote SSH destination, uncomment and update the following variables:

```env
########### SSH/SFTP STORAGE
# SSH_HOST_NAME=""
# SSH_PORT="22"
# SSH_REMOTE_PATH=""
# SSH_USER=""
# SSH_PASSWORD=""
# SSH_IDENTITY_FILE="/var/www/html/id_rsa"
# SSH_IDENTITY_PASSPHRASE=""
```

**Example:**

```env
########### SSH/SFTP STORAGE
SSH_HOST_NAME="185.119.22.54"
SSH_PORT="22"
SSH_REMOTE_PATH="/backups/"
SSH_USER="root"
SSH_PASSWORD="NotSoStrongP@ssword"
# SSH_IDENTITY_FILE="/var/www/html/id_rsa"
# SSH_IDENTITY_PASSPHRASE=""
```

> 🔗 For more destination types and examples, see [Backups Documentation](/docs/panel/files/backups/#destinations)

---

#### 3: Edit Schedule

To set the backup frequency, go to:

**Path:**
`OpenAdmin > Advanced > System Cron Jobs`

Locate the cron job for the command:

```bash
opencli docker-backup
```

Adjust the schedule as needed. This command will trigger backups according to your defined schedule for **all active users** on the server.

---

### 2. User-Configured

In this mode, the **Backups module is enabled** to allow users to configure their own backups based on their needs.

**Setup:**

* The admin must **enable the Backups module** in OpenPanel.
* Backups feature must be enabled on all relevant feature sets tied to hosting plans to allow user access.
* End users can set:

  * Backup destination (e.g., remote storage, custom paths)
  * Backup schedule (when backups run)
  * What data to back up (files, databases, or both)
  * Resource limits (e.g., bandwidth or CPU used during backup)

> 🔗 For end-user configuration, see [Backups Documentation](/docs/panel/files/backups/)

**Notes:**

* Users are responsible for managing their backups.
* Users can manually trigger backup process at any time if *Docker* feature is enabled.
* Admins do **not** have access to users' backup destinations or configurations.

---

## Restore Procedures

### Restore in Admin-Configured Backup Mode

* The admin performs restores manually, either via terminal commands or through the OpenPanel UI terminal.
* Common restore steps include:

  * For databases: dropping the relevant tables and importing the database dump from backup files.
  * For files: using FileManager or command line to delete corrupted files and re-upload backup copies.

---

### Restore in User-Configured Backup Mode

* End users are responsible for restoring their own backups, as backups are stored in user-defined destinations inaccessible to admins.
* Users follow similar restore steps as in the admin mode but must perform actions themselves using provided tools or instructions.
* Admins cannot restore or access backups on behalf of users in this mode.

---

---

// File: articles/databases/error-establishing-a-database-connection

# Error Establishing a Database Connection

If you see the error **“Error establishing a database connection”** in the OpenAdmin interface, it indicates that the database connection has failed.

![admin error mysql](/img/docs-content/tJMCcCx1-mysql-error-on-admin.png)

---

## MySQL Service

OpenPanel and OpenAdmin use a MySQL Docker service defined in `/root/docker-compose.yml`.

First, ensure that the service is running:

**From OpenAdmin:**

1. Go to **Services > Services Status**.
2. Check the status of the MySQL service.
3. Restart it from this page if necessary.

**From the terminal:**

```bash
docker ps -a
```

Look for the `openpanel_mysql` service in the output.

---

## MySQL Fails to Start

If the MySQL service fails to start, Docker will keep restarting it. You can observe this from the `docker ps -a` output.

Example:
```bash
root@openpanel:~# docker ps -a
CONTAINER ID   IMAGE                COMMAND                  CREATED          STATUS                          PORTS     NAMES
6d9885164cba   mysql/mysql-server   "/entrypoint.sh mysql…"   30 minutes ago   Restarting (1) 22 seconds ago             openpanel_mysql
```


* If the uptime is only a few seconds and the status shows **not running** or **unhealthy**, check the service logs:

```bash
docker logs -f openpanel_mysql
```

Example:
```bash
root@openpanel:~# docker logs -f openpanel_mysql
[Entrypoint] MySQL Docker Image 8.0.32-1.2.11-server
[Entrypoint] Starting MySQL 8.0.32-1.2.11-server
2025-10-17T15:36:55.291441Z 0 [Warning] [MY-011068] [Server] The syntax '--skip-host-cache' is deprecated and will be removed in a future release. Please use SET GLOBAL host_cache_size=0 instead.
2025-10-17T15:36:55.293565Z 0 [System] [MY-010116] [Server] /usr/sbin/mysqld (mysqld 8.0.32) starting as process 1
2025-10-17T15:36:55.304336Z 1 [System] [MY-013576] [InnoDB] InnoDB initialization has started.
2025-10-17T15:36:55.546466Z 1 [System] [MY-013577] [InnoDB] InnoDB initialization has ended.
2025-10-17T15:36:55.852133Z 0 [Warning] [MY-010068] [Server] CA certificate ca.pem is self signed.
2025-10-17T15:36:55.852166Z 0 [System] [MY-013602] [Server] Channel mysql_main configured to support TLS. Encrypted connections are now supported for this channel.
2025-10-17T15:36:55.852534Z 0 [ERROR] [MY-010259] [Server] Another process with pid 60 is using unix socket file.
2025-10-17T15:36:55.852547Z 0 [ERROR] [MY-010268] [Server] Unable to setup unix socket lock file.
2025-10-17T15:36:55.852555Z 0 [ERROR] [MY-010119] [Server] Aborting
2025-10-17T15:36:57.431776Z 0 [System] [MY-010910] [Server] /usr/sbin/mysqld: Shutdown complete (mysqld 8.0.32)  MySQL Community Server - GPL.
```

In this example, error is: *Another process with pid 60 is using unix socket file.*

[Googling the error](https://stackoverflow.com/questions/36103721/docker-db-container-running-another-process-with-pid-id-is-using-unix-socket) we get the solution: `cd /root && docker compose down --volumes` **NOTE: this will remove all existing mysql data including users, plans, domains.. only run it on a fresh installation, ie. if this mysql error occurs after installing openpanel**.

* Copy any error messages and search online. Common issues include:

  * Problem with the latest mysql docker image tag
  * MySQL not running properly on ARM CPUs

---

## MySQL command not working

You can test the connection directly from the terminal using the `mysql` command.

Example error:

```bash
root@openpanel:~# mysql
ERROR 2026 (HY000): TLS/SSL error: SSL is required, but the server does not support it
```

To resolve this error *TLS/SSL error: SSL is required, but the server does not support it* run: `echo "skip-ssl = true" >> /etc/my.cnf` [SOURCE](https://stackoverflow.com/questions/78677369/mariadb-11-also-mysql-cli-error-2026-hy000-tls-ssl-error-ssl-is-required)

---


Example error:
```bash
root@openpanel:~# mysql
ERROR 2003 (HY000): Can't connect to MySQL server on '127.0.0.1:3306' (111)
```

If this is a fresh installation and there are no users or plans yet, MySQL may fail to initialize during setup. To fix this:

```
cd /root
docker compose down
docker volume rm root_mysql # DANGER: this will delete all users and plans, only run it on a fresh install!
docker compose up -d openpanel_mysql openpanel
```

Otherwise, check if credentials stored in `/etc/my.cnf` are correct:

```bash
root@demo:~# cat /etc/my.cnf 
[client]
user = panel
database = panel
password = e391ac94321d110c
host = 127.0.0.1
protocol = tcp
```

---

## Firewall

Outgoing connections on **port 3306** must be allowed. Ensure this port is open in the Sentinel Firewall (CSF).

Check `/etc/csf/csf.conf` for the `TCP_OUT=` setting and confirm that port `3306` is included. If not, add it and restart CSF:

```bash
csf -r
```

---

If none of these steps resolve the issue, contact us via the forums or open a support ticket, and we will help troubleshoot the problem.

---

// File: articles/databases/how-to-connect-to-mysql-from-php-applications-in-openpanel

# Connecting to MySQL Server from Applications in OpenPanel

OpenPanel runs each user service inside its own container and uses local networks to isolate them. This means that applications do not connect to the database via `localhost` or `127.0.0.1`, but instead through container hostnames.

For more information about networks: [Network Isolation in OpenPanel](/docs/articles/docker/network-isolation-openpanel/)

To connect from your **PHP**, **Node.js**, or **Python** application to a MySQL/MariaDB database, you must use:

* **Hostname:** `mysql` (for MySQL) or `mariadb` (for MariaDB)
* **Port:** `3306` (default)
* **Username/Password:** created for the database from OpenPanel UI

⚠️ **Important:** Never use `localhost` or `127.0.0.1` as the database host. These will not work because containers are isolated.

---

## Example: WordPress

When setting up WordPress inside OpenPanel, use the following database configuration:

```ini
DB_HOST=mysql
```

Here, `DB_HOST` is set to `mysql`, so WordPress can reach the MySQL container. If you are using MariaDB, then replace `mysql` with `mariadb`.

---

## Example: Custom PHP Application

In a custom PHP app, you can connect like this:

```php
<?php
$host = "mysql";       // or "mariadb"
$db   = "my_database";
$user = "my_user";
$pass = "my_password";

$dsn = "mysql:host=$host;dbname=$db;charset=utf8mb4";

try {
    $pdo = new PDO($dsn, $user, $pass);
    echo "Connected successfully!";
} catch (PDOException $e) {
    echo "Connection failed: " . $e->getMessage();
}
```

---

## Example: Node.js Application

For Node.js using `mysql2` or `sequelize`:

```js
const mysql = require('mysql2');

const connection = mysql.createConnection({
  host: 'mysql',       // or "mariadb"
  user: 'my_user',
  password: 'my_password',
  database: 'my_database'
});

connection.connect(err => {
  if (err) {
    console.error('Connection error:', err);
    return;
  }
  console.log('Connected successfully!');
});
```

---

## Example: Python Application

Using `mysql-connector-python`:

```python
import mysql.connector

conn = mysql.connector.connect(
    host="mysql",        # or "mariadb"
    user="my_user",
    password="my_password",
    database="my_database"
)

cursor = conn.cursor()
cursor.execute("SELECT DATABASE();")
print("Connected to:", cursor.fetchone())
```

---

✅ **Summary:**

* Use `mysql` or `mariadb` as the hostname.
* Never use `localhost` or `127.0.0.1`.
* Works across PHP, WordPress, Node.js, Python, and any other app in [the `db` network](/docs/articles/docker/network-isolation-openpanel/).

---

// File: articles/databases/how-to-troubleshoot-error-establishing-a-database-connection

# How to troubleshoot: Error establishing a database connection

If your website/application is alerting you that there was an error establishing database connection you should take the following steps in order to troubleshoot the issue:

![dberror.png](/img/docs-content/Kzdwy4HN-example.png)

## Check the configuration file for errors

OpenPanel runs each user service inside its own container and uses local networks to isolate them. This means that applications do not connect to the database via `localhost` or `127.0.0.1`, but instead through container hostnames.

You can check the database connection parameters such as hostname and port on OpenPanel > MySQL/Databases by hovering the container name at the top of the page:

![hostnameport.png](/img/docs-content/d1L3xNbm-hostnameport.png)

Now compare these parameters with those inside the websites configuration file, in this example we are editing the wp-config.php file of a WordPress installation using File Manager:

![configbad.png](/img/docs-content/W3QCPtHW-configbad.png)

Since localhost was set inside the file the connection is failing, to fix the issue we replace localhost with the correct hostname (mariadb in our case) and click save at the top right corner of the editor:

![configfixed.png](/img/docs-content/d1zpKDx5-configfixed.png)

After saving this change the new configuration is applied and our WordPress instalation connects to the database successfully:

![examplefixed.png](/img/docs-content/Znv9Csjm-examplefixed.png)

## Make sure the database service (container) is running

The easiest way to make sure the database service is running is by accessing the Openpanel > MySQL/Databases page, if your databases are listed on that page that means the container is healthy and running.

If you get a blank page or an empty table instead it means that the database container is inactive, simply accessing this page will send a trigger to start the container automatically.

However if data doesn't appear on the page in a couple of minutes there's an issue with the database container.

If the Docker feature is enabled for your plan you can check the database container's logs on OpenPanel > Docker/Logs , you can also stop and start the container on OpenPanel > Docker/Containers .

![containers.png](/img/docs-content/imgur-GGvHfXb.png)

If the Docker feature is not enabled for your plan and data doesn't appear on the Openpanel > MySQL/Databases page contact your server administrator so that they can check further.

## Make sure that the website's database user is properly assigned to the database

You can reassign a user to a database at any time on OpenPanel > MySQL/Assign User to DB:

![assign user to database](/img/docs-content/prsWZfTz-assignuser.png)

Simply select your user and database from the dropdown menus and click the "Assign User to Database" button.

## Try Resetting the password of your database user

You can change your database user's password on OpenPanel > MySQL/Users:

![password1.png](/img/docs-content/1tQPpC9F-password1.png)

Click on the "Change Password" button next to your database user, you will be taken to the password reset page.

On this page make sure to copy the new password before clicking the "Change Password" button to confirm the change.

![password2.png](/img/docs-content/PqGkj3vM-password2.png)

Edit your website's configuration file using File Manager and switch the existing password with the new one that you've just set, click save at the top right corner of the editor when you're done.

![passconfig.png](/img/docs-content/J7Q7QLDg-passconfig.png)

## Test the connection manually

In order to connect to your database from a remote location you'll first need to open the following page: OpenPanel > MySQL/Remote MySQL .

![remotemysql.png](/img/docs-content/43vjTJg9-remotemysql.png)

To enable remote database access click on the "Click to Enable" button and wait for confirmation that the remote access feature has been enabled.

Next open your database client, in our example we'll be using DBeaver for Windows.

Create a new remote connection within your client, copy the server and port parameters from the "Remote" section of the Remote MySQL page on OpenPanel and paste them inside your client.

![dbclient.png](/img/docs-content/Ssw3pjvZ-dbclient.png)

Fill the database, user and password with your db parameters and attempt the connection via the client for this test.

---

// File: articles/databases/phpmyadmin-domain

# Domain for phpMyAdmin

UPDATE: panel domain set for OpenPanel interface is now used for phpMyAdmin as well. 

- `https://`DOMAIN:`2053` is used for phpmyadmin access when panel domain is set and has an SSL
- `http://`IP:`8888` is used for phpmyadmin access when IP is set for panel access

---

// File: articles/dev-experience/add-custom-icons-in-openpanel-dashboard

# Custom Section

To add custom section in *OpenPanel > Dashboard* page, navigate to **OpenAdmin > Settings > Custom Code** and edit the 'Custom Section'.

Example code:

```json
{
  "section_title": "my.openpanel.com",
  "section_position": "before_domains",
  "items": [
    {
      "label": "Manage Profile",
      "icon": "bi bi-person-fill-gear",
      "url": "https://panel.hostio.rs/clientarea.php?action=details"
    },
    {
      "label": "Manage Billing Information",
      "icon": "bi bi-credit-card",
      "url": "https://panel.hostio.rs/clientarea.php?action=details"
    },
    {
      "label": "View Email History",
      "icon": "bi bi-envelope-open",
      "url": "https://panel.hostio.rs/clientarea.php?action=emails"
    },
    {
      "label": "News & Announcements",
      "icon": "bi bi-megaphone-fill",
      "url": "https://panel.hostio.rs/index.php?rp=/announcements"
    },
    {
      "label": "Knowledgebase",
      "icon": "bi bi-book-half",
      "url": "https://panel.hostio.rs/index.php?rp=/knowledgebase"
    },
    {
      "label": "Server Status",
      "icon": "bi bi-hdd-network",
      "url": "https://panel.hostio.rs/serverstatus.php"
    },
    {
      "label": "Invoices",
      "icon": "bi bi-receipt",
      "url": "https://panel.hostio.rs/clientarea.php?action=invoices"
    },
    {
      "label": "Support Tickets",
      "icon": "bi bi-life-preserver",
      "url": "https://panel.hostio.rs/supporttickets.php"
    },
    {
      "label": "Open Ticket",
      "icon": "bi bi-journal-plus",
      "url": "https://panel.hostio.rs/submitticket.php"
    },
    {
      "label": "Register New Domain",
      "icon": "bi bi-globe",
      "url": "https://panel.hostio.rs/cart.php?a=add&domain=register"
    },
    {
      "label": "Transfer Domain",
      "icon": "bi bi-arrow-repeat",
      "url": "https://panel.hostio.rs/cart.php?a=add&domain=transfer"
    }
  ]
}
```

---

// File: articles/dev-experience/add-custom-services-to-openadmin

# Custom Services

Custom services can be added to OpenAdmin to be run and monitored from the admin panel.

In this example, We will add [netdata](https://learn.netdata.cloud/docs/netdata-agent/installation/docker) docker image.

## Add service

```
cd /root
nano docker-compose.yml
```

and add the netdata section:

```
  netdata:
    image: netdata/netdata
    container_name: netdata
    pid: host
    network_mode: host
    restart: unless-stopped
    cap_add:
      - SYS_PTRACE
      - SYS_ADMIN
    security_opt:
      - apparmor:unconfined
    environment:
      - DO_NOT_TRACK=1
      - NETDATA_CLOUD_ENABLE=no
    volumes:
      - ./netdata/config:/etc/netdata
      - ./netdata/lib:/var/lib/netdata
      - ./netdata/cache:/var/cache/netdata
      - /:/host/root:ro,rslave
      - /etc/passwd:/host/etc/passwd:ro
      - /etc/group:/host/etc/group:ro
      - /etc/localtime:/etc/localtime:ro
      - /proc:/host/proc:ro
      - /sys:/host/sys:ro
      - /etc/os-release:/host/etc/os-release:ro
      - /var/log:/host/var/log:ro
      - /var/run/docker.sock:/var/run/docker.sock:ro
      - /run/dbus:/run/dbus:ro
```

save and exit the file. then start the service:

```
docker --context=default compose up -d netdata
```

now, I suggest just whitelisting your IP on the firewall instead of opening the port to the internet.

Then open the IP:19999 in your browser:

![screenshot](/img/docs-content/CFRC5zG9-netdata.png)


## Monitor service

Next step is to make the netdata service available from **OpenAdmin > Services** page so we can view its status, start/stop or restart it.

For this, we need to add the netdata service in `/etc/openpanel/openadmin/config/services.json` file:

```
    {
        "name": "Netdata",
        "type": "docker",
        "on_dashboard": false,
        "real_name": "netdata"
    },
```
`real_name` is the service/container name, and `name` is the human-readable name displayed in OpenAdmin services.

Save the file and refresh the page in OpenAdmin - service is immediately visible and we can start/stop it from the panel.

![services](/img/docs-content/qpTMgY8r-2025-04-30-16-33.png)

We can also receive notifications when the service is not running. For this edit the file: `/etc/openpanel/openadmin/config/notifications.ini` and add service name (`netdata`) under services:

```
services=panel,admin,caddy,mysql,docker,csf,netdata
```

save the file and exit. Sentinel service will now also check if the netdata container is running and if not, send alerts to **OpenAdmin > Notifications** and if emails are enabled then to email as well.

---

// File: articles/dev-experience/autostart-services

# Auto-start Services

Services in OpenPanel start only when they are actually needed, to avoid wasting resources.

## Auto-start Services in OpenAdmin

Upon installing OpenPanel, only the following services are started:

- **OpenAdmin** – For managing the entire server and users.
- **Docker** – Needed for all other containerized services and user accounts.
- **Database** – MySQL database is created and initialized. This database holds Plans, Websites, Domains, and Users.
- **Firewall** – [Sentinel Firewall](https://sentinelfirewall.org/) is installed and started.

Other services are installed and started only when required.

| Service                | Installed | Auto-start                |
|------------------------|-----------|---------------------------|
| OpenAdmin              | ✔       | On installation            |
| Docker                 | ✔       | On installation            |
| Database               | ✔       | On installation            |
| Sentinel Firewall   | ✔       | On installation            |
| OpenPanel              | ✘        | After adding first user account |
| BIND9                  | ✘        | After adding first domain name  |
| Caddy                  | ✘        | After adding first domain name  |
| ImunifyAV       | ✘        | When enabled by Administrator  |
| Dovecot & Postfix       | ✘        | When enabled by Administrator  |
| FTP                    | ✘        | When enabled by Administrator, after first FTP account is created |
| phpMyAdmin                    | ✘        | When enabled by Administrator, after first MySQL database is created by a user |

## Auto-start Services in OpenPanel

Similar to OpenAdmin, services in OpenPanel also start only when they are needed. This allows for better resource management.

Services that auto-start for each user:

| Service            | Installed | Auto-start                                         |
|--------------------|-----------|---------------------------------------------------|
| Apache / Nginx / OpenLitespeed     | ✔       | After the user adds the first domain               |       |
| REDIS              | ✘        | After the user activates it           |
| Memcached          | ✘        | After the user activates it           |
| Elasticsearch      | ✘        | After the user activates it           |
| MySQL / MariaDB    | ✔       | After the user adds at least 1 database            |
| Cron               | ✔       | After the user adds at least 1 cron job            |
| PHP versions            | ✘        | After the user sets it for at least 1 domain |

---

// File: articles/dev-experience/create-custom-openpanel-template

# Custom OpenPanel Templates

Templates offer a flexible way to customize the appearance of your control panel interface. Whether you're looking to align the panel's look with your brand identity or simply want to refresh its appearance, our template system provides the tools necessary to achieve your desired aesthetics.

## Using Templates

OpenPanel templates are designed to be easily interchangeable, allowing users to swiftly change the look and feel of their control panel without affecting the underlying functionality. This ensures that you can update the appearance of your control panel as often as you like, without any downtime or disruption to your operations.

To change theme for OpenPanel, run command:

```opencli config update template PATH_HERE```

instead of *PATH_HERE* set either just the folder name or a full path, example:

```opencli config update template "/home/custom_template/"```


and restart service to apply: `docker restart openpanel`.

---

To change theme for OpenAdmin, run command:

```opencli config update admin_template PATH_HERE```

instead of *PATH_HERE* set either just the folder name or a full path, example:

```opencli config update admin_template "/home/custom_admin_template/"```

and restart service to apply: `service admin restart`.

---

## Creating Custom Templates

For those who require a more personalized touch, OpenPanel allows the creation of custom templates. This option is perfect for users who want to integrate their brand colors, logos, and other design elements into their control panel.

To create new templates copy the default templates folders:

For OpenPanel:
`docker cp openpanel:/templates/ /home/custom_template/`

For OpenAdmin:
`cp /user/local/admin/templates/ /home/custom_admin_template/`

and then make the changes in html/css files.

---

// File: articles/dev-experience/custom-plugins

# Custom Plugins

OpenPanel version 1.5.0 and newer support custom plugins.

## Requirements

Currently, plugins have a few requirements and limitations:

* A readme.txt file must be present for the plugin to be loaded by OpenPanel.
* The Python (.py) file name must match the plugin's folder name.
* Installing additional pip modules is not supported.

## Example: Traceroute

[Traceroute](https://github.com/stefanpejcic/traceroute) is a sample OpenPanel plugin that serves as a starter template for integrating third-party products and services into OpenPanel as plugins.

[![2025-07-21-14-34.png](/img/docs-content/X7cTZdzx-2025-07-21-14-34.png)](/img/docs-content/X7cTZdzx-2025-07-21-14-34.png)

### readme.txt

| **Key**           | **Example Value**                                    | **Explanation**                                                  |
|------------------|--------------------------------------------------------|------------------------------------------------------------------|
| `name`           | `traceroute`                                           | Folder and plugin name.                                          |
| `title`          | `Traceroute`                                           | Display title shown on Dashboard, sidebar and search.            |
| `description`    | `Run traceroute to IP or hostname.`                    | Short description of what the plugin does.                       |
| `link`           | `/advanced/traceroute`                                 | URL route to access the plugin from UI.                          |
| `version`        | `1.0.0`                                                | Version number of the plugin.                                    |
| `author`         | `Stefan Pejcic`                                        | Author or developer of the plugin.                               |
| `category`       | `advanced`                                             | Section in Dashboard and sidebar menu under which to display.    |
| `icon`           | `bi bi-person`                                         | Bootstrap Icon class name to use for Dashboard icons.            |
| `show_in_search` | `1`                                                    | Whether the plugin should appear in search results (1=yes, 0=no).|
| `help_link`      | `https://github.com/stefanpejcic/traceroute/`          | Link to help or documentation for the plugin.                    |
****

### Python

```py
# traceroute.py

'''
.py file needs to have the same name as the folder, so f folder is 'traceroute' file needs to be named 'traceroute.py' in order to be imported.
'''

# import flask app
from flask import Flask, render_template, render_template_string, request

# import what is needed for this plugin
import socket
import struct
import time
import os
import requests

# For translations
# https://python-babel.github.io/flask-babel/
from flask_babel import Babel, _

# Import stuff from OpenPanel core
from app import app, inject_data, get_openpanel_ip, login_required_route

# custom function example
def get_client_ip():
    if request.headers.getlist("X-Forwarded-For"):
        client_ip = request.headers.getlist("X-Forwarded-For")[0].split(',')[0].strip()
    else:
        client_ip = request.remote_addr

    return client_ip



# you can not run pip install for additional tools, and since mtr is not available in OpenPanel UI container, we need to use vanilla python to simulate traceroute output
def simple_traceroute(dest_name, max_hops=30, timeout=1):
    try:
        dest_addr = socket.gethostbyname(dest_name)
    except socket.gaierror:
        return f"Error: Invalid hostname or IP address '{dest_name}'"

    port = 33434
    result = []

    for ttl in range(1, max_hops + 1):
        try:
            recv_socket = socket.socket(socket.AF_INET, socket.SOCK_RAW, socket.IPPROTO_ICMP)
            recv_socket.settimeout(timeout)
            recv_socket.bind(("", port))

            send_socket = socket.socket(socket.AF_INET, socket.SOCK_DGRAM, socket.IPPROTO_UDP)
            send_socket.setsockopt(socket.SOL_IP, socket.IP_TTL, ttl)

            start_time = time.time()
            send_socket.sendto(b"", (dest_addr, port))

            try:
                data, curr_addr = recv_socket.recvfrom(512)
                end_time = time.time()
                curr_addr = curr_addr[0]

                try:
                    curr_name = socket.gethostbyaddr(curr_addr)[0]
                except socket.error:
                    curr_name = curr_addr

                elapsed = (end_time - start_time) * 1000  # ms
                line = f"{ttl}\t{curr_addr}\t{elapsed:.2f} ms"
            except socket.timeout:
                line = f"{ttl}\t*\tTimeout"

            send_socket.close()
            recv_socket.close()

            result.append(line)

            if curr_addr == dest_addr:
                break
        except PermissionError:
            return "Error: Root privileges required to run traceroute."
        except Exception as e:
            return f"Error: {str(e)}"

    return "\n".join(result)



# Route should be same as 'link' in readme.txt
@app.route('/advanced/traceroute', methods=['GET', 'POST'])
# remove login_required_route decorator if page should be accessed without login (NOT RECOMMENDED)
@login_required_route
def traceroute():
    result = ""
    if request.method == 'POST':
        target = request.form.get('target')
        if target:
            try:
                result = simple_traceroute(target)
            except Exception as e:
                result = f"Error: {str(e)}"
        else:
            # use _( ) to allow localization of the text
            result = _("Please enter a valid IP address or hostname.")

    # this is needed for templates to overwrite global templates folder
    #exit the html file name accordingly
    template_path = os.path.join(os.path.dirname(__file__), 'traceroute.html')
    with open(template_path) as f:
        template = f.read()

    # return ip address for openpanel account
    current_username = inject_data().get('current_username') # returns username of the current openpanel account
    server_ip = get_openpanel_ip(current_username) # returns IP for the current openpanel account
    client_ip = get_client_ip() # returns ip form our custom function

    return render_template_string(
        template,
        title=_('Traceroute'), # title is shown in breadcrumbs and browser tab
        server_ip=server_ip,
        client_ip=client_ip,
        result=result
    )
```


### template

Flask templates documentation: https://flask.palletsprojects.com/en/stable/tutorial/templates/

```html
<!-- traceroute.html -->

<!-- 
HTML comments are visible only when dev_mode is enabled
https://dev.openpanel.com/cli/config.html#dev-mode
-->


<!-- remove this extends line if you do NOT want the page to have OpenPanel UI header, sidebar, footer.. -->
{% extends 'base.html' %}

{% block content %}

<!-- START page header -->
<div class="border-b flex flex-col border-gray-200 bg-gray-50 dark:border-gray-800 dark:bg-gray-950 p-4 sm:p-6 lg:p-8 sm:flex-row sm:items-center sm:justify-between">
        <div>
        <div class="flex items-center gap-x-3"><h1 class="text-lg font-semibold text-gray-900 dark:text-gray-50">{{_('Traceroute')}}</h1></div>
        
        <p class="text-sm text-gray-500 dark:text-gray-500">{{_('Trace network traffic from the server to diagnose network congestion.
')}}</p>
    </div>
    <div class="mt-2 gap-2 sm:mt-0 sm:flex">
    </div>
</div>
<!-- END page header -->

<!-- START page content -->

<div id="collapseAddNewUser">

    <div class="sm:mx-auto sm:max-w-2xl" style="display:block;">
        <form method="POST" class="mt-8" x-data="{ loading: false }" @submit="loading = true">
            <!-- all forms need to send 'csrf_token' 
            https://flask-wtf.readthedocs.io/en/0.15.x/csrf/#html-forms
            -->
            <input type="hidden" name="csrf_token" value="{{ csrf_token() }}">
        
            <div class="grid grid-cols-1 gap-4">
        
                <div class="col-span-full sm:col-span-3">
                    {{ _('Your remote IP, to perform a reverse, traceroute is %(client_ip)s. The server IP address is %(server_ip)s.', client_ip=client_ip, server_ip=server_ip) }}
                </div>
        
                <div class="col-span-full sm:col-span-3">
                    <label class="text-sm leading-none text-gray-900 dark:text-gray-50 font-medium" for="target">{{_('IP address or hostname')}}:</label>
                    <div class="relative w-full mt-2">
                        <input
                            type="text" name="target" placeholder="{{_('IP address or hostname')}}" required
                            class="relative block w-full appearance-none rounded-md border px-2.5 py-2 shadow-sm outline-none transition sm:text-sm border-gray-300 dark:border-gray-800 text-gray-900 dark:text-gray-50 placeholder-gray-400 dark:placeholder-gray-500 bg-white dark:bg-gray-950" autofocus />
                        
                        <button
                            class="my-3 relative inline-flex items-center justify-center whitespace-nowrap rounded-md border px-3 py-2 text-center text-sm font-medium shadow-sm transition-all duration-100 ease-in-out disabled:pointer-events-none disabled:shadow-none outline outline-offset-2 outline-0 focus-visible:outline-2 outline-blue-500 dark:outline-blue-500 border-transparent text-white dark:text-white bg-blue-500 dark:bg-blue-500 hover:bg-blue-600 dark:hover:bg-blue-600 disabled:bg-blue-300 disabled:text-white disabled:dark:bg-blue-800 disabled:dark:text-blue-400"
                            type="submit"
                            :disabled="loading"
                        >
                            <template x-if="!loading">
                                <span>{{_('Trace')}}</span>
                            </template>
                            <template x-if="loading">
                                <span>{{_('Loading...')}}</span>
                            </template>
                        </button>
                    </div>
                </div>
            </div>
                
            {% if result %}
                <pre>{{ result }}</pre>
            {% endif %}
        </form>

    </div>
</div>

<!-- END page content -->

{% endblock %}
```


---

## Installing

Plugins must be placed inside the `/etc/openpanel/modules/` directory. Each plugin should reside in its own folder. For example, the `traceroute` plugin should be installed in `/etc/openpanel/modules/traceroute/`.

Inside the plugin folder, include the following files:

* `readme.txt`
* `traceroute.py`
* `traceroute.html`


It is recommended to install plugins via Git for easy updating. To install the `traceroute` plugin, run:

```bash
cd /etc/openpanel/modules/ && git clone https://github.com/stefanpejcic/traceroute
```

After installation, use the OpenAdmin UI to add the plugin’s features to the desired Feature Sets.

[![2025-07-21-14-59.png](/img/docs-content/g2r5JQFq-2025-07-21-14-59.png)](/img/docs-content/g2r5JQFq-2025-07-21-14-59.png)

And finally, restart the OpenPanel UI to load the new plugin.

---

// File: articles/dev-experience/customizing-openpanel-user-interface

# Branding & White-Label

Everything in OpenPanel is modular and can easily be modified or disabled without breaking the rest of the functionalities.

To customize OpenPanel, you have the following options:

- [Display personalized message per user](#personalized-messages)
- [Enable/disable features and pages from the OpenPanel interface](#enabledisable-features)
- [Add custom icons in Dashboard page](/docs/articles/dev-experience/add-custom-icons-in-openpanel-dashboard)
- [Customize Default, Suspended User and Suspended Domain pages](@customize-templates)
- [Localize the interface](#localize-the-interface)
- [Set custom branding](#set-custom-branding)
- [Set a custom color scheme](#set-a-custom-color-scheme)
- [Replace How-to articles with your knowledge base](#replace-how-to-articles-with-your-knowledge-base)
- [Customize any page](#edit-any-page-template)
- [Customize login page](#customize-login-page)
- [Add custom CSS or JS code to the interface](#create-custom-pages)
- [Create a custom module for OpenPanel](#create-custom-module)
- [Self-hosted temporary links for SiteManager](/docs/articles/dev-experience/selfhosted-temporary-links-api/)
- [Self-hosted screenshots for SiteManager](/docs/articles/dev-experience/selfhosted-screenshots-api/)



## Personalized messages

Administrators can set a custom message to be displayed for any OpenPanel uer from their **OpenAdmin > Users** page.

![custom img](/img/docs-content/9CCgHGG2-2025-06-11-12-26.png)

## Enable/disable features

Administrators have the ability to enable or disable each feature (page) in the OpenPanel interface per plan or per-user base. 

Once enabled, the feature becomes instantly available to all users, appearing in the OpenPanel interface sidebar, search results, and dashboard icons.

## Set pre-installed services

OpenPanel uses docker compose files as the base for each user. Based on the docker images in that compose files, different services can be set per plan/user. 


## Localize the interface

OpenPanel is localization ready and can easily be translated into any language.

OpenPanel is shipped with the EN locale, [additional locales can be installed by the Administrator](https://dev.openpanel.com/localization.html#How-to-translate).


## Set custom branding

Custom brand name and logo can be set from [OpenAdmin > Settings > OpenPanel](/docs/admin/settings/openpanel/#branding) page.

To set a custom name visible in the OpenPanel sidebar and on login pages, enter the desired name in the "Brand name" option. Alternatively, to display a logo instead, provide the URL in the "Logo image" field and save the changes.


## Customize Templates

You can customize all templates that are displayed to users:

- [Domain VHost Template](/docs/admin/services/nginx/#domain-vhost-template)
- [Default Landing Page](/docs/admin/services/nginx/#default-landing-page)
- [Suspended User Template](/docs/admin/services/nginx/#suspended-user-template)
- [Suspended Domain Template](/docs/admin/services/nginx/#suspended-domain-template)
- [Error Pages](/docs/admin/services/nginx/#error-pages)

## Create OpenPanel Module

To create a custom module (plugin) for OpenPanel follow this guide: [Example Module](https://dev.openpanel.com/modules/#Example-Module)

## Set a custom color scheme

To set a custom color-scheme for OpenPanel interface, edit the `/etc/openpanel/openpanel/custom_code/custom.css` file and in it set your preferred color scheme.

```bash
nano /etc/openpanel/openpanel/custom_code/custom.css
```

Set the custom css code, save and restart openpanel to apply changes:

```bash
cd /root && docker compose up -d openpanel
```

Example:

![custom_css_code](/img/docs-content/YprhHZhg-2024-06-18-15-04.png)





## Replace How-to articles with your knowledge base

[OpenPanel Dashboard page](/docs/panel/dashboard) displays [How-to articles](/docs/panel/dashboard/#how-to-guides) from the OpenPanel Docs, however these can be changed to display your knowledgebase articles instead. 

Edit the file `/etc/openpanel/openpanel/conf/knowledge_base_articles.json` and in it set your links:

```json
{
    "how_to_topics": [
        {"title": "How to install WordPress", "link": "https://openpanel.com/docs/panel/applications/wordpress#install-wordpress"},
        {"title": "Publishing a Python Application", "link": "https://openpanel.com/docs/panel/applications/pm2#python-applications"},
        {"title": "How to edit Nginx / Apache configuration", "link": "https://openpanel.com/docs/panel/advanced/server_settings#nginx--apache-settings"},
        {"title": "How to create a new MySQL database", "link": "https://openpanel.com/docs/panel/databases/#create-a-mysql-database"},
        {"title": "How to add a Cronjob", "link": "https://openpanel.com/docs/panel/advanced/cronjobs#add-a-cronjob"},
        {"title": "How to change server TimeZone", "link": "https://openpanel.com/docs/panel/advanced/server_settings#server-time"}
    ],
    "knowledge_base_link": "https://openpanel.com/docs/panel/intro/?source=openpanel_server"
}
```


## Edit any page template

Each OpenPanel template code is open and can easily be edited by just editing the HTML code.

Templates are located inside a Docker container named `openpanel`, so you first need to find the template that has the code that you want to edit.

For example, to edit the sidebar and hide the OpenPanel logo, follow these steps:

1. Create a new folder/file locally for your modified code.
   ```bash
   mkdir /root/custom_template/
   ```
2. Copy the existing template code.
   ```bash
   docker cp openpanel:/usr/local/panel/templates/partials/sidebar.html /root/custom_template/sidebar.html
   ```
3. Edit the code.

4. Configure OpenPanel to use your template.
   Edit the `/root/docker-compose.yml` file and in it set your file to overwrite the original template:
   ```bash
   nano /root/docker-compose.yml
   ```
   and in the file under [openpanel > volumes](https://github.com/stefanpejcic/openpanel-configuration/blob/180c781bfb7122c354fd339fbee43c1ce6ec017f/docker/compose/new-docker-compose.yml#L31) set local path and original:
   ```bash
   - /root/custom_theme/sidebar.html:/usr/local/panel/templates/partials/sidebar.html
   ```
6. Restart OpenPanel to apply the new template.
   ```bash
   cd /root && docker compose up -d openpanel
   ```


## Customize login page


OpenPanel login page template code is located at `/usr/local/panel/templates/user/login.html` inside the docker container.

To edit the login page:

1. Create a new folder/file locally for your modified code.
   ```bash
   mkdir /root/custom_template/
   ```
2. Copy the existing template code.
   ```bash
   docker cp openpanel:/usr/local/panel/templates/user/login.html /root/custom_template/login.html
   ```
3. Edit the code.

4. Configure OpenPanel to use your template.
   Edit the `/root/docker-compose.yml` file and in it set your file to overwrite the original template:
   ```bash
   nano /root/docker-compose.yml
   ```
   and in the file under [openpanel > volumes](https://github.com/stefanpejcic/openpanel-configuration/blob/180c781bfb7122c354fd339fbee43c1ce6ec017f/docker/compose/new-docker-compose.yml#L31) set local path and original:
   ```bash
   - /root/custom_theme/login.html:/usr/local/panel/templates/user/login.html
   ```
6. Restart OpenPanel to apply the new login template.
   ```bash
   cd /root && docker compose up -d openpanel
   ```


## Add custom CSS or JS code

To add custom CSS code to the OpenPanel interface, edit the file `/etc/openpanel/openpanel/custom_code/custom.css`:

```bash
nano /etc/openpanel/openpanel/custom_code/custom.css
```

To add custom JavaScript code to the OpenPanel interface, edit the file `/etc/openpanel/openpanel/custom_code/custom.js`:

```bash
nano /etc/openpanel/openpanel/custom_code/custom.js
```

To insert custom code within the `<head>` tag of the OpenPanel interface, modify the content of the file located at `/etc/openpanel/openpanel/custom_code/in_header.html` and include your custom code within it:

```bash
nano /etc/openpanel/openpanel/custom_code/in_header.html
```

To insert custom code within the `<footer>` tag of the OpenPanel interface, modify the content of the file located at `/etc/openpanel/openpanel/custom_code/in_footer.html` and include your custom code within it:

```bash
nano /etc/openpanel/openpanel/custom_code/in_footer.html
```


## Customize Email templates

How to modify the email template used for user notifications: https://community.openpanel.org/d/189-customizing-the-email-template-used-for-user-notifications

---

// File: articles/dev-experience/disable-openadmin-server-reboot

# Disable Reboot within OpenAdmin

If for some reason, you want to disable *Server Reboot* feature through OpenAdmin, you can do that on your server.

There is no setting in OpenAdmin to do so, but you can manually create a file that will disable this feature:

1. Log in to the server as root via SSH.
2. Execute the following command:
   ```bash
   touch /root/disable_openadmin_reboot_ui
   ```

---

// File: articles/dev-experience/disable-openadmin-web-terminal

# Disable Terminal within OpenAdmin

If for some reason, you want to disable command-line *root* access through OpenAdmin's Terminal feature, you can do that on your server.

There is no setting in OpenAdmin to do so, but you can manually create a file that will disable this feature:

1. Log in to the server as root via SSH.
2. Execute the following command:
   ```bash
   touch /root/disable_openadmin_terminal_ui
   ```

---

// File: articles/dev-experience/disable-openpanel-web-terminal

# Disable Terminal within OpenPanel

If for some reason, you want to disable command-line access through **Openpanel > Containers > Terminal** page, you can do that on your server.

There is no setting in OpenAdmin to do so, but you can manually create a file that will disable this feature:

1. Log in to the server as root via SSH.
2. Execute the following command:
   ```bash
   touch /etc/openpanel/disable_openpanel_terminal_ui
   ```

---

// File: articles/dev-experience/how-to-access-openadmin

# Access OpenAdmin

Run `opencli admin` command to find the address on which admin panel is accessible. Example output:

```bash
root@server:/home# opencli admin
● OpenAdmin is running and is available on: https://server.openpanel.org:2087/
```

To login to admin panel you need a username and password.

![openadmin login page](/img/admin/openadmin_login_page.png)

Both username and password are random generated on installation.

To view admin accounts:

```bash
opencli admin list
```

To set a new password for the admin account run command: `opencli admin password USER_HERE NEW_PASSWORD_HERE`

Example:
```bash
root@server:/home# opencli admin password stefan ba63vfav7fq36vas
Password for user 'stefan' changed.

===============================================================
● OpenAdmin is running and is available on: https://server.openpanel.co:2087/

- username: stefan
- password: ba63vfav7fq36vas

===============================================================
```

---

// File: articles/dev-experience/how-to-access-openpanel

# Access OpenPanel

OpenPanel is the end-user control panel, accessible by default via the server's IP address and port `2083`. Administrators can configure a custom domain and modify the default port.

To access your OpenPanel account, **use the link provided by your hosting provider**.

To login to user panel you need a username and password.

[![openpanel login page](/img/docs-content/sgXWKVyx-2025-07-09-18-12.png)](/img/docs-content/sgXWKVyx-2025-07-09-18-12.png)

---

// File: articles/dev-experience/limit_access_to_openadmin

# Restrict OpenAdmin

To restrict OpenAdmin access only to your team, whitelist your server's IP addresses on the firewall, and then disable port `2087`.

## Whitelist your team's IP addresses

Replace *YOUR_TEAM_IP* with your actual IP addresses. Repeat for each team IP.

```
csf -a YOUR_TEAM_IP
```

## Block all other access to port 2087

Edit `/etc/csf/csf.conf` and remove *2087* from the allowed *TCP_IN* list, or run:

```
csf -d 0.0.0.0/0 2087
```

Then restart CSF:

```
csf -r
```

---

// File: articles/dev-experience/openadmin-api

# OpenAdmin API Documentation

OpenAdmin API can be used to manage options available from the OpenAdmin interface: hosting plans, accounts, domains, services, DNS, email, security, server administration, and more. All API endpoints require **Bearer JWT authentication**.

:::info
OpenAdmin API is available only on [OpenPanel Enterprise edition](/enterprise/).
To use the API, enable it first from the [OpenAdmin > Settings > API Access](/docs/admin/settings/api/) page or from terminal with [`opencli api on` command](/docs/articles/opencli/api/#enable).
:::

To generate a token for use with the endpoints, send a **POST request** to `/api/` using your OpenAdmin username and password:

```bash
curl -X POST "https://OPENADMIN_DOMAIN_OR_IP:2087/api/" && \
  -H "Content-Type: application/json" -d '{"username":"OPENADMIN_USERNAME","password":"OPENADMIN_PASSWORD"}'
```

We recommend creating a separate admin user dedicated solely to API usage. This way, you can quickly suspend or delete that account if its credentials are ever compromised.

Example response with the token is:

```json
{"access_token":"eyJhbGciOiJIUzI1NiIsInRs4CI6IkpXVCJ9.eyJmcmVzaCI6ZmFsc2UsImlhdCI6MTc4MDc0OTkwOCwianRpIjoiZDcwZmY2NmEtNDNiOC00OGZkLThiMWEtZDIwYWUwMDNhNjEyIiwidHlwZSI6ImFjY2VzcyIsInN1YiI6Im9wc3VwcG9ydCIsIm5iZiI6MTc4MDc0OTkwOCwiY3NyZiI6IjZlOGRmNGVmLTA0MjktNGNkYy1hNTg5LTJkYzUwMDk2ZDI2NSIsI3V4cCI6MTc4M33c1MDgwOH0.WLQ8rsVOF6pQg07i1fI1lXfd8_cCmryiOjGqg8zgOmw"}
```

This token must be sent in header for all other API endpoints:

```
-H "Authorization: Bearer YOUR_JWT_TOKEN" -H "Content-Type: application/json"
```

💡 Hint: Use `opencli api list` command to view usage examples for all the endpoints available on your OpenPanel version.

:::danger
Some endpoints below are destructive or high-privilege (rebooting the server, changing the root SSH password, disabling OpenAdmin, migrating a server, WAF/firewall management). They run with the same privilege as the admin panel itself — scope and rotate API tokens accordingly.
:::

---

## Users

### List All Accounts

`GET /api/users`

<details>
  <summary>Example response</summary>

```json
[
  {
    "username": "stefan",
    "email": "stefan@pejcic.rs",
    "plan_name": "default_plan_nginx"
  }
]
```
</details>

### Create Account

`POST /api/users`
**Request Body:**

```json
{
  "email": "stefan@pejcic.rs",
  "username": "stefan",
  "password": "s32dsasaq",
  "plan_name": "default_plan_nginx"
}
```

**Response:**

```json
{
  "response": {
    "message": "Successfully added user stefan password: s32dsasaq"
  },
  "success": true
}
```

### Get Single Account

`GET /api/users/{username}`

### Suspend / Unsuspend / Change Password

`PATCH /api/users/{username}`
**Request Body Example:**

```json
{
  "action": "suspend",
  "password": "NEW_PASSWORD_HERE"
}
```

### Change Plan

`PUT /api/users/{username}`
**Request Body:**

```json
{
  "plan_name": "default_plan_nginx"
}
```

### Delete Account

`DELETE /api/users/{username}`

### Autologin to User Account

`CONNECT /api/users/{username}`

### List Users with Dedicated IPs

`GET /api/ips`

### List a User's Containers

`GET /api/users/{username}/containers`

Add `?stats=1` to get live CPU/memory/network stats for that user's containers instead of the compose service definitions.

### Manage a User's Container

`POST /api/users/{username}/containers/{action}/{container_name}`

`{action}` is one of `start`, `stop`, `restart`, `cpu`, `ram`.

**Request Body (for `cpu`/`ram` only):**

```json
{
  "value": "2"
}
```

---

## Plans

### List All Plans

`GET /api/plans`
**Response:**

```json
{
  "plans": [
    {
      "id": 1,
      "name": "ubuntu_nginx_mysql",
      "description": "Unlimited disk space and Nginx",
      "bandwidth": 100,
      "cpu": "1",
      "ram": "1g",
      "disk_limit": "10 GB",
      "storage_file": "0 GB",
      "inodes_limit": 1000000,
      "db_limit": 0,
      "domains_limit": 0,
      "websites_limit": 10,
      "docker_image": "openpanel/nginx"
    }
  ]
}
```

### Create Plan

`POST /api/plans`
**Request Body:**

```json
{
  "name": "Starter",
  "description": "Starter hosting plan",
  "email_limit": "10",
  "max_email_quota": "0",
  "max_hourly_email": "0",
  "ftp_limit": "5",
  "domains_limit": "5",
  "websites_limit": "5",
  "disk_limit": "5000",
  "inodes_limit": "100000",
  "db_limit": "5",
  "cpu": "1",
  "ram": "1",
  "bandwidth": "100",
  "feature_set": "default"
}
```

### Get Single Plan

`GET /api/plans/{plan_id}`

### Edit Plan

`PUT /api/plans/{plan_id}` (or `PATCH`)
**Request Body:** same fields as Create Plan — only send the ones you want to change, the rest fall back to defaults (`0` for limits, `1` for cpu/ram, `100` for bandwidth, `default` for feature_set).

### Delete Plan

`DELETE /api/plans/{plan_id}`

---

## Domains

### List All Domains

`GET /api/domains`

### Add Domain

`POST /api/domains/new`
**Request Body:**

```json
{
  "username": "current_user",
  "domain": "example.com",
  "docroot": "/var/www/html/example.com"
}
```

### Suspend Domain

`POST /api/domains/suspend/{domain}`

### Unsuspend Domain

`POST /api/domains/unsuspend/{domain}`

### Delete Domain

`POST /api/domains/delete/{domain}`

### View / Update Docroot

`GET /api/domains/docroot/{domain}`
`POST /api/domains/docroot/{domain}`
**Request Body:**

```json
{
  "docroot": "/var/www/html/newroot"
}
```

### View / Update DNS Zone File

`GET /api/domains/{domain}/dns`
`POST /api/domains/{domain}/dns`

Edits the raw bind zone file. On save the zone is validated with `named-checkzone` and reloaded — if validation fails, the previous version is restored automatically.

**Request Body:**

```json
{
  "content": "$TTL 86400\n@ IN SOA ..."
}
```

### View / Update Caddy Config for a Domain

`GET /api/domains/{domain}/caddy`
`POST /api/domains/{domain}/caddy`

Same validate-then-reload behavior as the DNS zone endpoint, but for the domain's Caddy config block.

**Request Body:**

```json
{
  "content": "example.com {\n  reverse_proxy ...\n}"
}
```

### View / Update VirtualHost Config

`GET /api/domains/{domain}/vhost/{username}`
`POST /api/domains/{domain}/vhost/{username}`

Updates the raw nginx/apache/openresty vhost file for that user's domain and restarts the webserver container.

**Request Body:**

```json
{
  "content": "..."
}
```

### SSL: View Status, Request AutoSSL, Upload Custom Cert, View Logs

`GET /api/domains/{domain}/ssl`
`POST /api/domains/{domain}/ssl`

**Request Body (AutoSSL):**

```json
{ "action": "autossl" }
```

**Request Body (custom certificate — paths must live under `/var/www/html/`):**

```json
{
  "action": "custom",
  "public_path": "/var/www/html/example.com/cert.pem",
  "private_path": "/var/www/html/example.com/key.pem"
}
```

**Request Body (issuance logs):**

```json
{ "action": "logs" }
```

### View Domain Access Log

`GET /api/domains/{domain}/log`

Supports `?page=N` and `?show_all=true` query params for pagination.

### View Domain GoAccess Stats

`GET /api/domains/{domain}/stats/{username}`

Returns the pre-rendered GoAccess HTML report (regenerated every 24h).

### DNS Cluster

`GET /api/dns/cluster` — view cluster config (allowed slave IPs, enabled state)
`POST /api/dns/cluster` — enable/disable the cluster, or add/remove a slave IP

**Request Body examples:**

```json
{ "action": "create", "ip": "1.2.3.4" }
```
```json
{ "action": "delete", "ip": "1.2.3.4" }
```
```json
{ "action": "enable" }
```

### DNS Cluster Node Status

`GET /api/dns/cluster/{ip}`

Checks reachability of a slave node via `rndc` first, falling back to SSH.

### DNS Zone Templates

`GET /api/dns/zone-templates`
`POST /api/dns/zone-templates`
**Request Body:**

```json
{
  "zone_template_ipv4": "...",
  "zone_template_ipv6": "..."
}
```

### Domain File Templates

`GET /api/domains/file-templates`
`POST /api/domains/file-templates`

Default templates used for new domains: `default_page`, `suspended_user`, `suspended_website`, `docker_nginx_domain`, `docker_openresty_domain`, `docker_apache_domain`, `docker_varnish`, `docker_caddy`. Send only the keys you want to update.

---

## Usage

### API Usage Info

`GET /api/usage`

### Current Usage Stats

`GET /api/usage/stats`
**Response:**

```json
{
  "usage_stats": "{\"timestamp\": \"2024-09-03\", \"users\": 1, \"domains\": 2, \"websites\": 0}"
}
```

### CPU Usage

`GET /api/usage/cpu`
**Response Example:**

```json
{
  "core_0": 0,
  "core_1": 0
}
```

### Memory Usage

`GET /api/usage/memory`

### Disk Usage Per User

`GET /api/usage/disk`

### Server Disk Usage

`GET /api/usage/server`
**Response Example:**

```json
[
  {
    "device": "/dev/vda1",
    "mountpoint": "/",
    "fstype": "ext4",
    "total": 123690532864,
    "used": 63366230016,
    "free": 60307525632,
    "percent": 51.2
  }
]
```

---

## System

### Get System Information

`GET /api/system`
**Response Example:**

```json
{
  "hostname": "stefi",
  "os": "Ubuntu 24.04 LTS",
  "time": "2024-09-04 15:09:16",
  "kernel": "6.8.0-36-generic",
  "cpu": "DO-Premium-Intel(x86_64)",
  "openpanel_version": "0.2.7",
  "running_processes": 178,
  "package_updates": 98,
  "uptime": "18905"
}
```

### Docker Info

`GET /api/docker/info`

Raw output of the Docker Engine `info` API call (containers, images, storage driver, etc).

---

## Services

### List Monitored Services

`GET /api/services`

### Edit Services List

`PUT /api/services`
**Request Body Example:**

```json
{
  "service1": { "name": "Service One", "status": "active" },
  "service2": { "name": "Service Two", "status": "inactive" }
}
```

### Check Status of Services

`GET /api/services/status`

### Start Service

`POST /api/service/start/{service_name}`

### Restart Service

`POST /api/service/restart/{service_name}`

### Stop Service

`POST /api/service/stop/{service_name}`

---

## Notifications

### List Notifications

`GET /api/notifications`

**Response Example:**

```json
[
  { "title": "Update available", "message": "New package updates available." }
]
```

### Mark Notification as Read

`POST /api/notifications/{line_number}/read`

Pass `?command=mark_all_as_read` to mark every notification as read in one call.

### Delete Notification

`DELETE /api/notifications/{line_number}`

Pass `?command=delete_all` to clear the whole log.

---

## Emails

### Mailserver Settings

`GET /api/emails/settings`
`POST /api/emails/settings`

**Request Body (set webmail domain):**

```json
{ "webmail_domain": "webmail.example.com" }
```

**Request Body (switch webmail client):**

```json
{ "webmail_software": "roundcube" }
```

**Request Body (toggle mailserver services — any of `ENABLE_POSTFWD`, `ENABLE_AMAVIS`, `ENABLE_DNSBL`, `ENABLE_RSPAMD`, `ENABLE_SPAMASSASSIN`, `ENABLE_MTA_STS`, `ENABLE_OPENDKIM`, `ENABLE_OPENDMARC`, `ENABLE_POP3`, `ENABLE_IMAP`, `ENABLE_CLAMAV`, `ENABLE_FAIL2BAN`, `SMTP_ONLY`, `ENABLE_SRS`):**

```json
{ "ENABLE_CLAMAV": "1", "ENABLE_FAIL2BAN": "1" }
```

**Request Body (change storage location — only allowed before any mailbox exists):**

```json
{ "storage_type": "custom", "email_storage_location": "/mnt/mail" }
```

### List / Manage Mailboxes

`GET /api/emails/accounts` — list all mailboxes and their quotas
`POST /api/emails/accounts` — update password, quota, or send/receive restrictions
`DELETE /api/emails/accounts` — delete one or more mailboxes

**Request Body (change password):**

```json
{ "action": "password", "email": "user@example.com", "password": "newpass" }
```

**Request Body (set quota, in MB):**

```json
{ "action": "quota-set", "email": "user@example.com", "quota": "1024" }
```

**Request Body (remove quota):**

```json
{ "action": "quota-del", "email": "user@example.com" }
```

**Request Body (restrict send/receive):**

```json
{ "action": "restrict", "email": "user@example.com", "type": "send", "restrict_action": "add" }
```

**Request Body (delete accounts):**

```json
{ "emails": ["user@example.com"] }
```

### Mail Queue

`GET /api/emails/queue` — list queued messages
`POST /api/emails/queue` — retry or delete queued messages

**Request Body:**

```json
{ "action": "retry", "scope": "all" }
```
```json
{ "action": "delete", "scope": "selected", "queue_ids": ["ABC123"] }
```

### Per-Domain Email Rate Limits

`GET /api/emails/domain-limits` — view postfwd rules (add `?hits=example.com` to view recent hits for a domain)
`POST /api/emails/domain-limits` — manage rules

**Request Body (set a limit):**

```json
{ "action": "update-domain", "domain": "example.com", "username": "user1", "limit": 100 }
```

**Request Body (reset counters):**

```json
{ "action": "reset-all" }
```

Other supported actions: `reset-domain`, `reset-user`, `delete-domain`, `delete-user`, `delete-all`. You can also send `{"raw_content": "..."}` to overwrite the postfwd rules file directly.

---

## Security

### HTTP Basic Auth

`GET /api/security/basic-auth`
`POST /api/security/basic-auth`
**Request Body:**

```json
{
  "basic_auth": "yes",
  "basic_auth_username": "admin",
  "basic_auth_password": "secret"
}
```

### Blacklisted User-Agents

`GET /api/security/blacklist-useragents`
`POST /api/security/blacklist-useragents`
**Request Body:**

```json
{
  "blacklist_useragents": "BadBot\nEvilCrawler",
  "enabled": "yes"
}
```

### Disable OpenAdmin

`POST /api/security/disable-admin`

:::danger
Irreversible from the web UI/API — the panel can only be re-enabled from the terminal (`opencli admin on`). Restricted to the Super Administrator.
:::

### ConfigServer Firewall (CSF)

`GET /api/security/firewall` — check whether CSF is installed
`POST /api/security/firewall` — forward a raw command to the CSF UI backend

**Request Body:**

```json
{ "action": "cf" }
```

### CorazaWAF Status

`GET /api/security/waf`
`POST /api/security/waf`
**Request Body:**

```json
{ "status": "yes" }
```

### CorazaWAF Rule Sets

`GET /api/security/waf/rules`
`POST /api/security/waf/rules`
**Request Body:**

```json
{ "rule_name": "REQUEST-901-INITIALIZATION", "action": "off" }
```

### Two-Factor Authentication

`GET /api/security/2fa` — returns `{"totp_enabled": true}`, or a fresh `secret` + `qr_data_uri` to scan if 2FA isn't enabled yet
`POST /api/security/2fa/enable` — confirm enrollment
`POST /api/security/2fa/disable` — turn 2FA off

**Request Body (enable):**

```json
{ "secret": "BASE32SECRET", "code": "123456" }
```

**Request Body (disable):**

```json
{ "password": "your-account-password" }
```

### Passkeys

`GET /api/security/passkeys` — list passkeys for the authenticated API user
`POST /api/security/passkeys` — rename a passkey
`DELETE /api/security/passkeys` — remove a passkey

**Request Body:**

```json
{ "id": 1, "name": "Yubikey" }
```

:::info
Passkey **registration** requires a live WebAuthn ceremony in a browser and isn't available over the API — use the OpenAdmin UI to enroll a new key, then manage it here.
:::

---

## Server

### Cron Jobs

`GET /api/server/crons`
`POST /api/server/crons`
**Request Body:**

```json
{
  "jobs": [
    { "line_number": 1, "schedule": "0 3 * * *", "logging": true }
  ]
}
```

### SSH

`GET /api/server/ssh` — status, running config, authorized keys, and current settings
`POST /api/server/ssh` — start/stop/restart the service, update settings, or manage authorized keys

**Request Body (service action):**

```json
{ "action": "restart" }
```

**Request Body (settings):**

```json
{ "port": "2222", "password_auth": "no", "pubkey_auth": "yes", "permit_root_login": "no" }
```

**Request Body (add/remove a key):**

```json
{ "new_key": "ssh-ed25519 AAAA... comment" }
```
```json
{ "key_to_remove": "ssh-ed25519 AAAA..." }
```

### SSH Full Config

`GET /api/server/ssh/config` — raw `sshd_config`
`POST /api/server/ssh/config` — overwrite it (restarts SSH)

### Timezone

`GET /api/server/timezone`
`POST /api/server/timezone`
**Request Body:**

```json
{ "timezone": "Europe/Belgrade" }
```

### Drop Memory Cache / Swap

`POST /api/server/memory/drop-cache`
`POST /api/server/memory/drop-swap`

### Process Manager

`GET /api/server/processes` — supports `?sort=cpu|memory|priority|name|owner|command|pid` (prefix with `-` to reverse)
`POST /api/server/processes/{pid}/kill`

### Clustering Node

`GET /api/server/node`
`POST /api/server/node`
**Request Body:**

```json
{ "default_node": "root@1.2.3.4", "default_ssh_key_path": "/root/.ssh/id_rsa" }
```

### Root Password

`POST /api/server/root-password`
**Request Body:**

```json
{ "password": "newpassword" }
```

:::danger
Restricted to the Super Administrator. Changes the actual root SSH password on the server.
:::

### Reboot

`POST /api/server/reboot`
**Request Body:**

```json
{ "reboot_type": "graceful" }
```

`reboot_type` is `graceful` (waits, then `reboot`) or `hard` (sysrq trigger). The request blocks until the reboot delay elapses, then the connection drops.

`GET /api/server/reboot/status` — used to poll whether the panel is back up.

### Server Migration

`GET /api/server/migrate` — check status/log of an in-progress or finished migration
`POST /api/server/migrate` — start importing data from another OpenPanel server over SSH

**Request Body:**

```json
{ "host": "1.2.3.4", "root": "root", "password": "secret" }
```

---

## Settings

### Administrators

`GET /api/settings/administrators`
`POST /api/settings/administrators`

**Request Body (create — Enterprise only):**

```json
{ "action": "create", "username": "newadmin", "password": "secret123" }
```

Other supported actions: `suspend`, `unsuspend`, `delete`, `rename_user` (with `new_username`), `reset_password` (with `new_password`), `disable_2fa`, `disable_passkeys`.

### Resellers

`GET /api/settings/resellers`
`POST /api/settings/resellers`

**Request Body (create):**

```json
{ "action": "create", "username": "reseller1", "password": "secret123" }
```

**Request Body (update limits):**

```json
{ "action": "update", "username": "reseller1", "allowed_plans": "1,2", "max_accounts": "10", "max_disk_blocks": "1000" }
```

Other supported actions: `suspend`, `unsuspend`, `delete`, `rename_user`, `reset_password`, `disable_2fa`, `disable_passkeys`. A reseller token can only manage its own account and is restricted to `reset_password`.

### General Settings

`GET /api/settings/general`
`POST /api/settings/general`
**Request Body:**

```json
{ "2083_port": "2083", "2087_port": "2087", "force_domain": "panel.example.com", "dev_mode": "off" }
```

### Defaults for New Accounts

`GET /api/settings/defaults`
`POST /api/settings/defaults`
**Request Body:**

```json
{
  "values": { "DEFAULT_PHP_VERSION": "8.2", "WEB_SERVER": "nginx" },
  "services": ["phpmyadmin"]
}
```

### Default Compose/Env Templates

`GET /api/settings/defaults/files`
`POST /api/settings/defaults/files`
`DELETE /api/settings/defaults/files` — resets both files from the upstream GitHub source

**Request Body:**

```json
{ "env": "...", "compose": "..." }
```

### Per-User Compose/Env Files

`GET /api/settings/defaults/files/{username}`
`POST /api/settings/defaults/files/{username}`

### Feature Sets

`GET /api/settings/features` — list feature sets
`GET /api/settings/features/{plan}` — view one set
`POST /api/settings/features` — create a new set
`POST /api/settings/features/{plan}` — update/enable-all/disable-all/delete a set

**Request Body (create):**

```json
{ "feature_name": "my_set" }
```

**Request Body (update):**

```json
{ "action": "update", "features": ["ftp", "cron"] }
```

Other actions: `enable_all`, `disable_all`, `delete`.

### Locales

`GET /api/settings/locales`
`POST /api/settings/locales`

**Request Body (install):**

```json
{ "locale": "en-us" }
```

**Request Body (set default):**

```json
{ "default": "en-us" }
```

### Modules / Plugins

`GET /api/settings/modules`
`POST /api/settings/modules`
**Request Body:**

```json
{ "enabled_modules": ["dns", "malware_scan", "phpmyadmin"] }
```

### Custom Code

`GET /api/settings/custom-code`
`POST /api/settings/custom-code`

Send any of: `custom_css`, `custom_js`, `in_header`, `in_footer`, `post_update`, `pre_startup`, `custom_section`, `forbidden_usernames`, `restricted_domains`, `howto_guides`, `wp_themes`, `wp_plugins`, `pagespeed_api_key`.

```json
{ "custom_css": "body { background: #111; }" }
```

### PHP

`GET /api/settings/php`
`POST /api/settings/php`
**Request Body:**

```json
{ "php82": "memory_limit=512M\nupload_max_filesize=64M" }
```

Send `"options"` to update `/etc/openpanel/php/options.txt`, or `phpXY` (`php56` … `php84`) to update a specific version's `php.ini`.

### Caddy Metrics

`GET /api/settings/caddy/metrics`

Returns raw Prometheus-format metrics from Caddy's `/metrics` endpoint.

### Update Preferences

`GET /api/settings/updates` — current preference, latest available version, and update log
`POST /api/settings/updates`
**Request Body:**

```json
{ "preference": "minor_only" }
```

`preference` is one of `minor_and_major`, `minor_only`, `major_only`, `none`.

### Run Update Now

`POST /api/settings/updates/now`

Starts `opencli update --force` in the background.

### Pin/Downgrade Version

`GET /api/settings/updates/tags` — list available `openpanel/openpanel-ui` docker tags
`POST /api/settings/updates/tags`
**Request Body:**

```json
{ "version": "1.7.60" }
```

### Notification Preferences

`GET /api/settings/notifications`
`POST /api/settings/notifications`
**Request Body:**

```json
{
  "cpu": "90",
  "webhook_url": "https://example.com/hook",
  "update": "on",
  "ssh_whitelist": "1.2.3.4/32\n5.6.7.0/24"
}
```

Supports numeric thresholds (`load`, `cpu`, `ram`, `du`, `swap`, `max_total_conn`, `max_conn_per_ip`), `webhook_url`, `email`, SMTP fields (`mail_server`, `mail_port`, `mail_use_tls`, `mail_use_ssl`, `mail_debug`, `mail_username`, `mail_password`, `mail_default_sender`), the `services` toggle, boolean event toggles (`update`, `attack`, `limit`, `login`, `ssh`, `reboot`, `dns`, plus the `ACTIONS` section like `admin_create`, `user_delete`, `domains_ssl`, etc — pass `"on"`/`"off"`), and `ssh_whitelist` (newline-separated IPs/CIDRs).

---

## License & Support

### License Key

`GET /api/license` — current key
`POST /api/license` — set/validate a key
`DELETE /api/license` — remove the license

**Request Body:**

```json
{ "key": "YOUR-LICENSE-KEY" }
```

### License Info

`GET /api/license/info`

### Verify License

`POST /api/license/verify`

### Generate Support Report

`GET /api/support/report`

Runs `opencli report --public --non-interactive` and returns the generated report.

---

## Import & Transfer

### Import from cPanel / CyberPanel Backup

`GET /api/import/{panel_type}` — list import job statuses (`{panel_type}` is `cpanel` or `cyberpanel`)
`POST /api/import/{panel_type}` — start an import in the background

**Request Body:**

```json
{ "path": "/root/backup-user.tar.gz", "plan_name": "default_plan_apache" }
```

### View Import Log

`GET /api/import/logs/account/{log_filename}`

### List Detected Backup Files

`GET /api/import/backup-files`

Scans `/`, `/home`, and `/root` for `backup-*.tar.gz` files.

### OpenPanel-to-OpenPanel Transfers

`GET /api/import/transfers` — list transfer log files
`POST /api/import/transfers` — start a transfer

**Request Body:**

```json
{
  "openpanel_username": "newuser",
  "server": "1.2.3.4",
  "username": "root",
  "password": "secret",
  "live_transfer": true
}
```

### Transfer Status for a User

`GET /api/import/transfers/{username}`

### View Transfer Log

`GET /api/import/logs/transfer/{log_filename}`

---

// File: articles/dev-experience/openadmin-keyboard-shortcuts

# Keyboard Shortcuts

OpenAdmin UI can be navigated using keyboard shortcuts.

## Available shortcuts

To view all available shortcuts: `Ctrl` + `K` 

| Shortcut                     | Action                          | URL Path                      |
|-----------------------------|----------------------------------|-------------------------------|
| `Ctrl` + `Escape`           | Logout                           | `/logout`                    |
| `Ctrl` + `Shift` + `H`      | Dashboard                        | `/dashboard`                 |
| `Ctrl` + `Shift` + `N`      | Notifications                    | `/view_notifications`        |
| `Ctrl` + `Shift` + `U`      | Users                            | `/users`                     |
| `Ctrl` + `Shift` + `R`      | Resellers                        | `/resellers`                 |
| `Ctrl` + `Shift` + `A`      | Administrators                   | `/administrators`            |
| `Ctrl` + `Shift` + `P`      | Plans                            | `/plans`                     |
| `Ctrl` + `Shift` + `F`      | Feature Manager                  | `/features`                  |
| `Ctrl` + `Shift` + `D`      | Domains                          | `/domains`                   |
| `Ctrl` + `Shift` + `E`      | Email Accounts                   | `/emails/accounts`           |
| `Ctrl` + `Shift` + `S`      | Services Status                  | `/services`                  |
| `Ctrl` + `Shift` + `C`      | ConfigServer Firewall (CSF)      | `/security/firewall`         |
| `Ctrl` + `Shift` + `W`      | CorazaWAF Settings               | `/security/waf`              |
| `Ctrl` + `Shift` + `L`      | View Logs                        | `/services/logs`             |
| `Ctrl` + `Shift` + `B`      | Basic Auth                       | `/security/basic_auth`       |
| `Ctrl` + `Shift` + `1` (Numpad only) | License                     | `/license`                   |

> ℹ️ Use `Cmd` on macOS in place of `Ctrl`.

---

## Edit shortcuts

Administrators can change thr shortcuts by editing the file: `/etc/openpanel/openadmin/config/shortcuts.json`.

Default content:

```json
{
  "ctrl+shift+h": "/dashboard",
  "ctrl+shift+n": "/notifications",
  "ctrl+shift+u": "/users",
  "ctrl+shift+r": "/resellers",
  "ctrl+shift+a": "/administrators",
  "ctrl+shift+p": "/plans",
  "ctrl+shift+f": "/features",
  "ctrl+shift+d": "/domains",
  "ctrl+shift+e": "/emails/accounts",
  "ctrl+shift+s": "/services",
  "ctrl+shift+c": "/security/firewall",
  "ctrl+shift+w": "/security/waf",
  "ctrl+shift+l": "/services/logs",
  "ctrl+shift+b": "/security/basic_auth",
  "ctrl+escape": "/logout"
}
```

After editing the file, restart OpenAdmin: `service admin restart`.

---

## Disable shortcuts

To completelly disable the shortcuts on OpenAdmin, delete the file: `/etc/openpanel/openadmin/config/shortcuts.json`

---

// File: articles/dev-experience/openpanel-pre-post-hooks

# OpenCLI Hooks

OpenPanel supports **pre** and **post hooks** for all commands, that run bash scripts before or after running opencli commands.

To create a hook, first create a new directory: `/etc/openpanel/openpanel/hooks/` and inside create a file based on the desired command:

- `pre_` prefix for script to run **before** a command.
- `post_` prefix for a script to run **after** executing an opencli command.

## Examples

To run a custom script before the user creation process (opencli *user-add*) you would create a new file:
```bash
/etc/openpanel/openpanel/hooks/pre_user-add.sh
````


Another example to run **after a domain is added**:

When a user adds a new domain via the UI, the underlying command executed is:

```bash
/etc/openpanel/openpanel/hooks/post_domains-add.sh
```

These scripts will be executed automatically when the command runs, depending on whether you're hooking into the pre- or post-execution phase.

## Passing Arguments to Hooks

All arguments passed to the `opencli` command are also forwarded to your hook script.

For example, if the following command is executed:

```bash
opencli domains-add example.com stefan --docroot /var/www/example --php_version 8.1 --skip_caddy --skip_vhost --skip_containers --skip_dns --debug
```

Your hook script will receive the same arguments:

```bash
bash /etc/openpanel/openpanel/hooks/post_domains-add.sh example.com johndoe --docroot /var/www/example --php_version 8.1 --skip_caddy --skip_vhost --skip_containers --skip_dns --debug
```

---

// File: articles/dev-experience/openpanel-structure

# OpenPanel Folder Structure

OpenPanel uses the following files and directories:

Configuration:
```
/etc/openpanel/
├── bind9/                    - Configuration for DNS service.
├── caddy/                    - Caddy webserver configuration and data.
├── clamav/                   - ClamAV service configuration.
├── docker/                   - Docker configuration.
├── ftp/                      - Settings and user data for FTP service.
├── goaccess/                 - Configuration for GoAccess reports.
├── mysql/                    - Database schema.
├── nginx/                    - Nginx webserver configuraton [DEPRECATED].
├── openadmin/                - Settings for the admin panel.
├── openpanel/                - Settings for the user panel.
├── php/                      - PHP blueprints.
├── services/                 - Services configuration files.
├── skeleton/                 - Files used for new user accounts.
├── ssh/                      - SSH configuration and motd.
└── varnish/                  - Varnish configuration - [DEPRECATED].
```

Default configuration can be viewed [here](https://github.com/stefanpejcic/OpenPanel-configuration).


## User Files

All files for a user are stored in their /home directory: `/home/$docker_context/`:

```
/home/stefan/
├── docker-compose.yml        - Contains all services that user can run.
├── .env                      - Contains ports, resource limits and passwrods for services.
├── httpd.conf                - main configuration that is used IF user runs Apache webserver.
├── nginx.conf                - main configuration that is used IF user runs Nginx webserver.
├── openresty.conf            - main configuration that is used IF user runs OpenResty webserver.
├── openlitespeed.conf        - main configuration that is used IF user runs OpenLitespeed webserver.
├── default.vcl               - Varnish Configuration that is used if Varnish cache is enabled for user.
├── php.ini/                  - PHP.INI files hat user can edit via 'OpenPanel > PHP > PHP.INI Editor' page.
├── crons.ini                 - Cron jobs that user can edit via 'OpenPanel > Cron Jobs' page.
├── backup.env                - Backup configuration that user can edit via 'OpenPanel > Files > Backups' page.
├── my.cnf                    - MySQL root user logins that are used for ALL actions from the OpenPanel UI.
├── custom.cnf                - MySQL Configuration that user can edit via 'OpenPanel > MySQL > Configuration' page.
├── postgre_custom.conf       - PostgreSQL Configuration that user can edit via 'OpenPanel > PostgreSQL > Configuration' page.
├── pma.php                   - used to allow auto-login to phpMyAdmin from OpenPanel UI.
├── docker-data/              - All docker files: containers, images, volumes..
│   └── volumes/ 
│       ├── $context_html_data/             - Website files (/var/www/html/ in 'OpenPanel > File Manager' page).
│       ├── $context_mysql_data/            - MySQL storage (all databases).
│       ├── $context_mysql_dumps/           - MySQL /tmp folder used for dumps.
│       ├── $context_pg_data/               - PostgreSQL storage (all databases).
│       └── $context_webserver_data/        - VirtualHosts files for domains.
├── .config/                  - systemd service files.
├── .docker/                  - Docker service files.
├── bin/                      - service files.
├── sockets/                  - sockets for running services.
└── .bashrc                   - Sets path and docker host.
```

## User Services files

Certain files are shared across user services to provide Administrators with a single point of management. This enables faster updates and easier customization for all users. For example, it allows updating WP-CLI simultaneously for everyone or configuring OpenLiteSpeed consistently across all accounts.

- `/etc/openpanel/wordpress/wp-cli.phar`           - WP-CLI binnary used in OpenLitespeed and all PHP containers.
- `/etc/openpanel/openlitespeed/start.sh`          - Sets permissions and maps all individual VHosts files on OpenLitespeed.
- `/etc/openpanel/nginx/certs/`                    - Self-signed SSL files for domains used inside user webservers.
- `/etc/openpanel/nginx/default_page.html`         - Landing page displayed on user domains if no files exist.
- `/etc/openpanel/mysql/scripts/dump.sh`           - Script used to generate mysql dumps when performing backups.
- `/etc/openpanel/mysql/phpmyadmin/config.inc.php` - phpMyAdmin configuration file that allows auto-login from UI.
- `/etc/openpanel/php/ioncube/`                    - Ioncube Loader files for PHP.
- `/etc/openpanel/php/ioncube_extension.ini`       - Ioncube Loader extension for PHP.

## Shared Services files

Files that are used by shared services like FTP, Caddy webserver and Mailserver.

- `/etc/openpanel/wordpress/wp-cli.phar`           - WP-CLI binnary used in OpenLitespeed and all PHP containers.
- `/etc/openpanel/wordpress/wp-cli.phar`           - WP-CLI binnary used in OpenLitespeed and all PHP containers.

## Templates files

Files that are used for new services/domains that users add.

- `/etc/openpanel/docker/compose/nodejs.yml`       - Used for new docker services via 'OpenPanel > AutoInstaller > NodeJS' page.
- `/etc/openpanel/docker/compose/python.yml`       - Used for new docker services via 'OpenPanel > AutoInstaller > Python' page.
- `/etc/openpanel/docker/daemon/rootless.json`     - Used for new users to configure docker rootless service.
- `/etc/openpanel/apache/httpd.conf`     - Main configuration file used for new users with Apache webserver.
- `/etc/openpanel/backups/backup.env`     - Template used for new user backups.
- `/etc/openpanel/backups/customized.template`     - Notifications template used for user backups.
- `/etc/openpanel/bind9/zone_template.txt` - DNS zone template used for new domains with IPv4 set for the user.
- `/etc/openpanel/bind9/zone_template_ipv6.txt` - DNS zone template used for new domains with IPv6 set for the user.
- `/etc/openpanel/bind9/zone_template_ipv6.txt` - DNS zone template used for new domains with IPv6 set for the user.
- `/etc/openpanel/caddy/templates/domain.conf` - Caddyfile used for new domains.
- `/etc/openpanel/caddy/templates/suspended_domain.html` - Landing page displayed on suspended domains for a user.
- `/etc/openpanel/caddy/templates/suspended_user.html` - Landing page displayed on domains for a suspended user.
- `/etc/openpanel/csf/csf.blocklists` - CSF blocklists used when configuring Sentinel Firewall.
- `/etc/openpanel/mysql/user.cnf` - Configuration file used for MySQL services.


## Configuration files

- `/etc/openpanel/caddy/templates/wp.rules` - Rules used for hardening options in WP Manager.
- `/etc/openpanel/clamav/extensions.txt` - List of extensions to scan using ClamAV (DEPRECATED).
- `/etc/openpanel/csf/csf.blocklists` - CSF blocklists used when configuring Sentinel Firewall.
- `/etc/openpanel/ftp/start_vsftpd.sh` - Entrypoint for FTP service (creates accounts on startup).
- `/etc/openpanel/ftp/vsftpd.conf` - Vsftpd main configuration file.
- `/etc/openpanel/goaccess/goaccess.conf` - GoAccess main configuration file.
- `/etc/openpanel/modules/` - Custom plugins for OpenPanel UI.
- `/etc/openpanel/mysql/initialize/1.1/plans.sql` - Initializes database on OpenPanel installation.
- `/etc/openpanel/mysql/host_mysql.cnf` - Stores mysql logins for the OpenPanel installation.
- `/etc/openpanel/mysql/keys.txt` - List of configuration keys editable from 'OpenPanel > MySQL > Configuration' page.
- `/etc/openpanel/mysql/mysqld.cnf` - Configuration file for MySQL service.
- `/etc/openpanel/docker/templates/docker_apache_domain.conf` - VirtualHosts template for new domains on Apache webserver.
- `/etc/openpanel/docker/templates/docker_litespeed_domain.conf` - VirtualHosts template for new domains on OpenLitespeed webserver.
- `/etc/openpanel/docker/templates/docker_nginx_domain.conf` - VirtualHosts template for new domains on Nginx webserver.
- NOTE: list is incomplete, please refer to https://github.com/stefanpejcic/openpanel-configuration/tree/main for a full list.

---

// File: articles/dev-experience/openpanel-system-services

# Services

OpenPanel uses the following services:

## Caddy

[Caddy](https://caddyserver.com/) is utilized as a reverse proxy to manage traffic to and from user websites hosted in their Docker containers. It also handles SSL certificate generation and renewals for both user domains and the main control panel domain.

Configuration Files:
- `/etc/openpanel/caddy/Caddyfile`: This is the main configuration file that includes all others.
- `/etc/openpanel/caddy/check.conf`: This file manages domain verification for SSL generation on the server.
- `/etc/openpanel/caddy/redirects.conf`: Contains redirections for `/openpanel`, `/openadmin`, and `/webmail` for all domains.
- `/etc/openpanel/caddy/domains/`: This directory holds a `.conf` file for each domain added to the server.
- `/etc/openpanel/caddy/templates/`: Contains configuration templates for new and suspended domains.
- `/etc/openpanel/caddy/suspended_domains/`: Stores user domains once they have been suspended.

You can view the default Caddy configuration [here](https://github.com/stefanpejcic/openpanel-configuration/tree/main/caddy).

Admins can set memory (RAM) and CPU limits for Caddy by modifying the `/root/.env` file:

```
CADDY_RAM="1g"
CADDY_CPUS="1.0"
```

OpenPanel uses a custom Caddy image, which includes [OWASP Coraza WAF](https://coraza.io/), a high-performance open-source Web Application Firewall. The source for this custom image can be found [here](https://github.com/stefanpejcic/OpenPanel/blob/main/docker/caddy-coraza/Dockerfile).

If you prefer not to use Coraza WAF, you can switch to the official Caddy image by updating the `/root/.env` file:

To use the custom Caddy image with Coraza:

```
CADDY_IMAGE="openpanel/caddy-coraza"
```

To use the official Caddy image without Coraza:

```
CADDY_IMAGE="caddy/latest"
```

## Docker


[Docker](https://www.docker.com/) rootful is used to run all the shared services. Default services can be viewed [here](https://github.com/stefanpejcic/openpanel-configuration/blob/main/docker/compose/docker-compose.yml).

[Docker Rootless mode](https://docs.docker.com/engine/security/rootless/) is used for each user account to isolate their containers.

## MySQL

[MySQL](https://www.mysql.com/) is used as a database to store all user related information:

- Users
- Plans
- Domains
- Websites

MySQL login information is stored in files: `/etc/openpanel/mysql/host_db.conf` and `/etc/openpanel/mysql/hcontainer_db.conf`. 

- `/etc/openpanel/mysql/host_db.conf` is symlinked to `/etc/my.cnf` and is used for OpenAdmin service and OpenCLI commands.
- `/etc/openpanel/mysql/hcontainer_db.conf` is mounted to `/etc/my.cnf` in OpenPanel container and is used by it.

MySQL data is stored inside the `root_mysql` docker volume.

Admins can set memory (RAM) and CPU limits for MySQL service by modifying the `/root/.env` file:

```
MYSQL_RAM="0.5g"
MYSQL_CPUS="1.0"
```

`MYSQL_ROOT_PASSWORD` stores the random mysql root password:
```
MYSQL_ROOT_PASSWORD=
```

## SQLite

SQLite database is used by the OpenAdmin panel in order to completely separate the Admin and end-user interface.
Database file: `/etc/openpanel/openadmin/users.db` contians all administrator accounts.

## Named

[Named (BIND9)](https://www.isc.org/bind/) container is used for DNS.

Administrators can set custom nameservers on *OpenAdmin > OpenPanel Settings* to be used for OpenPanel websites.

[ default named.conf.options` configuration file](https://github.com/stefanpejcic/openpanel-configuration/blob/main/bind9/named.conf.options)

Admins can set memory (RAM) and CPU limits for BIND9 service by modifying the `/root/.env` file:

```
BIND9_RAM="0.1g"
BIND9_CPUS="0.1"
```

BIND9 version can be set by changing the `latest` tag to any version from [hub.docker.com](https://hub.docker.com/r/ubuntu/bind9/tags):
```
BIND9_VERSION="latest"
```

Timezone for the BIND9 service can be changed by editing:

```
BIND_TIMEZONE="America/New_York"
```

## GoAccess

OpenPanel uses [GoAccess](https://goaccess.io/) to generate beautiful HTML reports from Nginx access logs for each domain.
OpenPanel also downloads [GeoIPLite2 City and Country](https://dev.maxmind.com/geoip/geolite2-free-geolocation-data) databases in order to display location info for each IP address in reports.
To customize these reports edit the [/etc/openpanel/goaccess/goaccess.conf](https://github.com/stefanpejcic/openpanel-configuration/blob/main/goaccess/goaccess.conf) file.

## CSF


## OpenPanel

[openpanel/openpanel](https://hub.docker.com/r/openpanel/openpanel) docker image is used to provide access to the OpenPanel interface that allows users to manage their accounts.

Admins can set the OpenPanel version by changing the tag in the `/root/.env` file with any tag from [hub.docker.com](https://hub.docker.com/r/openpanel/openpanel/tags):
```
VERSION="1.0.0"
```

By default OpenPanel is accesible on port `2083` but this can also be configured by Admin by editing the `PORT` value:

```
PORT="2083"
```


OpenPanel is a [Flask](https://flask.palletsprojects.com/en/3.0.x/)-based application that uses [MySQL](#MySQL) to store user data and operates on the [Gunicorn](https://gunicorn.org/) web server. This configuration ensures that OpenPanel remains functional even if the web server is down, thereby providing complete isolation between user websites and the admin panel.

OpenPanel operates in production mode by default, logging only [errors and access logs](/logs.html). For developers needing more detailed logs for troubleshooting or development purposes, it is possible to switch to a more verbose logging mode by enabling dev_mode.




## OpenAdmin

`admin` service is used by the OpenAdmin interface.

By default, OpenAdmin is accessible on port `2087`, but this can be changed by the Admin by modifying the `port` value in the admin service configuration. However, due to limitations in billing systems like WHMCS, which do not support custom port settings, changing the port through the admin interface is not allowed. If the port is changed via the terminal, it may disrupt any third-party integrations that rely on the default port `2087`.

OpenAdmin is a [Flask](https://flask.palletsprojects.com/en/3.0.x/) application that utilizes [SQLite](https://www.sqlite.org/) for its database and runs on a separate Gunicorn instance. It operates independently from the OpenPanel and webserver.

## ClamAV

[ClamAV](https://www.clamav.net/) is an open-source antivirus engine for detecting trojans, viruses, malware & other malicious threats. OpenPanel uses ClamAV for the `'malware_scanner' feature.


Admins can set memory (RAM) and CPU limits for ClamAV service by modifying the `/root/.env` file:

```
CLAMAV_RAM="1g"
CLAMAV_CPUS="1.0"
```
*Note:ClamAV requires at least 1GB of RAM nad 1 CPU: https://docs.clamav.net/#recommended-system-requirements*

ClamAV version can be set by changing the `latest` tag to any version from [hub.docker.com](https://hub.docker.com/r/clamav/clamav/tags):
```
CLAMAV_VERSION="latest"
```

ClamAV will daily update the singatures database and keep it in RAM. To enable this feature set:

```
CLAMAV_DB_AUTOUPDATE="host"
```

Admins can specify the delay in seconds to wait for the signature database to load before starting the deamon:

```
CLAMD_STARTUP_DELAY=30
```


## Redis

Redis service is used by the OpenPanel user interface to keep user session data and temporary files in the meomory.

Admins can set memory (RAM) and CPU limits for Redis service by modifying the `/root/.env` file:

```
CLAMAV_RAM="1g"
CLAMAV_CPUS="1.0"
```

By default `/tmp/redis/` is used for the redis.sock file for conencting the OpenPanel and Redis services. This path can be changed by editing:
```
REDIS_SOCKET="/tmp/redis/"
```

## FTP

[vsftpd](https://security.appspot.com/vsftpd.html) is used as FTP server for the Enterprise edition. OpenPanel provides terminal commands and UI for managing ftp sub-accounts.

Admins can set memory (RAM) and CPU limits for FTP service by modifying the `/root/.env` file:

```
FTP_RAM="0.5g"
FTP_CPUS="0.5"
```

Port range for passive ftp can also be configured:
```
FTP_PORT_RANGE="21000-21010"
```

## MailServer

OpenPanel Enterprise supports mailserver. [Docker Mailserver](https://docker-mailserver.github.io/docker-mailserver/latest/) is used as a fullstack mail server (SMTP, IMAP, LDAP, Anti-spam, Anti-virus, etc.)

OpenPanel provides [terminal commands](/cli/email.html) and [UI](https://openpanel.com/docs/panel/intro/) for users to manage emails.

## Webmail

[Roundcube](https://roundcube.net/) is provided as a Webmail client

---

// File: articles/dev-experience/rate_limiting_for_openpanel

# Limit OpenPanel

Both OpenPanel and OpenAdmin interfaces have a built-in rate limiting and IP address blocking to protect against brute-force attacks.

This feature is enabled by default on all installations, and can be additionally customized via *OpenAdmin > Settings > OpenPanel* or from the terminal.

You can configure the maximum number of failed login attempts allowed per IP (default is `5` per minute) and the total number of failed attempts (default is `20`), after which the offending IP will be temporarily blocked by the firewall for one hour.

For OpenPanel limits are configurable in: /etc/openpanel/openpanel/conf/openpanel.config file:
```bash
[USERS]
login_ratelimit=5
login_blocklimit=20
```

![user ratelimit](/img/panel/v1/user_block.png)

For OpenAdmin limits are configurable in: /etc/openpanel/openadmin/config/admin.ini file:
```bash
[PANEL]
login_ratelimit=5
login_blocklimit=20
```

![admin ratelimit](/img/admin/admin_block.png)

If a user successfully logs in, the counter for `login_blocklimit` will reset.

Failed login attempts and blocked IP addresses are logged in the `/var/log/openpanel/admin/failed_login.log` file for OpenAdmin and in the `/var/log/openpanel/user/failed_login.log` file for OpenPanel.

---

// File: articles/dev-experience/remove-custom-port-for-openadmin

#  Removing the Port for OpenAdmin

By default, the OpenAdmin interface runs on a Gunicorn web server, while all other websites run on Caddy. This setup ensures that the admin panel remains accessible even if the main web server is down.

If you want to remove the port number for OpenAdmin and access it directly via your domain (e.g., `https://yourdomain.com/`), follow these steps:

1. Set port to `443`:
   ```bash
   opencli admin port 443
   ```
3. Restart service to apply the change:
   ```bash
   service amdin restart
   ```

---

// File: articles/dev-experience/remove-custom-port-for-openpanel

#  Removing the Port for OpenPanel

By default, the OpenPanel interface runs on a Gunicorn web server, while all other websites run on Caddy. This setup ensures that the admin panel remains accessible even if the main web server is down.

If you want to remove the port number for OpenPanel and access it directly via your domain (e.g., `https://yourdomain.com/`), follow these steps:

1. Set port to `443`:
   ```bash
   opencli port set 443
   ```
3. Restart services to apply the change:
   ```bash
   docker restart openpanel caddy
   ```

---

// File: articles/dev-experience/selfhosted-screenshots-api

# Screenshots API

[OpenPanel SiteManager](/docs/panel/applications/) displays a website screenshot for each website. These screenshots are by default locally generated and stored on your server.

## Remote API

When installing OpenPanel on your server, you can use the `--screenshots=<url>` flag to use a custom api instead.

Later, you can update the setting using: `opencli config update screenshots <url_of_your_remote_service>`


This is recommended for small servers, as the local screenshots api will use additional 1GB of storage.

To setup your own screenshots API:

1. Deploy: [![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fstefanpejcic%2Fscreenshot-v2%2F&project-name=openpanel-screenshots-api&repository-name=openpanel-screenshots-api) [![Deploy to netlify Vercel](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https%3A%2F%2Fgithub.com%2Fstefanpejcic%2Fscreenshot-v2%2F&project-name=openpanel-screenshots-api&repository-name=openpanel-screenshots-api)
2. Configure your custom domain
3. Update OpenPanel to use it, example if domain is `screenshots-v2.openpanel.com` then run:
   ```
   opencli config update screenshots http://screenshots-v2.openpanel.com/api/screenshot
   ```

---

// File: articles/dev-experience/selfhosted-temporary-links-api

# Temporary Links API

[OpenPanel SiteManager](/docs/panel/applications/) has a temporary-links option that allows user to test website from the server IP, prior to changing DNS. Proxy domains are subdomains on our hosted api `.openpanel.org`.

## Use Self-hosted Remote API

If you have multiple OpenPanel servers and want to use your own domain for temporary links, you can designate one server to host the api, and set OpenPanel servers to use that API instead.

To do this, set up the [Temporary Links service for OpenPanel server](https://github.com/stefanpejcic/OpenPanel/blob/main/services/proxy/README.md) on one server, add the domain to it, and then update the [temporary_links](https://dev.openpanel.com/cli/config.html#temporary-links) service on your OpenPanel servers to use the new instance:

```
opencli config update temporary_links "https://preview.openpanel.org/index.php"
```

---

// File: articles/dev-experience/separate-domain-for-openpanel-access

# Set a separate domain for OpenPanel UI

To set separate domain just for the OpenPanel UI, for example `pejcic.rs`:

1. Add the domain to Caddyfile

  ```bash
  DOMAIN="pejcic.rs" && cat << EOF >> "/etc/openpanel/caddy/Caddyfile"
  
  # START USERPANEL DOMAIN #
  $DOMAIN {
      reverse_proxy localhost:2083
  }
  
  http://$DOMAIN {
      reverse_proxy localhost:2083
  }
  # END USERPANEL DOMAIN #
  EOF
  ```

2. Create an empty file with the domain name so SSL can be generated and renewed:
  ```bash
  touch /etc/openpanel/caddy/domains/pejcic.rs.conf
  ```

3. Restart services
  ```bash
  docker restart caddy openpanel
  ```

---

// File: articles/dev-experience/troubleshooting-openpanel-guide

# Troubleshooting OpenPanel

When troubleshooting OpenPanel, the first step is to **reproduce the issue**. If you can confirm it’s a bug (and like all software, bugs do happen), try to identify a consistent way to trigger it.

* If the issue is **reproducible**, please [report it on GitHub Issues](https://github.com/stefanpejcic/OpenPanel/issues/new/choose) so we can prioritize it for the next update.
* If you’d like to investigate further on your own, follow the steps below.

---

## Step 1: Enable Developer Mode

Run the following command to turn on verbose debugging for both **OpenPanel** and **OpenAdmin** interfaces:

```bash
opencli config update dev_mode on
```

---

## Step 2: Check Logs

Reproduce the issue in the UI, then review the logs at the same time to spot errors.

* **OpenPanel logs:**

  ```bash
  docker logs -f openpanel
  ```
* **OpenAdmin logs:**

  ```bash
  tail -f /var/log/openpanel/admin/error.log
  ```

---

## Step 3: Disable Developer Mode

After finishing, disable developer mode to prevent unnecessary log growth:

```bash
opencli config update dev_mode off
```

---

// File: articles/docker/are-plan-limits-hard-or-soft-limits

# Hard Limits

Each user plan has fixed resource usage limits - these are **hard limits**, meaning users cannot exceed them under any circumstances.

- **Disk** and **Inode** [quotas](https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/7/html/storage_administration_guide/ch-disk-quotas) are hard limits enforced by the the Linux kernel.
- **CPU** and **Memory** allocations are also enforced as hard limits using Docker. These resources are strictly capped to prevent overuse.

> **Note:** CPU usage percentages can be misleading on systems with multiple CPU cores. For example, if a service is allocated 1.5 CPU cores, its maximum usage may appear as **150%**, not **100%**.
> For further details, see: [Docker CLI Issue #2134](https://github.com/docker/cli/issues/2134)

---

// File: articles/docker/context

# Managing User Containers from the Terminal

In OpenPanel, each user has their own [Docker context](https://docs.docker.com/engine/manage-resources/contexts/) running in [rootless mode](https://docs.docker.com/engine/security/rootless/). If you are familiar with Docker, you can manage a user’s files and services directly from the terminal.

SSH access as the **root user** on the server is required to switch between Docker contexts.

---

## Compose Setup

Each user’s environment is based on:

* **`docker-compose.yml`** – defines services, networks, and volumes.
* **`.env`** – defines CPU/memory limits, Docker image tags, and custom ports.

> ⚠️ Always edit these files via the OpenAdmin interface. The interface validates your changes. Editing directly from the terminal bypasses validation and can break services. Make a backup before any modifications.

* [Volume Management in OpenPanel](/docs/articles/docker/volume-management-openpanel/)
* [Network Isolation in OpenPanel](/docs/articles/docker/network-isolation-openpanel/)

---

## File Structure

Each user’s home directory is located at:

```
/home/USERNAME/
```

It contains configuration files and user data. Example structure:

```
├── .env                 # Environment variables: versions, ports, CPU/memory limits
├── backup.env           # Backup configuration
├── crons.ini            # Cron jobs
├── custom.cnf           # MySQL configuration
├── default.vcl          # Varnish cache configuration
├── docker-compose.yml   # Service definitions
├── docker-data          # Docker storage
│   ├── containerd       # Container runtime data
│   ├── containers       # Individual container data
│   ├── image            # Docker images
│   ├── network          # Docker networks
│   ├── overlay2         # Overlay filesystem storage
│   ├── plugins          # Docker plugins
│   └── volumes          # Persistent data volumes
│       ├── <USERNAME>_html_data   # Website files (/var/www/html/)
│       └── <USERNAME>_mysql_data  # MySQL database files (/var/lib/mysql/)
├── httpd.conf           # Apache configuration
├── my.cnf               # MySQL root credentials for service commands
├── nginx.conf           # NGINX configuration
├── openlitespeed.conf   # OpenLiteSpeed configuration
├── openresty.conf       # OpenResty configuration
├── php.ini/             # PHP configuration files
├── pma.php              # phpMyAdmin entry point
└── sockets              # Sockets (MySQL, Redis, PostgreSQL, etc.)
```

* Website files are stored in the Docker volume `USERNAME_html_data` and physically located at:

```
/home/USERNAME/docker_data/volumes/USERNAME_html_data/_data/
```

* File ownership should match the OpenPanel user ID. Check with:

```bash
id -u USERNAME
```

* Docker runs in **rootless mode**, mapping the user UID to `root` inside containers. This avoids permission issues while giving the user root-level permissions in their services.

* Disk quotas are enforced using the [quota](https://linux.die.net/man/2/quotactl) tool. To check disk and inodes usage for user:

```bash
quota -u USERNAME
```

---

## Managing Services

Services are defined in `/home/USERNAME/docker-compose.yml`. You can extend this file with custom services, but to maintain compatibility with the OpenPanel UI, [follow the guidelines](#).

Use the user’s Docker context to manage their services. Examples:

* **List running services:**

```bash
docker --context=USERNAME ps -a
```

* **Stop a service:**

```bash
docker --context=USERNAME stop mysql
```

* **Restart a service:**

```bash
cd /home/USERNAME && \
docker --context=USERNAME compose down mysql && \
docker --context=USERNAME compose up -d mysql
```

* **Exec into a service:**

```bash
docker --context=USERNAME exec -it mysql bash
```

* **View resource usage:**

```bash
docker --context=USERNAME stats --no-stream
```

---

## Domains

Domain configuration files are stored in:

* **Caddy configuration:**
```
/etc/openpanel/caddy/domains/<DOMAIN>.conf
```

Each domain has its own Caddyfile. Caddy handles SSL certificates and acts as a reverse proxy to the user’s web server.
For more information, see: [How Web Traffic Flows with User Containers](https://openpanel.com/docs/articles/docker/how-traffic-flows-in-openpanel/)


* **BIND9 zone file:**
```
/etc/bind/zones/<DOMAIN>.db
```
Contains the DNS records for the domain.

---

## Backups

OpenPanel uses [offen/docker-volume-backup](https://offen.github.io/docker-volume-backup/) for backups. Configuration is stored in `/home/{CONTEXT}/backup.env`.

* Administrators can schedule automatic backups for users.
* Users can also enable and manage their own backups if permitted.
* Only Docker volumes are backed up, which include the actual user data (website files and databases).

For detailed instructions, see: [Configuring OpenPanel Backups](/docs/articles/backups/configuring-backups)

---

## Crons

OpenPanel uses [mcuadros/ofelia](https://github.com/mcuadros/ofelia) for cron obs. Configuration is stored in `/home/{CONTEXT}/crons.ini`.

---

## Ports

Ports are defined in the user’s `.env` file:

```bash
root@stefan:/# grep _PORT /home/stefan/.env 
HTTP_PORT="127.0.0.1:32780:80"
HTTPS_PORT="127.0.0.1:32781:443"
PROXY_HTTP_PORT="127.0.0.1:32782:80" 
MYSQL_PORT="127.0.0.1:32777:3306"
PMA_PORT="32779:80"
POSTGRES_PORT="0:5432"
PGADMIN_PORT="0:80"
```

* Ports are generated during user creation but can be modified by the administrator. After changes, run `compose down && compose up` for the changes to take effect.
* ⚠️ Docker rootless mode prevents the use of ports under **1024**.
* Services should not expose ports externally unless remote access is required (e.g., phpMyAdmin, remote MySQL, or pgAdmin).

---

---

// File: articles/docker/how-does-openpanel-isolate-users

# User Isolation

OpenPanel is built with **security-first architecture**, enforcing multiple levels of isolation to protect user environments.

Isolation Layers:

* **System Isolation**
  Each OpenPanel user corresponds to a system user on the host machine. These users have no login access or passwords and are strictly used for enforcing **storage quotas and ownership**.

* **User Isolation**
  Every OpenPanel account runs inside a **dedicated Docker context**. This ensures one user cannot access, interfere with, or even detect the existence of other users or their containers.

* **Service Isolation**
  Each service within a user’s environment (e.g., PHP, MySQL, Redis) runs in its **own container**. Services are sandboxed even from each other, so if one is compromised (e.g., MySQL), it **cannot affect other containers**, even within the same user.

* **Network Isolation**
  User services are segmented into **internal Docker networks**, such as:

  * `www` for web-facing components (PHP, Nginx, file manager)
  * `db` for databases (MySQL, MariaDB, PostgreSQL)
  * `none` for isolated services (Redis, Memcached)

  This design allows fine-grained control over what services can communicate and also supports **per-user bandwidth throttling**.


```
╔════════════════════════════════════════════════════════════════╗
║                     🖥️  OPENPANEL SERVER                       ║
╠════════════════════════════════════════════════════════════════╣
║  • 🎛️ OpenPanel - user control panel                           ║
║  • ⚙️ OpenAdmin - administration panel                         ║
║  • 🌐 Caddy – Reverse Proxy & SSL                              ║
║  • 🔍 BIND9 – DNS Server                                       ║
║  • 🗄️ MySQL – User Management & Metadata                       ║
║  • 🐳 Docker Engine – Container Orchestration                  ║
╚════════════════════════════════════════════════════════════════╝
                                                   │   
        ┌──────────────────────────────────────────┼──────────────────────────────────────────┐
        │                                          │                                          │
        ▼                                          ▼                                          ▼
┌─────────────────────────────────┐ ┌─────────────────────────────────┐ ┌─────────────────────────────────┐
│           👤 USER 1             │ │           👤 USER 2             │ │           👤 USER 3             │ 
├─────────────────────────────────┤ ├─────────────────────────────────┤ ├─────────────────────────────────┤
│  🌐 Web Server:                 │ │  🌐 Web Server:                 │ │  🌐 Web Server:                 │
│  • Nginx + Varnish              │ │  • Apache                       │ │  • OpenResty + Varnish          │
│                                 │ │                                 │ │                                 │
│  ⚡ Applications:               │ │  ⚡ Applications:               │ │  ⚡ Applications:               │
│  • site1.com → PHP 8.4          │ │  • api.site.com → Node.js 20.1  │ │  • classic.com → PHP 7.0        │
│  • site2.com → PHP 8.2          │ │  • main.site.com → PHP 7.4      │ │  • modern.com → PHP 8.1         │
│  • legacy.com → PHP 7.0         │ │                                 │ │  • vintage.com → PHP 5.6        │
│                                 │ │                                 │ │  • api.site.com → Python 3.11   │
│                                 │ │                                 │ │                                 │
│  🗄️  Databases:                 │ │  🗄️  Databases:                 │ │  🗄️  Databases:                 │
│  • MySQL 8.0                    │ │  • MariaDB 10.11                │ │  • PostgreSQL                   │
│  • phpMyAdmin                   │ │  • phpMyAdmin                   │ │                                 │
├─────────────────────────────────┤ ├─────────────────────────────────┤ ├─────────────────────────────────┤
│  📊 Resource Limits:            │ │  📊 Resource Limits:            │ │  📊 Resource Limits:            │
│  • CPU: 2 cores                 │ │  • CPU: 4 cores                 │ │  • CPU: 1 core                  │
│  • RAM: 4 GB                    │ │  • RAM: 8 GB                    │ │  • RAM: 2 GB                    │
│  • Storage: 50 GB SSD           │ │  • Storage: 100 GB SSD          │ │  • Storage: 25 GB SSD           │
└─────────────────────────────────┘ └─────────────────────────────────┘ └─────────────────────────────────┘
```

---

// File: articles/docker/how-to-add-custom-docker-image-for-openpanel-user

# Adding custom docker images for OpenPanel users

Each user has a Docker service running in [Rootless mode](https://docs.docker.com/engine/security/rootless/) and a single `docker-compose.yml` file that has all their services defined.

For each user you can edit their `/home/USER/docker-compose.yml` file to specify custom services.


## Default services

To edit services for all new users that you create, edit the template files:

- `/etc/openpanel/docker/compose/1.0/docker-compose.yml` - services for users, volumes and networks.
- `/etc/openpanel/docker/compose/1.0/.env` - limits for services.

## Guidelines

You can add **any Docker image** by including its Compose configuration. However, there are a few important **rules** to follow so that OpenPanel can:

* Recognize the service as valid
* Allow editing of resource limits from the GUI
* Enable service start/stop control from the GUI
* Monitor usage statistics
* Enforce resource restrictions

Make sure your service definition follows the required structure to ensure full OpenPanel integration.

| **Name**          | **Description**                                                                                                                                                                                                                                                                                                          | **Example**                                                                                                                           |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------- |
| **service name**  | The service name must exactly match the container_name and **cannot contain spaces**.                                                                                                                                                                                                                                  | For uptimekuma: `container_name: uptimekuma`                                                                                     |
| **env variables** | All variables in the `.env` file must start with the service name in **uppercase**, followed by an underscore. Each service must define `_CPU` and `_RAM` to allow OpenPanel to restrict and monitor resource usage.                                                                                                     | `UPTIMEKUMA_VERSION="1"` `UPTIMEKUMA_CPU="0.5"` `UPTIMEKUMA_RAM="0.5G"`                                                      |
| **image tag**     | The image tag should be a variable, allowing it to be changed via the OpenPanel UI. If not provided, a fallback value is used.                                                                                                                                                                                           | `image: louislam/uptime-kuma:$&#123;UPTIMEKUMA_VERSION:-1&#125;`                                                                      |
| **volumes**       | Mounting host OS paths can expose the server. Use relative paths (e.g., `./data`) for app data. To use existing data like `/var/www/html/`, mount the appropriate volume. If Docker socket access is needed, mount `/hostfs/run/user/$&#123;USER_ID&#125;/docker.sock` as **read-only** to prevent privilege escalation. | `- ./data:/app/data` `- html_data:/var/www/html/` `- /hostfs/run/user/$&#123;USER_ID&#125;/docker.sock:/var/run/docker.sock:ro` |
| **resources**     | Define `cpus`, `memory`, and `pids` under the `deploy.resources.limits` section. Without `pids`, services are vulnerable to fork bombs. Use variables with fallback values for `cpus` and `memory`.                                                                                                                      | `cpus: "$&#123;BUSYBOX_CPU:-0.1&#125;"` `memory: "$&#123;BUSYBOX_RAM:-0.1G&#125;"` pids: 100                                    |
| **networks**      | Only add networks if the service needs access to other containers. Use either `www` or `db` networks. `www` is for app/webserver access; `db` is for database-only access.                                                                                                                                               | `- www` `- db`                                                                                                                     |
| **environment**   | Use the `environment` section to pass custom environment variables.                                                                                                                                                                                                                                                      | `EULA: "TRUE"` `ENABLE_QUERY: "$&#123;MINECRAFT_ENABLE_QUERY:-true&#125;"`                                                         |
| **ports**         | Only define ports if external access is required. For internal-only services (e.g., Redis, Memcached), **do not expose ports**.                                                                                                                                                                                          | `- "$&#123;MYSQL_PORT&#125;"` `- "$&#123;MINECRAFT_PORT:-25565&#125;:25565"`                                                       |
| **labels**        | Labels are optional and ignored by OpenPanel but can be used for external tools or metadata.                                                                                                                                                                                                                             | `- docker-volume-backup.archive-pre=/bin/sh -c '/dump.sh'`                                                                            |
| **healthcheck**   | Optional. If defined, OpenPanel respects the health check and uses it to manage restarts.                                                                                                                                                                                                                                | `test: ['CMD-SHELL', 'mysqladmin ping -h localhost']` `interval: 1s` `timeout: 5s` `retries: 10`                             |
| restart policy    | restart policy should be explicitly set to [unless-stopped](https://docs.docker.com/engine/containers/start-containers-automatically/#use-a-restart-policy) so that OpenPanel can auto-restart services in case of failure, except when user account is suspended.                                                       | `restart: unless-stopped`                                                                                                             |

## Examples

These examples are **drop-in snippets** you can insert into your files to add a new service for an OpenPanel user.

### FileBrowser

To add [FileBrowser](https://github.com/filebrowser/filebrowser) as a service for user in OpenPanel:

add to .env file:

```bash
# FILEBROWSER
FILEBROWSER_VERSION="s6"
FILEBROWSER_CPU="0.25"
FILEBROWSER_RAM="0.35"
```

add to `docker-compose.yml` file in the **services** section:

```bash
  filebrowser:
    image: filebrowser/filebrowser:${FILEBROWSER_VERSION:-s6}
    container_name: filebrowser
    volumes:
      - html_data:/srv
      - ./filebrowser/config/:/config/
      - ./filebrowser/database/:/database/
    environment:
      - PUID=${USER_ID:-0}
      - PGID=${USER_ID:-0}
    restart: unless-stopped
    deploy:
      resources:
        limits:
          cpus: "${FILEBROWSER_CPU:-0.35}"
          memory: "${FILEBROWSER_RAM:-0.35G}"   
          pids: 100
    networks:
      - www
```




### Minecraft

To add [Minecraft](https://github.com/itzg/docker-minecraft-server) as a service for user in OpenPanel:

add to .env file:

```bash
# MINECRAFT
MINECRAFT_VERSION="latest"
MINECRAFT_PORT="25565"
MINECRAFT_CPU="1.0"
MINECRAFT_RAM="1.0G"
MINECRAFT_ENABLE_QUERY="true"
MINECRAFT_MAX_PLAYERS="20"
MINECRAFT_MAX_WORLD_SIZE="10000"
MINECRAFT_ALLOW_NETHER="false"
MINECRAFT_ANNOUNCE_PLAYER_ACHIEVEMENTS="false"
MINECRAFT_ENABLE_COMMAND_BLOCK="false"
```

add to `docker-compose.yml` file in the **volumes** section:

```bash
  mc_data:
    driver: local
    labels:
      description: "This volume holds the minecraft data directory."
      purpose: "storage"
```

add to `docker-compose.yml` file in the **services** section:

```bash
  minecraft:
    image: itzg/minecraft-server:${MINECRAFT_VERSION:-latest}
    container_name: minecraft
    tty: true
    stdin_open: true
    ports:
      - "${MINECRAFT_PORT:-25565}:25565"
    environment:
      EULA: "TRUE"
      ENABLE_QUERY: "${MINECRAFT_ENABLE_QUERY:-true}"
      QUERY_PORT: "${MINECRAFT_PORT:-25565}"
    volumes:
      - mc_data:/data
    deploy:
      resources:
        limits:
          cpus: "${MINECRAFT_CPU:-1.0}"
          memory: "${MINECRAFT_RAM:-1.0G}"
          pids: 100
    healthcheck:
      test: mc-health
      start_period: 1m
      interval: 5s
      retries: 20
    networks:
      - www
```




### MsSQL

To add [MsSQL](https://hub.docker.com/r/microsoft/mssql-server) as a service for user in OpenPanel:

add to .env file:

```bash
# MSSQL
MSSQL_IMAGE="mcr.microsoft.com/mssql/server"
MSSQL_VERSION="latest"
MSSQL_PID="Standard"
MSSQL_PORT="0:1433"
MSSQL_CPU="1.0"
MSSQL_RAM="1.0G"
MSSQL_SA_PASSWORD="rootpassword"
```

add to `docker-compose.yml` file in the **volumes** section:

```bash
  mssql_data:
    driver: local
    labels:
      description: "This volume holds the MSSQL databases."
      purpose: "database"      
```

add to `docker-compose.yml` file in the **services** section:

```bash
  mssql:
    image: ${MSSQL_IMAGE}:${MSSQL_VERSION:-latest}
    container_name: mssql
    restart: unless-stopped
    environment:
      ACCEPT_EULA: "Y"
      MSSQL_SA_PASSWORD: ${MSSQL_SA_PASSWORD:-StrongPassword!}
      MSSQL_PID: ${MSSQL_PID:-Developer}  # Options: Developer, Express, Standard, Enterprise
    ports:
      - "${MSSQL_PORT}"
    volumes:
      - mssql_data:/var/opt/mssql                                      # MSSQL data
      - ./sockets/mssql:/var/opt/mssql/sockets          # MSSQL socket
      - ./mssql.conf:/etc/mssql/mssql.conf:ro           # Custom MSSQL config
    deploy:
      resources:
        limits:
          cpus: "${MSSQL_CPU:-1}"
          memory: "${MSSQL_RAM:-2G}"
          pids: 100
    networks:
      - db
    healthcheck:
      test: ['CMD-SHELL', 'sqlcmd -S localhost -U sa -P "$$MSSQL_SA_PASSWORD" -Q "SELECT 1" || exit 1']
      interval: 10s
      timeout: 5s
      retries: 5

```


### UptimeKuma

To add [UtimeKuma](https://github.com/louislam/uptime-kuma) as a service for user in OpenPanel:

add to .env file:

```bash
# UPTIMEKUMA
UPTIMEKUMA_VERSION="1"
UPTIMEKUMA_CPU="0.5"
UPTIMEKUMA_RAM="0.5G"
```

add to `docker-compose.yml` file in the **services** section:

```bash
  uptimekuma:
    image: louislam/uptime-kuma:${UPTIMEKUMA_VERSION:-1}
    container_name: uptimekuma
    volumes:
      - ./data:/app/data
      - /hostfs/run/user/${USER_ID}/docker.sock:/var/run/docker.sock:ro
    restart: unless-stopped
    deploy:
      resources:
        limits:
          cpus: "${UPTIMEKUMA_CPU:-0.35}"
          memory: "${UPTIMEKUMA_RAM:-0.35G}"   
          pids: 100
    networks:
      - www
```




### BusyBox

This example adds busybox container, its an example on how to add any docker compose service:

add to .env file:

```bash
# BUSYBOX
BUSYBOX_CPU="0.1"
BUSYBOX_RAM="0.1G"
```

add to `docker-compose.yml` file in the **services** section:

```bash
  busybox:
    image: busybox
    container_name: busybox          
    restart: unless-stopped
    working_dir: /var/www/html
    deploy:
      resources:
        limits:
          cpus: "${BUSYBOX_CPU:-0.1}"
          memory: "${BUSYBOX_RAM:-0.1G}"   
          pids: 100
    volumes:
      - html_data:/var/www/html/
```

---

// File: articles/docker/how-to-remove-resource-limits-for-user-service-containers

# Unlimited CPU&RAM

Setting unlimited CPU and RAM resources allows an OpenPanel user account to consume all available CPU cores and physical memory on the server.

**This is strongly discouraged**, even on a single-user VPS, as a rogue process or compromised website could destabilize the entire system. It's important to set resource limits to ensure the system has enough capacity for essential services such as monitoring, container orchestration, DNS, and more.

If you still want to enable unlimited resources, follow these steps carefully:

## Remove Limits from the User Plan

Set both the CPU and RAM limits to `0` (zero) in the plan settings to remove restrictions:

![userlimits.png](/img/panel/v2/userlimits-guide.png)

----

## Remove Docker Resource Limits


### For existing user

Run this command to remove CPU, memory, and PID limits from all services defined in the user's Docker Compose file. Replace `dorotea` with the actual username:

```bash
USERNAME=dorotea && \
sed -i '/deploy:/,/^[^[:space:]]/{
  /deploy:/d
  /resources:/d
  /limits:/d
  /cpus:/d
  /memory:/d
  /pids:/d
}' /home/$USERNAME/docker-compose.yml
```

If the user already has running services, stop and restart them to apply the changes (replace `dorotea` with the username):

```bash
USERNAME=dorotea && \
cd /home/$USERNAME && \
running_services=$(docker --context=$USERNAME compose ps --services --filter "status=running") && \
docker --context=$USERNAME compose down && \
docker --context=$USERNAME compose up -d $running_services
```


### For All new users

To ensure all new users have unlimited CPU and RAM by default, apply the same `sed` commands to the Docker Compose template used for new accounts:

```bash
sed -i '/deploy:/,/^[^[:space:]]/{
  /deploy:/d
  /resources:/d
  /limits:/d
  /cpus:/d
  /memory:/d
  /pids:/d
}' /etc/openpanel/docker/compose/1.0/docker-compose.yml
```

---


Once these changes are applied, any new or restarted services will be able to consume all available system resources. The control panel will display a warning to users indicating that CPU and RAM limits are disabled:

![userlimits3.png](/img/panel/v2/userlimits-guide3.png)

---

// File: articles/docker/how-to-set-mysql-mariadb-per-user-in-openpanel

# MySQL, MariaDB, or Percona

When creating a user, you can select which MySQL-compatible database type to use:

* **MySQL**
* **MariaDB**

Users also have the *Change MySQL Type* option, which allows switching between these types after creation.

Administrators can configure the default database type for new users from [**OpenAdmin > Settings > User Defaults**](/docs/admin/settings/defaults/).

---

## MySQL

[MySQL](https://www.mysql.com/) can be assigned either to all new users by default or to individual users during creation.

### Set for a Single User

To set MySQL for a single user during creation:

1. Open the **New User** form.
2. Under the **Advanced** section, select **MySQL** as the database type.

![mysql for user](/img/guides/mysql.png)

### Set as Default

To make MySQL the default for all newly created users:

* Go to [**OpenAdmin > Settings > User Defaults**](/docs/admin/settings/defaults/) and select **MySQL** as the default database type.

![mysql as default](/img/guides/mysql_default.png)

---

## MariaDB

[MariaDB](https://mariadb.org/) can be assigned either to all new users by default or to individual users during creation.

### Set for a Single User

To set MariaDB for a single user during creation:

1. Open the **New User** form.
2. Under the **Advanced** section, select **MariaDB** as the database type.

![mariadb for user](/img/guides/mariadb.png)


### Set as Default

To make MariaDB the default for all newly created users:

* Go to [**OpenAdmin > Settings > User Defaults**](/docs/admin/settings/defaults/) and select **MariaDB** as the default database type.

![mariadb as default](/img/guides/mariadb_default.png)

---

## Percona

[Percona](https://www.percona.com/mysql/software) is a drop-in replacement for MySQL. It can be set by changing the Docker image from `mysql` to `percona`. The interface and all actions remain fully compatible.

### Set for a Single User

To set Percona for a single user during creation:

1. Open the **New User** form.
2. Under the **Advanced** section, select **MySQL** as the database type.
3. Create the user.
4. Edit the user's Compose file and change the MySQL image to `percona`.

![percona for user](/img/guides/percona.png)

### Set as Default

To make Percona the default for all newly created users:

* Go to [**OpenAdmin > Settings > User Defaults > Advanced**](/docs/admin/settings/defaults/)
* Change the MySQL service image to `percona`.

![percona as default](/img/guides/percona_default.png)

---

// File: articles/docker/how-to-set-nginx-apache-varnish-per-user-in-openpanel

# Apache, Nginx, OpenResty, OpenLiteSpeed, and Varnish

Configuring Nginx, Apache, OpenResty, OpenLiteSpeed, and Varnish per user in OpenPanel.

When creating a user, you can set the webserver type to be used:

- Apache
- Apache + Varnish
- Nginx
- Nginx + Varnish
- OpenResty
- OpenResty + Varnish
- OpenLitespeed
- OpenLitespeed + Varnish


**Web servers comparison**:

| Feature / Webserver              | Apache                             | Nginx                                    | OpenResty                                | OpenLiteSpeed                                    |
| -------------------------------- | ---------------------------------- | ---------------------------------------- | ---------------------------------------- | ------------------------------------------------ |
| **Varnish Support**              | Yes                              | Yes                                    | Yes                                    | Yes                                            |
| **.htaccess Support**            | Full                             | None (requires editing VHost files)    | None (requires editing VHost files)             | Full ([with some limitations](https://docs.openlitespeed.org/config/rewriterules/))                   |
| **Multiple PHP Versions**        | Yes                        | Yes            | Yes            | No, just 1 version                            |
| **Performance (static content)** | Moderate                           | High                                     | High                                     | High                                             |
| **Performance (dynamic PHP)**    | Moderate                           | High                                     | High                                     | Very High                                        |
| **Ease of User Overrides**       | .htaccess or VHost Editor | Only via VHost Editor       | Only via VHost Editor          | .htaccess or VHost Editor      |
| **Memory Footprint**      | Moderate (~50–100 MB per process) | Low (~10–30 MB per worker)              | Low (~15–40 MB per worker)              | Moderate (~30–60 MB per process)                |
| **Docker Size**            | ~200 MB                           | ~120 MB                                 | ~150 MB                                 | ~1000 MB                                         || **Recommended Use Cases**        | Legacy apps, .htaccess-heavy sites | High-performance static or dynamic sites | Advanced Lua scripting, high concurrency | High-performance PHP hosting, WordPress, Laravel |

> **Notes:**
>
> * Memory / disk footprint values are approximate and depend on configuration and traffic.
> * Varnish can offload static content, reducing webserver load significantly.
> * With 'docker' module, users can switch webserver type anytime via **Change Webserver Type** page.
> * OpenLiteSpeed is generally best for high-performance PHP apps that need .htaccess support.

---

Administrators can select the default webserver to be used from [*OpenAdmin > Settings > User Defaults*](/docs/admin/settings/defaults/) page.

---

## Apache

[Apache](https://httpd.apache.org/) can be assigned either to all new users by default or to individual users during account creation.

### Set for a Single User

To set Apache for a single user during creation:

1. Open the **New User** form.
2. Under the **Advanced** section, select **Apache** as the webserver.

![apache for user](/img/guides/apache.gif)

> **Tip:** To enable Varnish for this user, simply turn **Varnish Cache ON** on the same page.

### Set as Default

To make Apache the default for all newly created users:

* Go to [**OpenAdmin > Settings > User Defaults**](/docs/admin/settings/defaults/) and select **Apache** as the default webserver.


---

## Nginx

[Nginx](https://httpd.apache.org/) can be assigned either to all new users by default or to individual users during account creation.

### Set for a Single User

1. Open the **New User** form.
2. Under **Advanced**, select **Nginx** as the webserver.

![nginx for user](/img/guides/nginx.gif)

> **Tip:** Enable Varnish Cache ON if you want to use **Nginx + Varnish**.

### Set as Default

* Go to [**OpenAdmin > Settings > User Defaults**](/docs/admin/settings/defaults/) and select **Nginx** as the default webserver.

---

## OpenResty

[OpenResty](https://openresty.org/) can be assigned either to all new users by default or to individual users during account creation.


### Set for a Single User

1. Open the **New User** form.
2. Under **Advanced**, select **OpenResty**.

![openresty for user](/img/guides/openresty.gif)

> **Tip:** Turn **Varnish Cache ON** for **OpenResty + Varnish**.

### Set as Default

* Go to [**OpenAdmin > Settings > User Defaults**](/docs/admin/settings/defaults/) and select **OpenResty** as default.

---

## OpenLiteSpeed

[OpenLiteSpeed](https://openlitespeed.org/) can be assigned either to all new users by default or to individual users during account creation.

### Set for a Single User

1. Open the **New User** form.
2. Under **Advanced**, select **OpenLiteSpeed**.

![openlitespeed for user](/img/guides/openlitespeed.gif)

> **Tip:** Enable **Varnish Cache ON** to combine OpenLiteSpeed with Varnish.

### Set as Default

* Go to [**OpenAdmin > Settings > User Defaults**](/docs/admin/settings/defaults/) and select **OpenLiteSpeed** as default.

---

// File: articles/docker/how-to-troubleshoot-services-with-openpanel

# Troubleshooting service issues with OpenPanel

If you've run into issues with a service that is managed by OpenPanel and your account has the Docker feature enabled you can use it to restart the service container and check the logs for further troubleshooting.

Simpy go to Openpanel > Docker > Containers and try stopping/starting the service container:

![containersGUI.png](/img/docs-content/650sKYW3-containersgui.png)

To check logs go to Openpanel > Docker > Logs and select a container from the dropdown menu to view it's logs:

![containersLogsGUI.png](/img/docs-content/Fzh4bqF1-containerlogsgui.png)

If the Docker feature is not enabled for your account contact your administrator so they can check further.

## Troubleshooting service issues as an Administrator 

Login to OpenAdmin on port 2087 , go to Users and click on an username start managing that account:

![containersAdmin1.png](/img/docs-content/rpYjNt8p-containers-Admin1.png)

Within the user management page go to the Services tab and Enable/Disable the service:

![containersAdmin2.png](/img/docs-content/hv4G4hdV-containers-Admin2.png)

If restarting the container doesn't solve the issue you'll need to troubleshoot further, access the server via SSH and investigate by running the following commands:

`machinectl shell $username@ /bin/bash -c 'systemctl --user status'` (replace $username with the OpenPanel user)

A status overview of the user’s own systemd service manager will be displayed:

![containersAdminSSH1](/img/docs-content/FKRzQY0S-containers-Admin-SSH1.png)

`machinectl shell $username@ /bin/bash -c 'journalctl --user -u $docker'` (replace $username with the OpenPanel user)

The Docker service logs will be displayed:

![containersAdminSSH2](/img/docs-content/6qjwc0mJ-containers-Admin-SSH2.png)

In case you don't find any errors or potential causes within the output of these commands you should start the service container manually and watch the logs with the command:

`cd /home/$username && docker --context=$username compose up SERVICE_NAME` (replace $username with the OpenPanel user and SERVICE_NAME with the name of the service you are troubleshooting)

---

// File: articles/docker/how-traffic-flows-in-openpanel

# How Web Traffic Flows with User Containers

Caddy is the **entry point** for all incoming web traffic.
When the first domain is added, Caddy automatically starts and begins listening on ports **80** (HTTP) and **443** (HTTPS).

Caddy is responsible for:

* **SSL certificates & renewals**
* **Redirects (HTTP → HTTPS)**
* **Web Application Firewall (CorazaWAF)**
* **Reverse proxying to user webservers**

---

## Per-User Webservers

Each user runs their own isolated **webserver instance** on a unique local port.
Supported webservers include:

* **Nginx**
* **Apache**
* **OpenResty**
* **OpenLiteSpeed**
* **Varnish**

Caddy forwards requests to the correct user’s webserver, based on domain configuration.

---

## Application Containers

The user’s webserver then proxies requests into **application containers**, such as:

* **PHP-FPM (multiple versions supported)**
* **Node.js**
* **Python / Django / Flask**
* **Docker containers**

Example flow for a PHP app:

```
Client → Caddy → Nginx → PHP-FPM container
```

Example flow for a Node.js app:

```
Client → Caddy → Nginx → Node.js container
```

---

## Handling Multiple PHP Versions

Each user runs its own **PHP-FPM container version**, ensuring compatibility with different frameworks or legacy apps. Multiple PHP versions (7.4, 8.0, 8.1, 8.2, 8.3, etc.) can coexist safely for a userL

Example:

```
Site A
Client → Caddy → Nginx → PHP-FPM-8.2

Site B
Client → Caddy → Nginx → PHP-FPM-7.4

Site C
Client → Caddy → Nginx → PHP-FPM-8.3
```
---

## Using Varnish (Optional)

If a user enables **Varnish caching**, it sits between Caddy and the webserver:

```
Client → Caddy → Varnish → Webserver → php container
```

This allows caching and performance acceleration before hitting the backend.

---

## Example Flows

### PHP (Nginx + PHP-FPM-8.2)

```
Client → Caddy          (SSL, WAF, redirects)  
       → Nginx          (per-user webserver)  
       → PHP-FPM-8.2    (specific PHP version)
```

### PHP (with Varnish + PHP-FPM-8.1)

```
Client → Caddy          (SSL, WAF, redirects)
       → Varnish        (caching)  
       → Nginx          (per-user webserver)  
       → PHP-FPM-8.1    (specific PHP version)
```

### Node.js

```
Client → Caddy          (SSL, WAF, redirects)
       → Nginx          (per-user webserver)  
       → Node.js        (user’s container)
```

### OpenLiteSpeed (with built-in LSPHP)

```
Client → Caddy          (SSL, WAF, redirects)  
       → OpenLiteSpeed  (VHost + lsphp runtime)
```

---

✅ **In short:**
**Caddy is always the first entry point** → routes traffic to a user’s **webserver** → which proxies requests to the user’s **application container (PHP version, Node.js, etc.)**.

---

// File: articles/docker/https-wordpress-behind-varnish-proxy

# Using Varnish with WordPress

Varnish does not support SSL, so you need to terminate TLS before passing requests to it, then after receiving http from Varnish, use again https.

For WordPress, adding the following code in wp-config.php is enough:

```
define('FORCE_SSL_ADMIN', true); if ($_SERVER['HTTP_X_FORWARDED_PROTO'] == 'https') $_SERVER['HTTPS']='on';
```


> **EDIT**: From version 1.5.7 this is automatically added for new WP installations.

---

// File: articles/docker/import-database

# Importing a Database

You can import tables into a MySQL/MariaDB database using one of the following methods:

* **Import Database** feature (via OpenPanel)
* **phpMyAdmin** interface
* **Terminal** feature (via OpenPanel)

---

## 1. Import Database (via OpenPanel)

The **Import Database** feature must be enabled on your plan for the option to appear in your OpenPanel dashboard.
Once available, follow the guide here: [Database Import Documentation](/docs/panel/mysql/import/)

---

## 2. Using phpMyAdmin

If the **phpMyAdmin** feature is enabled:

* Open phpMyAdmin from your dashboard.
* Select your target database.
* Use the **Import** tab to upload and execute your `.sql` file.

Alternatively, you can upload the SQL file using the **File Manager** to the `/var/www/html` directory. The uploaded files will then be visible on the phpMyAdmin import page.

Documentation: [phpMyAdmin Import Guide](https://openpanel.com/docs/panel/mysql/phpmyadmin/)

---

## 3. Using Terminal (Docker)

To use terminal access:

* The **Docker** feature must be enabled on your plan for container access to be visible in OpenPanel.
* Once enabled, select your MySQL/MariaDB container from the dashboard.
* Open the terminal and run the following commands to import your SQL file:

```bash
mysql

USE your_database_name;

wget https://example.com/some_file.sql

SOURCE ./your_file.sql;
```

---

// File: articles/docker/network-isolation-openpanel

# Network Isolation in OpenPanel

OpenPanel uses containers to isolate services for each user. These containers are then further segregated into local networks, providing an additional layer of isolation.

This setup ensures that containers within the same network can communicate securely, without exposing ports to the public internet.

## Available Networks

Containers can be assigned to one of three networks:

* **`db`** – containers that need database access
* **`www`** – containers that need webserver or caching access
* **`no network`** – containers with no access to other containers

Communication between containers in the same network can be done using container names as hostnames. For example, PHP containers can connect to MySQL simply by using `mysql` or `mariadb` as the hostname.

---

## `db` Network

The **db** network is designed for services that need access to databases.

By default, this network includes:

* MySQL
* MariaDB
* phpMyAdmin
* PostgreSQL
* PgAdmin
* Tor
* PHP-FPM services

If you are adding a custom service (container) that needs to connect to a database, you should attach it to the `db` network.

---

## `www` Network

The **www** network is used for services that need access to webservers, caching, or search engines.

By default, this network includes:

* OpenLiteSpeed
* Apache
* Nginx
* Varnish
* Tor
* Redis
* Memcached
* Elasticsearch
* OpenSearch
* PHP-FPM services

If you are adding a custom service (container) that needs to communicate with a webserver, Redis, or Memcached, you should attach it to the `www` network.

---

## `no network`

Containers without a network are completely isolated and cannot communicate with other containers.

These containers are typically only accessible through the terminal or the OpenPanel UI. They are ideal for services that do not require interaction with databases, webservers, or other containers.

---

// File: articles/docker/troubleshooting-caddy-webserver

# Troubleshooting Caddy Webserver

OpenPanel uses Caddy webserver to handle SSL and reverse proxy to per-user webservers.

If Caddy is disabled, all websites hosted on the server are down.

To troubleshoot Caddy-related issues:

## 1. Check if Caddy is running

Run:

```bash
curl -I localhost
```

You should see `Server: Caddy` in the response, for example:

```
root@demo:~# curl -I localhost
HTTP/1.1 308 Permanent Redirect
Connection: close
Location: https://localhost/
Server: Caddy
Date: Thu, 23 Oct 2025 13:11:03 GMT
```

If it appears, **Caddy is running properly**. If a specific website or domain isn’t working, troubleshoot that domain individually.

---

## 2. Check Caddy status

Check if Caddy is 'active' or 'running':

```bash
docker ps -a
```

If the status is `exited`, `restarting`, or `starting`, it indicates an issue with the container.

---

## 3. Validate the configuration

If Caddy has a syntax error in the main configuration file or any domain configuration, it may exit on startup and restart repeatedly.

To validate the configuration:

```bash
docker exec caddy caddy validate --config /etc/caddy/Caddyfile
```

* `warn` or `info` messages are fine.
* Any `error` messages must be resolved before Caddy will start correctly.

Main configuration file for Caddy is: `/etc/openpanel/caddy/Caddyfile` and per-domain files are stored in: `/etc/openpanel/caddy/domains/*.conf`

---

## 4. Increase resource limits

By default, Caddy is limited to 1 CPU core and 1GB RAM. To increase the limits:

1. Edit the `.env` file:

```bash
nano /root/.env
```

2. Adjust the values:

```
CADDY_CPU="1.0"
CADDY_RAM="1.0G"
```

3. Save the file and rebuild the container:

```bash
cd /root
docker compose down caddy
docker compose up -d caddy
```

---

## 5. View logs

If the above steps don’t resolve the issue, check the logs:

```bash
docker logs -f caddy
```

Copy any errors and search online or post them on [our Discord channel](https://discord.openpanel.com/) or [OpenPanel forums](https://community.openpanel.org/t/openadmin) for help.

---

// File: articles/docker/volume-management-openpanel

# Volume Management in OpenPanel

OpenPanel uses **volumes** to persist important user data across container restarts and updates.
Unlike container storage, which is ephemeral, volumes ensure that your databases, website files, and configurations remain intact even if containers are removed or recreated.

This setup provides both **data persistence** and **logical separation of responsibilities**, so each service stores its data in a dedicated, isolated volume.

---

## Available Volumes

OpenPanel provides several pre-configured volumes, each serving a specific purpose:

| Volume Name      | Description                                                 | Physical Location on OS                                             |
| ---------------- | ----------------------------------------------------------- | ------------------------------------------------------------------- |
| `mysql_data`     | Persistent storage for MySQL/MariaDB databases              | `/home/USERNAME/docker-data/volumes/USERNAME_mysql_data/_data/`     |
| `mysql_dumps`    | Storage for database backups in `.sql` format               | `/home/USERNAME/docker-data/volumes/USERNAME_mysql_dumps/_data/`    |
| `html_data`      | Persistent storage for website files under `/var/www/html/` | `/home/USERNAME/docker-data/volumes/USERNAME_html_data/_data/`      |
| `mail_data`      | Persistent storage for mailboxes under `/var/mail/`         | `/home/USERNAME/docker-data/volumes/USERNAME_mail_data/_data/`      |
| `webserver_data` | Storage for webserver vhost configurations                  | `/home/USERNAME/docker-data/volumes/USERNAME_webserver_data/_data/` |
| `pg_data`        | Persistent storage for PostgreSQL databases                 | `/home/USERNAME/docker-data/volumes/USERNAME_pg_data/_data/`        |

---

## `mysql_data` Volume

The **mysql_data** volume is where MySQL and MariaDB databases are stored.
It ensures that database data persists even if the database container is restarted or rebuilt.

* Path inside container: `/var/lib/mysql`
* Purpose: **Database persistence**

---

## `mysql_dumps` Volume

The **mysql_dumps** volume holds backup `.sql` dumps generated during backup operations.
It is separate from the main database volume to keep live data and backups isolated.

* Typical contents: `.sql` dump files
* Purpose: **Backup storage**

---

## `html_data` Volume

The **html_data** volume maps to the `/var/www/html/` directory used by web servers.
This is where website source files (PHP, HTML, JS, assets) are stored.

* Path inside container: `/var/www/html/`
* Purpose: **Website storage**

---

## `mail_data` Volume

The **mail_data** volume stores all email data, including user mailboxes.
This ensures mail persists independently of the mail service container lifecycle.

* Path inside container: `/var/mail/`
* Purpose: **Mail persistence**

---

## `webserver_data` Volume

The **webserver_data** volume is used to store configuration files for webservers such as Nginx or Apache.
This allows vhost configurations to persist across restarts and be easily modified.

* Typical contents: Virtual host configs, SSL configs
* Purpose: **Webserver configuration storage**

---

## `pg_data` Volume

The **pg_data** volume holds PostgreSQL database files.
Like `mysql_data`, this ensures database persistence and durability.

* Path inside container: `/var/lib/postgresql/data`
* Purpose: **Database persistence**

---

✅ With these volumes, OpenPanel cleanly separates **data**, **backups**, **configurations**, and **service-specific files**, ensuring both persistence and maintainability.

---

// File: articles/domains/403-error-on-website-disable-coraza-waf

# 403 Error Troubleshooting Guide

This guide covers the most common causes of **403 Forbidden** errors on a website and how to resolve them.

---

## 1. Coraza WAF

One of the most common causes is the **Coraza WAF** blocking access according to **ModSecurity CoreRuleSet** rules.

1. Navigate to **Advanced > WAF** in your hosting control panel.
   ![WAF disable](/img/docs-content/fZw2Skqv-waf-status.png)

2. Check if WAF is enabled for the domain. Temporarily disable it, then test the website to confirm if WAF is the cause.

3. If WAF is the issue:

   * **Not recommended:** Leave WAF disabled for the domain.
   * **Better option:** Identify the exact rule being triggered and disable only that rule.

4. To find the rule:

   * Click **View Logs** to open ModSecurity logs.
   * Search for your 403 request by IP, time, or request details.
   * Note the **Rule ID**.

5. Go to **Manage Rules** for the domain in the WAF section:

   * Disable by Rule ID: [SecRuleRemoveByID](https://coraza.io/docs/seclang/directives/#secruleremovebyid)
   * Disable by Tag: [SecRuleRemoveByTag](https://coraza.io/docs/seclang/directives/#secruleremovebytag)

   ![WAF edit rules](/img/docs-content/GcSm9Xzm-2025-08-13-11-58.png)

6. Re-enable WAF and retest the website.

---

## 2. WordPress

Content management systems like **WordPress** use `.htaccess` files that may block access.

1. Temporarily rename or remove the `.htaccess` file in your website’s root directory.
2. Create a simple test file (e.g., `index.php`) and open it in the browser.
3. If it loads, the issue is CMS-related.
4. Possible fixes:

   * Disable WordPress plugins temporarily.
   * Restore the default `.htaccess` file.
   * Seek help on your CMS forums or [OpenPanel Community](https://community.openpanel.org/).

---

## 3. File Permissions

Incorrect file ownership or permissions can also trigger 403 errors.

1. Open **File Manager** and navigate to the domain’s directory.

2. Click **Options** and enable **Owner** and **Group** columns.
   ![File manager owner](/img/docs-content/cZ4FdrY4-2025-08-13-11-52.png)

3. Ensure all files have the same owner and group.

4. Check file and folder permissions.

5. If ownership is incorrect, use **Files > Fix Permissions** to restore defaults.

---

## 4. Sensitive files

By default, webserver blocks access to sensitive files:

```
.git
composer.json
composer.lock
auth.json
config.php
wp-config.php
vendor
```

If you are sure you want these files accessible (not recommended), edit the domain’s VHost configuration.

### For OpenResty / Nginx:

```nginx
# <!-- BEGIN EXPOSED RESOURCES PROTECTION -->
location ~* ^/(\.git|composer\.(json|lock)|auth\.json|config\.php|wp-config\.php|vendor) {
    deny all;
    return 403;
}
# <!-- END EXPOSED RESOURCES PROTECTION -->
```

### For Apache:

```apache
# <!-- BEGIN EXPOSED RESOURCES PROTECTION -->
<Directory <DOCUMENT_ROOT>>
    <FilesMatch "\.(git|composer\.(json|lock)|auth\.json|config\.php|wp-config\.php|vendor)">
        Require all denied
    </FilesMatch>
</Directory>
# <!-- END EXPOSED RESOURCES PROTECTION -->
```

---

// File: articles/domains/bad-gateway-502-error-troubleshooting

# 502 Error Troubleshooting Guide

This guide explains the most common causes of **502 Bad Gateway** errors and how to fix them.

---

## 1. PHP-FPM Not Running

A 502 Bad Gateway error is common when using Nginx. It means the web server (Nginx) did not receive a response from the backend (such as PHP-FPM, Node.js, or Python).

**Steps to check PHP-FPM:**

1. Verify that the PHP service is running.
   If Docker feature is enabled, go to **Docker > Containers** and check the status of the PHP container.
   If inactive, start it.
   ![screenshot](/img/docs-content/wx8Dm4XP-image.png)

---

## 2. Restart Nginx

Even if PHP-FPM is running, Nginx may have started before it and failed to connect on the first attempt, causing cached errors.

**Fix:** Restart Nginx.

* If using Docker feature:
  Go to **Docker > Containers**, disable Nginx, then enable it again.
  ![screenshot](/img/docs-content/jRdPP7fs-image.png)

* If you do not have access to Docker feature, simply add another domain in order to restart Nginx:
  Go to **Domains > Add New**, insert domain name and click on 'Add'.
  ![screenshot](/img/docs-content/Bs9FNyF7-image.png)

---

## 3. Disable Varnish Cache

Sometimes a 502 error is cached by Varnish, even if the backend issue is resolved. If you are using Varnish Cache:

**Steps:**

1. Go to **Caching > Varnish** and disable it for the affected domain.
   ![screenshot](/img/docs-content/0krVf4Jy-image.png)
2. Reload the website in your browser.

You can also bypass cache by adding parameters to the URL:

* Example: `example.net?test` or `example.net?cachebypass`

If disabling Varnish resolves the issue, stop and start it to clear all cached entries.

---

## 4. Verify VirtualHosts

A misconfigured VirtualHost may cause Nginx to proxy requests to a backend that no longer exists. if you have access to the *edit_vhost* feature:

**Steps:**

1. Go to **Domains > [Select Domain] > Edit VHosts**.
   ![screenshot](/img/docs-content/mbSrwXWJ-image.png)
2. Check the proxy target (e.g., PHP service name or container).
   ![screenshot](/img/docs-content/rVPMn7nn-image.png)
3. Ensure the service name is spelled correctly and still exists.

---

With these steps, you should be able to identify and fix the most common causes of **502 Bad Gateway** errors.

---

// File: articles/domains/domain-shows-default-page

# Domain Shows Default Page

When you add a domain to **OpenPanel**, it will initially display the following message:

> **Ready, set, internet 🎉**
> This domain currently has no website. Please check back later.

This default page will appear until an `index.php` or `index.html` file is present in the domain’s document root.

![Default page](/img/docs-content/Zn8gbHm6-2025-08-13-12-20.png)

**Solution:**
Upload your website files (including an `index.php` or `index.html`) to the document root. Once uploaded, your website will replace the default page.

---

## Caching Issue

If **Varnish caching** is enabled and you access the domain before it has content, the default page may get cached.
This means that even after you upload your site, the cached default page could still be shown.

**How to fix:**

* Temporarily disable and then re-enable Varnish caching for the domain, or
* Completely disable and re-enable Varnish to clear all cached content.

**Disable Varnish for a specific domain:**

1. Go to **OpenPanel > Cache > Varnish**
2. Disable Varnish for that domain

![Disable Varnish cache for domain](/img/docs-content/dwSGj2qk-2025-08-13-12-25.png)

**Purge all Varnish cache:**
Simply click **Disable**, then **Enable** on the same page.

---

## Customize the Default Page

Administrators can change the default page shown on domains without content.

To customize:

1. In **OpenAdmin**, go to **Domains > Edit Domain Templates**
2. Modify the HTML code for the default page

![Edit default page in OpenAdmin](/img/docs-content/JRx0Qm3T-2025-08-13-12-28.png)

---

// File: articles/domains/gateway-timeout-504-error-troubleshooting

# 504 Error Troubleshooting Guide

This guide explains the most common causes of **504 Gateway Timeout** errors and how to fix them.

---

## 1. Restart PHP-FPM 

A 502 Bad Gateway error is common when using Nginx. It means the web server (Nginx) did not receive a response in time from the backend (such as PHP-FPM, Node.js, or Python).

**Steps to check PHP-FPM:**

1. Verify that the PHP service is running.
   If Docker feature is enabled, go to **Docker > Containers** and check the status of the PHP container.
   If inactive, start it.
   ![screenshot](/img/docs-content/wx8Dm4XP-image.png)
   If active, stop and start it again. This will terminate any background processes that might be stuck.

---

## 2. Wait

If you are not the website owner and have no access to OpenPanel account, the only thing you can do is notify the owner for this issue and wait till website starts responding again.

---

## 3. Update WHMCS

A 504 error can sometimes occur in WHMCS if it hasn’t been updated regularly. The solution is to update WHMCS to the latest version.
[Guide on updating WHMCS](https://docs.whmcs.com/8-13/system/updates/updating-whmcs/)


With these steps, you should be able to identify and fix the most common causes of **504 Gateway Timeout** errors.

---

// File: articles/domains/how-to-add-additional-hosts-in-spf

# Adding Additional Hosts to SPF Records

To include a specific host in SPF records across all domains, follow the instructions below.

---

## For Existing Domains

Use the following `sed` command to append a new host (e.g., `include:example.com`) to all SPF records in the zone files on the server:

```
sed -i 's/\(v=spf1\)/\1 include:example.com/' /etc/bind/zones/*.zone
```

---

## For New Domains

To ensure new domains include this host in their SPF records automatically:

1. Go to:
   `OpenAdmin > Domains > DNS Zone Templates`

2. Edit the zone template, include the desired hosts in the SPF entry:

   ```
   "v=spf1 include:example.com ~all"
   ```

This will ensure any newly created domain uses the updated SPF policy.

---

// File: articles/domains/how-to-configure-nameservers-in-openpanel

# Configure Nameservers

Before adding any domains, it is important to first create nameservers to ensure valid DNS zone files and proper propagation.

Configuring Nameservers involves two key steps:

1. **Create private nameservers (glue DNS records)** for your domain through your domain registrar.
2. **Add the nameservers** to the OpenPanel configuration.

Tutorials for Popular Domain Providers

- [Cloudflare](https://developers.cloudflare.com/dns/additional-options/custom-nameservers/zone-custom-nameservers/)  
- [GoDaddy](https://uk.godaddy.com/help/add-custom-hostnames-12320)  
- [NameCheap](https://www.namecheap.com/support/knowledgebase/article.aspx/768/10/how-do-i-register-personal-nameservers-for-my-domain/#:~:text=Click%20on%20the%20Manage%20option,5.)

To add nameservers in OpenPanel, navigate to **OpenAdmin > Settings > OpenPanel** and enter your nameservers in the `ns1`, `ns2`, `ns3`, `ns4` fields, then click **Save changes**.

Alternatively, you can set nameservers via terminal commands:

```bash
opencli config update ns1 your_ns1.domain.com
opencli config update ns2 your_ns2.domain.com
opencli config update ns3 your_ns3.domain.com
opencli config update ns4 your_ns4.domain.com
```

Currently, you can add up to 4 nameservers.

:::info
After creating nameservers it can take up to 12h for the records to be globally accessible. Use a tool such as [whatsmydns.net](https://www.whatsmydns.net/) to monitor the status.
:::

---

// File: articles/domains/how-to-enable-hsts-on-a-domain-in-openpanel

# How to Enable HSTS on a Domain in OpenPanel

HSTS ([HTTP Strict Transport Security](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Strict-Transport-Security)) can be enabled either globally for all domains or individually for specific domains in OpenPanel.

---

## Enabling HSTS for a Specific Domain

### As an End User

If you are an OpenPanel user:

1. Ensure you have access to the **edit_vhost** feature. If enabled, you will see **Edit VirtualHosts** under the **Domains** section.
2. Click **Edit VirtualHosts** and select the domain you want to configure.
3. In the editor, add the HSTS header **only within the HTTPS section**.
4. Use the correct syntax depending on your web server (Nginx, Apache, OpenLiteSpeed, etc.).
5. Save your changes.

Example Configurations:

#### OpenLiteSpeed

Add this in the Rewrite/Headers section for the HTTPS listener:
```bash
Header always set Strict-Transport-Security "max-age=2592000; includeSubDomains; preload"
```

#### Apache
Add the following inside the block:
```bash
<IfModule mod_headers.c>
    Header always set Strict-Transport-Security "max-age=2592000; includeSubDomains; preload"
</IfModule>
```

#### Nginx
Add this inside the server block:
```bash
add_header Strict-Transport-Security "max-age=2592000; includeSubDomains; preload" always;
```


---

### As an Administrator

If you have OpenAdmin or root SSH access:

1. Open the domain’s Caddy vhost configuration file:

```bash
/etc/openpanel/caddy/domains/DOMAIN_NAME.TLD.conf
```

2. Add the following HSTS header **just before the `tls {` line**:

```bash
# HSTS
header {
  Strict-Transport-Security "max-age=2592000; includeSubDomains; preload"
}
```

3. Save the file and reload Caddy.

---

## Enabling HSTS for All Domains

To apply HSTS automatically to all domains on the server:

1. Edit the default domain templates:

```bash
/etc/openpanel/caddy/templates/domain.conf_with_modsec
/etc/openpanel/caddy/templates/domain.conf
```

2. Add the HSTS header **just before the `tls {` line** in each template:

```bash
# HSTS
header {
  Strict-Transport-Security "max-age=2592000; includeSubDomains; preload"
}
```

3. Save the templates. All new domains created afterward will inherit this HSTS configuration.

---

// File: articles/domains/how-to-setup-dns-cluster-in-openpanel

# DNS Clustering

DNS clustering enables you to synchronize DNS records across multiple OpenPanel servers, providing redundancy and scalability for your DNS infrastructure.

All servers involved in the cluster must be running [BIND9](https://www.isc.org/bind/) - either installed by OpenPanel or as a standalone service or container.

## Share DNS Across Multiple OpenPanel Servers

The simplest way to build a redundant DNS cluster is to run OpenPanel on two or more servers, each managing DNS zones and nameservers in sync. No extra configuration is needed beyond what's described below.

### Step 1: Allow connections between the servers

Suppose you have two servers:

- Server #1 IP: `MASTER_IP`
- Server #2 IP: `SLAVE_IP`

You need to allow connection between the servers, on MASTER_IP whitelist the SLAVE_IP and on SLAVE_IP whitelist the MASTER_IP:

- on master: `csf -a SLAVE_IP`
- on slave: `csf -a MASTER_IP`


### Step 2: Prepare Slave Server

On MASTER server get the secret token from rndc.key file: `cat /etc/bind/rndc.key` 

On SLAVE:

- edit `/root/docker-compose.yml` and add `- "953:953/tcp"` under ports for bind9 service.
- edit `/etc/bind/named.conf.options` and add `allow-new-zones yes;` inside options block, and append at the end of the file: 
  ```
  controls {
      inet 0.0.0.0 port 953 allow { MASTER_IP_HERE; } keys { "rndc-key"; };
  };
  ```
-  restart service with: `docker exec openpanel_dns rndc reconfig | docker compose up -d bind9`

Test connection from MASTER_IP with:

```bash
docker exec openpanel_dns rndc -s SLAVE_IP -k rndc-key status
```

### Step 3: Create Nameservers in Your DNS Zone

Using the domain `yourdomain.com` as an example, define two nameservers:

- `dns1.yourdomain.com` → points to Server #1 IP (A record)
- `dns2.yourdomain.com` → points to Server #2 IP (A record)

Add these A records in your domain's DNS provider for `yourdomain.com`.


### Step 4: Register Nameservers in OpenPanel

On **master** server, open the OpenAdmin panel:
* Navigate to **Settings > OpenPanel > Nameservers**
* Add both `dns1.yourdomain.com` and `dns2.yourdomain.com`

[![2025-07-09-17-30.png](/img/docs-content/kXnvzCwW-2025-07-09-17-30.png)](/img/docs-content/kXnvzCwW-2025-07-09-17-30.png)

### Step 5: Enable DNS Clustering

On **master** server:

* Go to **OpenAdmin > Domains > DNS Cluster**
* Click **Enable DNS Clustering**

[![2025-07-09-17-32.png](/img/docs-content/FzG3NfG3-2025-07-09-17-32.png)](/img/docs-content/FzG3NfG3-2025-07-09-17-32.png)

* Click **Add Server** and enter the IP of the slave server, then **Add**

[![2025-07-09-17-33.png](/img/docs-content/7PX2C2MT-2025-07-09-17-33.png)](/img/docs-content/7PX2C2MT-2025-07-09-17-33.png)

### Test Your Cluster

Add a new domain on either server via a OpenPanel user account.

Then verify the DNS zone is synchronized on both servers using the `dig` command:

```bash
dig A +short yourdomain.com @185.241.214.214
dig A +short yourdomain.com @95.217.216.36
```

Replace `yourdomain.com` with the domain you added.

If both servers return the correct IP, your DNS clustering setup is working!

---

// File: articles/domains/not-found-404-error-troubleshooting

# 404 Error Troubleshooting Guide

This guide explains the most common causes of **404 Not Found** errors on a website and how to resolve them.

---

## 1. File Does Not Exist

The simplest and most common cause: the file isn’t there.
If you are requesting a static file, make sure it actually exists in the specified path or document root.

**Example:**
If you request `example.com/index.html`, confirm that `index.html` exists in the document root of the domain `example.com`.

**How to check:**

* Go to **Domains > [Your Domain] > *click on* Document Root**.
* Open the File Manager and verify that the file is present in the correct location.
![screenshot](/img/docs-content/TRPPtj2P-image.png)
---

## 2. Rewrite Rules

If the request is for a dynamic route (e.g., WordPress pretty permalinks such as `example.com/about`), the issue may be caused by misconfigured rewrite rules in your `.htaccess` file or VirtualHosts configuration.

**For Apache or LiteSpeed:**

* Open the File Manager and check for a `.htaccess` file in the domain’s document root.
  ![screenshot](/img/docs-content/b8nwVwP1-image.png)
* If it exists, review its contents.
  ![screenshot](/img/docs-content/338rwjvZ-image.png)
* For WordPress, you can simply go to [**WP Admin > Settings > Permalinks**](https://www.google.com/search?q=wordpress+recreate+htaccess) and click **Save** (even without changes). This refreshes the rewrite rules in `.htaccess`.
* Restart the webserver afterward to apply the changes from .htaccess file.

**For Nginx or OpenResty:**

* `.htaccess` files are not used. Rewrite rules are set directly in the VirtualHosts configuration.
* Go to **Domains > [Your Domain] > Edit VHosts**.
  ![screenshot](/img/docs-content/mbSrwXWJ-image.png)
* Review and correct the rewrite rules, then save the file. This automatically reloads the webserver to apply changes.
  ![screenshot](/img/docs-content/RCSpt0Q2-image.png)

After adjustments, test your website again.

---

## 3. Docker Mount Issues

In rare cases, Docker’s file mounting system (which uses inodes) can cause discrepancies. If a user or program has moved or renamed a home directory, the PHP service container may no longer see the same files as the File Manager.

This means the file might appear in File Manager but not be accessible to PHP.

**How to check:**

* If you have Docker access:

  1. Go to **Docker > Terminal**.
  2. Select the PHP service.
     ![screenshot](/img/docs-content/qphbySyB-image.png)
  3. Run:

     ```bash
     ls filename_here.php
     ```

     If the file does not appear, restart the PHP service to remount.

* To restart the PHP container:

  * Go to **Docker > Containers**.
  * Disable the PHP service, wait for the page to reload, then enable it again.
    ![screenshot](/img/docs-content/wx8Dm4XP-image.png)

* If you do not have Docker access:

  * Contact your hosting provider and request a PHP service restart.

Once done, verify the file again using the terminal.

---

// File: articles/domains/speed-up-dns-propagation

# Speed up DNS propagation

DNS propagation cannot be speed up.

To minimize the effects of DNS propagation, lower the `TTL` value for the DNS record you need to change at least 24 hours before the record change.

Setting the TTL to 300 seconds causes most DNS resolvers to update their cache for the DNS record every 5 minutes.

---

// File: articles/domains/ssl-troubleshooting-guide

# Troubleshooting Guide: Caddy / Let’s Encrypt SSL Validation Failure

## Issue

SSL certificate generation in **Caddy** fails with both `http-01` and `tls-alpn-01` ACME challenges.  
The following errors appear in Caddy logs:

```json
{
  "level": "error",
  "msg": "challenge failed",
  "identifier": "test1.test.com",
  "challenge_type": "http-01",
  "problem": {
    "type": "urn:ietf:params:acme:error:connection",
    "detail": "103.67.236.210: Fetching http://test1.test.com/.well-known/acme-challenge/...: Connection reset by peer"
  }
}
```
```
{
  "level": "error",
  "msg": "challenge failed",
  "identifier": "test1.test.com",
  "challenge_type": "tls-alpn-01",
  "problem": {
    "type": "urn:ietf:params:acme:error:connection",
    "detail": "103.67.236.210: Connection reset by peer"
  }
}
```

Despite these failures, Caddy successfully creates an ACME order:
```
https://acme-staging-v02.api.letsencrypt.org/acme/order/262155913/31213094193
```

##Cause

The connection resets indicate a network-level issue:

- Firewalls or WAF blocking inbound connections on ports 80/443
- Manual ACME challenge configuration overriding Caddy’s internal ACME handling
- Repeated failed attempts may trigger Let’s Encrypt rate limits (HTTP 429)

##Workaround / Steps to Resolve

1. Remove manual ACME challenge configuration

If you have something like this in your Caddyfile:
```
@acme {
    path /.well-known/acme-challenge/*
}
handle @acme {
    reverse_proxy http://127.0.0.1:32773
}
tls {
    issuer acme {
        email dev@test.com
    }
}
```
Remove it entirely and let Caddy manage ACME challenges automatically.

2. Ensure firewall allows ACME validation

Let’s Encrypt must be able to reach your server on ports 80 and 443:
```
iptables -I INPUT -p tcp --dport 80 -j ACCEPT
iptables -I INPUT -p tcp --dport 443 -j ACCEPT
iptables -I OUTPUT -p tcp --dport 80 -j ACCEPT
iptables -I OUTPUT -p tcp --dport 443 -j ACCEPT
```

Also check:

- Cloud / hosting provider firewalls
- WAF or DDoS protection rules

3. Restart Caddy

```docker restart caddy```

4. Wait for automatic ACME retry

Caddy will retry issuing the certificate automatically after fixing network issues.

5. Optional workarounds if rate limits are hit:

- Wait for Let’s Encrypt limits to reset
- Switch to Cloudflare proxy
- Use ZeroSSL:
```
tls {
    issuer acme {
        ca https://acme.zerossl.com/v2/DV90
        email admin@example.com
    }
}
```
##Disable WAF

ModSecurity rules do not affect SSL generation: Caddy automatically tries to generate SSL when a website is visited via HTTPS, and this happens before the request is examined by any WAF rules.

However, you can temporarily disable all rules - or disable the WAF completely by simply:

- Disabling 'waf' module in OpenAdmin > Settings > Modules 
- Changing image tag from openpanel/caddy-coraza to caddy:latest in OpenAdmin > Services > Services Limits > CADDY image.
- Stop & Start the Web Server from OpenAdmin > Services > Services Status.

Or use opencli command: ```opencli waf disable```

Note that you need to remove existing domains as well, or edit their files to not have any # modsecurity parts: https://github.com/stefanpejcic/openpanel-configuration/blob/main/caddy/templates/domain.conf_with_modsec#L17-L33

We don’t recommend disabling WAF unless you have another firewall in place - for example, if you’re using a Cloudflare proxy & firewall for all domains.


##Verification

After completing the steps above:

- Check Caddy logs for successful ACME issuance
- Confirm HTTPS is working:

```https://test1.test.com```

Optional: verify certificate details with:

```curl -v https://test1.test.com ```


##Notes
Avoid manual ACME challenge configurations unless absolutely necessary
Ensure firewall and provider-level settings do not block Let’s Encrypt validation IPs

---

// File: articles/domains/troubleshooting-dns

# Troubleshooting DNS

Make sure the DNS-server on the host server responds to requests for the domain zone:

`dig <domain> @<IP address> ANY +short`


## servers could not be reached
Response message `servers could not be reached` indicates that the bind9 service is not running.

Try to restart the service from **OpenAdmin > Services**

And if service restart failed check the service logs.

The usual culprit is an invalid DNS zone file for a domain, so edit the file mentioned in the error, save changes then restart service again.

----

## empty dig response

An empty response for the dig command  indicates that the DNS-server does not have information about the domain. Perhaps, it is not added to any account or its DNS zone file is missing.

To check if domain is added to any account use the command:
`opencli domains-whoowns <domain_name>`

---

## Can't connect to the server

Try to connect to port 53 of the server through telnet:

`telnet <IP address of the server> 53`

If you can not connect, check the Firewall settings on the admin panel.


---

## zone not loaded due to errors

When manually editing the zone files or importing then from another provider, it's important to check the files for syntax errors. If there are any errors the zone file will be skipped on service reload but will cause fail in service restart.

To check a domain zone file syntax:
```bash
named-checkzone <DOMAIN> /etc/bind/zones/<DOMAIN>.zone
```

Example:
```bash
# named-checkzone example.com /etc/bind/zones/example.com.zone
zone example.com/IN: NS 'ns17.openpanel.example.com' has no address records (A or AAAA)
zone example.com/IN: not loaded due to errors.
```

---

// File: articles/email/how-to-setup-dkim-for-mailserver

# Setup DKIM

Ensure that you're running the [**Enterprise edition**](https://openpanel.com/enterprise/) of OpenPanel. Email support is only available in this version.

Follow [this guide](/docs/articles/user-experience/how-to-setup-email-in-openpanel/) to enable Emails in OpenPanel.

---

OpenDKIM is currently enabled by default.

## 1. Generate DKIM keys

To generate DKIM keys for a domain, run:

```bash
opencli email-setup config dkim domain DOMAIN_NAME_HERE
```

---

## 2. DNS record

When mail signed with your DKIM key is sent from your mail server, the receiver needs to check a DNS `TXT` record to verify the DKIM signature is trustworthy.

### OpenPanel DNS

If you are using nameservers on the same OpenPanel server that mailserver is running on, then run:
```bash
docker cp openadmin_mailserver:/tmp/docker-mailserver/opendkim/keys/DOMAIN_NAME_HERE/mail.txt /tmp/mail.txt && cat /tmp/mail.txt >> /etc/bind/zones/DOMAIN_NAME_HERE.zone
```

Make sure to replace `DOMAIN_NAME_HERE` with *yourdomain.com*

This will append the DKIM record to the DNS zone.

---

### External DNS

If you are using external nameservers like [Cloudflare](https://www.cloudflare.com/), run this command to view the record:

```bash
docker cp openadmin_mailserver:/tmp/docker-mailserver/opendkim/keys/DOMAIN_NAME_HERE/mail.txt /tmp/mail.txt && cat /tmp/mail.txt
```

Add the TXT record to your **remote server's DNS zone**:

| **Field** | **Value**                                                                      |
| --------- | ------------------------------------------------------------------------------ |
| **Type**  | `TXT`                                                                          |
| **Name**  | `mail._domainkey`                                                              |
| **TTL**   | Default value (or `3600` seconds)                                              |
| **Data**  | Contents of the file inside parentheses - formatted as advised below           |

**Formatting the TXT record value correctly:**
`TXT` records with values that are longer than 255 characters need to be split into multiple parts. This is why the generated `mail.txt` file (containing your public key for use with DKIM) has multiple value parts wrapped within double-quotes between `(` and `)`.

A DNS web-interface may handle this separation internally instead, and [could expect the value provided all as a single line](https://serverfault.com/questions/763815/route-53-doesnt-allow-adding-dkim-keys-because-length-is-too-long) instead of split. When that is required, you'll need to manually format the value as described below.

Your generated DNS record file (mail.txt) should look similar to this:

```
mail._domainkey IN TXT ( "v=DKIM1; k=rsa; "
"p=MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqQMMqhb1S52Rg7VFS3EC6JQIMxNDdiBmOKZvY5fiVtD3Z+yd9ZV+V8e4IARVoMXWcJWSR6xkloitzfrRtJRwOYvmrcgugOalkmM0V4Gy/2aXeamuiBuUc4esDQEI3egmtAsHcVY1XCoYfs+9VqoHEq3vdr3UQ8zP/l+FP5UfcaJFCK/ZllqcO2P1GjIDVSHLdPpRHbMP/tU1a9mNZ"
"5QMZBJ/JuJK/s+2bp8gpxKn8rh1akSQjlynlV9NI+7J3CC7CUf3bGvoXIrb37C/lpJehS39KNtcGdaRufKauSfqx/7SxA0zyZC+r13f7ASbMaQFzm+/RRusTqozY/p/MsWx8QIDAQAB"
) ;
```

Take the content between `( ... )`, and combine all the quote wrapped content and remove the double-quotes including the white-space between them. That is your `TXT` record value, the above example would become this:

```
v=DKIM1; k=rsa; p=MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqQMMqhb1S52Rg7VFS3EC6JQIMxNDdiBmOKZvY5fiVtD3Z+yd9ZV+V8e4IARVoMXWcJWSR6xkloitzfrRtJRwOYvmrcgugOalkmM0V4Gy/2aXeamuiBuUc4esDQEI3egmtAsHcVY1XCoYfs+9VqoHEq3vdr3UQ8zP/l+FP5UfcaJFCK/ZllqcO2P1GjIDVSHLdPpRHbMP/tU1a9mNZ5QMZBJ/JuJK/s+2bp8gpxKn8rh1akSQjlynlV9NI+7J3CC7CUf3bGvoXIrb37C/lpJehS39KNtcGdaRufKauSfqx/7SxA0zyZC+r13f7ASbMaQFzm+/RRusTqozY/p/MsWx8QIDAQAB
```
---

### Test DNS

To test that your new DKIM record is correct, query it with the `dig` command. The `TXT` value response should be a single line split into multiple parts wrapped in double-quotes:

```bash
$ dig +short TXT mail._domainkey.example.com
"v=DKIM1; k=rsa; p=MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqQMMqhb1S52Rg7VFS3EC6JQIMxNDdiBmO.."
```

---

## 3. Restart Mailserver

Currently mailserver needs to be stopped and started again in order to start signing your outgoing emails with DKIM. Navigate to **OpenAdmin > Services > Status** and click 'Stop' for mailserver, then again 'Start'.

[![2025-07-17-15-37.png](/img/docs-content/d3hgY01F-2025-07-17-15-37.png)](/img/docs-content/d3hgY01F-2025-07-17-15-37.png)

---

## 4. Troubleshooting

[MxToolbox has a DKIM Verifier](https://mxtoolbox.com/dkim.aspx) that you can use to check your DKIM DNS record(s).

---

// File: articles/email/how-to-setup-email-in-gmail

# How to Set Up Email in Gmail

This guide explains how to add your **OpenPanel-created email account** to Gmail using a web browser.

> **Note:** If you are setting up email on a different device or service, see the main guide:
> [How to setup your email client](/docs/articles/email/how-to-setup-your-email-client)

---

## Add a New Account in Gmail

1. Open **Gmail** in your browser  

2. Click the **⚙️ Settings icon → See all settings → Accounts and Import tab**  

3. Under **"Check mail from other accounts"**, click **Add a mail account**  

4. Enter your **full email address** and click **Next**  

5. Select **Import emails from my other account (POP3)** and click **Next**  

---

## Incoming Mail (POP3) Settings

| Setting        | Description                                      | Example                          |
|----------------|--------------------------------------------------|----------------------------------|
| Username       | Your full email address                          | user@domain.tld                  |
| Password       | Your email account password                      | ********                         |
| Server         | Incoming mail server address                     | mail.domain.tld                  |
| Port           | Port number for incoming mail                    | 995                              |
| Security Type  | Encryption method for secure connection          | SSL/TLS                          |
| Authentication | Authentication method used to log in             | Password                         |
| Additional     | Optionally: "Leave a copy on server" for backup | Checked / Unchecked              |

Click **Add Account** to proceed.

---

## Outgoing Mail (SMTP) Settings

| Setting        | Description                                      | Example                          |
|----------------|--------------------------------------------------|----------------------------------|
| Username       | Your full email address                          | user@domain.tld                  |
| Password       | Your email account password                      | ********                         |
| Server         | Outgoing mail server address                     | mail.domain.tld                  |
| Port           | Port number for outgoing mail                    | 465 / 587                        |
| Security Type  | Encryption method for secure connection          | SSL/TLS                          |
| Authentication | Authentication method used to send mail          | Password                         |

Click **Add Account** to finish setup.

---

Your OpenPanel email is now integrated with Gmail. You can **send and receive emails directly** from your Gmail account.

---

// File: articles/email/how-to-setup-email-on-android

# How to Set Up Email on Android (Gmail App)

This guide explains how to set up your **OpenPanel-created email account** in the Gmail app on Android.

> **Note:** If you are setting up email on a different device or service, see the main guide:
> [How to setup your email client](/docs/articles/email/how-to-setup-your-email-client)

---

## Add a New Account

1. Open the **Gmail App**  
   Go to:  
   **Menu → Settings → Add Account → Personal (IMAP/POP) → Next**  

2. Enter your **email address** → **Next**  

3. Choose **IMAP** or **POP**  
   - If unsure, select **IMAP** (recommended).  
   - Learn more: [📬 POP3 vs IMAP: Email Access Protocols](/docs/articles/email/imap-vs-pop3/)  

4. Enter your **email password** → **Next**  

---

## Incoming Mail Settings

### IMAP (Recommended)

| Setting        | Description                                      | Example                          |
|----------------|--------------------------------------------------|----------------------------------|
| Username       | Your full email address                          | user@domain.tld                  |
| Password       | Your email account password                      | ********                         |
| Server         | Incoming mail server address                     | mail.domain.tld                  |
| Port           | Port number for incoming mail                    | 993                              |
| Security Type  | Encryption method for secure connection          | SSL/TLS                          |
| Authentication | Authentication method used to log in             | Normal Password                  |

---

### POP

| Setting        | Description                                      | Example                          |
|----------------|--------------------------------------------------|----------------------------------|
| Username       | Your full email address                          | user@domain.tld                  |
| Password       | Your email account password                      | ********                         |
| Server         | Incoming mail server address                     | mail.domain.tld                  |
| Port           | Port number for incoming mail                    | 993                              |
| Security Type  | Encryption method for secure connection          | SSL/TLS                          |
| Authentication | Authentication method used to log in             | Normal Password                  |

After entering your incoming mail settings, tap **Next**.

---

## Outgoing Mail Settings (SMTP)

Make sure **"Require Sign-in"** is enabled.  

| Setting        | Description                                      | Example                          |
|----------------|--------------------------------------------------|----------------------------------|
| Username       | Your full email address                          | user@domain.tld                  |
| Password       | Your email account password                      | ********                         |
| Server         | Outgoing mail server address                     | mail.domain.tld                  |
| Port           | Port number for outgoing mail                    | 465 / 587                        |
| Security Type  | Encryption method for secure connection          | SSL/TLS                          |
| Authentication | Authentication method used to log in             | Password                         |

After entering your outgoing mail settings, tap **Next**.

---

Your OpenPanel email account is now set up and ready to use in the Gmail app.

---

// File: articles/email/how-to-setup-email-on-apple-mail-app

# How to Set Up Email on Apple Mail (Mac)

This guide explains how to set up your **OpenPanel-created email account** in the Apple Mail app on macOS.

> **Note:** If you are setting up email on a different device or service, see the main guide:
> [How to setup your email client](/docs/articles/email/how-to-setup-your-email-client)

---

## Add a New Account

1. Open **Mail** on your Mac  

2. Go to **Mail → Preferences → Accounts tab**  

3. Click the **➕ (Add) icon → Add Other Mail Account**  

4. Enter the following details:  
   - **Full Name**: Your display name  
   - **Email Address**: Your full email address  
   - **Password**: Your email account password  
   
5. Click **Create**  

> Mail will attempt to detect the settings automatically. If detection fails, ignore the error and click **Next**.

---

## Incoming Mail Settings (IMAP)

| Setting        | Description                                      | Example                          |
|----------------|--------------------------------------------------|----------------------------------|
| Username       | Your full email address                          | user@domain.tld                  |
| Password       | Your email account password                      | ********                         |
| Server         | Incoming mail server address                     | mail.domain.tld                  |
| Port           | Port number for incoming mail                    | 993                              |
| Security Type  | Encryption method for secure connection          | SSL/TLS                          |
| Authentication | Authentication method used to log in             | Password                         |

---

## Outgoing Mail Settings (SMTP)

| Setting        | Description                                      | Example                          |
|----------------|--------------------------------------------------|----------------------------------|
| Username       | Your full email address                          | user@domain.tld                  |
| Password       | Your email account password                      | ********                         |
| Server         | Outgoing mail server address                     | mail.domain.tld                  |
| Port           | Port number for outgoing mail                    | 465 / 587                        |
| Security Type  | Encryption method for secure connection          | SSL/TLS                          |
| Authentication | Authentication method used to log in             | Password                         |

Once all information is entered, click **Create**.  

---

Your email account is now ready to use in the Apple Mail app.

---

// File: articles/email/how-to-setup-email-on-iphone

# How to Set Up Email on iPhone

This guide explains how to set up your **OpenPanel-created email account** in the iPhone Mail app.

> **Note:** If you are setting up email on a different device or service, see the main guide:
> [How to setup your email client](/docs/articles/email/how-to-setup-your-email-client)

---

## Add a New Account

1. Open **Settings → Mail → Accounts → Add Account → Other → Add Mail Account**  

2. Enter the following details:  
   - **Name**: Your display name  
   - **Email**: Your full email address  
   - **Password**: Your email account password  
   - **Description**: Optional account description  
   
3. Tap **Next**

---

## Incoming Mail Settings (IMAP)

| Setting        | Description                                      | Example                          |
|----------------|--------------------------------------------------|----------------------------------|
| Username       | Your full email address                          | user@domain.tld                  |
| Password       | Your email account password                      | ********                         |
| Server         | Incoming mail server address                     | mail.domain.tld                  |
| Port           | Port number for incoming mail                    | 993                              |
| Security Type  | Encryption method for secure connection          | SSL/TLS                          |
| Authentication | Authentication method used to log in             | Normal Password                  |

---

## Outgoing Mail Settings (SMTP)

| Setting        | Description                                      | Example                          |
|----------------|--------------------------------------------------|----------------------------------|
| Username       | Your full email address                          | user@domain.tld                  |
| Password       | Your email account password                      | ********                         |
| Server         | Outgoing mail server address                     | mail.domain.tld                  |
| Port           | Port number for outgoing mail                    | 465 / 587                        |
| Security Type  | Encryption method for secure connection          | SSL/TLS                          |
| Authentication | Authentication method used to log in             | Password                         |

Tap **Save** to verify your settings.  

---

Your email account is now ready to use in the iPhone Mail app.

---

// File: articles/email/how-to-setup-email-on-outlook-365-desktop-app

# How to Set Up Email on Outlook 365 (Desktop App)

This guide explains how to set up your **OpenPanel-created email account** in the Microsoft Outlook 365 desktop app.

> **Note:** If you are setting up email on a different device or service, see the main guide:
> [How to setup your email client](/docs/articles/email/how-to-setup-your-email-client)

---

## Add a New Account

1. Open **Microsoft Outlook**  
   Go to:  
   **Tools → Accounts → ➕ (Add) → New Account**

2. Enter your **email address**  

3. On the next screen, select **"Not Office 365"**, then choose **IMAP**  

---

## Incoming Mail Settings

| Setting        | Description                                      | Example                          |
|----------------|--------------------------------------------------|----------------------------------|
| Username       | Your full email address                          | user@domain.tld                  |
| Password       | Your email account password                      | ********                         |
| Server         | Incoming mail server address                     | mail.domain.tld                  |
| Port           | Port number for incoming mail                    | 993                              |
| Security Type  | Encryption method for secure connection          | SSL/TLS                          |
| Authentication | Authentication method used to log in             | Normal Password                  |

---

## Outgoing Mail Settings (SMTP)

| Setting        | Description                                      | Example                          |
|----------------|--------------------------------------------------|----------------------------------|
| Username       | Your full email address                          | user@domain.tld                  |
| Password       | Your email account password                      | ********                         |
| Server         | Outgoing mail server address                     | mail.domain.tld                  |
| Port           | Port number for outgoing mail                    | 465 / 587                        |
| Security Type  | Encryption method for secure connection          | SSL/TLS                          |
| Authentication | Authentication method used to log in             | Password                         |

Once all details are entered, click **Add Account**.  

----

Your OpenPanel email account is now set up in Outlook 365.

---

// File: articles/email/how-to-setup-email-on-thunderbird

# How to Set Up Email on Thunderbird

This guide explains how to set up your **OpenPanel-created email account** in the Thunderbird email app.

> **Note:** If you are setting up email on a different device or service, see the main guide:
> [How to setup your email client](/docs/articles/email/how-to-setup-your-email-client)

---

## Add a New Account

1. Open **Thunderbird → File → New → Existing Mail Account**  

2. Enter the following details:  
   - **Your Name**: Your display name  
   - **Email Address**: Your full email address  
   - **Password**: Your email account password  
   
3. Click **Continue**  

> Thunderbird will attempt to automatically detect your settings. If an error occurs, ignore it and enter the details manually.

---

## Choose Account Type

Thunderbird allows **IMAP** or **POP**.  
- If unsure, select **IMAP** (recommended).  
- Learn more: [📬 IMAP vs POP3](/docs/articles/email/imap-vs-pop3/)

---

## Incoming Mail Settings

### IMAP (Recommended)

| Setting        | Description                                      | Example                          |
|----------------|--------------------------------------------------|----------------------------------|
| Username       | Your full email address                          | user@domain.tld                  |
| Password       | Your email account password                      | ********                         |
| Server         | Incoming mail server address                     | mail.domain.tld                  |
| Port           | Port number for incoming mail                    | 993                              |
| Security Type  | Encryption method for secure connection          | SSL/TLS                          |
| Authentication | Authentication method used to log in             | Normal Password                  |

### POP

| Setting        | Description                                      | Example                          |
|----------------|--------------------------------------------------|----------------------------------|
| Username       | Your full email address                          | user@domain.tld                  |
| Password       | Your email account password                      | ********                         |
| Server         | Incoming mail server address                     | mail.domain.tld                  |
| Port           | Port number for incoming mail                    | 995                              |
| Security Type  | Encryption method for secure connection          | SSL/TLS                          |
| Authentication | Authentication method used to log in             | Normal Password                  |

After entering incoming mail settings, click **Done**.

---

## Outgoing Mail Settings (SMTP)

| Setting        | Description                                      | Example                          |
|----------------|--------------------------------------------------|----------------------------------|
| Username       | Your full email address                          | user@domain.tld                  |
| Password       | Your email account password                      | ********                         |
| Server         | Outgoing mail server address                     | mail.domain.tld                  |
| Port           | Port number for outgoing mail                    | 465 / 587                        |
| Security Type  | Encryption method for secure connection          | SSL/TLS                          |
| Authentication | Authentication method used to log in             | Normal Password                  |

---

Your email account is now ready to use in Thunderbird.

---

// File: articles/email/how-to-setup-fail2ban-mailserver-openpanel

# Setup Fail2ban

Ensure that you're running the [**Enterprise edition**](https://openpanel.com/enterprise/) of OpenPanel. Email support is only available in this version.

Follow [this guide](/docs/articles/user-experience/how-to-setup-email-in-openpanel/) to enable Emails in OpenPanel.

---

Fail2ban is an intrusion prevention software framework. Written in the Python programming language, it is designed to prevent against brute-force attacks. It is able to run on POSIX systems that have an interface to a packet-control system or firewall installed locally, such as NFTables or TCP Wrapper. [More Information](https://en.wikipedia.org/wiki/Fail2ban)

Enabling Fail2Ban support requires granting at least the `NET_ADMIN` capability to the mailserver in order to interact with the kernel and ban IP addresses.


## 1. Enable Fail2ban

To enable Fail2ban, navigate to **OpenAdmin > Emails > Settings** and under 'Enable Services' select **fail2ban** then click on 'Save Stack'.

[![2025-07-17-14-33.png](/img/docs-content/G3q4ByVh-2025-07-17-14-33.png)](/img/docs-content/G3q4ByVh-2025-07-17-14-33.png)

---

## 2. Recreate mailserver

Fail2ban requires that the mailserver container is stopped, and start again in order to activate. Navigate to **OpenAdmin > Services > Status** and click 'Stop' for mailserver, then again 'Start'.

[![2025-07-17-15-37.png](/img/docs-content/d3hgY01F-2025-07-17-15-37.png)](/img/docs-content/d3hgY01F-2025-07-17-15-37.png)

---

## Edit Configuration

Mailserver will automatically ban IP addresses of hosts that have generated **6** failed attempts over the course of the last week. The bans themselves last for one week. The Postfix jail is configured to use `mode = extra`.

If created, the following configuration files will be copied inside the container during startup. To customize the configuration, simply create a new file and customize the examples:

- `/usr/local/mail/openmail/docker-data/dms/config/fail2ban-jail.cf` - adjust the configuration of individual jails and their defaults, [example file](https://github.com/docker-mailserver/docker-mailserver/blob/master/config-examples/fail2ban-jail.cf)
- `/usr/local/mail/openmail/docker-data/dms/config/fail2ban-fail2ban.cf` - adjust F2B behavior in general, [example file](https://github.com/docker-mailserver/docker-mailserver/blob/master/config-examples/fail2ban-fail2ban.cf)

**Example:**

To modify the number of failed logins before IP is blocked (default: 6), or change the bantime (default: 1w):

- create file `/usr/local/mail/openmail/docker-data/dms/config/fail2ban-jail.cf`
- in it, paste [this example](https://github.com/docker-mailserver/docker-mailserver/blob/master/config-examples/fail2ban-jail.cf)
- change the `maxretry` and `bantime` values:

```yaml
[DEFAULT]

# "bantime" is the number of seconds that a host is banned.
bantime = 1w

# A host is banned if it has generated "maxretry" during the last "findtime"
# seconds.
findtime = 1w

# "maxretry" is the number of failures before a host get banned.
maxretry = 6

# "ignoreip" can be a list of IP addresses, CIDR masks or DNS hosts. Fail2ban
# will not ban a host which matches an address in this list. Several addresses
# can be defined using space (and/or comma) separator.
ignoreip = 127.0.0.1/8

# default ban action
# nftables-multiport: block IP only on affected port
# nftables-allports:  block IP on all ports
banaction = nftables-allports

[dovecot]
enabled = true

[postfix]
enabled = true
# For a reference on why this mode was chose, see
# https://github.com/docker-mailserver/docker-mailserver/issues/3256#issuecomment-1511188760
mode = extra

[postfix-sasl]
enabled = true

# This jail is used for manual bans.
# To ban an IP address use: opencli email-setup fail2ban ban <IP>
[custom]
enabled = true
bantime = 180d
port = smtp,pop3,pop3s,imap,imaps,submission,submissions,sieve
```

---

## View and Manage Bans

- `opencli email-setup fail2ban` - shows all banned IP addresses
- `opencli email-setup fail2ban status` - shows more detailed status
- `opencli email-setup fail2ban ban <IP>` - ban an IP address
- `opencli email-setup fail2ban unban <IP>` - unban an IP address
- `opencli email-setup fail2ban log` - view fail2ban log file

---

// File: articles/email/how-to-setup-your-email-client

# How to setup your email client

How do I set up my email client with a specific device or service?

This page contains links to specific guides on how to set an email client using a specific device or service.

- [How to setup email on iPhone](/docs/articles/email/how-to-setup-email-on-iphone)
- [How to setup email on Android](/docs/articles/email/how-to-setup-email-on-android)
- [How to setup email on Apple Mail app](/docs/articles/email/how-to-setup-email-on-apple-mail-app)
- [How to setup email on Thunderbird](/docs/articles/email/how-to-setup-email-on-thunderbird)
- [How to setup email on Outlook 365 desktop app](/docs/articles/email/how-to-setup-email-on-outlook-365-desktop-app)
- [How to setup email on Gmail using desktop / browser](/docs/articles/email/how-to-setup-email-in-gmail)

---

// File: articles/email/how-to-use-remote-server-for-emails-in-openpanel

# Offload Email Storage to a Remote NFS Server

## Architecture

- **OpenPanel server** — runs websites and mail services (Postfix/Dovecot)
- **NFS server** — stores `/var/mail/` data

---

## Before You Start

**Check your email storage path** in OpenAdmin > Emails > Settings you can configure where mail is stored. The default since v1.0 is `/var/mail/`. This setting is locked once email accounts exist, so check the current value and substitute it in the paths below.

**Check your package manager**: the commands below assume a Debian-based distro. Replace `apt` with your distro's package manager if needed.

---

## Step 1: Prepare the NFS Server

Install NFS:
```bash
apt update && apt install nfs-kernel-server
```

Create the mail storage directory:
```bash
mkdir -p /var/mail
```

Add the export — edit `/etc/exports`:
```bash
/var/mail  <OPENPANEL_SERVER_IP>(rw,sync,no_subtree_check,no_root_squash)
```
Apply:
```bash
exportfs -ra
systemctl restart nfs-kernel-server
```

---

## Step 2: Configure the OpenPanel Server

Install the NFS client:
```bash
apt update && apt install nfs-common
```

If mail is already running, stop it:
```bash
cd /usr/local/openmail && docker --context=default compose down mailserver
```

Back up existing mail data:
```bash
cp -a /var/mail /var/mail_backup
```

Create the mount point and mount the NFS share:
```bash
mkdir -p /var/mail
mount <NFS_SERVER_IP>:/var/mail /var/mail
```

Make the mount persistent — add to `/etc/fstab`:
```bash
<NFS_SERVER_IP>:/var/mail  /var/mail  nfs  defaults,_netdev  0  0
```

Apply:
```bash
mount -a
```

---

## Step 3: Restart Mail Services

```bash
cd /usr/local/openmail && docker --context=default compose up -d mailserver
```

Verify the mount:
```bash
df -h | grep mail
```

---

## Test

- Create a new email account and confirm it works
- Delete an existing account and confirm cleanup
- Reboot and confirm the NFS mount persists

---

// File: articles/email/imap-vs-pop3

# IMAP vs POP3

📬 POP3 vs IMAP: Email Access Protocols

**POP3** and **IMAP** are two distinct protocols for accessing email stored on a server.

* **POP3 (Post Office Protocol v3)** was introduced in **[1996](https://www.ietf.org/rfc/rfc1939.txt)**. It’s designed for environments with limited internet connectivity and minimal server storage. It downloads emails to a local device and typically removes them from the server afterward—making it ideal for older dial-up connections.

* **IMAP (Internet Message Access Protocol)** came later in **[2003](https://datatracker.ietf.org/doc/html/rfc3501)**, evolving alongside persistent broadband connections (like cable or DSL). IMAP stores emails on the server and synchronizes their status (read, unread, replied, labeled, etc.) across all devices. This makes it ideal for modern use across phones, tablets, and desktops.

---

## Key Differences

| Feature               | **IMAP**                        | **POP3**                                       |
| --------------------- | ------------------------------- | ---------------------------------------------- |
| **Mail Storage**      | Stays on the **server**         | Downloaded to the **local device**             |
| **Synchronization**   | Yes – across all devices        | No – removed from server once accessed*       |
| **Sent Mail**         | Stored on **server**            | Stored on **device**                           |
| **Deleted Mail**      | Goes to Trash (must be emptied) | Removed from device only (no effect on server) |
| **Disaster Recovery** | Yes – via server backups        | No – stored only locally                       |
| **Offline Access**    | No – requires Internet          | Yes – once downloaded                          |

> * POP3 **can** be configured to leave messages on the server, but this often leads to duplicate emails across devices and is not recommended. Use IMAP for proper syncing.

---

## Which is right for me?

**Choose IMAP** – it’s the modern standard and the best option for most users. It allows full synchronization across all devices and ensures that your email stays safe and accessible on the server.

**Choose POP3** only if:

* You have **limited internet access**
* You **must** access your email **offline**
* Server storage is severely restricted

---

// File: articles/email/rspamd-gui-port-11334

# RSPAMD GUI

[Rspamd](https://rspamd.com/) is an advanced spam filtering system that offers many different ways to filter messages, including regular expressions and statistical analysis. Each message is analyzed by rspamd and given a spam score.

![rspamd gui](/img/docs-content/wHkc2j15-2025-08-11-17-56-1.png)

[OpenPanel Enterprise edition](https://openpanel.com/enterprise/#compare) includes RSPAMD by default.

## How to enable Rspamd

To enable RSPAMD:

1. Go to **OpenAdmin > Emails > Settings**.
2. Enable the 'RSPAMD' option.
  ![rspamd enable openadmin](/img/docs-content/M6gTbRyZ-2025-08-11-18-04.png)
3. Save changes and restart the email server.
  ![rspamd restart openadmin](/img/docs-content/6KPyXsDs-2025-08-11-18-05.png)

> **NOTE**: If Rspamd is enabled, you should disable the following services (as they provide overlapping functionality): *Amavis, SpamAssassin, OpenDKIM, OpenDMARC*.

### Setting a Password for the Rspamd GUI

You must set a controller password before logging in.

1. Open a terminal and run:

   ```bash
   docker exec -it openadmin_mailserver rspamadm pw
   ```

   * Enter your new password.
   * You'll receive a hashed value, for example:

     ```
     $2$mu7yqw9bn9heied5aeh8utec173umcub$oesyhcdpayqob6emzctn76c3dfrr1ipsi1hmht4a9sm7ytui8wjy
     ```

2. Enter the mailserver container:

   ```bash
   docker exec -it openadmin_mailserver sh
   ```

3. Add the hashed password to the configuration:

   ```bash
   echo 'password = "HASH_HERE";' >> /etc/rspamd/local.d/worker-controller.inc
   ```

4. Exit the container and restart the mailserver:

   ```bash
   exit
   docker restart openadmin_mailserver
   ```

## How to access the RSPAMD GUI

Rspamd includes a web-based GUI that displays statistics and filtering data.

The interface is accessible via port `11334`.

![rspamd login](/img/docs-content/HWSMgjMf-2025-08-11-17-56.png)

1. Open your browser and visit:

   ```
   http://<SERVER_IP_ADDRESS>:11334
   ```
2. Enter the password you configured.
3. You now have access to the Rspamd dashboard.

---

// File: articles/email/troubleshooting-email-errors

# Email Errors

Email communication is crucial for any organization, but issues can arise that disrupt this essential service. This guide provides practical steps to diagnose and resolve common email errors encountered in [OpenPanel Enterprise edition](/product/openpanel-premium-control-panel/), ensuring your email systems run smoothly and efficiently.

## Not able to send emails

Cloud hosting providers such as Hetzner block sending emails using `25` and `465` ports. Make sure that your provider does not block these ports.


## ERROR list mail user: '/tmp/docker-mailserver/postfix-accounts.cf' does not exist

Dovecot is not started until the first email account is created, therefor listing email accounts with the command `opencli email-setup email list` before creating any email accounts, will produce error:
```bash
root@stefi:/usr/local/mail/openmail# opencli email-setup email list
2024-08-27 07:55:15+00:00 ERROR listmailuser: '/tmp/docker-mailserver/postfix-accounts.cf' does not exist
2024-08-27 07:55:15+00:00 ERROR listmailuser: Aborting
```

**Solution**: Create an email account first with [opencli email-setup email add](https://dev.openpanel.com/cli/email.html#Create-email).

----


## Error: auth-master: userdb lookup(user@example.net): connect(/run/dovecot/auth-userdb) failed: No such file or directory

Immediately after creating first email account, dovecot is still creating necessary files in the background, so running the `opencli email-setup email list`  immediately after creating first email account will produce an error:

```
root@stefi:/usr/local/mail/openmail# opencli email-setup email list
doveadm(stefan@stefi.openpanel.site)<577><>: Error: auth-master: userdb lookup(stefan@stefi.openpanel.site): connect(/run/dovecot/auth-userdb) failed: No such file or directory
doveadm(stefan@stefi.openpanel.site): Error: User lookup failed: Internal error occurred. Refer to server log for more information.
2024-08-27 07:55:46+00:00 ERROR listmailuser: Supplied non-number argument '' to '_bytes_to_human_readable_size()'
2024-08-27 07:55:46+00:00 ERROR listmailuser: Aborting
2024-08-27 07:55:46+00:00 ERROR listmailuser: Supplied non-number argument '' to '_bytes_to_human_readable_size()'
2024-08-27 07:55:46+00:00 ERROR listmailuser: Aborting
* stefan@stefi.openpanel.site (  /  ) [%]
```

**Solution**: Repeat the command `opencli email-setup email list`

----

---

// File: articles/extensions/add-openpanel-in-virtualizor

# Virtualizor

To add OpenPanel as a custom panel to be shown on Virtualizor to endusers:

```bash
bash <(curl -sSL https://raw.githubusercontent.com/stefanpejcic/OpenPanel-Virtualizor/refs/heads/main/INSTALL.sh)
```

---

// File: articles/extensions/openpanel-and-blesta

# Blesta

OpenPanel Enterprise edition has billing integrations with [WHMCS](/docs/articles/extensions/openpanel-and-whmcs/), [FOSSBilling](/docs/articles/extensions/openpanel-and-fossbilling/) and Blesta.

### Blesta extension by BlestaClub
OpenPanel Blesta extension allows users to integrate billing automations with their OpenPanel server.  

**Provided by BlestaClub:**  
https://blesta.club/extensions/openpanel

---

### Open-source Blesta module
An open-source Blesta module for OpenPanel is also available, maintained by the community.  

**GitHub repository:**  
https://github.com/Equitia/blesta-module-openpanel

---

// File: articles/extensions/openpanel-and-fossbilling

# FOSSBilling

OpenPanel Enterprise edition has billing integrations with [WHMCS](/docs/articles/extensions/openpanel-and-whmcs/) and FOSSBilling.

## OpenPanel

### Whitelist FOSSBilling

Before you can setup the OpenPanel server manager in FOSSBilling, you need to first whitelist your FOSSBilling server's IP address inside of OpenAdmin interface, and enable API access. 

To enable access to the FOSSBilling server's IP, first check the ip address on that server, from terminal you can run:

```bash
curl ip.openpanel.com
```

Login to OpenAdmin and under **Settings > Firewall** add the FOSSBilling server's IP under **Allow IP address**:

![whitelist ip](/img/docs-content/433M6LBr-2024-08-04-16-10.png)

### Enable API access

To enable API access on OpenPanel, navigate to **Settings > API Access** from the OpenAdmin interface and click on 'Enable API access' button:

![enable api](/img/docs-content/VsthWbWL-2024-08-04-16-14.png)

## FOSSBilling

### Download OpenPanel Server Manager

On the FOSSBilling server navigate to the directory where FOSSBilling is installed and run this command to download the latest OpenPanel Server Manager:

```bash
wget -O library/Server/Manager/OpenPanel.php https://raw.githubusercontent.com/stefanpejcic/FOSSBilling-OpenPanel/main/OpenPanel.php
```

### Add OpenPanel Server

Login to your FOSSBilling admin panel and go to **System -> Hosting plans and servers** from within the navigation bar, then click on 'New server':

![new server](/img/docs-content/bYV8DngC-2024-08-04-15-19.png)

in the new form we need to set:

![add openpanel server](/img/docs-content/jKcjYwHJ-2024-08-04-15-21.png)


4. Name: anything that you want to identify the server
5. Hostname: if you are using domain to access OpenPanel, add it here, otherwise add the IP address.
6. IP: set the IP address of the OpenPanel server.
7. Assigned IP addresses: set IP addresses that are added on OpenPanel server.
8. Nameserver 1: Set nameserver to use for domains
9. Nameserver 2: Set nameserver to use for domains
10. Server manages: **Select OpenPanel**
11. Username: Set OpenAdmin panel username
12. Password: Set OpenAdmin panel password
13. Connection port: Set to `2087`
14. Use secure connection: *Yes* fi you are using domain name for panel access, otherwise *No*

and click on the 'Add server' button.

### Add Hosting Plan for OpenPanel

From your FOSSBilling admin panel go to **System -> Hosting plans and servers** from within the navigation bar, then click on 'New hosting plan'.

Set the name for the plan **same as on OpenPanel hosting plan** and click on 'Create hosting plan'.

![add plan](/img/docs-content/02LsZqL7-2024-08-04-15-23.png)


You can also set mysql type and webserver as additional parameters:

| Parameter    | Values |
| -------- | ------- |
| `mysql_type`  | `apache` `nginx` `openresty` `varnish+apache`  `varnish+nginx` `varnish+openresty`  |
| `webserver` | `mysql` `mariadb`     |

![additional parameters](/img/docs-content/S4DGnS4S-2025-05-01-10-33.png)


### Assign OpenPanel Server to product

From your FOSSBilling admin panel go to **Products -> Products & Services** from within the navigation bar, then click on the edit icon for the plan:

![edit plan](/img/docs-content/N0twqkGM-2024-08-04-15-24.png)

Click on 'Configuration' and for Server select the OpenPanel server and for hosting plan set it to match the plan name on OpenPanel server:

![important](/img/docs-content/GmG155CV-2024-08-04-15-26.png)

### Test connection

Create a new client and order the product that is configured to create OpenPanel account.

User should be able to login to their OpenPanel account:

![login](/img/docs-content/x882pjf3-2024-08-04-15-17.png)

and to reset the password:

![reset password](/img/docs-content/PJ7kgGNs-2024-08-04-15-17-1.png)

---

// File: articles/extensions/openpanel-and-whmcs

# WHMCS

OpenPanel Enterprise edition has billing integrations with WHMCS and [FOSSBilling](/docs/articles/extensions/openpanel-and-fossbilling).

OpenPanel WHMCS module allows users to integrate billing automations with their OpenPanel server.

# OpenPanel 

To setup WHMCS to use your OpenPanel server follow these steps:

## Enable API

First make sure that API access is enabled by going to `OpenAdmin > API` or by running `opencli config get api` from the terminal:
![enable_api](/img/docs-content/L6vwMQ4t-image.png)
If API is not enabled, click on the "Enable API access" button or from terminal run 
```bash
opencli config update api on
```

We recommend creating new Administrator user for API, to create a new user navigate to *OpenAdmin > OpenAdmin Settings* and create new admin user, or from terminal run:
```bash
opencli admin new USERNAME_HERE PASSWORD_HERE
```

## Whitelist on OpenPanel

On OpenPanel server make sure that the OpenAdmin port 2087 is open on `OpenAdmin > Firewall` or whitelist the IP address of your WHMCS server.
to whitelist ip address from terminal run:

```bash
csf -a WHMCS_IP_HERE
```
or if using UFS:
```bash
ufw allow from WHMCS_IP_HERE
```

## Create hosting package
Hosting packages need to be created on both OpenPanel and WHMCS servers.
On OpenPanel server login to admin panel and on `OpenAdmin > Plans` create hosting packages that you will be assigning to users on WHMCS.

# WHMCS

## Install OpenPanel WHMCS Module

Login to SSH for WHMCS server
Navigate to `path_to_whmcs/modules/servers`
Run this command to create a new folder and in it download the module:
```bash
git clone https://github.com/stefanpejcic/openpanel-whmcs-module.git openpanel
```

## Whitelist on WHMCS

On WHMCS server also make sure that the 2087 port is opened or whitelist the IP address of your OpenPanel server.

## WHMCS Module Setup

From WHMCS navigate to: *System Settings > Products & Services > Servers*
![screenshot](/img/docs-content/MHWpL3tc-image.png)
Click on *Create New Server* and under module select **OpenPanel** then add OpenPanel server IP, username and password for the OpenAdmin panel:
![create_whmcs_group](/img/docs-content/3Jh3nqWY-image.png)

## Create hosting package
On the WHMCS server create first a new group and then create new plans under this group. When creating products, make sure to select OpenPanel for Module and the newly created group
![screenshot2](/img/docs-content/NLvF4GSc-image.png)

## Test
Create an order and create a new order to test OpenPanel API.

---

// File: articles/install-update/create-openpanel-iso

# Creating an OpenPanel ISO Image

This guide is intended for server providers offering Cloud, VPS, or Dedicated servers who want to enable fast image deployment with OpenPanel.

Creating an OpenPanel ISO image is straightforward. Follow these steps:

1. **Install and configure OpenPanel** on your server.
2. **Power off the server.**
3. **Create an image** of the server.

> ⚠️ **Note:** Your server’s hostname and email settings are preserved in the image. You will need to update these after deploying the image.

Some settings can be configured automatically during deployment, like the hostname. Others, such as email and database credentials, must be updated manually.

### Example: Update panel domain

```bash
opencli domain YOUR_DOMAIN
```

Additionally, it is recommended to **change the MySQL root password** and update it in `/etc/my.cnf` to ensure security.

---

// File: articles/install-update/how-to-check-openpanel-version

# Check Version

To check OpenPanel version from terminal:

```bash
opencli version 
```

Example output:

```bash
root@server:~# opencli version
1.7.5
```

---

// File: articles/install-update/how-to-disable-auto-update-openpanel

# Disable Updates

<Tabs>
  <TabItem value="openadmin-admin-updates" label="With OpenAdmin" default>

To disable automatic updates, navigate to **OpenAdmin > Settings > Update Preferences** and change 'Update automatically' option to 'Never':

![openadmin update preferences](/img/admin/openadmin_set_update_preferences.png)

  </TabItem>
  <TabItem value="CLI" label="With OpenCLI">

To disable automatic updates from the terminal use commands:

```bash
opencli config update autoupdate no
```

```bash
opencli config update autopatch no
```
  </TabItem>
</Tabs>

---

// File: articles/install-update/how-to-enable-auto-update-openpanel

# Enable Updates

- `autopatch` option allows Administrator to automatically update OpenPanel to minor versions. MINOR versions include only security updates and bug fixes.
- `autoupdate` option allows Administrator to enable or disable automatic updates to major versions. MAJOR versions add new functionality in a backward compatible manner.

<Tabs>
  <TabItem value="openadmin-admin-updates" label="With OpenAdmin" default>

To enable automatic updates, navigate to **OpenAdmin > Settings > Update Preferences** and change 'Update automatically' option to 'Both':

![openadmin update preferences](/img/admin/openadmin_set_update_preferences.png)

  </TabItem>
  <TabItem value="CLI" label="With OpenCLI">

To enable automatic updates from the terminal use commands:

```bash
opencli config update autoupdate yes
```

```bash
opencli config update autopatch yes
```
  </TabItem>
</Tabs>

---

// File: articles/install-update/how-to-manually-update-openpanel

# Manually Update

When a new update is available, you will receive a notification in the OpenAdmin panel.

<Tabs>
  <TabItem value="openadmin-admin-update-now" label="With OpenAdmin" default>

To manually update OpenPanel, navigate to **OpenAdmin > Settings > Update Preferences** and click on the "Update Now" button.

NOTE: update is visible only if newer version is available.

  </TabItem>
  <TabItem value="CLI-update-now" label="With OpenCLI">

To update OpenPanel manually from the terminal, run the following command:

```bash
opencli update --force
```
[Documentation for `opencli update` command](https://dev.openpanel.com/cli/update.html)

  </TabItem>
  
</Tabs>

---

// File: articles/install-update/install-on-aws

# Installation on AWS EC2

This guide will walk you through deploying **OpenPanel** on an AWS EC2 instance with Ubuntu or Debian.

## Prerequisites

- An active [AWS account](https://aws.amazon.com/console/).
- Basic familiarity with EC2, SSH, and terminal commands.

---

## Step 1: Launch an EC2 Instance

1. Log in to the **[AWS Management Console](https://aws.amazon.com/console/)**.
2. Navigate to **EC2** → **Instances** → **Launch instances**.
3. Select an operating system (choose one of the following):
   - Ubuntu 24.04
   - Debian 11  
   *(x86 or ARM architecture is supported)*.
4. Choose an instance type meeting the minimum requirements:
   - **1 CPU**
   - **1 GB RAM**  
   *(Recommended: `t3.small` or equivalent)*.

---

## Step 2: Configure SSH Access

1. Create or select an existing **key pair** for SSH access.
2. Download the private key (`.pem`) and store it securely.

---

## Step 3: Configure Network Settings

1. Select the desired **VPC** and **subnet**.
2. Create a **security group** allowing all TCP traffic:  
   > OpenPanel manages its own firewall, so allowing all TCP is acceptable.
3. Allocate and associate an **Elastic IP** to your instance for a fixed public IP.

---

## Step 4: Connect to Your Instance

Use SSH to connect to your EC2 instance:

```bash
ssh -i your_private_key.pem ubuntu@yourElasticIpAddress
```

> Replace `your_private_key.pem` with your key file and `yourElasticIpAddress` with the allocated Elastic IP.


---



## Step 5: Run the OpenPanel Installer

Once logged in, run the installer script:

```bash
bash <(curl -sSL https://openpanel.org)
```

---

## Step 6: Access OpenPanel

After installation:

1. Open your browser and navigate to your Elastic IP and port `2087`.

---

## Notes

* Ensure your server meets [the minimum requirements](https://openpanel.com/docs/admin/intro/#requirements) for OpenPanel.
* For production environments, consider restricting access to your security group after installation for security.
* Refer to the [OpenPanel Install Command Generator](https://openpanel.com/install) for advanced configuration.

---

**Congratulations!** You have successfully installed OpenPanel on AWS EC2.

---

// File: articles/install-update/install-on-digitalocean

# OpenPanel Installation on DigitalOcean

This guide will walk you through deploying **OpenPanel** on a DigitalOcean Droplet with Ubuntu.

---

## Prerequisites

- An active [DigitalOcean account](https://www.digitalocean.com/).
- Basic familiarity with SSH and terminal commands.

---

## Step 1: Create a Droplet

1. Log in to your **DigitalOcean account**.
2. Click **Create → Droplet**.
3. Choose an operating system:
   - Ubuntu 24.04
4. Select a **Droplet size**:
   - Recommended: **1 CPU, 2 GB RAM** (Premium AMD with NVMe SSD suggested for performance)
5. Choose **authentication**:
   - **SSH key** (recommended) or password authentication
6. Assign a **Reserved IP** for a static IP address.
7. Complete creation and note your Droplet’s IP address.

---

## Step 2: Connect to Your Droplet

Use SSH to connect:
```bash
ssh root@yourDropletIpAddress
````

> Replace `yourDropletIpAddress` with the static IP you assigned to your Droplet.

---

## Step 3: Run the OpenPanel Installer

Once logged in, run the installer script:
```bash
bash <(curl -sSL https://openpanel.org)
```

---

## Step 4: Access OpenPanel

1. Open your browser and navigate to:

```
https://yourDropletIpAddress:2087
```

2. Log in using the credentials created during installation.

---

## Notes

* Ensure your Droplet meets [OpenPanel minimum requirements](https://openpanel.com/docs/admin/intro/#requirements).
* For production, restrict firewall access to limit exposure after installation.
* Use the [OpenPanel Install Command Generator](https://openpanel.com/install) for advanced configuration options.

---

**Congratulations!** You have successfully installed OpenPanel on DigitalOcean.

---

// File: articles/install-update/install-on-google-cloud

# OpenPanel Installation on Google Cloud

This guide will walk you through deploying **OpenPanel** on a Google Cloud VM instance with Ubuntu.

---

## Prerequisites

- An active [Google Cloud account](https://console.cloud.google.com/).
- Basic familiarity with SSH, Compute Engine, and firewall settings.

---

## Step 1: Create a VM Instance

1. Log in to the **Google Cloud Console**.
2. Navigate to **Compute Engine → VM instances → Create Instance**.
3. Choose a **boot disk image**:
   - Ubuntu 24.04
4. Select a **machine type** meeting the minimum requirements:
   - **1 CPU, 2 GB RAM** (recommended: `e2-small` or equivalent)
5. Add a **network tag** (e.g., `OPENPANEL`) for firewall rules.
6. In **Network interfaces**, assign a **static external IP**.
7. Click **Create** to launch the VM.

---

## Step 2: Configure Firewall Rules

1. Navigate to **VPC Network → Firewall rules → Create Firewall Rule**.
2. Configure the rule:
   - **Targets:** Specified target tags → `OPENPANEL`
   - **Source IP ranges:** `0.0.0.0/0`
   - **Protocols and ports:** `tcp:2087` (admin panel port)
3. Save the firewall rule.

> OpenPanel manages its own internal firewall; the above rule allows external access to the admin panel.

---

## Step 3: Connect to Your VM

Use SSH to connect:

```bash
ssh username@yourStaticIpAddress
````

> Replace `username` with your VM username (e.g., `ubuntu` or `debian`) and `yourStaticIpAddress` with your static external IP.

---

## Step 4: Run the OpenPanel Installer

Once connected, run the installer script:

```bash
bash <(curl -sSL https://openpanel.org)
```

> Follow the prompts to select your preferred database engine and complete installation.

---

## Step 5: Access OpenPanel

1. Open your browser and navigate to:

```
https://yourStaticIpAddress:2087
```

2. Log in using the credentials created during installation.

---

## Notes

* Ensure your VM meets [OpenPanel minimum requirements](https://openpanel.com/docs/admin/intro/#requirements).
* After installation, consider restricting firewall access for better security.
* Use the [OpenPanel Install Command Generator](https://openpanel.com/install) for advanced configuration options.

---

**Congratulations!** You have successfully installed OpenPanel on Google Cloud.

---

// File: articles/install-update/install-on-microsoft-azure

# OpenPanel Installation on Microsoft Azure

This guide will walk you through deploying **OpenPanel** on an Azure Virtual Machine with Ubuntu.

---

## Prerequisites

- An active [Microsoft Azure account](https://portal.azure.com/).
- Basic familiarity with SSH, Azure Virtual Machines, and network/firewall settings.

---

## Step 1: Create a Virtual Machine

1. Log in to the **[Azure Portal](https://portal.azure.com/)**.
2. Navigate to **Virtual Machines → Create → Virtual Machine**.
3. Select an **image**:
   - Ubuntu 24.04
4. Choose a **size** meeting the minimum requirements:
   - **1 CPU, 2 GB RAM** (recommended: `Standard_B1s` or equivalent)
5. Choose **authentication type**:
   - **SSH public key** (recommended)
   - Enter a username and upload or paste your SSH public key
6. Configure networking and firewall settings:
   - Allow all TCP traffic **or** specific ports:
     - `22` (SSH)
     - `80` (HTTP)
     - `443` (HTTPS)
     - `2083` (OpenPanel)
     - `2087` (OpenAdmin)
     - `443 UDP` (for HTTP/3 support)

---

## Step 2: Connect to Your Virtual Machine

Use SSH to connect:

```bash
ssh -i your_private_key azure@yourIpAddress
````

> Replace `your_private_key` with your private key file and `yourIpAddress` with the public IP of your VM.

---

## Step 3: Run the OpenPanel Installer

Once logged in, run the installer script:

```bash
bash <(curl -sSL https://openpanel.org)
```

> Follow the prompts to select your preferred database engine and complete installation.

---

## Step 4: Access OpenPanel

1. Open your browser and navigate to:

```
https://yourIpAddress:2087
```

2. Log in using the credentials created during installation.

---

## Notes

* Ensure your VM meets [OpenPanel minimum requirements](https://openpanel.com/docs/admin/intro/#requirements).
* After installation, consider restricting firewall access for better security.
* Use the [OpenPanel Install Command Generator](https://openpanel.com/install) for advanced configuration options.

---

**Congratulations!** You have successfully installed OpenPanel on Microsoft Azure.

---

// File: articles/install-update/install-on-virtualizor

# Installing OpenPanel on Virtualizor

To add OpenPanel to your Virtualizor server as an additional control panel available for your users to install:

1. Log in to your server:
   * as root via SSH, or
   * as a user with sudo privileges and type `sudo -i`.

2. Copy and paste the following command into the terminal:
```bash
bash <(curl -sSL https://raw.githubusercontent.com/stefanpejcic/OpenPanel-Virtualizor/refs/heads/main/INSTALL.sh)
```

---

// File: articles/install-update/install-on-vultr

# OpenPanel Installation on Vultr

This guide will walk you through deploying **OpenPanel** on a Vultr instance with Ubuntu.

---

## Prerequisites

- An active [Vultr account](https://www.vultr.com/).
- Basic familiarity with SSH and terminal commands.

---

## Step 1: Create a Vultr Instance

1. Log in to your **Vultr account**.
2. Click **Products → Deploy New Instance**.
3. Choose a **server location** near your users.
4. Select an **OS image**:
   - Ubuntu 24.04
5. Choose a **server size** meeting minimum requirements:
   - **1 CPU, 2 GB RAM** (recommended: `Cloud Compute` or equivalent)
6. Configure **SSH key authentication** (recommended) and add your public key.
7. Complete the instance creation.

---

## Step 2: Connect to Your Instance

Use SSH to connect:

```bash
ssh root@yourInstanceIp
````

> Replace `yourInstanceIp` with the public IP of your Vultr instance.

---

## Step 3: Run the OpenPanel Installer

Run the installation script:

```bash
bash <(curl -sSL https://openpanel.org)
```

> Follow the prompts to select your preferred database engine and complete installation.

---

## Step 4: Access OpenPanel

1. Open your browser and navigate to:

```
https://yourInstanceIp:2087
```

2. Log in using the credentials created during installation.

---

## Notes

* Ensure your Vultr instance meets [OpenPanel minimum requirements](https://openpanel.com/docs/admin/intro/#requirements).
* For production environments, consider restricting firewall access after installation.
* Use the [OpenPanel Install Command Generator](https://openpanel.com/install) for advanced configuration options.

---

**Congratulations!** You have successfully installed OpenPanel on Vultr.

---

// File: articles/install-update/install-using-ansible

# Installing OpenPanel via Ansible

Use the following **Ansible playbook** to install OpenPanel on one or more target machines:

```yaml
---
- name: Install OpenPanel on target machine
  hosts: all
  become: true
  vars:
    # Customize installation flags as needed. Full list: https://openpanel.com/install
    openpanel_install_flags: "--debug --username=admin --password=super123"

  tasks:
    - name: Download and run OpenPanel installer
      shell: |
        curl -sSL https://openpanel.org | bash -s -- {{ openpanel_install_flags }}
      args:
        executable: /bin/bash
```

Save this as `install-openpanel.yml` and run:

```bash
ansible-playbook -i inventory install-openpanel.yml
```

This will automatically install OpenPanel on all machines in your inventory.

---

// File: articles/install-update/install-using-cloudinit

# Installing OpenPanel via Cloud-Init

Use the following **cloud-init YAML** configuration to automatically install OpenPanel on your server during first boot:

```yaml
#cloud-config
packages:
  - curl
  - lsb-release
  - gnupg

runcmd:
  - curl -fsSL https://openpanel.org/ | bash
```

---

// File: articles/install-update/install

# Installing OpenPanel

Before starting, ensure your server meets [the minimum requirements](/docs/admin/intro/#requirements) and runs a supported distribution.

To install OpenPanel on your server:

1. Log in to your new server;
- as root via SSH or
- as a user with sudo privileges and type "sudo -i"
2. Copy and paste openpanel installation command into the terminal
```shell
bash <(curl -sSL https://openpanel.org)
```

The installation script supports [optional flags](/install) that can be used to configure openpanel, skip certain installation steps or simply display debugging information.

If you encountered any errors while running the installation script, please copy & paste the installation log file to [the community forums](https://community.openpanel.org).

---

// File: articles/install-update/openpanel-main-ip-address

# Main IP in OpenPanel

The network configuration of the server determines the server's main IP address. The Main IP address is **not** configurable through OpenPanel.

A network administrator or your hosting provider can only modify it. The main IP address is the IP address that the kernel selects as the default outbound IP address. For this reason, this is the IP address that the OpenPanel licensing system uses as the IP address of your server.

To check the current IP address:

```bash
curl -4Lk https://ip.openpanel.com
```

---

For assigning a specific IP address to a user, see: [How to set a Dedicated IP address for a user](/docs/articles/accounts/set-dedicated-ip-address-for-user)

---

// File: articles/install-update/openpanel-post-install-hook

# OpenPanel Post-install script

To execute custom code after OpenPanel installation process, use the `--post_install=` flag and specify the path or link to your script.

Example:

```bash
 --post_install=/root/my_custom_script.sh
```

Example:

```bash
 --post_install=https://example.net/scripts/my_custom_script.sh
```

---

// File: articles/install-update/skip-specific-openpanel-version-update

# Skip Update

OpenPanel can be updated either **automatically** or **manually**, depending on your preferences.

The update process performs the following actions:

* Pulls the latest OpenPanel UI Docker image from Docker Hub
* Updates the OpenAdmin UI from the latest GitHub release
* Updates OpenCLI commands from GitHub
* Executes any update scripts provided for configuration changes
* Checks and installs updates via the system package manager
* Updates docker compose to latest version
* Verifies if any kernel updates require a reboot
* Executes post-update scripts if provided by the administrator

If both **autoupdate** and **autopatch** options are enabled, updates will be applied automatically when a new version is released.

However, you can **skip specific versions** by listing them in the following file:

```
/etc/openpanel/upgrade/skip_versions
```

### When to Use This

This is useful, for example, if a changelog announces the removal of a feature you rely on. By skipping that version, you can ensure your current setup remains unaffected.

### How to Skip a Version

1. Create the directory (if it doesn't already exist):

```bash
mkdir -p /etc/openpanel/upgrade/
```

2. Add the version number you want to skip:

```bash
echo 1.4.9 >> /etc/openpanel/upgrade/skip_versions
```

Now, when version `1.4.9` is released, it will be ignored even if autoupdates are enabled.

You can add as many versions as needed:

```bash
echo 1.5.0 >> /etc/openpanel/upgrade/skip_versions
echo 1.5.1 >> /etc/openpanel/upgrade/skip_versions
```

That's it - a simple and effective control over your OpenPanel update process.

---

// File: articles/license/hot_to_cancel_openpanel_license

# How do I cancel my license in the my.openpanel.com?

To cancel a license purchased through the my.openpanel.com website, follow the steps below:

1. Log in to your [my.openpanel.com](https://my.openpanel.com/index.php?rp=/login) account.
   ![openpanel login form](/img/whmcs/1_login.png)
2. Navigate to **Licenses**, then click **My Licenses**.
   ![list licenses](/img/whmcs/2_license.png)
3. Click on **Active** next to the license you wish to cancel.
   ![select license](/img/whmcs/3_active.png)
4. Click **Cancel**.
   ![cancel](/img/whmcs/4_cancel.png)
5. Click on **Request Cancellation**.
   ![confirm](/img/whmcs/5_request_cancel.png)

- If *Immediate* is selected: your license will be immediately terminated.
- If *End of billing period* is selected: your license will be terminated at the end of the billing period and tou will no longer receive invoices for it.

---

// File: articles/license/how_to_downgrade_openpanel_license

# Downgrade License

OpenPanel is available in two editions:

- **Community** - a free hosting control panel for Debian and Ubuntu OS, suitable for VPS and private use.
- **Enterprise** - offers advanced features for user isolation and management, suitable for web hosting providers.

More information: [OpenPanel Community VS Enterprise edition](/enterprise)

## Downgrade

:::info
Downgrading from the Enterprise to the Community edition will immediately remove all Enterprise features and modules from the OpenPanel UI. Existing enterprise services - such as FTP and email - will continue running, but you will no longer have the ability to manage them from the OpenPanel interface.
:::

To downgrade from Enterprise edition to Community:

- From OpenAdmin:
  Navigate to **OpenAdmin > License** and click on the 'Downgrade' button:
  
  ![remove license key](/img/guides/downgrade_license.png)

- From terminal:
  ```bash
  opencli license delete
  ```

---

// File: articles/license/openpanel-refund-policy

# OpenPanel Refund Policy

New OpenPanel Enterprise licenses purchased through my.openpanel.com are eligible for a refund within **7 days** of the purchase date, **provided the license has not been activated**. Once a license key is activated, no refund will be issued regardless of the time elapsed since purchase.

> **Note**: This policy only applies to **new license purchases** and does not include license renewals.

[Refund Policy](/refund-policy)

## Requesting a Refund

To request a refund for an eligible new license, please [submit a request](https://my.openpanel.com/submitticket.php?step=2&deptid=1) to our Customer Service team.

## Renewals and Cancellations

**Important**: If your license auto-renewed or is canceled after the 72-hour refund window (Only applies to new license purchases), it will not qualify for a refund.

In such cases, you can follow the steps to cancel the license using this article: [How do I cancel my OpenPanel license?](/docs/articles/license/hot_to_cancel_openpanel_license)

---

// File: articles/license/openpanel_enterprise_for_nonprofits

# Educational or NPO

How to get a discount for OpenPanel licenses for educational or non-profit organizations:

Are there discounts on OpenPanel Enterprise licenses for educational institutions or non-profit organizations?

Yes, we offer discounts for educational institutions and non-profit organizations. Please [reach out](mailto:info@openpanel.com) to us with the following details:

- Contact information, including the full address and the name of the contact person.
- The number of Enterprise licenses needed.
- The intended purpose for the licenses.

---

// File: articles/license/pricing

# OpenPanel Pricing

OpenPanel is available in two editions:

- **OpenPanel Community** is a free version of the panel that is limited to 3 user accounts and 50 domains, which should be more than enough for personal use.
- **OpenPanel Enterprise** unlocks premium features for user isolation and management, suitable for web hosting providers. It has API access and can easily be integrated with 3rd party billing tools like WHMCS and FOSSBilling.

[OpenPanel Community VS Enterprise](/enterprise)

---

// File: articles/license/transfer-openpanel-license-to-new-server

# Transfer License to a New Server

Follow these steps to transfer your **OpenPanel Enterprise Edition** license to another server:

1. Disable the license on your current server.
2. Reissue the license from your [my.openpanel.com](https://my.openpanel.com) account.
3. Add the license to your new server.

---

## 1. Remove License from the Old Server

On the server where your license is currently activated, remove the license using one of the following methods:

* **From OpenAdmin:**
  Go to **OpenAdmin > License** and click the **Downgrade** button.
  ![Downgrade license](/img/docs-content/RSsLWmLQ-downgrade.png)

* **From the Terminal:**

  ```bash
  opencli license delete
  ```

Once the license has been removed from the old server, continue to the next step.

---

## 2. Reissue the License

Each license is automatically bound to the IP address of the server where it’s first activated.
To transfer it to a new server, you need to **reissue** the license:

1. Log in to your [my.openpanel.com account](https://my.openpanel.com/index.php?rp=/login).
2. Go to the [Licenses](https://my.openpanel.com/clientarea.php?action=services) section.
   ![Licenses list](/img/docs-content/KjG6p24j-lienses.png)
3. Find the license you want to move and click on it.
   ![License list](/img/docs-content/xC0pnPQZ-rows.png)
4. Click the **Reissue** button.
   ![Reissue license](/img/docs-content/xC0pnPQZ-rows.png)

After reissuing, the license is no longer tied to any IP address.
It will automatically bind to the next server where you activate it.

---

## 3. Add License to the New Server

Now, activate the license on your new server. You can do this in one of two ways:

* **From OpenAdmin:**
  Go to **OpenAdmin > License**, enter your license key, and click **Save key**.
  ![Add license key](/img/guides/add_key.png)

* **From the Terminal:**

  ```bash
  opencli license add YOUR-KEY-HERE
  ```

---

**That’s it!** Your OpenPanel Enterprise license is now successfully transferred to the new server.

---

// File: articles/license/upgrade_to_openpanel_enterprise_and-activate_license

# Upgrade to Enterprise

OpenPanel is available in two editions:

- **Community** - a free hosting control panel for Debian and Ubuntu OS, suitable for VPS and private use.
- **Enterprise** - offers advanced features for user isolation and management, suitable for web hosting providers.

More information: [OpenPanel Community VS Enterprise edition](/enterprise)

## Purchase License

To purchase a license for the OpenPanel Enterprise edition [click here](https://my.openpanel.com/cart.php?a=add&pid=1).

After payment, license key is automatically issued and you will see it under the Services page:

![license key](/img/guides/add_license.png)

## Add License Key

### To existing installation:

- From OpenAdmin:
  If you already have OpenPanel Community edition installed, navigate to **OpenAdmin > Try Enterprise** and add the key into the form:
  
  ![add license key](/img/guides/add_key.png)

- From terminal:
  ```bash
  opencli license enterprise-XXX
  ```
  Replace `enterprise-XXX` with your license key.
  
  ![opencli license](/img/guides/key_command.png)

### To new installation:

If you will be installing OpenPanel Enterprise on another server, copy the install command from your service page and paste it into new server:

![install command](/img/guides/key_code.png)

---

// File: articles/license/what_happens_when_openpanel_enterprise_license_expires

# How license expiration affects OpenPanel

When the Enterprise license expires, all OpenAdmin UI pages are redirected to a **“License Expired”** page, example:

![license expired openadmin](/img/docs-content/Xj7ncdPm-Snimak-ekrana-napravlen-dana-2026-03-05-19-40-35.png)

This continues until the license key is removed. Once the key is removed, the admin panel automatically downgrades to the **Community Edition**, meaning premium features are no longer available.

The **OpenPanel UI** continues to function normally, and all features remain accessible to existing users.

To downgrade OpenPanel Enterprise to Community edition: [How-to Guides > Downgrade License](/docs/articles/license/how_to_downgrade_openpanel_license/)

**Summary**

- **License expired, key still present:** Admin panel is blocked; user panel works normally.  
- **License expired, key removed:** Admin panel downgrades to Community Edition features only.

Our goal is not to lock you into using the panel or increase prices year after year. We provide the **Community Edition** so you can familiarize yourself with the stack.

You can also start [a **30-day trial** to access premium features](/blog/openpanel-enterprise-free-trial/).

Finally, we offer a **fixed pricing guarantee**, so your subscription remains stable at [**€14.95/month** or **€149.50/year**](https://my.openpanel.com/index.php?rp=/store/openpanel/enterprise-license).

---

// File: articles/opencli/admin

# Admin

enable/disable the admin panel, reset password, add admin users, etc.

```bash
Usage: opencli admin <command> [options]

Commands:
  on                                            Enable and start the OpenAdmin service.
  off                                           Stop and disable the OpenAdmin service.
  log                                           Display the last 25 lines of the OpenAdmin error log.
  logs                                          Display live logs for all OpenAdminn services.
  list                                          List all current admin users.
  new <user> <pass>                             Add a new user with the specified username and password.
  password <user> <pass>                        Reset the password for the specified admin user.
  update <user> --allowed_plans=[] --max_accounts=<int> --max_disk_blocks=1000000 Assign plans and set limits for reseller.
  rename <old> <new>                            Change the admin username.
  suspend <user>                                Suspend admin user.
  unsuspend <user>                              Unsuspend admin user.
  notifications <command> <param> [value]       Control notification preferences.

  Notifications Commands:
    check                                       Check and write notifications.
    get <param>                                 Get the value of the specified notification parameter.
    update <param> <value>                      Update the specified notification parameter with the new value.

Examples:
  opencli admin on
  opencli admin off
  opencli admin log
  opencli admin logs
  opencli admin list
  opencli admin new stefan SuperStrong1
  opencli admin password stefan SuperStrong2
  opencli admin rename stefan pejcic
  opencli admin suspend pejcic
  opencli admin unsuspend pejcic
  opencli admin notifications check
  opencli admin notifications get ssl
  opencli admin notifications update ssl true
```



### Check Status

Check if admin panel is enabled or disabled and display link on which the OpenAdmin is accessibe:

```bash
opencli admin
```

Example:
```bash
# opencli admin
● OpenAdmin is running and is available on: https://server.openpanel.co:2087/
```

### Enable / Disable OpenAdmin

OpenAdmin can run in headless mode, that is to say without a front-end UI. This can further save on memory requirements and keep your server secure.

To disable access to the OpenAdmin panel:

```bash
opencli admin off
```

To enable access to the OpenAdmin panel:

```bash
opencli admin on
```
### List Admin users

To view all admin accounts:

```bash
opencli admin list
```

### Create new Admin

To create new admin accounts:

```bash
opencli admin new <username> <password>
```


### Create new Reseller

To create new reseller accounts:

```bash
opencli admin new <username> <password> --reseller
```

### Reset Admin Password

To reset the password for an admin user:

```bash
opencli admin password <username> <new_password>
```

### Rename Admin User

To rename an existing admin user:

```bash
opencli admin rename <old_username> <new_username>
```

### Suspend Admin User

To suspend an existing admin user:

```bash
opencli admin suspend <username>
```

### Unsuspend Admin User

To unsuspend an existing admin user:

```bash
opencli admin unsuspend <username>
```

### Delete Admin User

To rename an existing admin user:

```bash
opencli admin delete <username>
```

:::info
Note: User with 'admin' role can not be deleted.
:::



## Notifications

`opencli admin notifications` allows you to change the notification preferences.

Settings are stored in `/etc/openpanel/openadmin/config/notifications.ini` file. However, it is recommended not to modify this file directly. Instead, it's best to utilize the opencli commands. This way, any changes made are immediately applied, and the admin service is automatically restarted only when necessary.

#### Get

The `get` parameter allows you to view current notification settings.

```bash
opencli admin notifications get <OPTION>
```

Example:

```bash
# opencli admin notifications get reboot
yes
```

#### Update

The `update` parameter allows you to change the notification settings.


```bash
opencli admin notifications update <OPTION> <NEW-VALUE>
```

Example:
```bash
opencli admin notifications update load 10
Updated load to 10
```

#### Options

Currently available options for notifications are:

- reboot
- attack
- limit
- update
- load
- swap
- cpu
- ram
- du


### View OpenAdmin logs

To multitail [all OpenAdmin logs](/logs.html):

```bash
opencli admin logs
```


To tail OpenAdmin error log:

```bash
opencli admin log
```

---

// File: articles/opencli/api

# API

:::info
API access is available only on [OpenPanel Enterprise edition](https://openpanel.com/beta/)
:::

## Enable

To enable OpenAdmin API access:

```bash
opencli api on
```

## Disable

To disable OpenAdmin API access:

```bash
opencli api off
```

## Status

To check current OpenAdmin API status:

```bash
opencli api status
```

## API list

`opencli api list` displays all available api endpoints for the installed OpenAdmin version.

```bash
opencli api list
```

![available endpoints](/img/docs-content/KjkSXLsT-2024-09-04-18-22.png)

---

// File: articles/opencli/config

# Config

`opencli config` allows you to change the settings for the user interface.


## Get
The `get` parameter allows you to view current settings.
```bash
opencli config get <OPTION>
```

Example:
```bash
# opencli config get api
off
```

## Update
The `update` parameter allows you to change the settings.
```bash
opencli config update <OPTION> <NEW-VALUE>
```

Example:
```bash
opencli config update api on nesto.rs
Updated api to on
```

:::info
To apply the new settings, OpenPanel UI willl be restarted if needed.
:::

## Available Options
Currently available configuration options:

### logo
`logo` allows you to set a url for image *(suggested dimensions are 80x200px) that will be displayed to users on:

- every page
- login page
- notification emails footer

```bash
logo=https://http.cat/images/100.jpg
```

### brand_name

`brand_name` allows you to brand the OpenPanel name that users see in their user panel with your custom brand name.

This brand name is displayed in the following positions:
- on top left when logo is not provided
- in the page title
- in the footer text on every page
  

```bash
brand_name=pcx3.com
```

### max_login_records

`max_login_records` determines how many records are kept for every users login history page. Default value, if empty is 20.

```bash
max_login_records=20
```

### default_php_version

`default_php_version` sets the PHP version used for new accounts. Default value is 8.3

```bash
default_php_version=8.3
```


### domains_per_page

Set number of domains to show per page for the user, default value is 100.

```bash
domains_per_page=100
```

### domain_log_per_page

Set number of lines (table rows) to display per page on *Domains > Access Logs* and *Advanced > WAF Logs*. Default value is 500.

```bash
domain_log_per_page=500
```

### domain_log_max_for_show_all

Set maximum number of lines (table rows) to display **when user selects *show_all* option** on *Domains > Access Logs* and *Advanced > WAF Logs*. Default value is 10000.

```bash
domain_log_max_for_show_all=10000
```

### acccess_logs_per_page

Set number of lines to show per page from the domains activity log.

```bash
acccess_logs_per_page=1000
```

### resource_usage_items_per_page

Set number of rows to display per page on the 'Resource Usage History' page.

```bash
resource_usage_items_per_page=100
```

### resource_usage_retention

Set number of records to keep for each user, default value is 100.

```bash
resource_usage_retention=100
```

### resource_usage_charts_mode
`resource_usage_charts_mode` allows you to set the number of charts displayed on users _Historical Resource Usage_ page.


- _one_ - displays a single chart for both CPU and RAM usage.
- _two_ (Default) - displays two charts: one for CPU and another for RAM. 
- _none_ - displays no charts.

```bash
resource_usage_charts_mode=two
```

### found_a_bug_link
When set to 'yes', a *Found a bug? Let us know* link appears in the bottom-right corner of all pages in the OpenPanel and OpenAdmin UI, allowing users to report issues directly on GitHub.

```bash
found_a_bug_link=yes
```

### ip_county_flag
When set to 'yes', a *Cuntry Code Flag* icon appears in the Dashboard page for last login IP address.
```bash
ip_county_flag=yes
```

### login_ratelimit
The `login_ratelimit` parameter allows you to specify the maximum number of failed login attempts per minute for each IP address accessing the OpenPanel interface. The default setting is `5`.

```bash
login_ratelimit=5
```

### login_blocklimit

The `login_blocklimit` parameter allows you to specify the maximum number of failed login attempts per IP before it is temporary blocked for one hour. The default setting is `20`.

```bash
login_blocklimit=20
```


### session_lifetime

The `session_lifetime` parameter allows you to specify the number of minutes that user session is valid after they login. If there are no user interactions during this period then the session espires. The default setting is `300`.

```bash
session_lifetime=300
```


### session_duration

The `session_duration` parameter allows you to specify the number of minutes that session is extended for after the `session_lifetime` setting based on user interactions. The default setting is `30`.

```bash
session_duration=30
```

### terminal_timeout

`terminal_timeout` enables you to set time in seconds to limit command execution from *OpenPanel > Docker > Terminal* and *OpenAdmin > Advanced > Terminal*.

```bash
terminal_timeout=30
```

### weakpass

`weakpass` enables you to check passwords against the [weakpass.com](https://weakpass.com/wordlist) dictionaries and prevent the use of weak passwords. By default, it is set to 'yes,' allowing weak passwords to be used.

```bash
weakpass=yes
```

### password_reset

`password_reset` allows you to enable or disable the password reset functionality for the login page. By default password reset is disabled.

```bash
password_reset=yes
```


### permit_username_change_by_user

`permit_username_change_by_user` allows Administrators to enable or disable the username change functionality by OpenPanel users from their Account page. By default username change is disabled.

```bash
permit_username_change_by_user=no
```

### avatar_type

`avatar_type` allows you to set the type of images used for users profile pictures in the users panel.


Available options:

- _gravatar_ - displays the gravatar picture associated with the email address of the user.
- _letter_ - displays a CSS generated icon using the users first letter of the username.
- _icon_ - displays a placeholder bootstrap icon representing the user.

```bash
avatar_type=gravatar
```

### logout_url

`logout_url` allows administrators to define the destination to which users should be redirected after they log out. The default setting directs them to the `/login` page.

```bash
logout_url=https://google.com
```

### activity_items_per_page

`activity_items_per_page` allows administrators to define the default number of displayed items on the `/activity` page, the value defaults to 25.

```bash
activity_items_per_page=50
```

### activity_lines_retention

`activity_lines_retention` allows administrators to define the default number of lines to keep for each user `/activity` log. The value defaults to 1500.

```bash
activity_lines_retention=1500
```


### activity_max_size_bytes

`activity_max_size_bytes` allows administrators to define the total size in bytes for each user `/activity` log. The value defaults to 2000000 (2MB).

```bash
activity_max_size_bytes=2000000
```



### nameservers

The `ns1` `ns2` `ns3` `ns4` options allow you to set nameservers that will be used in dns zone files for newly added domains, and displayed to users on their panel dashboard.
Nameservers should be added in pairs, ns1 and ns2, ns3 and ns4.

```bash
ns1=ns1.openpanel.com
ns2=ns2.openpanel.com
ns3=ns3.openpanel.com
ns4=ns4.openpanel.com
```

### enabled_modules

In OpenPanel version 0.1.5, we implemented the Modules feature, which, by default, loads only the essential modules. Administrators also have the option to selectively disable modules they do not require.


### logrotate_enable
Enable or disable **logrotate** for system logs: webserver, DNS, OpenPanel, FTP, MailServer, etc.
```bash
logrotate_enable=yes
```

* **yes** → Log rotation is active for supported services.
* **no** → Logs will grow indefinitely unless manually managed.

### `logrotate_size_limit`
Set the maximum log file size (in MB) before rotation occurs. Once a log file exceeds this size, it will be rotated automatically.

```bash
logrotate_size_limit=100
```

### `logrotate_retention`
Define the number of rotated log files to keep. Once the limit is reached, the oldest files are deleted.
```bash
logrotate_retention=10
```

* Example: If set to `10`, the system will keep 10 old log archives per log file.
* Helps control disk usage.

---

### `logrotate_keep_days`
Specify how many days rotated logs should be retained before deletion.
```bash
logrotate_keep_days=30
```

* Example: Setting to `30` means rotated logs older than 30 days will be removed.
* Works alongside `logrotate_retention` — whichever limit is hit first will trigger deletion.


### `goaccess_enable`

Enable or disable **GoAccess** web log analytics.

```bash
goaccess_enable=yes
```

* **yes** → GoAccess will process web server logs to generate analytics reports.
* **no** → Analytics will be disabled.

### `goaccess_schedule`

Set how often GoAccess reports should be generated.

```bash
goaccess_schedule=monthly
```

* Supported values: `daily`, `weekly`, `monthly`.
* Determines the frequency of log analysis and report generation.


### `goaccess_email`

Control whether GoAccess reports are emailed automatically.

```bash
goaccess_email=no
```

* **yes** → Reports are sent via email to the configured recipient.
* **no** → Reports are generated but not emailed.


### `goaccess_keep_days`

Specify how long GoAccess reports are retained before deletion.

```bash
goaccess_keep_days=365
```

* Example: `365` means reports older than one year will be removed automatically.
* Helps manage disk space while keeping historical analytics.



### autopatch

The `autopatch` option allows Administrator to automatically update OpenPanel to minor versions.

| Autopatch    | Update to minor version  | Update to major version  |
| -------- | ------- | ------- |
| yes | 1.0.2 will be updated to 1.0.3 | 1.0.2 will **NOT** be updated to 2.0.0 |
| no | 1.0.2 will **NOT** be updated to 1.0.3 | 1.0.2 will **NOT** be updated to 2.0.0 |

```bash
autopatch=yes
```

### autoupdate

The `autoupdate` option allows Aministrator to enable or disable automatic updates.

| Autoupdate    | Update to minor version  | Update to major version  |
| -------- | ------- | ------- |
| yes | 1.0.2 will **NOT** be updated to 1.0.3 | 1.0.2 will be updated to 2.0.0 |
| no | 1.0.2 will **NOT** be updated to 1.0.3 | 1.0.2 will **NOT** be updated to 2.0.0 |

```bash
autoupdate=yes
```


### twofa_nag

The `twofa_nag` option allows Administrator to set if 2FA nag should be displayed to users on their dashboard page.


```bash
twofa_nag=yes
```

### how_to_guides

The `how_to_guides` option allows Aministrator to enable or disable the How-to guides section from users dashboards.


```bash
how_to_guides=yes
```
If configured as "yes", the system will initially attempt to access a JSON file containing your custom how-to guides. In the event that the file is not available, articles from https://openpanel.com/docs/panel/dashboard/#how-to-guides will be shown instead.


### api

The `api` option allows the **Administrator** to enable or disable API functionality. The default value is `off`.

* **on** → API access is enabled.
* **off** → API access is disabled.

**Check current status**:
```bash
opencli config get how_to_guides
```

**Enable API**:
```bash
opencli config update how_to_guides on
```

**Disable API (default)**:
```bash
opencli config update how_to_guides off
```

### dev_mode

The `dev_mode` option allows Aministrator to view more verbose information in both OpenPanel and OpenAdmin, as well as their log files.

- displays detailed startup log
- verbose logging for API requests
- disables minified responses for both interfaces (HTML, JS, CSS and JSON)
- uses latest CDN for tailwindcss and alpinejs
- displays detailed processing of each request

* **on** → DEV_MODE is enabled.
* **off** → DEV_MODE is disabled.

**Check current status**:
```bash
opencli config get dev_mode
```

**Enable dev_mode**:
```bash
opencli config update dev_mode on
```

**Disable dev_mode (default)**:
```bash
opencli config update dev_mode off
```


### favicons

The `favicons` option allows you to specify api to use for favicon images.

To set api:
```
opencli config update favicons https://www.google.com/s2/favicons?domain=

opencli config update favicons https://favicon-api.openpanel.org/
```

For selfhosting favicon api, check [vemetric/favicon-api](https://github.com/Vemetric/favicon-api?tab=readme-ov-file#deployment)

### favorites_items

The `favorites_items` option controls total number of favorites items that user can have at a time. Default is 10.

To change value:

```
opencli config update favorites_items 5
```

### demo_mode

The `demo_mode` option allows Aministrator lock both OpenPanel and OpenAdmin UI in read-only mode, allowing users to login and view data, but not to make any changes.

* **on** → DEMO_MODE is enabled.
* **off** → DEMO_MODE is disabled.

**Check current status**:
```bash
opencli config get dev_mode
```

**Enable demo_mode**:
```bash
opencli config update dev_mode on
```

**Disable demo_mode (default)**:
```bash
opencli config update demo_mode off
```

### max_ram

The `max_ram` option allows Aministrator to set maximum % of available RAM that can be used by Docker service.

**Check current value**:
```bash
opencli config get max_ram
```

**Set new value**:
```bash
opencli config update max_ram 85
```

### max_cpu

The `max_cpu` option allows Aministrator to set maximum % of available CPU that can be used by Docker service.

**Check current value**:
```bash
opencli config get max_cpu
```

**Set new value**:
```bash
opencli config update max_cpu 95
```

### screenshots
The `screenshots` option allows Aministrator to set a custom screenshots api to be used for generating website screenshots. 

- If 'local' is defined then screenshots will be generated locally on the server.
- If left empty, default is our remote api
- To define custom screenshots api add it's url as value.

```bash
screenshots=http://screenshots-api.openpanel.com/screenshot
```


### temporary_links

The `temporary_links` option allows Aministrator to set a custom domain name to be used to generate temporary sub-domains for WP installations.

```bash
temporary_links=https://preview.openpanel.org/index.php
```

### blacklist_useragents

The `blacklist_useragents` option allows Administrators to blacklist certain useragents from accessing OpenPanel UI.

**Check current value**:
```bash
opencli config get blacklist_useragents
```

**Enable blacklist**:
```bash
opencli config update blacklist_useragents yes
```

**Disable blacklist**:
```bash
opencli config update blacklist_useragents no
```

### `mail_server`
Hostname or IP address of the SMTP mail server to be used for sending notifications to users.

**Check current value**:
```bash
opencli config get mail_server
```

**Set new value**:
```bash
opencli config update mail_server smtp.example.com
```


### `mail_port`
SMTP server port (common: 25, 465, 587).

**Check current value**:
```bash
opencli config get mail_port
```

**Set new value**:
```bash
opencli config update mail_port 465
```


### `mail_use_tls`
Enable or disable STARTTLS encryption.

**Check current value**:
```bash
opencli config get mail_use_tls
```

**Set new value**:
```bash
opencli config update mail_use_tls True
```


### `mail_use_ssl`
Enable or disable SSL/TLS for SMTP connections.

**Check current value**:
```bash
opencli config get mail_use_ssl
```

**Set new value**:
```bash
opencli config update mail_use_ssl True
```


### `mail_username`
SMTP username for authentication.

**Check current value**:
```bash
opencli config get mail_username
```

**Set new value**:
```bash
opencli config update mail_username user@example.com
```


### `mail_password`
SMTP password for authentication.

**Check current value**:
```bash
opencli config get mail_password
```

**Set new value**:
```bash
opencli config update mail_password yourpassword
```


### `mail_default_sender`
Default “From” address for outgoing emails.

**Check current value**:
```bash
opencli config get mail_default_sender
```

**Set new value**:
```bash
opencli config update mail_default_sender no-reply@example.com
```


### `mail_security_token`
Optional token for email API or internal security.

**Check current value**:
```bash
opencli config get mail_security_token
```

**Set new value**:
```bash
opencli config update mail_security_token 78bd237db2da
```


### `mail_debug`
Enable debug logging for email operations (each email sent from the OpenAdmin is stored as file on the server).

**Check current value**:
```bash
opencli config get mail_debug
```

**Set new value**:
```bash
opencli config update mail_debug True
```




### `autopurge_trash`
Automatically purge files in the File Manager trash after a number of days.

**Check current value**:
```bash
opencli config get autopurge_trash
```

**Set new value**:
```bash
opencli config update autopurge_trash 7
```


### `filemanager_buttons_style`

Set default buttons style on 'OpenPanel > File Manager' - Available 'classic' 'modern'

**Check current value**:
```bash
opencli config get filemanager_buttons_style
```

Set 'classic':
```bash
opencli config update filemanager_buttons_style classic
```

Set 'modern':
```bash
opencli config update filemanager_buttons_style modern
```

### `filemanager_edit_size`
Maximum file size (in MB) allowed for editing files using the File Manager.

**Check current value**:
```bash
opencli config get filemanager_edit_size
```

**Set new value**:
```bash
opencli config update filemanager_edit_size 5
```


### `filemanager_view_size`
Maximum file size (in MB) allowed for viewing files in the File Manager.

**Check current value**:
```bash
opencli config get filemanager_view_size
```

**Set new value**:
```bash
opencli config update filemanager_view_size 5
```


### `filemanager_download_size`
Maximum file size (in MB) allowed for downloading files using the File Manager.

**Check current value**:
```bash
opencli config get filemanager_download_size
```

**Set new value**:
```bash
opencli config update filemanager_download_size 2000
```


### `filemanager_upload_size`
Maximum file size (in MB) allowed for uploading files in the File Manager.

**Check current value**:
```bash
opencli config get filemanager_upload_size
```

**Set new value**:
```bash
opencli config update filemanager_upload_size 2000
```


### `filemanager_compress_max_time`
Maximum time (in seconds) allowed for compressing files using File Manager.

**Check current value**:
```bash
opencli config get filemanager_compress_max_time
```

**Set new value**:
```bash
opencli config update filemanager_compress_max_time 5
```


### `filemanager_extract_max_time`
Maximum time (in seconds) allowed for extracting archives using File Manager.

**Check current value**:
```bash
opencli config get filemanager_extract_max_time
```

**Set new value**:
```bash
opencli config update filemanager_extract_max_time 5
```


### `filemanager_download_max_time`
Maximum time (in seconds) allowed for downloading files.

**Check current value**:
```bash
opencli config get filemanager_download_max_time
```

**Set new value**:
```bash
opencli config update filemanager_download_max_time 60
```


### `filemanager_edit_extensions`

Allowed file extensions for editing in the File Manager.
**Check current value**:
```bash
opencli config get filemanager_edit_extensions
```

**Set new value**:
```bash
opencli config update filemanager_edit_extensions ".txt .md error_log .log env gitconfig cfg htaccess .ini .php .sh .html .json .htm .html5 .xml .py .php5 .php7 .php8 .sql .css .js .conf"
```


### `filemanager_image_extensions`
Allowed image file extensions to be viewed using Fle Manager.

**Check current value**:
```bash
opencli config get filemanager_image_extensions
```

**Set new value**:
```bash
opencli config update filemanager_image_extensions ".jpg .jpeg .png .gif .webp .avif"
```


### `filemanager_archives_extensions`
Allowed archive file extensions for compression/extraction.

**Check current value**:
```bash
opencli config get filemanager_archives_extensions
```

**Set new value**:
```bash
opencli config update filemanager_archives_extensions ".zip .tar .gz .tar.gz"
```


### `cron_max_file_size_kb`
Max size in KB for user's cronjob file `/home/{context}/crons.ini` to be editable via *OpenPanel > CronJobs* page. Default is `100`.

**Check current value**:
```bash
opencli config get cron_max_file_size_kb
```

**Set new value**:
```bash
opencli config update cron_max_file_size_kb 100
```


### `mysql_import_max_size_gb`
Max size in GB for file that is allowed to be imported via *OpenPanel > MySQL > Import* page. Default is `1`.

**Check current value**:
```bash
opencli config get mysql_import_max_size_gb
```

**Set new value**:
```bash
opencli config update mysql_import_max_size_gb 100
```

### `mysql_startup_time`
Max time in seconds to wait on *OpenPanel > MySQL* page when initializing database (first time user open the page) before considering mysql failed. Default is 10.

**Check current value**:
```bash
opencli config get mysql_startup_time
```

**Set new value**:
```bash
opencli config update mysql_startup_time `0
```


### `mysql_restricted_usernames`
List of usernames that will be considered system users and can not be edited via OpenPanel UI.

**Check current value**:
```bash
opencli config get mysql_restricted_usernames
```

**Set new value**:
```bash
opencli config update mysql_restricted_usernames "mysql.sys mysql sys mariadb.sys phpmyadmin mysql.session mysql.infoschema root debian-sys-maint healthcheck"
```


### `mysql_restricted_databases`
List of databases that will be considered system databases and can not be edited via OpenPanel UI.

**Check current value**:
```bash
opencli config get mysql_restricted_databases
```

**Set new value**:
```bash
opencli config update mysql_restricted_databases "information_schema performance_schema mysql phpmyadmin sys mariadb.sys"
```

---

// File: articles/opencli/docker

# Docker

Manage Docker settings: update docker images, set global resource limits for docker, etc.

### docker

Command opens interactive shell into user containers.

To view list of all users:
```bash
opencli docker
```

To view list of active containers for a user:
```bash
opencli docker <USERNAME>
```

To open terminal directly in a container for a user:
```bash
opencli docker <USERNAME> <container>
```


### Images

Uses [Cup 🥤](https://github.com/sergi0g/cup) to check for image updates and displays them on **OpenPanel > Containers > Image Updates**

Check image updates for specific user:
```bash
opencli docker-images <USERNAME>
```

Example:
```bash
root@test:/usr/local/opencli# opencli docker-images s70nesto

Running Cup in context: s70nesto
Output for user s70nesto saved to /home/s70nesto/docker-data/cup/cup.json

{"images":[{"in_use":false,"parts":{"registry":"registry-1.docker.io","repository":"shinsenter/php","tag":"8.2-fpm"},"reference":"shinsenter/php:8.2-fpm","result":{"error":null,"has_update":true,"info":{"current_version":"8.2","new_tag":"8.4-fpm","new_version":"8.4","type":"version","version_update_type":"minor"}},"server":null,"time":276,"url":"https://hub.docker.com/r/shinsenter/php/tags"},{"in_use":true,"parts":{"registry":"ghcr.io","repository":"sergi0g/cup","tag":"latest"},"reference":"ghcr.io/sergi0g/cup:latest","result":{"error":null,"has_update":false,"info":null},"server":null,"time":162,"url":"https://github.com/sergi0g/cup"},{"in_use":true,"parts":{"registry":"registry-1.docker.io","repository":"mcuadros/ofelia","tag":"latest"},"reference":"mcuadros/ofelia:latest","result":{"error":null,"has_update":false,"info":null},"server":null,"time":575,"url":"https://github.com/mcuadros/ofelia"},{"in_use":false,"parts":{"registry":"registry-1.docker.io","repository":"library/mysql","tag":"8.0"},"reference":"mysql:8.0","result":{"error":null,"has_update":true,"info":{"current_version":"8.0","new_tag":"9.3","new_version":"9.3","type":"version","version_update_type":"major"}},"server":null,"time":549,"url":null},{"in_use":false,"parts":{"registry":"registry-1.docker.io","repository":"library/phpmyadmin","tag":"latest"},"reference":"phpmyadmin:latest","result":{"error":null,"has_update":true,"info":{"local_digests":["sha256:5f37deab81ddca73cb44de568ecbe0109fd738a76d614f41833f6b0788ad4012"],"remote_digest":"sha256:db901a16f662cfa7857b55353883e91ce1dc45cfadf57e9631bb44a38274e69b","type":"digest"}},"server":null,"time":550,"url":"https://github.com/phpmyadmin/docker#readme"},{"in_use":false,"parts":{"registry":"registry-1.docker.io","repository":"library/httpd","tag":"latest"},"reference":"httpd:latest","result":{"error":null,"has_update":true,"info":{"local_digests":["sha256:f6557a77ee2f16c50a5ccbb2564a3fd56087da311bf69a160d43f73b23d3af2d"],"remote_digest":"sha256:1ae8051591a5ded56e4a3d7399c423e940e8475ad0e5adb82e6e10893fe9b365","type":"digest"}},"server":null,"time":552,"url":null}],"metrics":{"major_updates":1,"minor_updates":1,"monitored_images":6,"other_updates":2,"patch_updates":0,"unknown":0,"up_to_date":2,"updates_available":4}}
```

Check image updates for all users:
```bash
opencli docker-images --all
```

### logs

View logs sizes for user and system containers.


```bash
# opencli docker-logs

Usage: opencli docker-logs [options]

Options:
  <USERNAME>                                    Display log sizes for specified user.
  --system                                      Display log sizes just for system containers.
  --users                                       Display log sizes just for user containers.
  --all                                         Display log sizes for all user and system containers.

Examples:
  opencli docker-logs stefan
  opencli docker-logs --users
  opencli docker-logs --system
  opencli docker-logs --all

```


### Collect Stats

To collect docker resource usage information (cpu, ram, i/o) for all users:
```bash
opencli docker-collect_stats
```

`collect_stats` script will also rotate data according to [`resource_usage_retention` setting](/cli/config.html#resource-usage-retention)


### Limits DEPRECATED

Set global docker limits (storage, ram and cpu) for all system containers.
```bash
opencli docker-limits [--apply | --read]
```


To view current limits: 
```bash
opencli docker-limits --read
```

Example:
```bash
root@stefan:~# opencli docker-limits --read
[DOCKER]
max_ram=90
max_cpu=95
max_disk=114
```

#### CPU and RAM limit

To apply new limits for CPU % and RAM %:

```bash
opencli docker-limits --apply
```

#### Storage (disk) limit

To increase storage (disk) allocated to Docker, pass the size in **GB**:

```bash
opencli docker-limits --apply 100
```

---

// File: articles/opencli/domain

# Domain 

`opencli domain` command is used to set domain name for accessing the OpenPanel and OpenAdmin interfaces.

View current setting:
```bash
opencli domain
```

Set domain:

```bash
opencli domain set <DOMAIN_NAME>
```
Example:
```bash
opencli domain set srv7.openpanel.org
```

`--debug` flag can be passed to dispaly verbose information as script is running.

Note: If domain is not pointed to the server via A record and SSL can not be generated, then `http://IP` will be used instead of `https://DOMAIN`.

Set IP address to be used instead of domain:

```bash
opencli domain set ip
```

---

// File: articles/opencli/domains

# Domains


## All

Lists all domain names currently hosted on the server:

```bash
opencli domains-all
```

## User

Lists all domain names currently owned by a specific user.

```bash
opencli domains-user <USERNAME> [--docroot|--php_version]
```

## Add

Add a domain name for a user:

```bash
opencli domains-add <DOMAIN_NAME> <USERNAME> [--docroot DOCUMENT_ROOT] [--php_version N.N] [--skip_caddy --skip_vhost --skip_containers --skip_dns] --debug
```

### Custom Docroot

To add a domain name with custom docroot:

```bash
opencli domains-add <DOMAIN_NAME> <USERNAME> --docroot DOCUMENT_ROOT
```

### Custom PHP version

To add a domain name with custom PHP version:

```bash
opencli domains-add <DOMAIN_NAME> <USERNAME> --php_version N.N
```


### Skip Flags

> **Warning:** These flags are intended primarily for automation and debugging purposes and should generally **not be used manually in the terminal**.
> Most skip flags are used by automation scripts when adding multiple domains at once, allowing services to be started only after all domains have been provisioned. The `--skip_dns`, `--skip_vhost`, and `--skip_caddy` options are also useful for troubleshooting and retry operations.

* **Skip DNS** – Add a domain without creating a DNS zone:

  ```bash
  opencli domains-add <DOMAIN_NAME> <USERNAME> --skip_dns
  ```

* **Skip Vhosts** – Add a domain without creating virtual host configurations or starting the user's PHP and web server containers:

  ```bash
  opencli domains-add <DOMAIN_NAME> <USERNAME> --skip_vhost
  ```

* **Skip Containers** – Add a domain without starting the user's PHP and web server containers:

  ```bash
  opencli domains-add <DOMAIN_NAME> <USERNAME> --skip_containers
  ```

* **Skip Caddy** – Add a domain without creating a Caddy virtual host configuration:

  ```bash
  opencli domains-add <DOMAIN_NAME> <USERNAME> --skip_caddy
  ```

**Note:** These options are primarily intended for bulk provisioning workflows (like [cpanel account importer](/docs/articles/transfers/import-cpanel-backup-to-openpanel/) or [user transfer](/docs/articles/transfers/transfer-openpanel-account-to-another-server/)) and advanced troubleshooting scenarios.

## Suspend

Suspend a domain name:

```bash
opencli domains-suspend <DOMAIN_NAME>
```

## Unsuspend

Unsuspend a domain name:

```bash
opencli domains-unsuspend <DOMAIN_NAME>
```

## Delete

Delete a domain name:

```bash
opencli domains-delete <DOMAIN_NAME> [--debug]
```

## SSL

Check SSL for domain, add custom certificate, view files.

```bash
opencli domains-ssl <DOMAIN_NAME> [status|info|logs|auto|custom] [path/to/fullchain.pem path/to/key.pem]
```

### Examples

Display command examples for a specific domain:
```bash
opencli domains-ssl <DOMAIN_NAME>
```

### Status

Display current SSL status for a domain:
```bash
opencli domains-ssl <DOMAIN_NAME> status
```

### Info

View ceritificate files a domain:
```bash
opencli domains-ssl <DOMAIN_NAME> info
```

### Logs

View caddy SSL-related logs for a domain:
```bash
opencli domains-ssl <DOMAIN_NAME> logs
```

### Custom

Setup a custom SSL for a domain:
```bash
opencli domains-ssl <DOMAIN_NAME> custom <CERT_PATH> <KEY_PATH>
```

### Auto

Switch to autoSSL for a domain (default):
```bash
opencli domains-ssl <DOMAIN_NAME> auto
```

## Docroot

View and change docroot for a domain.

```bash
opencli domains-docroot <DOMAIN_NAME> [update </var/www/html/>] --debug
```

### View

To view the current docroot for a domain:
```bash
opencli domains-docroot <DOMAIN_NAME>
```

### Update

To update a docroot for a domain:
```bash
opencli domains-docroot <DOMAIN_NAME> update <docroot> [--debug]
```

## DNS

Manage DNS service and domain zones.


### Reconfig

To load new DNS zones into the Bind server:

```bash
opencli domains-dns reconfig
````

### Check

To check and validate a DNS zone for a domain:

```bash
opencli domains-dns check <DOMAIN_NAME>
```

### Reload

To reload a DNS zone for a single domain:

```bash
opencli domains-dns reload <DOMAIN_NAME>
```

### Show

To display the DNS zone for a single domain:

```bash
opencli domains-dns show <DOMAIN_NAME>
```

### List

To list all domains with DNS zones on the server:

```bash
opencli domains-dns list
```

### Create

To create a DNS zone for a domain:

```bash
opencli domains-dns create <DOMAIN_NAME>
```

### Delete

To delete a DNS zone for a domain:

```bash
opencli domains-dns delete <DOMAIN_NAME>
```

### Default

To restore the default DNS zone for a domain:

```bash
opencli domains-dns default <DOMAIN_NAME>
```

### Count

To display the total number of DNS zones present on the server:

```bash
opencli domains-dns count
```

### Config

To check the main Bind configuration file for syntax errors:

```bash
opencli domains-dns config
```

### Start

To start the DNS server:

```bash
opencli domains-dns start
```

### Restart

To perform a soft restart of the Bind9 Docker container:

```bash
opencli domains-dns restart
```

### Hard Restart

To perform a hard restart by terminating the container and starting it again:

```bash
opencli domains-dns hard-restart
```

### Stop

To stop the DNS server:

```bash
opencli domains-dns stop
```


## DNSSEC

Enable [DNSSEC](https://en.wikipedia.org/wiki/Domain_Name_System_Security_Extensions) for a domain and re-sign after changes the zone.

```bash
opencli domains-dnssec <DOMAIN_NAME> [--update | --check]
```

### Check

Check if domain has DNSSEC enabled:
```bash
opencli domains-dnssec <DOMAIN_NAME> --check
```

### Update

Configure/update DNSSEC for a domain:
```bash
opencli domains-dnssec <DOMAIN_NAME> --update
```


## HSTS

Manage [HSTS](https://en.wikipedia.org/wiki/HTTP_Strict_Transport_Security) for a domain.

```bash
opencli domains-hsts <DOMAIN_NAME> [on|off]
```

### Status
Check HSTS status for a domain:
```bash
opencli domains-hsts <DOMAIN_NAME> [on|off]
```

### Enable
Enable HSTS for a domain:
```bash
opencli domains-hsts <DOMAIN_NAME> on
```

### Disable
Disable HSTS for a domain:
```bash
opencli domains-hsts <DOMAIN_NAME> off
```


## Edit

Edit VirtualHosts file for a domain or enter its docroot.

```
opencli domains-edit <DOMAIN_NAME> [--ws]
```

### Docroot

`cd` into the domain docroot:
```
opencli domains-edit <DOMAIN_NAME>
```

### VHost

Open the VirtualHost file for a domain using `nano` edit, and upon saving restart user webserver:
```
opencli domains-edit <DOMAIN_NAME> --ws
```

## Stats

Parse caddy access logs for users domains and generate static html.

```bash
opencli domains-stats <USERNAME> --debug
```

Generate stats for all domains:
```bash
opencli domains-stats [--debug]
```

Generate stats for domains owned by a specific user:
```bash
opencli domains-stats <USERNAME> [--debug]
```



## Update NS

Change nameservers for a single or all dns zones.

```bash
opencli domains-update_ns <DOMAIN_NAME>|--all
```

Update the zone file for a specific domain:
```bash
opencli domains-update_ns <DOMAIN_NAME>
```

Update all zone files:
```bash
opencli domains-update_ns --all [-y]
```





## Varnish

Check Varnish status for domain, enable/disable Varnish caching.

```bash
opencli domains-varnish <DOMAIN_NAME> <on|off> <--short>
```

### Status

Display Varnish Cache status for domain:
 
```bash
opencli domains-varnish <DOMAIN_NAME>
```

### Enable

Enable Varnish Cache for a domain :
 
```bash
opencli domains-varnish <DOMAIN_NAME> on [--short]
```

### Disable

Disable Varnish Cache for a domain:
 
```bash
opencli domains-varnish <DOMAIN_NAME> off [--short]
```

## Whoowns

Check which username owns a certain domain name.

To check owner for a domain:

```bash
opencli domains-whoowns <DOMAIN_NAME>
```

To check owner and docker context for a domain:

```bash
opencli domains-whoowns <DOMAIN_NAME> --context
```

To check owner and docroot for a domain:

```bash
opencli domains-whoowns <DOMAIN_NAME> --docroot
```

---

// File: articles/opencli/email

# Emails 

The following commands are available **for OpenPanel Enterprise** users:

## MailServer

Using the `opencli email-server` command you can install and manage the mailserver:

```bash
root@pejcic:~# opencli email-server
Usage:

opencli email-server status                           Show status
opencli email-server config                           Show configuration
opencli email-server install                          Install the email server  
opencli email-server start                            Start the email server
opencli email-server stop                             Stop the email server
opencli email-server restart                          Restart the email server
opencli email-server queue                            Show mail queue
opencli email-server flush                            Flush mail queue
opencli email-server view   <queue id>                Show mail by queue id
opencli email-server unhold <queue id> [<queue id>]   Release mail that was put "on hold" (marked with '!')
opencli email-server unhold ALL                       Release all mails that were put "on hold" (marked with '!')
opencli email-server delete <queue id> [<queue id>]   Delete mail from queue
opencli email-server delete ALL                       Delete all mails from queue
opencli email-server fail2ban [<ban|unban> <IP>]      Interact with fail2ban
opencli email-server fail2ban log                     Show fail2ban log
opencli email-server ports                            Show published ports
opencli email-server postconf                         Show postfix configuration
opencli email-server logs [-f]                        Show logs. Use -f to 'follow' the logs
opencli email-server login                            Run container shell
opencli email-server supervisor                       Interact with supervisorctl
opencli email-servers install                         Generate summary reports
opencli email-server update-check                     Check for container package updates
opencli email-server update-packages                  Update container packages
opencli email-server versions                         Show versions
```

### Install

To install mailserver:

```bash
opencli email-server install
```


### Start

To start the mailserver:

```bash
opencli email-server start
```


### Restart

To restart the mailserver:

```bash
opencli email-server restart
```


### Stop

To stop the mailserver:

```bash
opencli email-server stop
```


### Status

To view current mailserver status:

```bash
opencli email-server status
```

Example:
```bash
root@stefi:/usr/# opencli email-server status
Container:    Up 21 minutes (healthy)

Version:      v14.0.0


Packages:     Updates available

Ports:        25/tcp -> 0.0.0.0:25
              25/tcp -> [::]:25
              143/tcp -> 0.0.0.0:143
              143/tcp -> [::]:143
              465/tcp -> 0.0.0.0:465
              465/tcp -> [::]:465
              587/tcp -> 0.0.0.0:587
              587/tcp -> [::]:587
              993/tcp -> 0.0.0.0:993
              993/tcp -> [::]:993

Postfix:      Mail queue is empty

Supervisor:   amavis                           RUNNING   pid 910, uptime 0:20:23
              changedetector                   RUNNING   pid 949, uptime 0:20:23
              cron                             RUNNING   pid 803, uptime 0:20:25
              dovecot                          RUNNING   pid 813, uptime 0:20:25
              mailserver                       RUNNING   pid 8, uptime 0:21:06
              opendkim                         RUNNING   pid 848, uptime 0:20:24
              opendmarc                        RUNNING   pid 864, uptime 0:20:24
              postfix                          RUNNING   pid 876, uptime 0:20:24
              rsyslog                          RUNNING   pid 807, uptime 0:20:25
              update-check                     RUNNING   pid 822, uptime 0:20:24
              clamav                           STOPPED   Not started
              fail2ban                         STOPPED   Not started
              fetchmail                        STOPPED   Not started
              mta-sts-daemon                   STOPPED   Not started
              postgrey                         STOPPED   Not started
              postsrsd                         STOPPED   Not started
              rspamd                           STOPPED   Not started
              rspamd-redis                     STOPPED   Not started
              saslauthd_ldap                   STOPPED   Not started
              saslauthd_mysql                  STOPPED   Not started
              saslauthd_pam                    STOPPED   Not started
              saslauthd_rimap                  STOPPED   Not started
              saslauthd_shadow                 STOPPED   Not started
```




### Config

To view active mailserver configuration:

```bash
opencli email-server config
```

Example:
```bash
root@stefi:~# opencli email-server config                           
ACCOUNT_PROVISIONER='FILE'
AMAVIS_LOGLEVEL='0'
CLAMAV_MESSAGE_SIZE_LIMIT='25M'
DEFAULT_RELAY_HOST=''
DMS_VMAIL_GID='5000'
DMS_VMAIL_UID='5000'
DOVECOT_INET_PROTOCOLS='ipv4'
DOVECOT_MAILBOX_FORMAT='maildir'
DOVECOT_TLS='no'
ENABLE_AMAVIS='1'
ENABLE_CLAMAV='0'
ENABLE_DNSBL='0'
ENABLE_FAIL2BAN='0'
ENABLE_FETCHMAIL='0'
ENABLE_GETMAIL='0'
ENABLE_IMAP='1'
ENABLE_MANAGESIEVE='0'
ENABLE_OAUTH2='0'
ENABLE_OPENDKIM='1'
ENABLE_OPENDMARC='1'
ENABLE_POLICYD_SPF='1'
ENABLE_POP3='0'
ENABLE_POSTGREY='0'
ENABLE_QUOTAS='1'
ENABLE_RSPAMD='0'
ENABLE_RSPAMD_REDIS='0'
ENABLE_SASLAUTHD='0'
ENABLE_SPAMASSASSIN='0'
```

### Queue

To view current mail queue:

```bash
opencli email-server queue
```

### Flush Queue

To flush current mail queue:

```bash
opencli email-server flush
```

### View

To view mail by queue id:

```bash
opencli email-server view <queue id>
```


### Unhold

To release a specific mail that was put "on hold" (marked with '!'):
```bash
opencli email-server unhold <queue id> [<queue id>]
```

To release ALL mails that are put "on hold" (marked with '!'):
```bash
opencli email-server unhold ALL
```

### Delete

To delete specific mail from queue:
```bash
opencli email-server delete <queue id>
```

To delete multiple mails from wueue using their queue IDs :
```bash
opencli email-server delete <queue id> [<queue id>] [<queue id>] [<queue id>]
```

To delete ALL mails from queue:
```bash
opencli email-server delete ALL
```

### Fail2Ban

To interact with fail2ban:
```bash
opencli email-server fail2ban
```

To ban IP address using fail2ban:
```bash
opencli email-server fail2ban ban <IP>
```

To unban IP address using fail2ban:
```bash
opencli email-server fail2ban unban <IP>
```

To view fail2ban logs:
```bash
opencli email-server fail2ban log
```


### Postfix

To view current postfix configuration:
```bash
opencli email-server postconf
```

Example:
```bash
root@stefi:~# opencli email-server postconf
2bounce_notice_recipient = postmaster
access_map_defer_code = 450
access_map_reject_code = 554
address_verify_cache_cleanup_interval = 12h
address_verify_default_transport = $default_transport
address_verify_local_transport = $local_transport
address_verify_map = btree:$data_directory/verify_cache
address_verify_negative_cache = yes
address_verify_negative_expire_time = 3d
address_verify_negative_refresh_time = 3h
address_verify_pending_request_limit = 5000
address_verify_poll_count = ${stress?{1}:{3}}
address_verify_poll_delay = 3s
address_verify_positive_expire_time = 31d
address_verify_positive_refresh_time = 7d
...
```

### Logs

Display mailserver logs:
```bash
opencli email-server logs
```

Use -f to 'follow' the logs:
```bash
opencli email-server logs -f
```

### pflogsumm

Generate HTML reports from mail logs:
```bash
opencli email-server pflogsumm
```

### Supervisor

Interact with the supervisor:
```bash
opencli email-server supervisor
```

Example:
```bash
root@stefi:~# opencli email-server supervisor
amavis                           RUNNING   pid 910, uptime 0:38:23
changedetector                   RUNNING   pid 949, uptime 0:38:23
clamav                           STOPPED   Not started
cron                             RUNNING   pid 803, uptime 0:38:25
dovecot                          RUNNING   pid 813, uptime 0:38:25
fail2ban                         STOPPED   Not started
fetchmail                        STOPPED   Not started
mailserver                       RUNNING   pid 8, uptime 0:39:06
mta-sts-daemon                   STOPPED   Not started
opendkim                         RUNNING   pid 848, uptime 0:38:24
opendmarc                        RUNNING   pid 864, uptime 0:38:24
postfix                          RUNNING   pid 876, uptime 0:38:24
postgrey                         STOPPED   Not started
postsrsd                         STOPPED   Not started
rspamd                           STOPPED   Not started
rspamd-redis                     STOPPED   Not started
rsyslog                          RUNNING   pid 807, uptime 0:38:25
saslauthd_ldap                   STOPPED   Not started
saslauthd_mysql                  STOPPED   Not started
saslauthd_pam                    STOPPED   Not started
saslauthd_rimap                  STOPPED   Not started
saslauthd_shadow                 STOPPED   Not started
update-check                     RUNNING   pid 822, uptime 0:38:24
```

### Login

Login as root user to the mailserver container:
```bash
opencli email-server login
```

### Ports

Display ports currently in use by the mailserver:
```bash
opencli email-server ports
```

Example:
```bash
root@stefi:~# opencli email-server ports
Published ports:

25/tcp -> 0.0.0.0:25
25/tcp -> [::]:25
143/tcp -> 0.0.0.0:143
143/tcp -> [::]:143
465/tcp -> 0.0.0.0:465
465/tcp -> [::]:465
587/tcp -> 0.0.0.0:587
587/tcp -> [::]:587
993/tcp -> 0.0.0.0:993
993/tcp -> [::]:993
```


### Update Check

Check for container package updates:
```bash
opencli email-server update-check
```

### Update Packages

Update container packages:
```bash
opencli email-server update-packages
```



### Versions

Display versions:
```bash
opencli email-server versions
```

Example:
```bash
root@stefi:~# opencli email-server versions
Mailserver:    v14.0.0

amavisd-new:   1:2.13.0-3
clamav:        1.0.3+dfsg-1~deb12u1
dovecot-core:  1:2.3.19.1+dfsg1-2.1
fail2ban:      1.0.2-2
fetchmail:     6.4.37-1
getmail6:      6.18.11-2
rspamd:        3.8.4-1~93fa4f6dc~bookworm
opendkim:      2.11.0~beta2-8+deb12u1
opendmarc:     1.4.2-2+b1
postfix:       3.7.10-0+deb12u1
spamassassin:  4.0.0-6
supervisor:    4.2.5-1
```


### Uninstall

To uninstall the mailserver:

```bash
opencli email-server uninstall
```



## Webmail

Display current webmail domain:

```bash
opencli email-webmail
```

Set 'webmail.example.com' as a webmail domain:

```bash
opencli email-webmail domain webmail.example.com
```

## Emails

`opencli email-setup` command is used to create and manage email accounts.

To view a list of all available sub-commands:

```bash
opencli email-setup help
```

### List emails

To view a list of all email addresses on server:

```bash
opencli email-setup email list
```

### Create email

To create new email account:

```bash
opencli email-setup email add <EMAIL ADDRESS> [<PASSWORD>]
```

### Change password

To change password for email account:

```bash
opencli email-setup email update <EMAIL ADDRESS> [<PASSWORD>]
```

### Delete email

To delete an email account:

```bash
opencli email-setup email del [ OPTIONS... ] <EMAIL ADDRESS> [ <EMAIL ADDRESS>... ]
```


### Restrict email

To suspend sending or receving of emails for an email account:

```bash
opencli email-setup email restrict <add|del|list> <send|receive> [<EMAIL ADDRESS>]
```



## Aliases

The `opencli email-setup alias` command is used to manage email aliases:



### List Aliases

To list all email aliases:
```bash
opencli email-setup alias list
```

### Add Alias

To create a new email alias:
```bash
opencli email-setup alias add <EMAIL ADDRESS> <RECIPIENT>
```


### Delete Alias

To delete existing email alias:
```bash
opencli email-setup alias del <EMAIL ADDRESS> <RECIPIENT>
```

## Quotas

The `opencli email-setup quota` command is used to manage email quotas:

### Set Quota

To set quota for email account:

```bash
opencli email-setup quota set <EMAIL ADDRESS> [<QUOTA>]
```

### Remove Quota

To remove quota for email account:

```bash
opencli email-setup quota del <EMAIL ADDRESS>
```



## Dovecot Master

[Dovecot Master](https://doc.dovecot.org/2.3/configuration_manual/authentication/master_users/) accounts are used to auto-login from OpenPanel interface to any email address.

`opencli email-setup dovecot-master` 


### List Dovecot Master 

To list all dovecot-master accounts:

```bash
opencli email-setup dovecot-master list
```


### Add Dovecot Master 

To create a new dovecot-master account:

```bash
opencli email-setup dovecot-master add <USERNAME> [<PASSWORD>]
```

### Update Dovecot Master 

To chaneg password for existing dovecot-master account:

```bash
opencli email-setup dovecot-master update <USERNAME> [<PASSWORD>]
```

### Add Dovecot Master 

To delete an dovecot-master account:

```bash
opencli email-setup dovecot-master del [ OPTIONS... ] <USERNAME> [ <USERNAME>... ]
```





## DKIM

To manage DKIM use `opencli email-setup config` command:

### Setup DKIM

To setup DKIM:

```bash
opencli email-setup config dkim [ ARGUMENTS... ]
```

## Email Relay

To setup [email relay](https://en.wikipedia.org/wiki/Open_mail_relay) use `opencli email-setup relay` command:


### Add Auth

To add auth to email relay:

```bash
opencli email-setup relay add-auth <DOMAIN> <USERNAME> [<PASSWORD>]
```

### Add Domain

To add auth domain to email relay:

```bash
opencli email-setup relay add-domain <DOMAIN> <HOST> [<PORT>]
```

### Exclude Auth

To exclude auth from email relay:

```bash
opencli email-setup relay exclude-domain <DOMAIN>
```




## Fail2Ban

[Fail2Ban](https://github.com/fail2ban/fail2ban) is used for restricting and blocking access to email accounts.

To display available options:
```bash
opencli email-setup fail2ban 
```

### Ban IP

To ban IP address from accessing mail server:
```bash
opencli email-setup fail2ban ban <IP>
```

### UnBan IP

To unban IP address and allow it to access mail server:
```bash
opencli email-setup fail2ban unban <IP>
```

### View Log

To view the fail2ban log:
```bash
opencli email-setup fail2ban log
```


### View Status

To view the fail2ban status:
```bash
opencli email-setup fail2ban status
```

## Debug

For debugging emails the following commands are available:

### Fetchmail

[Fetchmail](https://www.fetchmail.info/fetchmail-man.html) is a powerful tool that can be used to debug email:

```bash
opencli email-setup debug fetchmail
```

### Login

To troubleshoot emaail address login:

```bash
opencli email-setup debug login <COMMANDS>
```

### Mail Logs

To view the mailserver logs:
```bash
opencli email-setup debug show-mail-logs
```

---

// File: articles/opencli/error

# Error 

`opencli error` command allows Administrators to trace OpenPanel error IDs.

```bash
opencli error ID_HERE
```

Example output:

```bash
root@stefan:~# opencli error 9RIdD2X6aGaIzCzAEh0YL57U
[2024-11-06 14:14:47,298] ERROR in app: Exception on /emails/mozda@stefan.openpanel.org [GET]
Traceback (most recent call last):
File "/usr/local/lib/python3.12/site-packages/flask/app.py", line 1473, in wsgi_app
response = self.full_dispatch_request()
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/usr/local/lib/python3.12/site-packages/flask/app.py", line 882, in full_dispatch_request
rv = self.handle_user_exception(e)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/usr/local/lib/python3.12/site-packages/flask/app.py", line 880, in full_dispatch_request
rv = self.dispatch_request()
^^^^^^^^^^^^^^^^^^^^^^^
File "/usr/local/lib/python3.12/site-packages/flask/app.py", line 865, in dispatch_request
return self.ensure_sync(self.view_functions[rule.endpoint])(**view_args)  # type: ignore[no-any-return]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/usr/local/panel/app.py", line 478, in wrapper
return func(*args, **kwargs)
^^^^^^^^^^^^^^^^^^^^^
File "/usr/local/panel/modules/emails.py", line 240, in emails
send_output = check_output(f'opencli email-setup email restrict list send {emaifdfdl}', shell=True, stderr=subprocess.STDOUT).decode('utf-8').strip()
^^^^^^^^^
NameError: name 'emaifdfdl' is not defined
ERROR:root:Error Code: 9RIdD2X6aGaIzCzAEh0YL57U - 500 Internal Server Error: The server encountered an internal error and was unable to complete your request. Either the server is overloaded or there is an error in the application.

```

---

// File: articles/opencli/faq

# FAQ 

`opencli faq` displays answers to the most frequently asked questions:

```bash
opencli faq
```

<details>
  <summary>Example output</summary>

```bash
# opencli faq

Frequently Asked Questions

1. What is the login link for admin panel?

LINK: https://demo.openpanel.com:2087/
------------------------------------------------------------

2. What is the login link for user panel?

LINK: https://demo.openpanel.com:2083/
------------------------------------------------------------

3. How to restart OpenAdmin or OpenPanel services?

- OpenPanel: docker restart openpanel
- OpenAdmin: service admin restart
------------------------------------------------------------

4. How to reset admin password?

execute command opencli admin password USERNAME NEW_PASSWORD
------------------------------------------------------------

5. How to create new admin account?

execute command opencli admin new USERNAME PASSWORD
------------------------------------------------------------

6. How to list admin accounts?

execute command opencli admin list
------------------------------------------------------------

7. How to check OpenPanel version?

execute command opencli --version
------------------------------------------------------------

8. How to update OpenPanel?

execute command opencli update --force
------------------------------------------------------------

9. How to disable automatic updates?

execute command opencli config update autoupdate off
------------------------------------------------------------

10. Where are the logs?

- User panel errors:      /var/log/openpanel/user/error.log
- User panel access log:  /var/log/openpanel/user/access.log
- Admin panel errors:     /var/log/openpanel/admin/error.log
- Admin panel access log: /var/log/openpanel/admin/access.log
- Admin panel API access: /var/log/openpanel/admin/api.log
- Admin panel logins:     /var/log/openpanel/admin/login.log
- Admin panel alerts:     /var/log/openpanel/admin/notifications.log
- Admin panel crons:      /var/log/openpanel/admin/cron.log
------------------------------------------------------------

11. How to enable detailed logs?

- opencli config update dev_mode yes
------------------------------------------------------------
```
</details>

---

// File: articles/opencli/files

# Files

### Purge Trash

The `purge_trash` script is run periodically to remove files form users *.Trash* folder, according to the `autopurge_trash` setting.


#### Single User

To purge files for a single user:

```bash
opencli files-purge_trash --user [USERNAME]
```

To list files that would be purged (dry-run) for a single user:

```bash
opencli files-purge_trash --user [USERNAME] --dry-run
```

To purge files for a single user regardless of the `autopurge_trash` setting:

```bash
opencli files-purge_trash --user [USERNAME] --force
```

#### All Users

To purge files for all users:

```bash
opencli files-purge_trash
```

To list files that would be purged (dry-run) for all users:

```bash
opencli files-purge_trash --dry-run
```

To purge files for all users regardless of the `autopurge_trash` setting:

```bash
opencli files-purge_trash --force
```


### Fix Permissions

The `fix_permissions` script can be used to fix permissions on user files inside their container.

It performs:

Website files:
- sets the owner of all files in `/var/www/html/` to the  www-data user.
- sets the group of all files in `/var/www/html/` to the www-data group.
- sets the permissions of all files to 644.
- sets the permissions of all directories to 755.

Website files:
- sets the owner of all files in `/var/www/html/` to the  www-data user.
- sets the group of all files in `/var/www/html/` to the www-data group.
- sets the permissions of all files to 644.
- sets the permissions of all directories to 755.

Emails:
- sets the owner of all files in `/var/mail/` to the  user.
- sets the permissions of all files to 644.
- sets the permissions of all directories to 755.


#### Single folder

Fix permissions for specific folder for user:

```bash
opencli files-fix_permissions <USERNAME> <PATH>
```

**TIP:** add `--debug` flag to show verbose information on what is exaclty being done:
```bash
opencli files-fix_permissions <USERNAME> <PATH> --debug
```

Example:
```bash
opencli files-fix_permissions stefan stefan.pejcic.rs
```

## Single User
Fix permissions for all folders iniside user home directory (`/var/www/html/`):

```bash
opencli files-fix_permissions <USERNAME>
```

#### All Users

Use the `--all` flag to change permissions for all active users:

```bash
opencli files-fix_permissions --all
```

---

// File: articles/opencli/ftp

# FTP

Enable and manage FTP server shared for all OpenPanel users.


## List

List all FTP sub-users from all OpenPanel accounts:
```bash
opencli ftp-list
```


List all FTP sub-users for a single OpenPanel accounts:
```bash
opencli ftp-list <OPENPANEL_USERNAME>
```

## Add
Create FTP sub-user for openpanel user:
```bash
opencli ftp-add <NEW_USERNAME> <NEW_PASSWORD> <FOLDER> <OPENPANEL_USERNAME>
```

## Password
Change password for FTP sub-user of openpanel user:
```bash
opencli ftp-password <username> <new_password> <openpanel_username> [--debug]
```

## Path
Change FTP path for sub-user:
```bash
opencli ftp-path <action> <username> <path> <openpanel_username> [--debug]
```

## Delete
Delete FTP sub-user for openpanel user:
```bash
opencli ftp-delete <username> <openpanel_username> [--debug]
```

## Connections
View all current connections to the FTP servise:
```bash
opencli ftp-connections
```

View current connections for a specific OpenPanel user:
```bash
opencli ftp-connections <openpanel_username>
```

## Logs
View live FTP service logs while service is running:
```
opencli ftp-connections <openpanel_username>
```

## Users
Recreate list of all ftp users:
```bash
opencli ftp-users
```

---

// File: articles/opencli/hooks

## Hooks

OpenPanel supports hooks that run bash scripts before or after running opencli commands.

To create a hook, first create a new directory: `/etc/openpanel/openpanel/hooks/` and inside create a file based on the desired command:

- `pre_` prefix for script to run **before** a command.
- `post_` prefix for a script to run **after** executing an opencli command.

Example, to run a custom script before the user creation process (opencli *user-add*) you would create a new file:
```bash
pre_user-add.sh
```

another example, script that executes after adding a domain (opencli *domains-add*) you would create file:
```bash
post_domains-add.sh
```

any command-line attributes passed to opencli script will also be to your custom scripts.

---

// File: articles/opencli/imunify

# Imunify 

`opencli imunify` command enables administrators to install, start, manage, and uninstall the [ImunifyAV standalone service](https://cloudlinux.zendesk.com/hc/en-us/articles/4716287786396-Imunify360-Standalone-installation-guide-with-integration-conf-examples).

> Note: Imunify, its trademarks, and all related assets are the property of [CloudLinux Zug GmbH](https://cloudlinux.com/).

This command acts as a wrapper that installs and runs the ImunifyAV GUI as a standalone PHP server, following the official setup guide provided here: [Imunify360 Standalone installation guide with integration.conf examples
](https://cloudlinux.zendesk.com/hc/en-us/articles/4716287786396-Imunify360-Standalone-installation-guide-with-integration-conf-examples) 

## Install

To install ImunifyAV:

```bash
opencli imunify install
```

## Status

To check the status of the ImunifyAV GUI:

```bash
opencli imunify status
```

## Start

To start the ImunifyAV GUI:

```bash
opencli imunify start
```

## Stop

To stop the ImunifyAV GUI:

```bash
opencli imunify stop
```

## Update

To update ImunifyAV:

```bash
opencli imunify update
```

## Uninstall

To uninstall ImunifyAV:

```bash
opencli imunify uninstall
```

---

// File: articles/opencli/license

# License

`opencli license` command is used to set a license key for [OpenPanel Enterprise](https://openpanel.com/enterprise/), verify it, display information and delete the key to downgrade to Community edition.


View available options:
```bash
opencli license
```

Adding a license key:
```bash
opencli license <KEY>
```

Additional flags are available:

- `--json` - displays response as json.
- `--no-restart` - skips restarting OpenAdmin interface after adding a key.

View license key:
```bash
opencli license key
```

View license information:
```bash
opencli license info
```
Delete license key:
```bash
opencli license delete
```

---

// File: articles/opencli/locale

# Locale

List or install new locale(s) for OpenPanel interface:

- List all available locales:
  ```bash
  opencli locale
  ```
- Installing single locale:
  ```bash
  opencli locale sr-sr
  ```
- Installing multiple locales at once:
  ```bash
  opencli locale sr-sr tr-tr
  ```
- Installing ALL available locales at once:
  ```bash
  opencli locale $(curl -s "https://api.github.com/repos/stefanpejcic/openpanel-translations/contents" | jq -r '.[] | select(.type=="dir") | .name' | tr '\n' ' ')
  ```

---

// File: articles/opencli/opencli

# OpenCLI
OpenPanel uses OpenCLI, a command line interface designed for administrators to manage server from the terminal.

OpenCLI keeps history of used commands and allows you to view last and top 5 used commands:
```bash
# opencli

Usage: opencli <COMMAND> [additional_arguments]

Suggested commands:
  opencli faq                       Display frequently asked questions and answers.
  opencli --help                    List all available OpenCLI commands and their usage.

Recently used commands:
  opencli docker-collect_stats
  opencli faq
  opencli update
  opencli update_check
  opencli user-add

Most commonly used commands:
  opencli admin
  opencli docker-collect_stats
  opencli faq
  opencli update
  opencli update_check
```

The autocomplete functionality enhances user experience by displaying available OpenCLI commands. This feature is activated when you type the `opencli` command, add a space, and then press `TAB`. The command suggestions are dynamically generated by the `opencli --help` script command.

## Help

`opencli help` command generates a list of available OpenCLI commands on the current server:

```
opencli --help
```

As new commands are added gradually, they might not yet be available in your OpenPanel version. To check if a command is available on a server, run `opencli <command> --help`.

<details>
  <summary>Example output</summary>

```bash
opencli server-ips
Description: Generates a file with a list of users with their dedicated IPs
Usage: opencli server-ips
------------------------
opencli server-migrate
Description: Migrates all data from this server to another.
Usage: opencli server-migrate -h <DESTINATION_IP> --user root --password <DESTINATION_PASSWORD>
------------------------
opencli ftp-add
Description: Create FTP sub-user for openpanel user.
Usage: opencli ftp-add <NEW_USERNAME> <NEW_PASSWORD> <FOLDER> <OPENPANEL_USERNAME>
------------------------
opencli ftp-delete
Description: Delete FTP sub-user for openpanel user.
Usage: opencli ftp-delete <username> <openpanel_username> [--debug]
------------------------
opencli ftp-path
Description: Change FTP path for a user.
Usage: opencli ftp-path <username> <path> <openpanel_username> [--debug]
------------------------
opencli ftp-password
Description: Change password for FTP sub-user of openpanel user.
Usage: opencli ftp-password <username> <new_password> <openpanel_username> [--debug]
------------------------
opencli ftp-connections
Description: Display all active FTP connection or for particular OpenPanel user.
Usage: opencli ftp-add <NEW_USERNAME> <NEW_PASSWORD> <FOLDER> <OPENPANEL_USERNAME>
------------------------
opencli ftp-logs
Description: View the FTP server log
Usage: opencli ftp-log
------------------------
opencli ftp-list
Description: List FTP sub-users for openpanel user.
Usage: opencli ftp-list <OPENPANEL_USERNAME>
------------------------
opencli patch
Description: Download and install a patch
Usage: opencli patch <NAME>
------------------------
opencli domain
Description: View and set domain/ip for accessing panels.
Usage: opencli domain [set <domain_name> | ip] [--debug]
------------------------
opencli api-list
Description: List available API endpoints with usage examples.
Usage: opencli api-list [--save]
------------------------
opencli license
Description: Manage OpenPanel Enterprise license.
Usage: opencli license verify 
------------------------
opencli faq
Description: Display answers to most frequently asked questions.
Usage: opencli faq
------------------------
opencli email-manage
Description: Manage mailserver configuration and overview.
Usage: opencli email-manage <COMMAND> <ATTRIBUTES>
------------------------
opencli email-server
Description: Manage mailserver
Usage: opencli email-server <install|start|restart|stop|uninstall> [--debug]
------------------------
opencli email-quotas
Description: Fixes email permission issues for all domains.
Usage: opencli email-quotas
------------------------
opencli email-webmail
Description: Display webmail domain or choose webmail software
Usage: opencli email-webmail [--debug]
------------------------
opencli email-setup
Description: Setup email addresses, forwarders, filters..
Usage: opencli email-setup <COMMAND> <ATTRIBUTES>
------------------------
opencli update
Description: Check if update is available, install updates.
Usage: opencli update [--check | --force | --admin | --cli]
------------------------
opencli webserver-get_webserver_for_user
Description: View cached or check the installed webserver inside user container.
Usage: opencli webserver-get_webserver_for_user <USERNAME>
------------------------
opencli version
Description: Displays the current (installed) version of OpenPanel docker image.
Usage: opencli version 
------------------------
opencli dev
Description: Overwrite OpenPanel container files and restart service to apply.
Usage: opencli dev [path]
------------------------
opencli sentinel
Description: OpenAdmin Notifications
Usage: opencli sentinel [-report|--startup]
------------------------
opencli docker-collect_stats
Description: Collect docker usage information for all users.
Usage: opencli docker-collect_stats
------------------------
opencli docker-usage_stats_cleanup
Description: Rotates resource usage logs for all users according to the resource_usage_retention setting.
------------------------
opencli docker-backup
Description: Generates a backup for all users.
Usage: opencli docker-backup
------------------------
opencli docker-images
Description: Check images for updates.
Usage: opencli docker-images [--all|<USERNAME>]
------------------------
opencli docker-logs
Description: Display log sizes for user and sytem containers
Usage: opencli docker-logs [--all|system|<USERNAME>]
------------------------
opencli docker-limits
Description: Set global docker limits for all containers combined.
Usage: opencli docker-limits [--apply | --apply SIZE | --read]
------------------------
opencli user-2fa
Description: Check or disable 2FA for a user.
Usage: opencli user-2fa <username> [disable]
------------------------
opencli user-redis
Description: Check and enable/disable REDIS for user.
Usage: opencli user-redis [check|enable|disable] <USERNAME>
------------------------
opencli user-loginlog
Description: View users .loginlog that shows last 20 successfull logins.
Usage: opencli user-loginlog <USERNAME> [--json]
------------------------
opencli user-ssh
Description: Manage SSH settings for user.
Usage: opencli user-ssh <check|enable|disable> <username>
------------------------
opencli user-email
Description: Change email for user
Usage: opencli user-email <USERNAME> <NEW_EMAIL>
------------------------
opencli user-varnish
Description: Enable/disable Varnish Caching for user and display current status.
Usage: opencli user-varnish <USERNAME> [on|off]
------------------------
opencli user-add
Description: Create a new user with the provided plan_name.
Usage: opencli user-add <USERNAME> <PASSWORD|generate> <EMAIL> "<PLAN_NAME>" [--send-email] [--debug]  [--webserver="<nginx|apache|openresty|openlitespeed|litespeed|varnish+nginx|varnish+apache|varnish+openresty|varnish+openlitespeed>"] [--sql=<mysql|mariadb>] [--reseller=<RESELLER_USERNAME>][--server=<IP_ADDRESS>]  [--key=<SSH_KEY_PATH>]
------------------------
opencli user-rename
Description: Rename username.
Usage: opencli user-rename <old_username> <new_username>
------------------------
opencli user-delete
Description: Delete user account and permanently remove all their data.
Usage: opencli user-delete <username> [-y] [--all]
------------------------
opencli user-resources
Description: View services limits for user.
Usage: opencli user-resources <CONTEXT> [--activate=<SERVICE_NAME>] [--deactivate=<SERVICE_NAME>] [--update_cpu=<FLOAT>] [--update_ram=<FLOAT>] [--service=<NAME>] [--json]
------------------------
opencli user-change_plan
Description: Change plan for a user and apply new plan limits.
Usage: opencli user-change_plan <USERNAME> <NEW_PLAN_NAME>
------------------------
opencli user-password
Description: Reset password for a user.
Usage: opencli user-password <USERNAME> <NEW_PASSWORD | RANDOM> [--ssh]
------------------------
opencli user-memcached
Description: Check and enable/disable Memcached for user.
Usage: opencli user-memcached [check|enable|disable] <USERNAME>
------------------------
opencli user-login
Description: Login as a user container.
Usage: opencli user-login <USERNAME>
------------------------
opencli user-unsuspend
Description: Unsuspend user: start all containers and unsuspend domains
Usage: opencli user-unsuspend <USERNAME>
------------------------
opencli user-ip
Description: Assing or remove dedicated IP to a user.
Usage: opencli user-ip <USERNAME> <IP | DELETE> [-y] [--debug]
------------------------
opencli user-suspend
Description: Suspend user: stop all containers and suspend domains.
Usage: opencli user-suspend <USERNAME>
------------------------
opencli user-list
Description: Display all users: id, username, email, plan, registered date.
Usage: opencli user-list [--json]
------------------------
opencli user-transfer
Description: Transfers a single user account from this server to another.
Usage: opencli user-transfer --account <OPENPANEL_USER> --host <DESTINATION_IP> --username <DESTINATION_SSH_USERNAME> --password <DESTINATION_SSH_PASSWORD> [--live-transfer]
------------------------
opencli user-check
Description: Performs comprehensive security checks on user files, Docker daemon and containers.
Usage: opencli user-check <USERNAME>
------------------------
opencli user-quota
Description: Enforce and recalculate disk and inodes for a user.
Usage: opencli user-quota <username|--all>
------------------------
opencli report
Description: Generate a system report and send it to OpenPanel support team.
Usage: opencli report
------------------------
opencli websites-scan
Description: Scan user files for WP sites and add them to SiteManager interface.
Usage: opencli websites-scan $username
------------------------
opencli websites-all
Description: Lists all websites currently hosted on the server.
Usage: opencli websites-all
------------------------
opencli websites-user
Description: Lists all websites and domains owned by a specific user.
Usage: opencli websites-user <USERNAME> [--json]
------------------------
opencli websites-pagespeed
Description: Check Google PageSpeed data for website(s)
Usage: opencli websites-pagespeed <DOMAIN> [-all]
------------------------
opencli imunify
Description: Install and manage ImunifyAV service.
Usage: opencli imunify [status|start|stop|install|update|uninstall]
------------------------
opencli config
Description: View / change configuration for users and set defaults for new accounts.
Usage: opencli config get <setting_name>
------------------------
opencli docker
Description: Manage OpenPanel system or user containers with lazydocker.
Usage: opencli docker [username]
------------------------
opencli install
Description: Create cronjobs and configuration files needed for openpanel.
Usage: opencli install
------------------------
opencli imav-deploy
------------------------
opencli port
Description: View and change port for accessing openpanel.
Usage: opencli port [set <port>] 
------------------------
opencli plan-delete
Description: Delete hosting plan
Usage: opencli plan-delete <PLAN_NAME>
------------------------
opencli plan-list
Description: Display all plans: id, name, description, limits..
Usage: opencli plan-list [--json]
------------------------
opencli plan-edit
Description: Edit an existing hosting plan (Package) and modify its parameters.
Usage: opencli plan-edit --debug id=<ID> name"<TEXT>" description="<TEXT>" emails=<COUNT> ftp=<COUNT> domains=<COUNT> websites=<COUNT> disk=<COUNT> inodes=<COUNT> databases=<COUNT> cpu=<COUNT> ram=<COUNT> bandwidth=<COUNT> feature_set=<DEFAULT>
------------------------
opencli plan-usage
Description: Display all users that are currently using the plan.
Usage: opencli plan-usage <PLAN_NAME> [--json]
------------------------
opencli plan-apply
Description: Change plan for a user and apply new plan limits.
Usage: opencli plan-apply <USERNAME> <NEW_PLAN_ID>
------------------------
opencli plan-create
Description: Create a new hosting plan (Package) and set its limits.
Usage: opencli plan-create name"<TEXT>" description="<TEXT>" emails=<COUNT> ftp=<COUNT> domains=<COUNT> websites=<COUNT> disk=<COUNT> inodes=<COUNT> databases=<COUNT> cpu=<COUNT> ram=<COUNT> bandwidth=<COUNT> feature_set=<NAME>
------------------------
opencli php-domain
Description: View or change the PHP version used for a single domain name.
Usage: opencli php-domain <domain_name>
------------------------
opencli php-ini
Description: View or change php.ini values of any php version for a user.
Usage: opencli php-ini <username> <action> <setting> [value]
------------------------
opencli php-default
Description: View or change the default PHP version used for new domains added by user.
Usage: opencli php-default <username>
------------------------
opencli admin
Description: Manage OpenAdmin service and Administrators.
Usage: opencli admin <command> [options]
------------------------
opencli waf
Description: Manage CorazaWAF
Usage: opencli waf <setting> 
------------------------
opencli files-calculate_resellers_storage
Description: Calculates total disk usage for all resellers.
Usage: opencli files-calculate_resellers_storage
------------------------
opencli files-fix_permissions
Description: Fix permissions for users /home directory files inside the container.
Usage: opencli files-fix_permissions <USERNAME> [PATH]
------------------------
opencli files-purge_trash
Description: Auto-purge .Trash folders for users.
Usage: opencli files-purge_trash --user [USERNAME]
------------------------
opencli firewall-reset
Description: Deletes all docker related ports from CSF and opens exposed ports.
------------------------
opencli domains-dnssec
Description: Enable DNSSEC for a domain and re-sign after changes in the zone.
Usage: opencli domains-dnssec <DOMAIN> [--update | --check]
------------------------
opencli domains-update_ns
Description: Change nameservers for a single or all dns zones.
Usage: opencli domains-update_ns <DOMAIN_NAME>
------------------------
opencli domains-all
Description: Lists all domain names currently hosted on the server.
Usage: opencli domains-all [--docroot|--php_version]
------------------------
opencli domains-varnish
Description: Check Varnish status for domain, enable/disable Varnish caching.
Usage: opencli domains-varnish <DOMAIN-NAME> [on|off] [--short]
------------------------
opencli domains-add
Description: Add a domain name for user.
Usage: opencli domains-add <DOMAIN_NAME> <USERNAME> [--docroot DOCUMENT_ROOT] [--php_version N.N] [--skip_caddy --skip_vhost --skip_containers --skip_dns] --debug
------------------------
opencli domains-delete
Description: Delete a domain name.
Usage: opencli domains-delete <DOMAIN_NAME> --debug
------------------------
opencli domains-whoowns
Description: Check which username owns a certain domain name.
Usage: opencli domains-whoowns <DOMAIN-NAME> [--context] [--docroot]
------------------------
opencli domains-unsuspend
Description: Unsuspend a domain name
Usage: opencli domains-unsuspend <DOMAIN-NAME>
------------------------
opencli domains-dns
Description: Manage DNS for a domain.
Usage: opencli domains-dns <DOMAIN>
------------------------
opencli domains-user
Description: Lists all domain names currently owned by a specific user.
Usage: opencli domains-user <USERNAME> [--docroot|--php_version]
------------------------
opencli domains-suspend
Description: Suspend a domain name
Usage: opencli domains-suspend <DOMAIN-NAME>
------------------------
opencli domains-ssl
Description: Check SSL for domain, add custom certificate, view files.
Usage: opencli domains-ssl <DOMAIN_NAME> [status|info|auto|custom] [path/to/fullchain.pem path/to/key.pem]
------------------------
opencli domains-edit
Description: AEnter docroot for a domain.
Usage: opencli domains-edit <DOMAIN_NAME>
------------------------
opencli domains-docroot
Description: View and change docroot for a domain.
Usage: opencli domains-docroot <DOMAIN_NAME> [update </var/www/html/>] --debug
------------------------
opencli domains-stats
Description: Parse caddy access logs for users domains and generate static html
Usage: opencli domains-stats
------------------------
opencli proxy
Description: View and change proxy path '/openpanel' for accessing openpanel.
Usage: opencli port [set <path>] 
------------------------
opencli error
Description: Displays information for specific error ID received in OpenPanel UI.
Usage: opencli error <ID_HERE>
------------------------
opencli locale
Description: Install locales (Languages) for OpenPanel UI.
Usage: opencli locale <CODE>
```
</details>

---

// File: articles/opencli/php

# PHP

Manage users' PHP versions: list enabled, list available, change version, etc.

### Get version for a domain

To view the current PHP version used by a domain, run the following command:

```bash
opencli php-domain <DOMAIN-NAME>
```

Example:
```bash
# opencli php-domain pejcic.rs
Domain 'pejcic.rs' (owned by user: stefan) uses PHP version: php8.1
```

### Change version for a domain

To change a PHP version for a domain name run the `domain` script with `--update` flag::

```bash
opencli php-domain <DOMAIN-NAME> --update <PHP-VERSION>
```

Example:
```bash
# opencli php-domain pejcic.rs --update 8.3
Updating PHP version to: 8.3
Domain 'pejcic.rs' (owned by user: stefan) uses PHP version: php8.3
Updating PHP version in the Apache configuration file...
 * Reloading Apache httpd web server apache2
 *
Updated PHP version in the configuration file to 8.3
```

### View default version

The default PHP version for a user determines which PHP version will be used for all domains that the user adds in the future. It does not change the PHP version for any existing domains.

To list the currently set default PHP version for a user, run the following command:

```bash
opencli php-default <USERNAME>
```

Example:
```bash
# opencli php-default stefan
Default PHP version for user 'stefan' is: php8.3
```

### Change the default version

To update the default PHP version for a user use the php-default with `--update` flag and provide the new PHP version.

```bash
opencli php-default <USERNAME> --update <VERSION>
```

Example:
```bash
# opencli php-default stefan --update 8.1
PHP version for user 'stefan' updated to: 8.1
```

### List versions

To list all available PHP versions for a user, grep 'php-fpm' in docker-compose.yml file for the user:

```bash
grep php-fpm- /home/ <USERNAME>/docker-compose.yml
```


Example:
```bash
# grep php-fpm- /home/demo/docker-compose.yml
  php-fpm-5.6:
    container_name: php-fpm-5.6
  php-fpm-7.0:
    container_name: php-fpm-7.0
  php-fpm-7.1:
    container_name: php-fpm-7.1
  php-fpm-7.2:
    container_name: php-fpm-7.2
  php-fpm-7.3:
    container_name: php-fpm-7.3
  php-fpm-7.4:
    container_name: php-fpm-7.4
  php-fpm-8.0:
    container_name: php-fpm-8.0
  php-fpm-8.1:
    container_name: php-fpm-8.1
  php-fpm-8.2:
    container_name: php-fpm-8.2
  php-fpm-8.3:
    container_name: php-fpm-8.3
  php-fpm-8.4:
    container_name: php-fpm-8.4
```

---

// File: articles/opencli/plan

# Plans

Scripts for creating and editing hosting plans (packages).

## List Plans

To list all current hosting packages (plans) run:

```bash
opencli plan-list
```

<details>
  <summary>Example output</summary>

```bash
# opencli plan-list
+----+----------------+------------------------+---------------+----------------+-------------+-----------+------------+--------------+----------+------+------+-----------+-------------+-----------------+
| id | name           | description            | domains_limit | websites_limit | email_limit | ftp_limit | disk_limit | inodes_limit | db_limit | cpu  | ram  | bandwidth | feature_set | max_email_quota |
+----+----------------+------------------------+---------------+----------------+-------------+-----------+------------+--------------+----------+------+------+-----------+-------------+-----------------+
|  1 | Standard plan  | Small plan for testing |             0 |             10 |           0 |         0 | 5 GB       |      1000000 |        0 | 2    | 2g   |        10 | basic       | 10G             |
|  2 | Developer Plus | 4 cores, 6G ram        |             0 |             10 |           0 |         0 | 10 GB      |      1000000 |        0 | 4    | 6g   |       100 | default     | 0               |
|  3 | example        | ddfsds                 |             1 |              1 |           1 |         1 | 10 GB      |      1000000 |        1 | 1    | 1g   |       100 | default     | 10G             |
+----+----------------+------------------------+---------------+----------------+-------------+-----------+------------+--------------+----------+------+------+-----------+-------------+-----------------+
```
</details>

You can also format the data as JSON:

```bash
opencli plan-list --json
```

## Create Plan

To create a new plan run the following command:

```bash
opencli plan-create name"<TEXT>" description="<TEXT>" emails=<COUNT> ftp=<COUNT> domains=<COUNT> websites=<COUNT> disk=<COUNT> inodes=<COUNT> databases=<COUNT> cpu=<COUNT> ram=<COUNT> bandwidth=<COUNT> feature_set=<NAME> max_email_quota=<COUNT>
```

| Parameter           | Description                                      | Type    | Notes                                                         |
|---------------------|--------------------------------------------------|---------|---------------------------------------------------------------|
| `name`              | Name of the plan                                 | String  | No spaces                                                     |
| `description`       | Plan description                                 | String  | Use quotes for multiple words                                |
| `feature_set`       | Feature set assigned to the plan                 | String  | Must match an existing feature set name                      |
| `email_limit`       | Max number of email accounts                     | Integer | `0` for unlimited                                            |
| `max_email_quota`   | Max size per email account                       | String  | Integer followed by `B`, `k`, `M`, `G`, or `T`; `0` unlimited |
| `ftp_limit`         | Max number of FTP accounts                       | Integer | `0` for unlimited                                            |
| `domains_limit`     | Max number of domains                            | Integer | `0` for unlimited                                            |
| `websites_limit`    | Max number of websites                           | Integer | `0` for unlimited                                            |
| `disk_limit`        | Disk space limit in GB                           | Integer |                                                               |
| `inodes_limit`      | Max number of inodes                             | Integer | `0` for unlimited (minimum recommended: 250000)             |
| `db_limit`          | Max number of databases                          | Integer | `0` for unlimited                                            |
| `cpu`               | CPU core limit                                   | Integer |                                                               |
| `ram`               | RAM limit in GB                                  | Integer |                                                               |
| `bandwidth`         | Port speed in Mbit/s                             | Integer |                                                               |

Example:
```bash
opencli plan-create name="New Plan" description="This is a new plan" emails=100 ftp=50 domains=20 websites=30 disk=100 inodes=100000 databases=10 cpu=4 ram=8 bandwidth=100 feature_set=default max_email_quota=2G"
```

## List Users on Plan

List all users that are currently using a plan:

```bash
opencli plan-usage
```

<details>
  <summary>Example output</summary>

```bash
# opencli plan-usage 'Standard plan'
+----+----------+-------------------+---------------+---------------------+
| id | username | email             | plan_name     | registered_date     |
+----+----------+-------------------+---------------+---------------------+
|  3 | demo     | stefan@netops.com | Standard plan | 2025-04-28 14:47:52 |
|  4 | dummy    | dummy             | Standard plan | 2025-04-28 15:20:19 |
+----+----------+-------------------+---------------+---------------------+

```
</details>

You can also format the data as JSON:

```bash
opencli plan-usage --json
```


## Delete Plan

Delete a plan if no users are currently using it.

```bash
opencli plan-delete <PLAN_NAME> 
```

<details>
  <summary>Example output</summary>
  
```bash
# opencli plan-delete 'ubuntu_nginx_mysql'
Plan 'ubuntu_nginx_mysql' deleted successfully.
```
</details>

TIP: use `'` or `"` around the plan name if it contains spaces: `"plan name here"`.

`--json` flag can be passed to return the response as JSON.

<details>
  <summary>Example output</summary>

```bash
# opencli plan-delete 'ubuntu_nginx_mysql'  --json
{"message": "Plan 'ubuntu_nginx_mysql' deleted successfully."}
```
</details>


## Edit Plan

Change plan limits.

```bash
opencli plan-edit --debug id=<ID> name"<TEXT>" description="<TEXT>" emails=<COUNT> ftp=<COUNT> domains=<COUNT> websites=<COUNT> disk=<COUNT> inodes=<COUNT> databases=<COUNT> cpu=<COUNT> ram=<COUNT> bandwidth=<COUNT> feature_set=<DEFAULT> max_email_quota=<COUNT>
```

| Parameter           | Description                                      | Type    | Notes                                                         |
|---------------------|--------------------------------------------------|---------|---------------------------------------------------------------|
| `name`              | Name of the plan                                 | String  | No spaces                                                     |
| `description`       | Plan description                                 | String  | Use quotes for multiple words                                |
| `feature_set`       | Feature set assigned to the plan                 | String  | Must match an existing feature set name                      |
| `email_limit`       | Max number of email accounts                     | Integer | `0` for unlimited                                            |
| `max_email_quota`   | Max size per email account                       | String  | Integer followed by `B`, `k`, `M`, `G`, or `T`; `0` unlimited |
| `ftp_limit`         | Max number of FTP accounts                       | Integer | `0` for unlimited                                            |
| `domains_limit`     | Max number of domains                            | Integer | `0` for unlimited                                            |
| `websites_limit`    | Max number of websites                           | Integer | `0` for unlimited                                            |
| `disk_limit`        | Disk space limit in GB                           | Integer |                                                               |
| `inodes_limit`      | Max number of inodes                             | Integer | `0` for unlimited (minimum recommended: 250000)             |
| `db_limit`          | Max number of databases                          | Integer | `0` for unlimited                                            |
| `cpu`               | CPU core limit                                   | Integer |                                                               |
| `ram`               | RAM limit in GB                                  | Integer |                                                               |
| `bandwidth`         | Port speed in Mbit/s                             | Integer |                                                               |



<details>
  <summary>Example output</summary>

```bash
# opencli plan-edit --debug id=1 name="New Plan" description="This is a new plan" emails=100 ftp=50 domains=20 websites=30 disk=100 inodes=100000 databases=10 cpu=4 ram=8 bandwidth=100 feature_set="default" max_email_quota="2G"
```
</details>

---

// File: articles/opencli/port

# Port 

`opencli port` command is used to change port (`2023`) for accessing OpenPanel.

View current port:
```bash
opencli port
```

Set custom port:

```bash
opencli port set <NUMBER>
```
Example:
```bash
opencli port set 5000
```

Set default port `2083`:

```bash
opencli port default
```

---

// File: articles/opencli/proxy

# Proxy 

`opencli proxy` command is used to change `/openpanel` suffix to something else. 

View current setting:
```bash
opencli proxy
```

Set `/something` on every domain to redirect to OpenPanel interface:
```bash
opencli domain set something
```

Switch back to the default `/openpanel`:
```bash
opencli domain set default
```


You can also pass `--no-restart` flag to avoid interrupting the Caddy or OpenPanel services.

---

// File: articles/opencli/report

# Check server info

To check current server info you can use the following command:

```bash
opencli report 
```

To make the report public and share it when asking for support:
```bash
opencli report --public
```

---

// File: articles/opencli/sentinel

# Sentinel

Sentinel is an AI-powered service that autonomously monitors your server, makes decisions, and sends alerts to the notifications center and emails.

Using the command you can check current system health and get suggestions on improving configuration:

```bash
opencli sentinel
```

![sentinel openpanel cli](/img/docs-content/kg56D2x2-sentinel-openpaenl.png)


<details>
  <summary>Example email notifications</summary>

### Login to OpenAdmin from an unknown ip address
![sentinel_adminlogin.png](/img/docs-content/jjdk02DP-sentinel-adminlogin.png)

### Server reboot alert
![sentinel_reboot.png](/img/docs-content/1XpKN1gy-sentinel-reboot.png)

### Daily usage report
![sentinel_dailyusage.png](/img/docs-content/kgjvSc5R-sentinel-dailyusage.png)

### Disk usage alert
![sentinel_diskspace.png](/img/docs-content/zvSnGwMB-sentinel-diskspace.png)

### High LOAD alert
![sentinel_highload.png](/img/docs-content/PrTWFcp8-sentinel-highload.png)

### CPU usage alert
![sentinel_highcpu.png](/img/docs-content/s2kSP0Cx-sentinel-highcpu.png)

### MEM usage alert
![sentinel_highmem.png](/img/docs-content/PJ4wjXpv-sentinel-highmem.png)

### SWAP usage alert
![sentinel_highswap.png](/img/docs-content/JzgBmdnx-sentinel-highswap.png)

### MySQL service inactive alert
![sentinel_mysql.png](/img/docs-content/761C3HNt-sentinel-mysql.png)

### Nameservers resolution alert
![sentinel_nameservers.png](/img/docs-content/GtqHfXVk-sentinel-nameservers.png)

### OpenPanel container inactive alert
![sentinel_opanelcontainer.png](/img/docs-content/xTpXyFKQ-sentinel-opanelcontainer.png)

### Hostname resolution alert
![sentinel_resolve.png](/img/docs-content/158mPRqx-sentinel-resolve.png)

</details>

---

// File: articles/opencli/server

# Server

Scripts for managing the server.

## Logrotate

Reads configuration: [`logrotate_enable`](/cli/config.html#logrotate-enable) [`logrotate_size_limit`](/cli/config.html#logrotate-size-limit) [`logrotate_retention`](/cli/config.html#logrotate-retention) [`logrotate_keep_days`](/cli/config.html#logrotate-keep-days) and configures logrotate for caddy, openpanel, syslog.

```bash
opencli server-logrotate
```

## Migrate

Migrates all data from this server to another.

Usage: 
```bash
opencli server-migrate -h <DESTINATION_IP> --user root --password <DESTINATION_PASSWORD>
```

All available flags:
```bash
opencli server-migrate -h <remote_host> -u <remote_user> [--password <password>] [--exclude-home] [--exclude-logs] [--exclude-mail] [--exclude-bind] [--exclude-openpanel] [--exclude-mysql] [--exclude-stack] [--exclude-postupdate] [--exclude-users]
```

---

// File: articles/opencli/update

# Update 

`opencli update` command is used to check if new update is available and to update.

Check if update is available:
```bash
opencli update --check
```

Start update immediately if `autoupdate` or `autopatch` is enabled:
```bash
opencli update
```

Start update immediately, regardless of `autoupdate` or `autopatch` setting:
```bash
opencli update --force
```

Update only OpenAdmin UI *(`/usr/local/admin/` from [stefanpejcic/openadmin](https://github.com/stefanpejcic/openadmin))*:
```bash
opencli update --admin
```

Update only OpenPanel UI *(docker image from [openpanel/openpanel-ui](https://hub.docker.com/r/openpanel/openpanel-ui))*:
```bash
opencli update --panel
```

Update only OpenCLI *(`/usr/local/opencli/` from [stefanpejcic/opencli](https://github.com/stefanpejcic/opencli))*:
```bash
opencli update --cli
```

---

// File: articles/opencli/user

# Users

Manage users: Add, Delete, Suspend, Unsuspend, etc.

### List Users

To list all users, use the following command:

```bash
opencli user-list
```


<details>
  <summary>Example output</summary>

```bash
# opencli user-list
+----+----------------+-------------------+----------------+----------------+-------+---------------------+
| id | username       | email             | plan_name      | server         | owner | registered_date     |
+----+----------------+-------------------+----------------+----------------+-------+---------------------+
|  1 | stefan         | stefan@pejcic.rs  | Developer Plus | stefan         | NULL  | 2025-12-25 14:49:38 |
|  2 | panel          | stefan@netops.com | Developer Plus | panel          | NULL  | 2025-12-25 14:50:18 |
|  6 | emailfilterapi | emailfilterapi    | Developer Plus | emailfilterapi | NULL  | 2026-01-28 12:25:41 |
+----+----------------+-------------------+----------------+----------------+-------+---------------------+
```
</details>


You can also format the data as JSON:

```bash
opencli user-list --json
```

<details>
  <summary>Example output</summary>

```json
{
  "data": [
    {
      "id": 1000,
      "username": "stefan",
      "context": "stefan",
      "owner": "root",
      "package": {
        "name": "Developer Plus",
        "owner": "root"
      },
      "email": "stefan@pejcic.rs",
      "locale_code": "EN_us"
    },
    {
      "id": 1001,
      "username": "panel",
      "context": "panel",
      "owner": "root",
      "package": {
        "name": "Developer Plus",
        "owner": "root"
      },
      "email": "stefan@netops.com",
      "locale_code": "EN_us"
    },
    {
      "id": 1002,
      "username": "emailfilterapi",
      "context": "emailfilterapi",
      "owner": "root",
      "package": {
        "name": "Developer Plus",
        "owner": "root"
      },
      "email": "emailfilterapi",
      "locale_code": "EN_us"
    }
  ],
  "metadata": {
    "result": "ok"
  }
}
```
</details>


To display only user count:

```bash
opencli user-list --total
```

<details>
  <summary>Example output</summary>

```bash
# opencli user-list --total
Total number of users: 3
```
</details>


or:

```bash
opencli user-list --total --json
```

<details>
  <summary>Example output</summary>

```bash
#opencli user-list --total --json
3
```
</details>


#### List all users Quotas


```bash
opencli user-list --quota
```


<details>
  <summary>Example output</summary>

```json
{
  "timestamp": "2026-04-01T10:16:01Z",
  "users": [
    {"username":"stefan","uid":1000,"home_path":"/home/stefan/","disk_used":269744,"disk_soft":5120000,"disk_hard":5120000,"inodes_used":130,"inodes_soft":1000000,"inodes_hard":1000000},
    {"username":"pejcic","uid":1001,"home_path":"/home/pejcic/","disk_used":550216,"disk_soft":5120000,"disk_hard":5120000,"inodes_used":143,"inodes_soft":1000000,"inodes_hard":1000000},
    {"username":"demo","uid":1002,"home_path":"/home/demo/","disk_used":4138604,"disk_soft":10240000,"disk_hard":10240000,"inodes_used":74889,"inodes_soft":1000000,"inodes_hard":1000000}
  ]
}   
```
</details>

### Add User

```
opencli user-add <USERNAME> <PASSWORD|generate> <EMAIL> "<PLAN_NAME>" [--send-email] [--debug] [--reseller=<RESELLER_USERNAME>] [--server=<IP_ADDRESS>]  [--key=<SSH_KEY_PATH>]
```

To create a new user run the following command:

```bash
opencli user-add <USERNAME> <PASSWORD> <EMAIL> <PLAN_NAME>
```

Example:
```bash
opencli user-add stefan pejcic324 stefan@pejcic.rs 'Default Plan Nginx'
```


:::tip
Provide `random` as password to generate a strong random password.
:::


To send email to the email address for the user with login credentials, pass the `--send-email` flag.


#### Create user on Slave server

To create a new user on another server:

1. Create ssh key pair and establish ssh connection from master to the slave server.
2. Run the following command:

```bash
opencli user-add <USERNAME> <PASSWORD> <EMAIL> "<PLAN_NAME>" --server=<IP_ADDRESS> --key=<SSH_KEY_PATH>
```

#### Create all new users on Slave server

To automatically create all future users on another server:

1. Create ssh key pair and establish ssh connection from master to the slave server.
2. Set the new server IP and path to the key file in `/etc/openpanel/openadmin/config/admin.ini` file:
   ```
   [CLUSTERING]
   default_node="11.22.33.44"
   default_ssh_key_path="/root/some-key.rsa"
   ```
3. That's it, all new user accounts are created on the remote server.

> NOTE: The remote server must have a fresh installation of Ubuntu 24.04 - other distributions and versions are not supported.

#### Create user for Reseller


```bash
opencli user-add <USERNAME> <PASSWORD> <EMAIL> "<PLAN_NAME>" --reseller=<RESELLER_USERNAME>
```

### Transfer User

To transfer user account to another server:

```bash
opencli user-transfer --account <OPENPANEL_USER> --host <DESTINATION_IP> --username <OPENPANEL_USERNAME> --password <DESTINATION_SSH_PASSWORD> --port 22
```

add `--live-transfer` flag to suspend account after the transfer, and forward DNS to the new server.

### Delete User

To delete a user and all his data run the following command:

```bash
opencli user-delete <USERNAME>
```

add `-y` flag to disable prompt.

:::warning
This action is irreversible and will permanently delete all user data.
:::

To delete all users and all their data use the `--all` flag:

```bash
opencli user-delete --all
```

### Suspend User

To suspend (temporary disable access) to user, run the follwowing command:

```bash
opencli user-suspend <USERNAME> [-y]
```

### Unsuspend User

To unsuspend (enable access) to user, run the follwowing command:

```bash
opencli user-unsuspend <USERNAME>
```

### Rename User

To change a username run:
```bash
opencli user-rename <USERNAME> <NEW_USERNAME>
```

### Change Email

To change a email run:
```bash
opencli user-email <USERNAME> <NEW_EMAIL>
```

### Change Password

To reset the password for a OpenPanel user, you can use the `user-password` command:

```bash
opencli user-password <USERNAME> <NEW_PASSWORD>
```

### Login as User

This command allows you to generate an auto-login link for any OpenPanel user.

```bash
opencli user-login <USERNAME>
```

<details>
  <summary>Example output</summary>

```bash
# opencli user-login demouser --open
https://demo.openpanel.org:2083/login_autologin?admin_token=RMWvZK1cdeRkZQJGVQv682qby9XIPr&username=demouser
```
</details>

To invalidate an existing token for a user:
```bash
opencli user-login <USERNAME> --delete
```

To open the link in a browser:
```bash
opencli user-login <USERNAME> --open
```

### Change Plan

Command: `opencli user-change_plan` allows you to change plan for a user.

```bash
opencli user-change_plan <username> "<new_plan_name>"
```

### Quota

Command: `opencli user-quota` enforces and recalculates disk and inodes for specific or all users.

```bash
opencli user-quota <username|--all>
```

<details>
  <summary>Example output</summary>

```bash
# opencli user-quota stefan
[2026-01-28 17:51:40] Processing user: stefan
[2026-01-28 17:51:40] Quota set for user stefan: 20480000 blocks (20 GB) and 2500000 inodes
[2026-01-28 17:51:40] Updating repquota file...
[2026-01-28 17:51:40] Repquota file updated successfully: /etc/openpanel/openpanel/core/users/repquota
```
</details>

### Check / Disable 2FA

To disable **Two-Factor Authentication** for a user, run the following command:

```bash
opencli user-2fa <USERNAME> [disable]
```


### Assign / Remove IP to User

To assign free 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, run the following command:


```bash
opencli user-ip <USERNAME> <IP_ADDRESS> --y
```


To remove dedicated IP address from a user run:

```bash
opencli user-ip <USERNAME> delete
```


### Check

Check files and security for a user:

```bash
opencli user-check <USERNAME>
```

<details>
  <summary>Example output</summary>

```bash
# opencli user-check mozda
===== Checking user: mozda =====
---- Docker Daemon Security ----
[INFO] Running for user: mozda
[WARN] Inter-container communication on default bridge is allowed
[WARN] Docker logging level is not set to 'info' ('default')
[PASS] Docker is not allowed to modify iptables
[PASS] Not using deprecated aufs storage driver
[WARN] TLS authentication for Docker daemon is NOT configured
[PASS] Docker daemon is NOT listening on TCP socket
[PASS] Experimental features are NOT enabled
[PASS] Rootless context is configured
[PASS] Containers can not get new privileges
[PASS] Google DNS resolvers are configured

---- System and User Files ----
[PASS] /home/mozda/docker-data is configured for docker data.
[PASS] home.mozda.bin.rootlesskit file exists.
[PASS] .env file exists.
[PASS] docker-compose.yml file exists.
[PASS] backup.env file exists.
[PASS] crons.ini file exists.
[PASS] custom.cnf file exists.
[PASS] default.vcl file exists.
[PASS] httpd.conf file exists.
[PASS] nginx.conf file exists.
[PASS] openresty.conf file exists.
[PASS] pma.php file exists.
[PASS] Disk usage is below quota (3.80 GB used of 4.88 GB).
[PASS] Inode usage is below quota (113350 used of 1000000).
[INFO] Checking files ownership for user: mozda (UID: 1004, GID: 1004)
[WARN] File '/home/mozda/docker-data/overlay2/25af867389efa6af7eb6120dceef0bb601796ab469af0c9c4c798671594be432/diff/var/www/html' is owned by UID:100032 instead of UID:1004
[FAIL] Some docker files in /home/mozda/docker-data/ are not owned by UID:1004

---- Container Security Checks ----
[INFO] Found 2 running container(s)
---- Container: openresty ----
[PASS] openresty: Container running from OpenPanel
[PASS] openresty: Container name matches compose service name: openresty
[PASS] openresty: Container is running
[PASS] openresty: Container is running as root
[PASS] openresty: Using specific tag for image: openresty/openresty:bullseye-fat
[WARN] openresty: No HEALTHCHECK configured
[WARN] openresty: SELinux options not set
[WARN] openresty: --no-new-privileges restriction not set
[PASS] openresty: No extra Linux capabilities added
[PASS] openresty: Privileged mode is disabled
[WARN] openresty: Bind mounts under /home/ or /etc/openpanel/
[PASS] openresty: Docker socket is NOT mounted
[PASS] openresty: sshd is NOT running inside container
[PASS] openresty: Using OpenPanel network (mozda_www)
[PASS] openresty: All ports are bound to 127.0.0.1
[PASS] openresty: Memory usage is limited to .50 GB
[PASS] openresty: CPU usage is limited to .50 CPUs
[PASS] openresty: PID cgroup limit is set (100)
[WARN] openresty: Root filesystem is NOT read-only
[PASS] openresty: Host devices are NOT exposed
[WARN] openresty: Default ulimit is used
---- Container: php-fpm-8.2 ----
[PASS] php-fpm-8.2: Container running from OpenPanel
[PASS] php-fpm-8.2: Container name matches compose service name: php-fpm-8.2
[PASS] php-fpm-8.2: Container is running
[PASS] php-fpm-8.2: Container is running as root
[WARN] php-fpm-8.2: No HEALTHCHECK configured
[WARN] php-fpm-8.2: SELinux options not set
[WARN] php-fpm-8.2: --no-new-privileges restriction not set
[PASS] php-fpm-8.2: No extra Linux capabilities added
[PASS] php-fpm-8.2: Privileged mode is disabled
[WARN] php-fpm-8.2: Bind mounts under /home/ or /etc/openpanel/
[PASS] php-fpm-8.2: Docker socket is NOT mounted
[PASS] php-fpm-8.2: sshd is NOT running inside container
[PASS] php-fpm-8.2: Using OpenPanel network (mozda_db)
[PASS] php-fpm-8.2: No exposed ports
[PASS] php-fpm-8.2: Memory usage is limited to .25 GB
[PASS] php-fpm-8.2: CPU usage is limited to .12 CPUs
[PASS] php-fpm-8.2: PID cgroup limit is set (100)
[WARN] php-fpm-8.2: Root filesystem is NOT read-only
[PASS] php-fpm-8.2: Host devices are NOT exposed
[WARN] php-fpm-8.2: Default ulimit is used

===== Audit Summary =====
Total checks performed: 70
✅ Passed: 50
❌ Failed: 1
⚠️  Warnings: 16
ℹ️  Info: 3

⚠️  Critical issues found! Please review and address failed checks.
```
</details>




### View disk usage for user

To list real-time disk and inodes usage for a user:

```bash
opencli user-disk <USERNAME> <summary|detail|path> [--json]
```

Example usage:

- Disk usage summary for user:

  <details>
    <summary>Example output</summary>
  
    ```bash
    # opencli user-disk proba summary
    
    -------------- disk usage --------------
    - 564M	/home/proba
    - 864M	/var/lib/docker/devicemapper/mnt/ac28d2b066f5ffcacf4510b042623f6a3c196bd4f5fb9e842063c5325e4d0184
    ```
    
    ```bash
    # opencli user-disk proba summary --json
    
    {"home_directory_usage": "564564", "docker_container_usage": "883864", "home_path": "/home/proba", "docker_path": "/var/lib/docker/devicemapper/mnt/ac28d2b066f5ffcacf4510b042623f6a3c196bd4f5fb9e842063c5325e4d0184"}
    ```
  </details>



- Detailed disk usage report for user:

  <details>
    <summary>Example output</summary>

    ```bash
    # opencli user-disk proba detail
    ------------- home directory -------------
    - home directory:        /home/proba
    - mountpoint:            /home/proba
    - bytes used:            61440
    - bytes total:           10375548928
    - bytes limit:           true
    - inodes used:           20
    - inodes total:          1000960
    ---------------- container ---------------
    - container directory:   /var/lib/docker/devicemapper/mnt/ac28d2b066f5ffcacf4510b042623f6a3c196bd4f5fb9e842063c5325e4d0184
    - bytes used:            1025388544
    - bytes total:           10726932480
    - inodes used:           20905
    - inodes total:          5242880
    - storage driver:        devicemapper
    ```
  </details>

- Paths for user:
  ```bash
  # opencli user-disk proba path
  
  -------------- paths --------------
  - home_directory=/home/proba
  - docker_container_path=/var/lib/docker/devicemapper/mnt/ac28d2b066f5ffcacf4510b042623f6a3c196bd4f5fb9e842063c5325e4d0184
  ```
  
  ```bash
  # opencli user-disk proba path --json
  
  {"home_directory": "/home/proba","docker_container_path": "/var/lib/docker/devicemapper/mnt/ac28d2b066f5ffcacf4510b042623f6a3c196bd4f5fb9e842063c5325e4d0184"}
  ```



### Block IP

Prevent specific IP addresses or CIDR ranges from accessing any user websites:

```bash
opencli user-block_ip <username> [--list='ip_here another_ip' | --delete-all]
```

List blocked IPs for a user:
```bash
opencli user-block_ip <username>
```

Block IP addresses from accessing user websites:
```bash
opencli user-block_ip <username> --list='11.22.33.44 124.64.23.0/24'
```

Remove all blocked IP addresses for a user:
```bash
opencli user-block_ip <username> --delete-all
```

### View login log
View up to last 20 successfull logins for the user.

```bash
opencli user-loginlog <USERNAME> [--json]
```

### Varnish
Check Varnish Caching status for user and enable/disable Varnish service.

```bash
opencli user-varnish <USERNAME> [enable|disable|status]
```


Enable Varnish:
```bash
opencli user-varnish <USERNAME> enable 
```

Disable Varnish:
```bash
opencli user-varnish <USERNAME> disable 
```

Check status:
```bash
opencli user-varnish <USERNAME> status
```

Check short status (returns *Current status: on/off*):
```bash
opencli user-varnish <USERNAME>
```

---

// File: articles/opencli/version

# Version 

`opencli version` will display installed OpenPanel version:

```bash
opencli version
```

<details>
  <summary>Example output</summary>

```bash
# opencli version
1.7.4
```
</details>

---

// File: articles/opencli/waf

# CorazaWAF

`opencli waf` command can be used to enable/disable CorazaWAF on the server, enable/disable WAF per domain, view rules, view statistics, etc.

## Status

```bash
opencli waf status
```


## Enable
To enable the WAF and ensure it is used for new domains, run:

```bash
opencli waf enable
```


## Disable
To completely disable the WAF for all existing domains and prevent it from being applied to new domains, run:

```bash
opencli waf disable
```



## Domain


### Status
Check if CorazaWAF is enabled for domain:

```bash
opencli waf domain <DOMAIN_NAME>
```

### Enable
Enable WAF for a domain:

```bash
opencli waf domain <DOMAIN_NAME> enable
```

### Disable
Disable WAF for a domain:

```bash
opencli waf domain <DOMAIN_NAME> disable
```

## Update

Update OWASP CRS:

```bash
opencli waf update
```

### Update Log

View update log for OWASP CRS:

```bash
opencli waf update log
```

## IDs

List all rule IDs from all enabled sets:

```bash
opencli waf ids
```

## Tags

List all rule tags from all enabled sets:

```bash
opencli waf tags
```

## Stats

Get stats from the log.

### Country
```bash
opencli waf stats country
```

Example:
```
root@apolo2:/home/pcx3# opencli waf stats country
    2000 US
    1501 DE
    1033 BE
     809 SG
     705 SC
     606 ID
     603 IN
     505 NL
     500 RS
     209 CH
     109 FR
     108 PY
     102 BG
      70 CA
```

### IP
```bash
opencli waf stats ip
```

Example:
```
root@apolo2:/home/pcx3# opencli waf stats ip
   11069 154.83.103.102
    9038 154.83.103.15
    9038 154.83.103.111
    9038 154.83.103.106
    7007 154.83.103.19
    7007 154.83.103.109
    4069 154.83.103.202
    4069 154.83.103.10
    4062 108.162.221.121
    4055 154.83.103.14
```

### Path
```bash
opencli waf stats path
```

Example:
```
root@apolo2:/home/pcx3# opencli waf stats path
    1308 /modules/younitedpay/logo.png
     707 /.git/config
     608 /.env
     304 /.git/HEAD
     301 /wp-content/plugins/WordPressCore/include.php
     301 /php/how-to-fix-file_get_contents-wrapper-is-disabled-error-in-php/
     204 /wp-includes/images/include.php
     203 /wp-includes/widgets/include.php
     201 /.aws/credentials
     109 /wp-content/themes/include.php
```

### Agent
```bash
opencli waf stats agent
```

Example:
```
root@apolo2:/home/pcx3# opencli waf stats agent
   10400  Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36
    1909  Mozlila/5.0 (Linux; Android 7.0; SM-G892A Bulid/NRD90M; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/60.0.3112.107 Moblie Safari/537.36
    1308  Go-http-client/2.0
     809  Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/134.0.0.0 Safari/537.36 Edg/134.0.0.0
     702  Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/134.0.0.0 Safari/537.36
     610  Mozilla/5.0 (Windows NT 10.0; WOW64) Gecko/20060309 Firefox/22.0
     600  Mozilla/5.0 (Macintosh; Intel Mac OS X 11_8_4) Gecko/20052101 Firefox/22.0
     544  Mozilla/5.0
     371  Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/132.0.0.0 Safari/537.36 OPR/117.0.0.0
     350  Mozilla/5.0 (Windows; U; MSIE 9.0; Windows NT 10.0; Trident/5.0; WOW64)
```

### Hourly
```bash
opencli waf stats hourly
```

Example:
```
root@apolo2:/home/pcx3# opencli waf stats hourly
     14 2025/04/14 00
     14 2025/04/14 10
      7 2025/04/14 19
      7 2025/04/15 18
      7 2025/04/15 22
      7 2025/04/16 00
     14 2025/04/16 10
     14 2025/04/16 11
      7 2025/04/17 04
      7 2025/04/17 07
      7 2025/04/17 12
      7 2025/04/18 01
      7 2025/04/18 06
      7 2025/04/18 07
      7 2025/04/18 10
      7 2025/04/18 19
    469 2025/04/20 07
     14 2025/04/20 08
      7 2025/04/20 14
     14 2025/04/20 18
      7 2025/04/21 15
     14 2025/04/22 05
```

### Request
```bash
opencli waf stats request
```

Example:
```
root@apolo2:/home/pcx3# opencli waf stats request
    1803 POST /xmlrpc.php HTTP/1.1
    1408 POST /xmlrpc.php HTTP/2.0
    1038 GET /modules/younitedpay/logo.png HTTP/2.0
     608 GET /.git/config HTTP/1.1
     641 GET /.env HTTP/1.1
     553 POST /api/discussions/137 HTTP/1.1
     334 POST /api/discussions/128 HTTP/1.1
     324 GET /.git/HEAD HTTP/1.1
     301 POST /wp-comments-post.php HTTP/1.1
     214 POST //xmlrpc.php HTTP/2.0
```

---

// File: articles/opencli/webserver

# Apache / Nginx

Scripts for managing users webserver: Nginx or Apache


### Get users webserver

To list users current webserver run the following command:

```bash
opencli webserver-get_webserver_for_user <USERNAME>
```

Example:
```bash
# opencli webserver-get_webserver_for_user stefan
Web Server for user stefan: apache
```

The script will by default display cached information from the users `server_config.yml` file, optionally you can add `--update` flag to check the current webserver in the container and update the file.

Example:
```bash
# opencli webserver-get_webserver_for_user stefan --update
Web Server for user stefan updated to: apache

---

// File: articles/opencli/websites

# Websites

Manage websites.

### List all websites

List all websites hosted on the server:

```bash
opencli websites-all
```

### List websites for user

List all websites owned by user:

```bash
opencli websites-user <USERNAME>
```

### Add websites for user

Scan user files and add WordPress installations:
```bash
opencli websites-scan <USERNAME>
```

use `-all` flag to run for all users:
```bash
opencli websites-scan -all
```


### Secure

Server-level restrictions to harden WordPress instance. Rules are applied at the webserver level before PHP processing.

List all available rules:
```bash
opencli websites-secure --list-available-rules
```

Check if rules exist for a domain:
```bash
opencli websites-secure <domain>
```

List enabled rules for domain:
```bash
opencli websites-secure <domain> --list-active-rules
```

Enable rules for a domain:
```bash
opencli websites-secure <domain> --rules='rule1 rule2'
```
  
Disable all rules for a domain:
```bash
opencli websites-secure <domain> --disable-all
```

### Vulnerability

Check WordPress website for WP core, theme and plugin vulnerabilities:

```bash
opencli websites-vulnerability <WEBSITE>
```

Example:
```bash
opencli websites-vulnerability pejcic.rs
```

Check vulnerabilities for all WordPress websites hosted on server:

```bash
opencli websites-vulnerability --all
```

### PageSpeed

Get Google PageSpeed data for a single website:

```bash
opencli websites-pagespeed <WEBSITE>
```

Example:
```bash
opencli websites-pagespeed pejcic.rs/blog
```

Get Google PageSpeed data for all websites hosted on server:

```bash
opencli websites-pagespeed -all
```

> **Note:**  
> Since version **1.2.2**, users can provide their own [PageSpeed API key](https://developers.google.com/speed/docs/insights/v5/get-started) by creating a file named `pagespeed_api_key.txt` in their home directory at `/var/www/html/`.  
>  
> Administrators can also set a system-wide API key by creating the file `/etc/openpanel/openpanel/service/pagespeed.api` and placing the key inside.

---

// File: articles/security/csf-blocklists

# CSF Blocklists

CSF/LFD supports downloading and applying blocklists of IPs and CIDRs from public sources. 

OpenPanel does **not** enable any IP blocklists by default upon installation.

## from OpenAdmin

To enable a blocklist from OpenAdmin interface, navigate to **Security > Firewall** then scroll down and click on the 'LFD Blocklists':

[![2025-07-22-17-06.png](/img/docs-content/LsdV3g1b-2025-07-22-17-06.png)](/img/docs-content/LsdV3g1b-2025-07-22-17-06.png)

**Uncomment** the line that starts with the desired blocklist, by removing the `#` before it, then click on 'Change':

[![2025-07-22-17-06-1.png](/img/docs-content/jjz4gq6d-2025-07-22-17-06-1.png)](/img/docs-content/jjz4gq6d-2025-07-22-17-06-1.png)

Finally click on 'Restart csf+lfd':

[![2025-07-22-17-07.png](/img/docs-content/KYrt7qF1-2025-07-22-17-07.png)](/img/docs-content/KYrt7qF1-2025-07-22-17-07.png)


## from Terminal

To enable a specific blocklist:

1. Open file `/etc/csf/csf.blocklists`
2. **Uncomment** the line that starts with the desired blocklist.
3. Save the file.
4. **Restart CSF**, then **restart LFD**: `csf -ra && service lfd restart`





## Format

| Parameter | Description |
|-----------|-------------|
| **NAME**     | List name with all uppercase alphabetic characters, no spaces, and a maximum of 25 characters. This will be used as the iptables chain name. |
| **INTERVAL** | Refresh interval (in seconds) to download the list. Must be at least `3600` (1 hour), but `86400` (1 day) is generally sufficient. |
| **MAX**      | Maximum number of IP addresses to use from the list. A value of `0` means all IPs will be included. |
| **URL**      | URL of the IP list source. |


## Blocklists


| Name | Category | Maintainer | Description | Enabled by Default |
|------|----------|------------|-------------|-------------|
| [ABUSEIPDB](https://api.abuseipdb.com/api/v2/blacklist?key=YOUR_API_KEY&plaintext=1) | reputation | [abuseipdb.com](https://www.abuseipdb.com/) | IP reputation database of abusive IPs engaging in hacking attempts or other malicious behavior (**You must [sign up](https://www.abuseipdb.com/register?plan=free) to their website for a free API key then replace YOUR_API_KEY with it in the source URL**). |  |
| [UNLIMITED_RS](https://blacklist.unl.rs/) | reputation | [unlimited.rs](https://blacklist.unl.rs/) | UNLIMITED.RS attacking IP addresses (all). |  |
| [BDE](https://api.blocklist.de/getlast.php?time=3600) | attacks | [blocklist.de](https://www.blocklist.de) | Blocklist.de attacking IP addresses (last hour). |  |
| [BDEALL](https://lists.blocklist.de/lists/all.txt) | attacks | [blocklist.de](https://www.blocklist.de) | Blocklist.de attacking IP addresses (all). |  |
| [BDS_ATIF](https://www.binarydefense.com/banlist.txt) | reputation | [binarydefense.com](https://www.binarydefense.com/) | Artillery Threat Intelligence feed and banlist feed. |  |
| [BFB](https://danger.rulez.sk/projects/bruteforceblocker/blist.php) | attacks | [Daniel Gerzo](https://danger.rulez.sk/index.php/bruteforceblocker/) | BruteForceBlocker IP List. |  |
| [BLOCKLIST_NET_UA](https://blocklist.net.ua/blocklist.csv) | abuse | [blocklist.net.ua](https://blocklist.net.ua) | Helps stop spam and brute force attacks from dubious sources. |  |
| [BOGON](https://www.team-cymru.org/Services/Bogons/bogon-bn-agg.txt) | unroutable | [team-cymru.org](https://www.team-cymru.org/Services/Bogons/) | Private/reserved IPs and unallocated netblocks. |  |
| [BOTSCOUT](https://botscout.com/last_caught_cache.htm) | abuse | [botscout.com](https://botscout.com/) | Prevents bots from abusing forms, spamming, etc. |  |
| [CIARMY](https://cinsscore.com/list/ci-badguys.txt) | reputation | [cinsscore.com](https://cinsscore.com/) | Poor rogue packet score IPs from the CINS Army list. |  |
| [DARKLIST_DE](https://www.darklist.de/raw.php) | attacks | [darklist.de](https://www.darklist.de/) | SSH fail2ban reporting. |  |
| [DSHIELD](https://feeds.dshield.org/block.txt) | attacks | [dShield.org](https://dshield.org/) | Top 20 attacking class C (/24) subnets over 3 days. |  |
| [ET_BLOCK](https://rules.emergingthreats.net/fwrules/emerging-Block-IPs.txt) | attacks | [emergingthreats.net](https://www.emergingthreats.net/) | Default blacklist; better to use individual ipsets. |  |
| [ET_COMPROMISED](https://rules.emergingthreats.net/blockrules/compromised-ips.txt) | attacks | [emergingthreats.net](https://www.emergingthreats.net/) | Compromised hosts. |  |
| [ET_TOR](https://rules.emergingthreats.net/blockrules/emerging-tor.rules) | anonymizers | [emergingthreats.net](https://www.emergingthreats.net/) | TOR network IPs. |  |
| [FEODO](https://feodotracker.abuse.ch/blocklist/?download=ipblocklist) | malware | [abuse.ch](https://feodotracker.abuse.ch/) | Feodo (Cridex/Bugat) trojan IPs. |  |
| [GREENSNOW](https://blocklist.greensnow.co/greensnow.txt) | attacks | [greenSnow.co](https://greensnow.co/) | Monitors brute force, FTP, SMTP, SSH, etc. |  |
| [HONEYPOT](https://www.projecthoneypot.org/list_of_ips.php?t=d&rss=1) | attacks | [projecthoneypot.org](https://www.projecthoneypot.org) | Dictionary attacker IPs. |  |
| [INTERSERVER_2D](https://sigs.interserver.net/ipslim.txt) | attacks | [interserver.net](https://sigs.interserver.net/) | Brute force/spam/malicious IPs (last 2 days). |  |
| [INTERSERVER_7D](https://sigs.interserver.net/ip.txt) | attacks | [interserver.net](https://sigs.interserver.net/) | Same as above (last 7 days). |  |
| [INTERSERVER_ALL](https://sigs.interserver.net/iprbl.txt) | attacks | [interserver.net](https://sigs.interserver.net/) | All known malicious IPs. |  |
| [SBLAM](https://sblam.com/blacklist.txt) | abuse | [sblam.com](https://sblam.com/) | Web form spammers. |  |
| [SPAMDROP](https://www.spamhaus.org/drop/drop.lasso) | spam | [spamhaus.org](https://www.spamhaus.org/drop/) | DROP - Do not Route Or Peer List. |  |
| [SPAMDROPV6](https://www.spamhaus.org/drop/dropv6.txt) | spam | [spamhaus.org](https://www.spamhaus.org/drop/) | DROPv6 for IPv6. |  |
| [SPAMEDROP](https://www.spamhaus.org/drop/edrop.lasso) | spam | [spamhaus.org](https://www.spamhaus.org/drop/) | Extended DROP List (EDROP). |  |
| [SSLBL](https://sslbl.abuse.ch/blacklist/sslipblacklist.csv) | malware | [abuse.ch](https://sslbl.abuse.ch/) | SSL traffic related to malware/botnets. |  |
| [SSLBL_AGGRESSIVE](https://sslbl.abuse.ch/blacklist/sslipblacklist_aggressive.csv) | malware | [abuse.ch](https://sslbl.abuse.ch/) | Aggressive SSL blacklist (may cause false positives). |  |
| [STOPFORUMSPAM](https://www.stopforumspam.com/downloads/bannedips.zip) | abuse | [stopforumspam.com](https://www.stopforumspam.com/) | Forum spammer IPs. |  |
| [STOPFORUMSPAM_180D](https://www.stopforumspam.com/downloads/listed_ip_180.zip) | abuse | [stopforumspam.com](https://www.stopforumspam.com/) | Last 180 days. |  |
| [STOPFORUMSPAM_1D](https://www.stopforumspam.com/downloads/listed_ip_1.zip) | abuse | [stopforumspam.com](https://www.stopforumspam.com/) | Last 24 hours. |  |
| [STOPFORUMSPAM_30D](https://www.stopforumspam.com/downloads/listed_ip_30.zip) | abuse | [stopforumspam.com](https://www.stopforumspam.com/) | Last 30 days. |  |
| [STOPFORUMSPAM_365D](https://www.stopforumspam.com/downloads/listed_ip_365.zip) | abuse | [stopforumspam.com](https://www.stopforumspam.com/) | Last 365 days. |  |
| [STOPFORUMSPAM_7D](https://www.stopforumspam.com/downloads/listed_ip_7.zip) | abuse | [stopforumspam.com](https://www.stopforumspam.com/) | Last 7 days. |  |
| [STOPFORUMSPAM_90D](https://www.stopforumspam.com/downloads/listed_ip_90.zip) | abuse | [stopforumspam.com](https://www.stopforumspam.com/) | Last 90 days. |  |
| [STOPFORUMSPAM_TOXIC](https://www.stopforumspam.com/downloads/toxic_ip_cidr.txt) | abuse | [stopforumspam.com](https://www.stopforumspam.com/) | Networks with heavy bot activity. |  |
| [TOR](https://check.torproject.org/cgi-bin/TorBulkExitList.py?ip=1.2.3.4) | anonymizers | [torproject.org](https://trac.torproject.org/projects/tor/wiki/doc/TorDNSExitList) | TOR exit node list. |  |



**NOTE: These lists are not under the control of OpenPanel and could have false positives.**

---

// File: articles/security/how-to-limit-connections-csf

# Limiting Connections with CSF

CSF allows you to restrict the number of simultaneous connections to specific ports on your server.

For example, you can configure CSF to limit port 80 to a maximum of 5 concurrent connections, and port 443 to 20 concurrent connections by adding the following to your configuration file:

```
CONNLIMIT = "80;5,443;20"
```

**How CONNLIMIT Works:**

The `CONNLIMIT` setting uses a comma-separated list of `port;limit` pairs.

For example:
```
CONNLIMIT = "22;5,80;20"
```

means:

1. Each IP address can have up to 5 concurrent new connections to port 22.
2. Each IP address can have up to 20 concurrent new connections to port 80.

---

// File: articles/security/how-to-update-lfd-alerts-email

# Update LF_ALERT_TO

How to Set the Email Address for CSF/LFD Alerts

---

Updating the notification email through **OpenAdmin** will also update the email used by **CSF/LFD** for alerts.

To do this via command line, simply run:

```bash
opencli config update email youremail@yourdomain.com
```

This updates both the OpenAdmin notifications and the `LF_ALERT_TO` setting for CSF/LFD.

---

## Using a Different Email for CSF/LFD

If you want **CSF/LFD** to send alerts to a different address than the one set in OpenAdmin:

1. Open the CSF configuration file in your preferred text editor:

   ```bash
   nano /etc/csf/csf.conf
   ```

2. Locate the following line:

   ```
   LF_ALERT_TO = ""
   ```

3. Replace it with your desired email:

   ```
   LF_ALERT_TO = "youremail@yourdomain.com"
   ```

4. Save the file and restart CSF to apply changes:

   ```bash
   csf -r
   ```

That's it! CSF/LFD will now send notifications to your specified email address.

---

> **Note:** CSF/LFD is third-party software not developed or maintained by OpenPanel.
> For support, please contact Sentinel Firewall directly:
> [https://sentinelfirewall.org/](https://sentinelfirewall.org/)

---

// File: articles/security/securing-openpanel

# Securing OpenPanel

This section describes the best practices and settings that can increase the security of your OpenPanel server and, thus, protect it from various types of attacks and loss of sensitive data:

For Server Administrators (OpenAdmin):

- [Enable Basic Access Authentication for OpenAdmin](/docs/admin/security/basic_auth/)
- [Configure CorazaWAF rules](/docs/admin/security/waf/)
- [Change OpenPanel or OpenAdmin ports](/docs/admin/settings/general/#ports)
- [Restrict access to OpenAdmin](/docs/articles/dev-experience/limit_access_to_openadmin/)
- [Check passwords against weakpass.com lists](/docs/admin/settings/openpanel/#display)
- [Changing the OpenPanel Administrator Username](/docs/admin/accounts/administrators/#create-new-admin)
- [Securing OpenPanel and the Mail Server With SSL/TLS Certificates](/docs/admin/settings/general/#domain)
- [Restricting access to Features based on Hosting Plans](/docs/admin/plans/feature-manager/#use-cases)
- [Setup Fail2ban for email](/docs/articles/email/how-to-setup-fail2ban-mailserver-openpanel/)
- [Setup DKIM for emails](/docs/articles/email/how-to-setup-dkim-for-mailserver/)
- [Setup ImunifyAV](/docs/articles/security/setup-imunifyav/)
- [Enable CSF Blocklists](/docs/articles/security/csf-blocklists/)
- [Limiting Connections with CSF](/docs/articles/security/how-to-limit-connections-csf/)
- [Rate-limiting failed Openpanel logins](/docs/articles/dev-experience/rate_limiting_for_openpanel/)
- [Change SSH root user password](/docs/admin/advanced/root-password/)
- [Change SSH port](/docs/admin/advanced/ssh/#basic-ssh-settings/)
- [Configure SSH Keys](/docs/admin/advanced/ssh/#authorized-ssh-keys)
- [Disable Terminal in OpenAdmin](docs/articles/dev-experience/disable-openadmin-web-terminal/)
- [Disable Server Reboot in OpenAdmin](docs/articles/dev-experience/disable-openadmin-server-reboot/)
- [Disable OpenAdmin access](/docs/admin/security/disable-admin/)

For Website Administrators (OpenPanel):
- [Enabling WAF protection per domain](/docs/panel/advanced/waf/)
- [Configure Automatic Backups](/docs/panel/files/backups/)
- [Fix Files Permissions](/docs/panel/files/fix_permissions/)
- [Scan website files for Malware](/docs/panel/files/malware-scanner/)
- [Suspend a Compromised Website](/docs/panel/domains/suspend/)
- [Setting up Multi-Factor Authentication in OpenPanel](/docs/panel/account/2fa/)
- [Configure Automatic SSL](/docs/panel/domains/ssl/#autossl)
- [Reviewing Account activity log](/docs/panel/account/account_activity/)
- [Reviewing Active Sessions](/docs/panel/account/active_sessions/)
- [Viewing Login History](/docs/panel/account/login_history/)

---

// File: articles/security/setup-imunifyav

# Setting Up ImunifyAV

ImunifyAV regularly scans user files and alerts you if any malware is detected.

---

To configure ImunifyAV via the control panel:

1. Go to **OpenAdmin > Security > ImunifyAV**.
2. Click the **cog icon** to access settings.
3. Adjust the resource limits for scans and set the scan schedule — by default, scans run monthly.

[![imunifyav.png](/img/docs-content/PqmmF0JV-imunifyav.png)](/img/docs-content/PqmmF0JV-imunifyav.png)


Alternatively, you can perform these configurations directly from the terminal:

**Setting Resource Limits for ImunifyAV**:

```bash
imunify-antivirus config update '{"MALWARE_SCAN_INTENSITY": {"cpu": 2}}'
imunify-antivirus config update '{"MALWARE_SCAN_INTENSITY": {"io": 2}}'
imunify-antivirus config update '{"MALWARE_SCAN_INTENSITY": {"ram": 1024}}'
imunify-antivirus config update '{"MALWARE_SCAN_INTENSITY": {"user_scan_cpu": 2}}'
imunify-antivirus config update '{"MALWARE_SCAN_INTENSITY": {"user_scan_io": 2}}'
imunify-antivirus config update '{"MALWARE_SCAN_INTENSITY": {"user_scan_ram": 1024}}'
imunify-antivirus config update '{"RESOURCE_MANAGEMENT": {"cpu_limit": 1}}'
imunify-antivirus config update '{"RESOURCE_MANAGEMENT": {"io_limit": 1}}'
imunify-antivirus config update '{"RESOURCE_MANAGEMENT": {"ram_limit": 500}}'
```

**Adjusting the Scan Schedule**:

```bash
imunify-antivirus config update '{"MALWARE_SCAN_SCHEDULE": {"day_of_month": 1}}'
imunify-antivirus config update '{"MALWARE_SCAN_SCHEDULE": {"hour": 3}}'
imunify-antivirus config update '{"MALWARE_SCAN_SCHEDULE": {"interval": "none"}}'
```

---

## Upgrade to ImunifyAV+

Execute the following command on your server to activate the Imunify AV+ license.  **If you plan on using Imunify AV free version you can skip this step**.

**Activation using an activation key**:
To activate your ImunifyAV+ license using the activation key, run the following commands:

```
imunify-antivirus unregister
imunify-antivirus register YOUR_KEY
```

Where `YOUR_KEY` is your license key, replace it with the actual key – trial or purchased. Key format is: `IMAVPXXXXXXXXXXXXXXX`.

**Activation with IP-based license**:
If you have an IP-based license, run the following commands:

```
imunify-antivirus unregister
imunify-antivirus register IPL
```

----


For more information refer to ImunifyAV Documentation

---

// File: articles/server/cloudflared-tunnel-openpanel

# Cloudflare Tunnel + OpenPanel

Cloudflare Tunnel allows you to securely expose services (websites, APIs, or internal tools) to the internet **without opening firewall ports** or exposing your server’s IP address.

This guide covers configuring Cloudflare Tunnel for an OpenPanel server.

> **NOTE**: This article was generated by AI and may require verification. Click the link at the bottom of the page to edit and contribute.

---

## 1. Add `cloudflared` service

Edit your existing `/root/docker-compose.yml` and add:

```yaml
  cloudflared:
    image: cloudflare/cloudflared:latest
    restart: unless-stopped
    command: tunnel --config /etc/cloudflared/config.yml run
    volumes:
      - ./cloudflared:/etc/cloudflared
    network_mode: host
```

Create the Cloudflared folder:

```bash
mkdir -p /root/cloudflared
```

Create `/root/cloudflared/config.yml`:

```yaml
tunnel: my-openpanel-tunnel
credentials-file: /etc/cloudflared/<TUNNEL-ID>.json

ingress:
  - hostname: site1.example.com
    service: http://localhost
  - hostname: site2.example.com
    service: http://localhost
```

---

## 2. Install & Login (one-time)

Run the following to authenticate Cloudflare:

```bash
docker run -it --rm \
  -v /root/cloudflared:/etc/cloudflared \
  cloudflare/cloudflared:latest tunnel login
```

Open the link in your browser and log in with your Cloudflare account.

---

## 3. Create a Tunnel

```bash
docker run -it --rm \
  -v /root/cloudflared:/etc/cloudflared \
  cloudflare/cloudflared:latest tunnel create my-openpanel-tunnel
```

This generates `<TUNNEL-ID>.json` in `/root/cloudflared`.

---

## 4. Update `config.yml`

* Replace `<TUNNEL-ID>` with the actual ID.
* Update the `service` URLs to match your internal site addresses.

---

## 5. Configure DNS in Cloudflare

For each site (`site1.example.com`, `site2.example.com`):

* Type: `CNAME`
* Value: `<TUNNEL-ID>.cfargotunnel.com`
* Proxy status: **Proxied** (orange cloud)

---

## 6. Start the Tunnel

```bash
cd /root && docker compose up -d cloudflared
```

---

## 7. Block Direct Access

In your firewall, block all inbound HTTP/HTTPS traffic (and `2083` and `2087` ports) **except** Cloudflare IP ranges:

* [IPv4 ranges](https://www.cloudflare.com/ips-v4)
* [IPv6 ranges](https://www.cloudflare.com/ips-v6)

## If you haven't created a tunnel yet:
## 8. Create New Tunnel in Dashboard
* Log in to Cloudflare Dashboard
* Go to [https://dash.cloudflare.com](https://dash.cloudflare.com)
* Sign in with your account
* Go to Zero Trust → Networks → Tunnels
* Click Create a tunnel
* Choose Cloudflared as the connector type
* Give it a name (e.g., "my-openpanel-tunnel")
* Click Save tunnel
* The next screen will show your Tunnel ID and provide a credentials file to download
* Download the JSON credentials file - the filename is ```<TUNNEL_ID>.json```

---

// File: articles/server/how-to-free-up-disk-space-on-linux

# How To Free Up Disk Space

Low disk space can affect server stability and performance. This guide helps you identify and free up disk space on your OpenPanel server.

---

### 1. Check Disk Usage

Start by checking how much space is currently used:

```bash
df -h
```

To find large directories:

```bash
du -h / | sort -hr | head -n 20
```

---

### 2. Clean Up Docker

Docker can quickly consume space with unused containers, images, volumes, and networks.

* To remove **unused** Docker data:

```bash
docker system prune
```

* To also remove unused **volumes** (use with caution):

```bash
docker system prune --volumes
```

> 🧼 **Note:** This only removes resources not actively in use. Review the list before confirming.

* View what's taking space:

```bash
docker system df
```

---

### 3. Clear Logs

Log files often grow large over time:

* Delete rotated/compressed logs:

```bash
rm -f /var/log/*.gz /var/log/*.1
```

* Truncate current logs:

```bash
truncate -s 0 /var/log/syslog
truncate -s 0 /var/log/auth.log
```

---

### 4. Remove Unused Packages

Free space by removing orphaned packages:

* For Debian/Ubuntu:

```bash
apt autoremove
apt clean
```

* For CentOS/RHEL:

```bash
yum autoremove
yum clean all
```

---

### 5. Clear Cache

Remove stored .deb or .rpm files:

* APT cache:

```bash
rm -rf /var/cache/apt/archives/*
```

* YUM cache:

```bash
rm -rf /var/cache/yum
```

---

### 6. Delete Temporary Files

Clean up temp directories:

```bash
rm -rf /tmp/*
rm -rf /var/tmp/*
```

---

### 7. Clean User Trash

For all users:

```bash
rm -rf /home/*/.cache/*
rm -rf /home/*/.local/share/Trash/*
```

---

### 8. Remove Old Backups

Search for old or backup files:

```bash
find / -type f \( -name "*.bak" -o -name "*.old" \)
```

Inspect before deleting.

---

### 9. Analyze with ncdu

Use `ncdu` for a navigable summary:

```bash
apt install ncdu      # Debian/Ubuntu
yum install ncdu      # CentOS/RHEL

ncdu /
```

---

### 10. Update OpenPanel (Optional)

Updating OpenPanel removes previous docker images

```bash
opencli update --force
```

---

> **Tip:** Enable disk usage alerts via **OpenAdmin > Settings > Notifications**.

---

// File: articles/server/how-to-set-custom-ssl-openpanel-webmail

# Setting Custom SSL Certificates for OpenPanel, OpenAdmin, and Webmail

⚠️ Currently, adding custom SSL certificates for OpenPanel and Webmail is only possible from the terminal.

- Let's Encrypt certificates are stored in `/etc/openpanel/caddy/ssl/acme-v02.api.letsencrypt.org-directory/`
- Custom certificates must be placed in `/etc/openpanel/caddy/ssl/custom/`

---

## Custom SSL for OpenAdmin and OpenPanel

Follow these steps to configure a custom SSL certificate for OpenAdmin and OpenPanel interfaces:

### 1. Add the certificate

Create a directory `custom` in `/etc/openpanel/caddy/ssl/`:

```bash
mkdir -p /etc/openpanel/caddy/ssl/custom/
```

Then create directory name same as your domain
```bash
mkdir -p /etc/openpanel/caddy/ssl/acme-v02.api.letsencrypt.org-directory/YOUR_DOMAIN_HERE/
```

Upload your SSL files to this directory and name them:

* `$DOMAIN.crt`
* `$DOMAIN.key`

**Example:**

```
/etc/openpanel/caddy/ssl/custom/srv.openpanel.com/srv.openpanel.com.crt
/etc/openpanel/caddy/ssl/custom/srv.openpanel.com/srv.openpanel.com.key
```

### 2. Set the domain

```bash
opencli domain set <DOMAIN_NAME>
```

**Example:**
```bash
opencli domain set srv.openpanel.com
```

### 3. Configure Caddy

Open the **Caddyfile**:
```bash
nano /etc/openpanel/caddy/Caddyfile
```

Find the section for your domain:

```
# START HOSTNAME DOMAIN #
example.net {
    reverse_proxy localhost:2087
}
```

Add the `tls` line after `reverse_proxy`:

```
tls /etc/openpanel/caddy/ssl/custom/srv.openpanel.com/srv.openpanel.com.crt /etc/openpanel/caddy/ssl/custom/srv.openpanel.com/srv.openpanel.com.key
```

👉 Replace `srv.openpanel.com` with your actual domain.

Restart Caddy to apply the certificate:

```bash
docker restart caddy
```

---

## Custom SSL for Webmail

### 1. Add the certificate

Create a directory for your domain:

```bash
mkdir -p /etc/openpanel/caddy/ssl/custom/YOUR_DOMAIN_HERE/
```

Upload your SSL files and name them:

* `$DOMAIN.crt`
* `$DOMAIN.key`

**Example:**

```
/etc/openpanel/caddy/ssl/custom/webmail.openpanel.com/webmail.openpanel.com.crt
/etc/openpanel/caddy/ssl/custom/webmail.openpanel.com/webmail.openpanel.com.key
```

### 2. Assign the domain

```bash
opencli email-webmail domain <DOMAIN_NAME>
```

**Example:**

```bash
opencli email-webmail domain webmail.openpanel.com
```

### 3. Configure Caddy

Open the **Caddyfile**:

```bash
nano /etc/openpanel/caddy/Caddyfile
```

Locate the Webmail section:

```
# START WEBMAIL DOMAIN #
webmail.example.net {
    reverse_proxy localhost:8080
}
# END WEBMAIL DOMAIN #
```

Add the `tls` line after `reverse_proxy`:

```
tls /etc/openpanel/caddy/ssl/custom/webmail.openpanel.com/webmail.openpanel.com.crt /etc/openpanel/caddy/ssl/custom/webmail.openpanel.com/webmail.openpanel.com.key
```

👉 Replace `webmail.openpanel.com` with your domain.

Restart Caddy to apply the changes:

```bash
docker restart caddy
```

---

## Custom SSL for Domains (End-Users)

End-users can add their own SSL certificates directly from the **OpenPanel interface** if the `ssl` module and features are enabled.

📖 Documentation: [Custom SSL for Domains](https://openpanel.com/docs/panel/domains/ssl/#custom-ssl)

---

// File: articles/server/openadmin-system-crons

# OpenAdmin System Crons

Cron jobs used by OpenPanel are configured in **`/etc/cron.d/openpanel`** file and should **not be edited manually**, as they will be overwritten during updates.  

If you need to customize or add system cron jobs, use the **root user's crontab**.  


## docker-collect_stats --all
Command `opencli docker-collect_stats --all` collects the docker stats for all users. THis data is visible by end-users From 'Resurce Usage' pag, and for Amdinistrators form *Users > single user*  page.

Default schedule: hourly (`0 * * * *`)

Documentation: https://dev.openpanel.com/cli/docker.html#Collect-Stats




## domains-stats
Command `opencli domains-stats` parses (Caddy) access logs for all active users and their domains/.

- **Default schedule:** daily at 02:30 (`30 2 * * *`)  
- **Documentation:** [opencli domains-stats](https://dev.openpanel.com/cli/domains.html#Parse-domain-access-logs)



## websites-pagespeed --all
Command `opencli websites-pagespeed --all` collects **Google PageSpeed** data for all websites on the server. This data is visible by end-users from Site Manager and WP Manager pages.

If user has configured pagespeed api keys, those will be used automatically for all their domains.

- **Default schedule:** daily at 04:00 (`0 4 * * *`)  
- **Documentation:** [opencli websites-pagespeed](https://dev.openpanel.com/cli/websites.html#PageSpeed)


## update
Command `opencli update` checks for OpenPanel updates and performs them if `autopatch` or `autoupdate` are enabled.

- **Default schedule:** daily at 00:15 (`15 0 * * *`)  
- **Documentation:** [opencli update](https://dev.openpanel.com/cli/update.html)



## server-ips
Command `opencli server-ips` generates a fresh list of the server’s IP addresses.

- **Default schedule:** monthly on the 12th at 00:00 (`0 0 12 * *`)  
- **Documentation:** This command is DEPRECATED.


## ftp-users
Command `opencli ftp-users` recreates the FTP users file that displays users in OpenAdmin interface.

- **Default schedule:** every 8 hours (`0 */8 * * *`)  
- **Documentation:** [opencli ftp-users](https://dev.openpanel.com/cli/ftp.html#Users)



## email-server pflogsumm
Command `opencli email-server pflogsumm` generates an **HTML email summary report**, visible in **OpenAdmin > Emails > Summary Reports**.

- **Default schedule:** daily at 01:45 (`45 1 * * *`)  
- **Documentation:** [opencli email-server pflogsumm](https://dev.openpanel.com/cli/email.html#pflogsumm)



## docker-images --all
Command `opencli docker-images --all` checks all active user's docker images for updates using [Cup 🥤](https://github.com/sergi0g/cup) and displays the data to end-users on *Containers > Image Updates* page.

- **Default schedule:** daily at 03:45 (`45 3 * * *`)  
- **Documentation:** [opencli docker-images](https://dev.openpanel.com/cli/docker.html#Images)



## files-purge_trash
Command `opencli files-purge_trash` purges **FileManager Trash folders** for all users, based on the `autopurge_trash` setting retention.

- **Default schedule:** daily at 04:45 (`45 4 * * *`)  
- **Documentation:** [opencli files-purge_trash](https://dev.openpanel.com/cli/files.html#Purge-Trash)



## waf-update
Command `opencli waf-update` updates the default **OWASP CRS WAF rules**. Logs can be viewed via: `opencli waf-update log`.

- **Default schedule:** monthly on the 1st at 00:00 (`0 0 1 * *`)  
- **Documentation:** [opencli waf-update](https://dev.openpanel.com/cli/waf.html#Update)



## docker-backup
Command `opencli docker-backup` executes a **backup for all users’ Docker containers** This is disabled by default, as each end-user can then [schedule and manage their own backups from OpenPanel UI](/docs/panel/files/backups/).

- **Default schedule:** `59 23 31 2 *`  
- **Documentation:** [Configuring OpenPanel Backups: Admin-configured](/docs/articles/backups/comfiguring-backups/#1-admin-configured)



## sentinel
Command `opencli sentinel` runs the notification script for server monitoring.

- **Default schedule:** every 5 minutes (`*/5 * * * *`)  
- **Documentation:** [opencli sentinel](https://dev.openpanel.com/cli/sentinel.html)



## sentinel --report
Command `opencli sentinel --report` generates the [**daily usage report**](/docs/admin/settings/notifications).

- **Default schedule:** daily at 11:45 (`45 11 * * *`)
- **Documentation:** [opencli sentinel report](/docs/admin/settings/notifications)



## sentinel --startup
Command `opencli sentinel --startup` sends notification after server reboot.

- **Command:** `opencli sentinel --startup`
- **Default schedule:** `@reboot`



## Redis Temp Directory
At reboot, this cron ensures the Redis temporary directory exists with proper permissions.

- **Command:** `mkdir -p /tmp/redis && chmod 777 /tmp/redis`
- **Default schedule:** `@reboot`

---

// File: articles/server/user-data-cache-in-openpanel-ui

# Cached data in OpenPanel UI

The **OpenPanel end-user interface** reduces server disk I/O by leveraging caching with Redis.

* **System data** (generated only on service start):
  * `enabled_modules`
  * `logo`, `brand_name`
  * `dev_mode`
  * `found_a_bug_link`
  * `panel_version`
  * `avatar_type`, `gravatar_image_url`

* **User data** (generated on user login):
  * `user_id`, `username`, `email`
  * `docker_context`
  * `hosting_plan`
  * `feature_set`

* **Website & domain data** (generated only when accessed in the UI):
  * Websites list
  * Domain records

Data is refreshed periodically, but the system administrator can also force an immediate refresh by restarting the OpenPanel container, which regenerates all data.

**Cache duration for data in OpenPanel UI**:

| Item / Description                                                      | Cache (seconds) |
|-------------------------------------------------------------------------|----------------|
| Enterprise license validity                                              | 3600           |
| Account activity list                                                    | 300            |
| Country code for IP address                                              | 360            |
| Login history                                                            | 600            |
| Notification preferences                                                 | 300            |
| Active sessions                                                          | 10             |
| Website count in Auto Installer                                          | 30             |
| Varnish status                                                           | 360            |
| Server public IPv4 address                                               | 3600           |
| OpenPanel version                                                        | 7200           |
| SSL certificate existence for user panel                                  | 360            |
| Domain set for OpenPanel UI                                              | 3600               |
| OpenPanel configuration                                                  | 6000           |
| User websites in search results                                          | 600            |
| User websites in dashboard statistics widget                              | 300            |
| Disk and inode usage for user (dashboard widget)                          | 360            |
| Hosting plan limits (dashboard widget)                                    | 3600           |
| Domain usage (dashboard statistics)                                       | 360            |
| Database count (dashboard statistics)                                     | 360            |
| FTP account count (dashboard statistics)                                  | 360            |
| Docker stats (CPU, memory, containers, PIDs) (dashboard statistics)       | 360            |
| CNAME record existence when adding A record in DNS editor                 | 10             |
| Domain redirect existence                                                | 10             |
| Redirect URL for domain                                                  | 10             |
| Domains limit per plan                                                   | 3600           |
| Number of apex and subdomains                                            | 30             |
| SSL status for domain                                                    | 30             |
| Folder disk usage (File Manager)                                         | 5              |
| Webmail domain                                                           | 3600           |
| File content (File Manager - File Viewer)                                 | 30             |
| Subfolders and files list (File Manager)                                  | 5              |
| File statistics (owner, size, permissions) (File Manager)                 | 30             |
| Files in trash                                                           | 5              |
| Inode count for path (Inodes Explorer)                                    | 10             |
| FTP username validation                                                   | 60             |
| Malware scan results                                                     | 30             |
| Files in quarantine (Malware Scanner)                                     | 30             |
| GoAccess HTML report for domain                                           | 7200           |
| Server info page data                                                    | 360            |
| Plan limits when performing actions                                       | 300            |
| Exposed ports for Redis, Memcached, phpMyAdmin containers                | 300            |
| User account UID                                                         | 7200           |
| Domain ownership check                                                   | 60             |
| Website ownership check                                                  | 60             |
| Last login IP (dashboard widget)                                          | 600            |
| PHP version for domain                                                   | 30             |
| MySQL database size                                                      | 300            |
| Database info from wp-config.php (WP Manager)                             | 600            |
| Database info from local.php (Mautic Manager)                             | 300            |
| Server uptime and load (site info)                                       | 30             |
| Server info (CPU, IP, uptime, processor) (site info page)                 | 600            |
| Hosting plan limits (site info page)                                      | 600            |
| Database info: size, users, grants                                        | 600            |
| Service logs                                                             | 300            |
| Screenshot from API                                                      | 3600           |
| Screenshot link from remote API                                          | 60             |
| Database limit per plan (creating new database)                           | 3600           |
| List of all databases, users, grants (MySQL/Postgres)                     | 300            |
| Configuration values (my.cnf / postgresql.conf)                           | 30             |
| PHP extensions list                                                      | 30             |
| Available PHP versions for user                                          | 3600           |
| Running PHP services for user                                            | 10             |
| NodeJS/Python container logs                                             | 60             |
| NodeJS/Python Docker Hub tags                                            | 86400          |
| Webserver used by user                                                   | 300            |
| Domain settings for temporary links API (OpenPanel)                       | 7200           |
| Temporary link for website (API)                                         | 800            |
| WP version from wp-config.php (WP Manager)                                | 60             |
| Database info from wp-config.php (WP Manager)                             | 60             |
| PageSpeed results for website                                            | 60             |
| MySQL/MariaDB version for user (WP Manager)                               | 3600           |
| Docroot, DB info, PHP, WP, MySQL versions (WP Manager)                    | 300            |
| WP admin email (WP Manager)                                              | 300            |
| Backup existence check (WP Manager)                                       | 300            |
| PageSpeed API key check                                                   | 60             |
| Website existence check                                                  | 30             |

---

// File: articles/support/how-to-access-openpanel-demo

# Access demo

How to access OpenPanel demo servers?

Use the following link for viewing demos: https://openpanel.com/demo/

## OpenPanel demo

LINK: https://demo.openpanel.com:2083/login

If you are a website owner, then we recommend interacting with the **OpenPanel** interface.

This is where you can manage your websites and files.

## OpenAdmin demo

LINK: https://demo.openpanel.com:2087/login

If you are a web host, then we recommend interacting with the **OpenAdmin** interface.

This is where you can manage your server and customers.

---

// File: articles/support/how-to-troubleshoot-openadmin-error

# Troubleshooting OpenAdmin UI Errors

## 500 Error

If a **500 error** occurs in the OpenAdmin UI, enable dev_mode and tial to log to see the exact command run and response.

If you need assistance, you can copy the message to our [support forums](https://community.openpanel.org/) or [Discord channel](https://discord.openpanel.com/) for help troubleshooting.

---

## UI Not Responding

If a feature isn’t working as expected (like clicking a button with no response) it is likely a **front-end issue**.

To troubleshoot:

1. Open your browser’s **Developer Tools** (usually `F12` or `Ctrl+Shift+I` / `Cmd+Option+I`).
2. Navigate to the **Network** tab.
3. Repeat the action that’s not working.
4. Check for requests in the **Network** tab and any errors in the **Console** log.

* Selecting a request in the Network tab allows you to view the response returned by the backend.
* If the response doesn’t contain enough information to diagnose the issue, enable **dev_mode** on the server and check the Docker logs.

---

## Dev Mode

Enabling **dev_mode** allows OpenPanel and OpenAdmin interfaces to log detailed debugging information for every request. This helps administrators see the exact commands run by the panel and the responses received.

To enable dev_mode:

```bash
opencli config update dev_mode on
```

Then restart the panel.

When dev_mode is enabled, detailed logs for the user panel are available via:

```bash
tail -f /var/log/openpanel/admin/error.log
```

These logs provide verbose debugging information for troubleshooting.

---

// File: articles/support/how-to-troubleshoot-openpanel-error

# Troubleshooting OpenPanel UI Errors

## 500 Error

If a **500 error** occurs in the OpenPanel UI, a unique error code will be displayed on the page.

> ⚠️ This error code is specific to your machine. Only the server administrator can access detailed information about it.

To view the full error details, run the following command in your terminal:

```bash
opencli error ERROR_ID_HERE
```

Check the output for the error message. If you need assistance, you can copy the message to our [support forums](https://community.openpanel.org/) or [Discord channel](https://discord.openpanel.com/) for help troubleshooting.

---

## UI Not Responding

If a feature isn’t working as expected (like clicking a button with no response) it is likely a **front-end issue**.

To troubleshoot:

1. Open your browser’s **Developer Tools** (usually `F12` or `Ctrl+Shift+I` / `Cmd+Option+I`).
2. Navigate to the **Network** tab.
3. Repeat the action that’s not working.
4. Check for requests in the **Network** tab and any errors in the **Console** log.

* Selecting a request in the Network tab allows you to view the response returned by the backend.
* If the response doesn’t contain enough information to diagnose the issue, enable **dev_mode** on the server and check the Docker logs.

---

## Dev Mode

Enabling **dev_mode** allows OpenPanel and OpenAdmin interfaces to log detailed debugging information for every request. This helps administrators see the exact commands run by the panel and the responses received.

To enable dev_mode:

```bash
opencli config update dev_mode on
```

Then restart the panel.

When dev_mode is enabled, detailed logs for the user panel are available via:

```bash
docker logs -f openpanel
```

These logs provide verbose debugging information for troubleshooting.

---

// File: articles/support/how-to-unlinstall-openpanel

# Uninstall OpenPanel

OpenPanel has no official uninstaller, the only safe way to remove OpenPanel is to reinstall your server OS.

---

// File: articles/support/openpanel-welcome-email-smtp-fix

# Debugging Failed Welcome Emails in OpenPanel Enterprise

**Symptom:** `opencli user-add` / OpenAdmin UI reports `Failed to send welcome email`, with no error in `/var/log/openpanel/admin/error.log` and no `/var/log/openpanel/admin/emails/` directory, even though direct SMTP tests succeed.

## Debug Steps

**1. Enable verbose logging**

```bash
opencli config update dev_mode on
systemctl restart admin
tail -f /var/log/openpanel/admin/error.log
```

Reproduce via CLI with `-x` for a full trace:

```bash
opencli -x user-add <username> '<password>' <email> <plan>
```

Check whether the email step is actually attempted or silently skipped, e.g.:

```
+ send_welcome_email
+ [[ false == true ]]
+ return 0
```

If skipped, make sure the CLI command includes the same flags the UI sends (e.g. `--send-email`) — otherwise you're not reproducing the same code path.

**2. Verify stored SMTP config matches intended credentials**

Special characters can get stripped/mis-escaped via the UI:

```bash
grep '^mail_' /etc/openpanel/openpanel/conf/openpanel.config
```

Fix via CLI if needed:

```bash
opencli config update mail_password '<password>'
```

**3. Run a clean diagnostic pass**

```bash
#!/bin/bash
CONFIGURED_EMAIL=$(opencli config get email)
DEV_MODE=$(opencli config get dev_mode)

[[ -z "$CONFIGURED_EMAIL" ]] && { echo "ERROR: no notification email configured. Run: opencli config update email example@yourdomain.com"; exit 1; }
[[ "$DEV_MODE" != "on" ]] && { echo "ERROR: dev_mode must be on. Run: opencli config update dev_mode on && service admin restart"; exit 1; }

mv /var/log/openpanel/admin/error.log /var/log/openpanel/admin/error.log.OLD 2>&1 && touch /var/log/openpanel/admin/error.log
mv /var/log/openpanel/admin/notifications.log /var/log/openpanel/admin/notifications.log.OLD && touch /var/log/openpanel/admin/notifications.log

opencli -x sentinel --startup 2>&1 | tail -n 10
grep "/send_email" /var/log/openpanel/admin/access.log | tail -n 1
cat /var/log/openpanel/admin/error.log
```

This isolates whether the request even reaches `/send_email` and captures the resulting error.

## Common Root Causes

**Hairpin NAT** — if the panel calls its own public domain internally (rather than `localhost`) and the network/firewall doesn't support hairpin NAT, the internal call times out.

Fix: add a local hosts entry so the server resolves its own domain to itself:
```
127.0.0.1 <admin-panel-domain>
```

**SMTP provider IP block** — repeated test connections can trigger an anti-abuse block, e.g.:
```
421 - 4.4.5 Directory harvest attack detected
```

Fix: ask the mail provider to clear the block and whitelist the server's outgoing IP.

## Checklist

- [ ] Reproduce with `opencli -x user-add ...` using the same flags as the UI
- [ ] Enable `dev_mode`, restart admin, tail `error.log`
- [ ] Confirm the email step isn't being silently skipped
- [ ] Verify config file values match intended credentials
- [ ] Run the diagnostic script to confirm the request reaches `/send_email`
- [ ] Check for hairpin NAT issues
- [ ] Check with SMTP provider for IP blocks from repeated testing

---

// File: articles/support/report-bug

# Report a Bug

As a small team, we carefully prioritize our work to keep maintenance costs low and honor the fixed pricing we introduced in 2023. The same developers who build and maintain OpenPanel are also responsible for handling tickets and emails. To use our time effectively, we ask that you follow the guidelines below.

## When to Open a Ticket

Please **only open a ticket for sales, or marketing-related** matters.

## Where to Ask Questions

For how-to questions or general issues like “this is not working” please use:

* [Our Discord channel](https://discord.openpanel.com/)
* [Community forums](https://community.openpanel.org/)

These spaces are ideal for getting quick help from both the team and experienced users.

## How to Report a Bug

If you’ve found a bug, you can report it in one of the following ways:

* Use the **“Found a bug? Let us know”** link at the bottom of the page
* Open an issue directly on GitHub:
  [https://github.com/stefanpejcic/OpenPanel/issues/new/choose](https://github.com/stefanpejcic/OpenPanel/issues/new/choose)

Once submitted, our team is immediately notified. The appropriate team member will investigate, reproduce the issue, and work on a fix as soon as possible.

---

// File: articles/support/rootless-docker-dns-fix

# Fixing Outbound DNS/Internet Access in Rootless Docker (OpenPanel)

## Symptom

Containers running under a per-user **rootless Docker** context (via `vpnkit`) have no outbound internet access. DNS resolution fails for all external hostnames, even though:

- The host server has full internet access.
- System-level Docker containers (e.g. a reverse proxy container) resolve DNS correctly.
- The issue only affects rootless, per-user containers.

**Example errors:**

```bash
docker --context <user> exec apache wget -q --spider --timeout=5 https://example.com/feed.xml
# wget: bad address 'example.com'

docker --context <user> exec apache nslookup example.com 8.8.8.8
# ;; connection timed out; no servers could be reached
```

**Real-world impact:** In applications that fetch remote content (e.g. RSS/feed modules in a CMS), each unresolved external host can add significant delay per page load — since PHP/Apache waits on a DNS timeout for every unresolved host. This can turn a normal page load of a couple seconds into well over a minute.

## Root Cause

Rootless Docker uses `vpnkit` for networking. `vpnkit` intercepts DNS resolution before it reaches any nameservers configured inside the container or in `docker-compose.yml`. As a result:

- Adding `dns: [8.8.8.8, 1.1.1.1]` under the service in `docker-compose.yml` has **no effect**.
- Manually editing `/etc/resolv.conf` inside the container has **no effect**.

The actual fix must happen at the rootless Docker **daemon** level, not the container or compose level.

## Steps to Fix

### 1. Test from the correct container

Make sure you're testing from the container that actually serves outbound requests for the application (e.g. a PHP-FPM container), not just the web server container, since application-level outbound requests often run through a different process.

```bash
docker --context <user> exec <phpfpm-container> curl https://example.com/
```

### 2. Check the per-user daemon configuration

Locate the rootless daemon config for the affected user:

```bash
/home/<user>/.config/docker/daemon.json
```

Compare it against the platform's official reference configuration for rootless Docker daemons.

If fields are missing or incomplete, replace `daemon.json` with the full expected format, [view example](https://github.com/stefanpejcic/openpanel-configuration/blob/main/docker/daemon/rootless.json)


Don't forget to restart the Docker daemon for that user from step 4.

### 3. Verify the per-user network driver

Confirm that the internal network in the user's `docker-compose.yml` (`/home/<USER>/docker-compose.yml)` uses the bridge driver:

```yaml
networks:
  internal:
    driver: bridge
```

### 4. Restart the rootless Docker daemon for that user

```bash
machinectl shell <user>@ /bin/bash -c "systemctl --user start docker"
```

(Use `restart` instead of `start` if the daemon is already running.)

### 5. Verify connectivity after restart

```bash
docker --context <user> exec <phpfpm-container> curl https://example.com/
docker --context <user> exec apache wget -q -O- https://example.com/feed.xml
```

Both commands should now return valid output instead of timing out.

### 6. Diagnostic commands (if the issue persists)

Collect and review the following before escalating to platform support:

```bash
opencli report --public
docker info
docker --context=<user> network inspect <network-name>
```

## Notes

- Newly created users may already have a correct `daemon.json` by default — this issue can occur when an existing user's config predates the current reference format or was manually edited.
- If the fix doesn't resolve DNS, double-check whether `slirp4netns` is required for your specific OS/network driver combination, and share diagnostic output with platform support to help reproduce the environment.

## Summary Checklist

- [ ] Test DNS from the application/backend container, not just the web server container
- [ ] Compare the per-user `daemon.json` to the official rootless reference config
- [ ] Ensure the internal network driver is set to `bridge`
- [ ] Restart the user's rootless Docker daemon
- [ ] Re-test outbound connectivity from both the web server and backend containers

---

// File: articles/support/where-openpanel-stores-logs

# OpenPanel Log Files locations

OpenPanel generates the following logs:

| Log file | Description |
|----------|-------------|
|`/var/log/openpanel/user/access.log`| access logs for the OpenPanel|
|`docker logs openpanel`|verbose logs and errors for the OpenPanel when dev_mode is enabled|
|`/var/log/openpanel/admin/access.log`|access logs for the OpenAdmin |
|`/var/log/openpanel/admin/api.log`|OpenAdmin API log |
|`/var/log/openpanel/admin/login.log`|OpenAdmin successful logins|
|`/var/log/openpanel/admin/failed_login.log`|OpenAdmin failed login attempts |
|`/var/log/openpanel/user/failed_login.log`|OpenPanel failed login attempts |
|`/var/log/openpanel/admin/notifications.log`|OpenAdmin notifications (system and 8ser alerts) |
|`/var/log/openpanel/admin/cron.log`|OpenAdmin systme cron logs |
|`/var/log/openpanel/admin/error.log`|OpenAdmin error log |


:::info
By default, logging for OpenPanel, OpenAdmin, and the API is minimal in production. Administrators can [enable dev_mode](/docs/articles/support/how-to-troubleshoot-openpanel-error/#dev-mode) during troubleshooting to view more verbose logs.
:::


Services used by OpenPanel have the following logs:

| Log file | Description |
|----------|-------------|
|`docker logs openpanel_mysql`|MySQL error log|
|`docker logs openpanel_dns`|DNS service logs|


Logs can be viewed from the [OpenAdmin > Services > Log Viewer](/docs/admin/services/log_viewer/) and Administrators can even [add custom log files to OpenAdmin Log Viewer](/docs/admin/services/log_viewer/#how-to-add-more-files-to-openadmin-log-viewer).

---

// File: articles/transfers/import-cpanel-backup-to-openpanel

# Import cPanel backup

Import cPanel accounts from backup.

## Create cpanel backup

Create a cPanel account backup using backup wizard or download a backup from Jetbackup5 interface:

![cpanel backup wizard](/img/docs-content/q7MbhszY-1.png)

## Download backup
Transfer the generated backup to your server

## Import backup
To start import from OpenPanel, access OpenAdmin and click on 'Import cPanel Account' within the Advanced section of the sidebar.

![import cpanel backup in openpanel](/img/panel/v2/cpanelimport.png)

Insert full path to the uploaded cPanel backup archive, select a plan for the imported user and click on 'Import from Backup'.

![import cpanel backup in openpanel2](/img/panel/v2/cpanelimport2.png)

## That's it
Import is running in background

![import cpanel backup in openpanel3](/img/panel/v2/cpanelimport3.png)

You can trace progress and view the import log on this page.

![import cpanel backup in openpanel4](/img/panel/v2/cpanelimport4.png)

---

// File: articles/transfers/migrate-openadmin-to-new-server

# Migrate server

OpenPanel is a truly OS-agnostic hosting panel, meaning it runs seamlessly on any Linux distribution. This makes migrating the panel along with all user data - from one server to another straightforward and efficient.

To migrate all data from a server to another:

## Prepare the New Server

The new server should have a clean environment with **only OpenPanel installed**-no existing users or additional configurations.

Install OpenPanel by running:

```bash
bash <(curl -sSL https://openpanel.org)
```

Wait for the installation to complete, then proceed to the source server.

## Migrate from the Old Server

Migration can be performed via OpenAdmin UI or from the terminal:

### Using OpenAdmin

On the old server, login to **OpenAdmin** and navigate to *Advanced > Migration*, provide the new server’s IP address and root credentials:

Click on the 'Start Migration' button and wait for the process to complete:

### Using Terminal

```bash
opencli server-migrate -h NEW_SERVER_IP --user root --password NEW_SERVER_ROOT_PASSWORD
```

Allow the migration process to finish.

## Verify Migration

After completion, log in to the OpenAdmin panel on the new server using the same credentials you used on the old server.

Verify that all services have started correctly in OpenAdmin under Service Status, and test a few user websites to ensure they are functioning properly.

If everything looks good, proceed to update the DNS records for the domains to point to the new server.

If something is not running, check the migration log on source server for any errors: `/tmp/server_migrate.log`

---

// File: articles/transfers/transfer-openpanel-account-to-another-server

# Transfer account

This feature allows administrators to transfer (copy) individual accounts from one OpenPanel server to another.

To migrate all users and files at once, please refer to the, please refer to the [Server Migration Documentation](/docs/articles/transfers/migrate-openadmin-to-new-server/).

## How to Transfer an Account

### Using OpenAdmin

1. Navigate to **OpenAdmin > Users**.
2. Click on the user you want to transfer.
3. Under the **Transfer** section, fill in the remote server details:
   
   * **Server**: IP address or domain name of the remote server
   * **Port**: SSH port (usually `22`)
   * **Username**: SSH username for the remote server (usually `root`)
   * **Password**: SSH password for the specified user

   [![2025-07-17-18-32.png](/img/docs-content/BvbcRp2k-2025-07-17-18-32.png)](/img/docs-content/BvbcRp2k-2025-07-17-18-32.png)

5. (Optional) Enable the **Live Transfer** option.
   If checked, the account will be suspended on the current server after migration, and DNS will be forwarded to the new server.

6. Click **Start Transfer**.

Once initiated, the transfer process will begin. A log file will be generated - click on its name to view live progress.

---

### Using Terminal

To transfer an OpenPanel account to another server from the terminal, use the following command:

```bash
opencli user-transfer --account <OPENPANEL_USER> --host <DESTINATION_IP> --username <SSH_USERNAME> --password <DESTINATION_SSH_PASSWORD> [--live-transfer]
```

If the destination server uses a custom SSH port, include the `--port` flag, for example:

```bash
--port 2222
```

To use SSH key authentication instead of a password, simply omit the `--password` flag. Ensure that your SSH key is already configured on the destination server and verify the connection by running:

```bash
ssh root@<DESTINATION_IP>
```

---

// File: articles/user-experience/disable-php-errors-or-increase-upload-limits-per-website

# user.ini

If you have multiple websites in the same domain folder and only want to enable or disable php settings for a certain website, create a file `.user.ini` inside the website folder.

In the file set the desired php values, for example:

set post and upload max file size:

```bash
upload_max_filesize = 200M
post_max_size = 200M
```

display all php errors:

```bash
error_reporting = E_ALL
display_errors = on
```

After editing restart the php service. Navigate to PHP.INI editor and select the php version that your domain is using. Simply click on the save button and the service will be restarted, immediately applying settings from the .user.ini file.

---

// File: articles/user-experience/how-to-setup-email-in-openpanel

# Setup Email

[OpenPanel Enterprise](https://openpanel.com/enterprise/) supports Emails. Once enabled, a shared Email server becomes available for all users.

Follow these steps to enable Emails in OpenPanel:

---

## 1. Activate the Enterprise License

Ensure that you're running the **Enterprise Edition** of OpenPanel. Email support is only available in this version.

[Upgrading to OpenPanel Enterprise and activating License](/docs/articles/license/upgrade_to_openpanel_enterprise_and-activate_license/)

---

## 2. Enable the Email Module

OpenPanel uses a modular system where features can be individually enabled or disabled.

To enable the Email module:

* Go to **OpenAdmin > Settings > Modules**
* Find the **Emails** module and click **Activate**

![Email Module Activation](/img/docs-content/9FvhmLSX-2025-07-09-17-12.png)

---

## 3. Install the Email Service

The Email feature uses the [`docker-mailserver`](https://docker-mailserver.github.io/docker-mailserver/latest/) stack.

To start it:

* Navigate to **OpenAdmin > Emails > Email Accounts**
* Copy the command displayed on the page `opencli email-server install`
* Paste it on Terminal and wait for the process to finish.

[![2025-07-09-17-14.png](/img/docs-content/YCzMd1np-2025-07-09-17-14.png)](/img/docs-content/YCzMd1np-2025-07-09-17-14.png)

---

## 4. Enable the Emails Feature in Hosting Plans

Emails access must be explicitly enabled in the hosting plan's feature set.

To do this:

* Go to **OpenAdmin > Hosting Plans > Feature Manager**
* Select the feature set you want to modify
* Enable the **emails** feature

[![2025-07-09-17-17.png](/img/docs-content/NjfzwmGG-2025-07-09-17-17.png)](/img/docs-content/NjfzwmGG-2025-07-09-17-17.png)

---

## 5. Restart OpenPanel

Restarting OpenPanel ensures that the newly enabled module and feature sets take effect immediately for all users.

To restart:

* Go to **OpenAdmin > Services > Status**
* Click **Restart** next to **OpenPanel**

![Restart OpenPanel](/img/docs-content/pd1PdJ3V-2025-07-09-11-40.png)

---

## Done

Email is now enabled for all hosting plans that include the **emails** feature. Affected users can access Webmail an Email accounts form access it under **OpenPanel > Emails**.

[![2025-07-09-17-19.png](/img/docs-content/44QPNySY-2025-07-09-17-19.png)](/img/docs-content/44QPNySY-2025-07-09-17-19.png)

---

## Troubleshooting

If the mail server fails to start, try launching it manually from the terminal:

```bash
cd /usr/local/mail/openmail && docker compose up mailserver
```

Review the startup logs for any errors, resolve them, and once the service is running correctly, stop it and restart it in detached mode using the `-d` flag.

The most common reasons the mail server fails to start include:

* **Another service already using port 25**—for example, Exim.
  **Solution:** Disable or stop the conflicting service.

* **Firewall or iptables error** that block docker starting.
  **Solution:** Restart the Docker service to reset network rules.

* **Invalid Configuration** for mailserver.
  **Solution:** Revert the default mailserver .env file.

---

// File: articles/user-experience/how-to-setup-ftp-in-openpanel

# Setup FTP

[OpenPanel Enterprise](https://openpanel.com/enterprise/) supports FTP access. Once enabled, a shared FTP server becomes available for all users.

Follow these steps to enable FTP in OpenPanel:

---

## 1. Activate the Enterprise License

Ensure that you're running the **Enterprise Edition** of OpenPanel. FTP support is only available in this version.

[Upgrading to OpenPanel Enterprise and activating License](/docs/articles/license/upgrade_to_openpanel_enterprise_and-activate_license/)

---

## 2. Enable the FTP Module

OpenPanel uses a modular system where features can be individually enabled or disabled.

To enable the FTP module:

* Go to **OpenAdmin > Settings > Modules**
* Find the **FTP** module and click **Activate**

![FTP Module Activation](/img/docs-content/zGBwhJVz-2025-07-09-11-34.png)

---

## 3. Start the FTP Service

The FTP feature uses the `vsftpd` server.

To start it:

* Navigate to **OpenAdmin > Services > FTP Accounts**
* Click **Start FTP Server**

![Start FTP Server](/img/docs-content/pdMTHCNw-2025-07-09-11-35.png)

---

## 4. Enable the FTP Feature in Hosting Plans

FTP access must be explicitly enabled in the hosting plan's feature set.

To do this:

* Go to **OpenAdmin > Hosting Plans > Feature Manager**
* Select the feature set you want to modify
* Enable the **ftp** feature

![Enable FTP Feature](/img/docs-content/mrSbGGy9-2025-07-09-11-38.png)

---

## 5. Restart OpenPanel

Restarting OpenPanel ensures that the newly enabled module and feature sets take effect immediately for all users.

To restart:

* Go to **OpenAdmin > Services > Status**
* Click **Restart** next to **OpenPanel**

![Restart OpenPanel](/img/docs-content/pd1PdJ3V-2025-07-09-11-40.png)

---

## FTP Setup Complete

FTP is now enabled for all hosting plans that include the **ftp** feature. Affected users can access it under **OpenPanel > Files > FTP Accounts**.

[![2025-07-09-11-42.png](/img/docs-content/rsjn8QYQ-2025-07-09-11-42.png)](/img/docs-content/rsjn8QYQ-2025-07-09-11-42.png)

---

## Troubleshooting

If a user sees the following error:

> `FTP service is not yet started, please contact Administrator to enable it.`

It means the FTP service is not running. Revisit **Step 3: Start the FTP Service** to resolve this.

---

// File: articles/user-experience/how-to-setup-tls-ftp-in-openpanel

# Setup TLS for FTP

This guide explains how to enable Explicit FTP over TLS (FTPS) in OpenPanel using VSFTPD.

---

> [OpenPanel Enterprise](https://openpanel.com/enterprise/) supports FTP access. Once enabled, a shared FTP server becomes available for all users.
> First follow this guide on how to enable FTP in OpenPanel: [How to configure FTP server](/docs/articles/user-experience/how-to-setup-ftp-in-openpanel.md)

---

## Step 1: Add a Domain

To use TLS, you must have an SSL certificate available on the server. Start by adding a domain in one of the following ways:

* **As an OpenAdmin user** (for OpenPanel/OpenAdmin access):
  [https://openpanel.com/docs/admin/settings/general/#domain](https://openpanel.com/docs/admin/settings/general/#domain)

* **As an OpenPanel user**:
  [https://openpanel.com/docs/panel/domains/new/](https://openpanel.com/docs/panel/domains/new/)

Once added, OpenPanel will automatically generate an SSL certificate for the domain (if supported).

---

## Step 2: Verify SSL Certificate Files

Make sure the SSL certificate and private key files exist on the server.
If the certificate was auto-generated, the paths should look like this:

```bash
/etc/openpanel/caddy/ssl/acme-v02.api.letsencrypt.org-directory/DOMAIN_NAME/DOMAIN_NAME.crt
/etc/openpanel/caddy/ssl/acme-v02.api.letsencrypt.org-directory/DOMAIN_NAME/DOMAIN_NAME.key
```

Replace `DOMAIN_NAME` with your actual domain name.

---

## Step 3: Enable TLS in VSFTPD

1. Go to **OpenAdmin → Services → FTP → Configuration**
   ![image](/img/docs-content/DZyrjCXF-1.png)
3. Paste the following configuration options to enable TLS:
  
   ⚠️ **Important:** Replace `DOMAIN_NAME` with your domain name in both file paths.
  
   ```bash
   # Enable SSL
   ssl_enable=YES
   rsa_cert_file=/etc/openpanel/caddy/ssl/acme-v02.api.letsencrypt.org-directory/DOMAIN_NAME/DOMAIN_NAME.crt
   rsa_private_key_file=/etc/openpanel/caddy/ssl/acme-v02.api.letsencrypt.org-directory/DOMAIN_NAME/DOMAIN_NAME.key
   
   allow_anon_ssl=NO
   force_local_data_ssl=YES
   force_local_logins_ssl=YES
  
   ssl_tlsv1=NO
   ssl_sslv2=NO
   ssl_sslv3=NO
   ssl_ciphers=HIGH
   ```

3. Click **Save** to apply the changes.
   ![image2](/img/docs-content/52KQ9xYt-2.png)

---

## Step 4: Restart the FTP Service

1. Navigate to **OpenAdmin → Services → Services Status**.
2. Locate the **FTP** service.
3. Click **Stop**, then **Start** to restart the service.

![image2](/img/docs-content/0vTJnjCB-3.png)

---

// File: articles/user-experience/install-older-ioncube-loader-extensions

# How to Install Custom or Older IonCube Loader Versions in OpenPanel

Starting with **OpenPanel version 1.7.2**, IonCube Loader is automatically available for all PHP versions that support it on new installations.

## Older Versions

If you want to downgrade to an older ionCube Loader bundle (or use a custom bundle) you can do so easily.

After placing the files on your server:

* **For a single user:** Edit their `docker-compose.yml` file and update the volume mount points for the **php-fpm-*** services so they reference your custom files.
* **For all new users:** Edit the template file located at `/etc/openpanel/docker/compose/1.0/docker-compose.yml`.

## Check if enabled

To confirm whether IonCube Loader is active for your PHP version, you can use any of the following methods:

From terminal run:

```bash
php -i | grep ioncube
```

Or create a file named **info.php** in your domain’s public directory with the following content:

```php
<?php
phpinfo();
```

Then open it in your browser:
`https://yourdomain.tld/info.php`

Look for **IonCube PHP Loader** in the output to verify that it is enabled.

---

// File: articles/websites/cron-troubleshooting-guide

# OpenPanel Cron Troubleshooting Guide

This is a **generic troubleshooting guide** for OpenPanel cron jobs.

------------------------------------------------------------------------

## **1) How cron works in OpenPanel**

In OpenPanel:

-   Cron **does NOT run directly on the host** like traditional Linux
    crontab.
-   Each **user has their own cron container**.
-   Jobs run **inside a specified container** (e.g. `openlitespeed`,
    `nginx`, `php`, etc.).
-   Cron jobs are defined in **`/home/USERNAME/crons.ini`**, not in
    `/etc/crontab`.

------------------------------------------------------------------------

## **2) First diagnostic step --- run the command manually (is it even cron-related?)**

Before troubleshooting cron, always verify that the command itself
works.

Access the user container terminal:
https://openpanel.com/docs/panel/containers/terminal/#accessing-the-terminal

Inside the container, run your command manually, for example:

``` bash
php -q /var/www/html/example.com/apps/console/console.php example-task
```

### If this fails:

-   The issue is **NOT cron**
-   Fix the error first (missing PHP extensions, wrong path,
    permissions, app config, etc.)

Only continue with cron troubleshooting **after this works manually.**

------------------------------------------------------------------------

## **3) Check if the cron service is running**

Each user must have their own cron service active.

Check in OpenPanel: https://openpanel.com/docs/panel/advanced/services/

You should see a **cron service running for the user**.

### If it is NOT running, start it manually (terminal):

``` bash
cd /home/USERNAME && docker --context=USERNAME compose up -d cron
```


------------------------------------------------------------------------

## **4) Verify the cron file format (`crons.ini`)**

Check the user's cron file:

``` bash
cat /home/USERNAME/crons.ini
```

A correct job looks like this:

``` ini
[job-exec "example-job"]
schedule = @every 1m
container = openlitespeed
command = php -q /var/www/html/example.com/apps/console/console.php example-task
```

### Common mistakes

❌ Using host PHP path:

``` bash
/usr/local/lsws/lsphp84/bin/php
```

✅ Use container PHP instead:

``` bash
php
```

❌ Wrong container:

``` ini
container = web
```

✅ Must match the actual container:

``` ini
container = openlitespeed
```

------------------------------------------------------------------------

## **5) Check cron execution logs (very important)**

OpenPanel provides per-job execution logs.

Cron job logs: https://openpanel.com/docs/panel/advanced/cronjobs/#logs

Look for: - Job started - Job failed - PHP errors - Permission denied -
"Container not found"

------------------------------------------------------------------------

## **6) Verify paths inside the container**

Paths inside Docker may differ from host paths.

Check inside the container:

``` bash
docker --context USERNAME exec -it CONTAINER bash
ls /var/www/html
```

Confirm that:

    /var/www/html/example.com/

actually exists inside the container.

------------------------------------------------------------------------

## **7) Inspect the cron container logs**

If jobs still don't run, inspect the cron container itself:

``` bash
docker --context USERNAME logs cron
```

Look for:
- Scheduler errors
- Container startup issues
- Permission problems

------------------------------------------------------------------------

## **8) Validate correct container selection**

Make sure the job uses the correct container:

  App type              Likely container
  --------------------- ------------------
  OpenLiteSpeed + PHP   `openlitespeed` or `php`
  Nginx + PHP       `nginx` or `php`
  Standalone container     `CONTAINER_NAME`

If you pick the wrong one → job fails.

------------------------------------------------------------------------

## **9) Generic working cron template**

For an app hosted at `example.com`:

``` ini
[job-exec "task-1"]
schedule = @every 1m
container = openlitespeed
command = php -q /var/www/html/example.com/apps/console/console.php task-1

[job-exec "task-2"]
schedule = @every 5m
container = openlitespeed
command = php -q /var/www/html/example.com/apps/console/console.php task-2

[job-exec "task-hourly"]
schedule = @hourly
container = openlitespeed
command = php -q /var/www/html/example.com/apps/console/console.php hourly

[job-exec "task-daily"]
schedule = @daily
container = openlitespeed
command = php -q /var/www/html/example.com/apps/console/console.php daily
```

------------------------------------------------------------------------

## **10) Quick troubleshooting decision tree**

### ❓ "Cron doesn't run at all"

Check: - Is cron service running? → Services page\
- Is there a cron container? → `docker --context USERNAME  ps | grep cron`\
- Does `/home/USERNAME/crons.ini` exist?

### ❓ "Cron runs but command fails"

Check: - Run manually inside container first\
- Check cron logs in OpenPanel\
- Check container logs

### ❓ "Cron runs but the app still complains"

Check: - App logs inside `/var/www/html/example.com/.../logs/`\
- File permissions inside the container

---

// File: articles/websites/google-pagespeed-insights-api-key

# Google PageSpeed Insights API Key

OpenPanel's **Site Manager** automatically checks Google PageSpeed for your websites daily. However, if you’re running this check on a shared hosting server with 100+ websites, Google may block access due to API request limits. If this happens, no PageSpeed data will be shown, and you may see an error like this in the network tab of Site Manager:

```
API Error: Quota exceeded for quota metric ‘Queries’ and limit ‘Queries per day’ of service ‘pagespeedonline.googleapis.com’ for consumer ‘project_number:583797351490’. Aborting due to API error.
```

To prevent this, OpenPanel users can generate a **free Google PageSpeed Insights API key** and configure it for their websites.

---

## Generating a Google PageSpeed Insights API Key

1. Open the [Google Cloud Console](https://console.cloud.google.com/apis/api/pagespeedonline.googleapis.com/) and select your project.
2. Click the **Enable** button.
3. Navigate to **Credentials > Create Credentials > API key**.
4. Wait for the *“Creating API key…”* process to finish, then copy your new API key.

---

## Adding the API Key in OpenPanel

1. Go to **OpenPanel > Site Manager > [Select a website]**.
2. Click on **"Click to add PageSpeed Insights API key"** below the PageSpeed data section.
   ![add api key](/img/panel/v2/add_api_key.png)
3. Paste the API key you copied and click **Save**.
   ![add api key](/img/panel/v2/add_key.png)

> Once saved, the API key will be used for all websites under your account.

---

## Adding a Global API Key in OpenAdmin

Administrators can configure a global API key that will apply to all users who haven’t set their own key.

1. Go to **OpenAdmin > Settings > Custom Code**.
2. Paste your API key in the **PageSpeed API Key** field.
3. Click **Save**.

![admin key](/img/panel/v2/admin_add_key.png)

---

Once configured, the API key ensures PageSpeed data is correctly retrieved for all your websites without hitting Google’s quota limits.

---

// File: articles/websites/hosting-a-php-website-with-openpanel

# Hosting a PHP Website with OpenPanel

This guide walks you through hosting a PHP website on OpenPanel.

---

## Step 1 — Add a Domain

1. Go to **OpenPanel → Domains → Add New Domain**.
2. Enter your new domain name and click **Add Domain**.

![add domain](/img/docs-content/qMTzYC1t-slika.png)

---

## Step 2 — Set PHP version

1. Open **OpenPanel → PHP → Select PHP version**.
2. For your domain click on the version and then click on 'Change'

![change php version](/img/docs-content/Cwy4B9bL-slika.png)

---

## Step 3 — Upload Your Files

1. Open **OpenPanel → File Manager**.
2. Navigate to your domain’s directory.
3. Click **Upload** to select files from your device, or choose **Download from URL** to fetch files from an external source (e.g., GitHub).

![upload files](/img/docs-content/c4xdw7Dc-slika.png)

---

## Step 4 — Test Your Website

1. Visit your domain using `https://` to trigger SSL generation.
2. Your php site should now be live and visible immediately.

---

// File: articles/websites/hosting-a-static-website-with-openpanel

# Hosting a Static Website with OpenPanel

This guide walks you through hosting a static website on OpenPanel.

---

## Step 1 — Add a Domain

1. Go to **OpenPanel → Domains → Add New Domain**.
2. Enter your new domain name and click **Add Domain**.

![add domain](/img/docs-content/qMTzYC1t-slika.png)

---

## Step 2 — Upload Your Files

1. Open **OpenPanel → File Manager**.
2. Navigate to your domain’s directory.
3. Click **Upload** to select files from your device, or choose **Download from URL** to fetch files from an external source (e.g., GitHub).

![upload files](/img/docs-content/c4xdw7Dc-slika.png)

---

## Step 3 — Test Your Website

1. Visit your domain using `https://` to trigger SSL generation.
2. Your static site should now be live and visible immediately.

---

// File: articles/websites/how-to-install-mautic-with-openpanel

# How to Install Mautic® With OpenPanel

[Mautic](https://mautic.org/) provides free and open source marketing automation software available to everyone. Free email marketing and lead management software.

Before installing Mautic, make sure you've added a domain where the Mautic site will be hosted.

To add a domain:
**OpenPanel > Domains > Add New Domain**

![newDomain.png](/img/panel/v2/wpgDomain.png)

## Install Mautic via AutoInstaller

OpenPanel's AutoInstaller lets you install Mautic in just a few clicks.

1. **Open Site Manager** and press the **+New Website"** button.
   ![SiteManager_1.png](/img/panel/v2/wpgSitemanager1.png)
2. Click **Install Mautic**.
   ![SiteManager_2.png](/img/docs-content/z5FwjHGw-2025-08-15-18-01.png)
3. Fill in the **Website Name**, and choose your domain.
   Click **Start Installation** to begin.
   ![SiteManager_3.png](/img/docs-content/MqZ7rZnC-2025-08-15-18-01-1.png)
5. Once the installation is complete, you'll be redirected to the **Sites** page, where you can manage all of your installed websites.
   ![SiteManager_4.png](/img/docs-content/2mDFh7r8-2025-08-15-18-02.png)

---

// File: articles/websites/how-to-install-php-extensions-in-openpanel

# How to install a PHP extension in OpenPanel

OpenPanel uses the [`shinsenter/php`](https://github.com/shinsenter/php) Docker images for PHP services. These images include many commonly used PHP extensions out of the box and provide a simple way to install additional extensions when needed.

## Pre-installed PHP Extensions

Most popular PHP extensions are pre-installed by default, allowing projects to start quickly without extra configuration:

```
apcu
bcmath
calendar
Core
ctype
curl
date
dom
exif
fileinfo
filter
gd
gettext
gmp
hash
iconv
igbinary
intl
json
lexbor
libxml
mbstring
msgpack
mysqli
mysqlnd
openssl
pcntl
pcre
PDO
pdo_mysql
pdo_pgsql
pdo_sqlite
pgsql
Phar
posix
random
readline
redis
Reflection
session
SimpleXML
sodium
SPL
sqlite3
standard
tidy
tokenizer
uri
uuid
xml
xmlreader
xmlwriter
yaml
Zend OPcache
zip
zlib
```

and OpenPanel adds the `Zend OPcache` extension.

----
## Enabling installed PHP Extensions

1. **Connect to the server** via SSH as `root`
2. **Enter the PHP container** for the desired user and version:
```
   docker --context=USERNAME_HERE exec -it php-fpm-8.5 bash
```
 
3. **Enable the extension** using `docker-php-ext-enable`:
```
   docker-php-ext-enable mysqli pdo_mysql
```
 
4. **Exit and restart** the PHP container:
```
   exit
   docker --context=USERNAME_HERE restart php-fpm-8.5
```

## Adding Custom PHP Extensions

The PHP images include a helper command called `phpaddmod` to install PHP extensions: it installs the extension and edits the `php.ini` file to enable it.


### Install a PHP Extension for a Single User

To install a PHP extension for a single user, open a terminal for the desired PHP version.

### Example assumptions

* **Username**: `stefan`
* **PHP version**: `8.5`
* **Service name**: `php-fpm-8.5`

Adjust these values to match your environment.

---

### Option 1: OpenPanel Terminal (Enterprise Edition)

If the **Docker** module is enabled:

1. Go to **Containers → Terminal** in OpenPanel
2. Select the desired PHP version
3. Run the following commands

Example: installing the **GMP** extension:

```
apt update
apt install -y libgmp-dev
phpaddmod gmp
```

---

### Option 2: OpenAdmin Terminal

1. Go to **Users → (select user) → Services**
2. Open the terminal for the desired PHP version
3. Run the following commands

Example: installing the **GMP** extension:

```
apt update
apt install -y libgmp-dev
phpaddmod gmp
```

---

### Option 3: SSH Access (root)

1. Connect to the server via SSH as `root`
2. Enter the PHP container for the desired user and version:

```
docker --context=USERNAME_HERE exec -it php-fpm-8.5 bash
```

3. Install the extension

Example: installing the **GMP** extension:

```
apt update
apt install -y libgmp-dev
phpaddmod gmp
```

---

### Verify Installation

You can verify that the extension is installed by running:

```
php -m
```

Or by checking your application or website.

---

## Install PHP Extensions for All New Users

To have a PHP extension automatically available for **all newly created users**, you have two options:

1. **Modify the startup command** in the `docker-compose.yml` template to install the extension on container startup

   * This increases PHP container startup time

2. **Use a custom PHP Docker image** with the required extensions pre-installed

   * Recommended for production environments

> These approaches are intended for advanced users. If you need help, please contact the OpenPanel community forum or Discord channel.

---

## Install PHP Extensions for All Existing Users

To install a PHP extension for **all existing users**, you can:

* Run a custom Bash script that installs the extension for each user and PHP version
* Switch all users to a custom PHP Docker image that already includes the extension

Both approaches require advanced knowledge of Docker and OpenPanel internals.

---

// File: articles/websites/how-to-install-wordpress-with-openpanel

# How to Install WordPress® With OpenPanel

[WordPress](https://wordpress.org/)® is a powerful, web-based content management system (CMS) that makes it easy to build websites and blogs. This guide walks you through two methods for installing WordPress on your OpenPanel account: **automatic installation via WP Manager** and **manual installation**.

Before installing WordPress, make sure you've added a domain where the WordPress site will be hosted.

To add a domain:
**OpenPanel > Domains > Add New Domain**

![newDomain.png](/img/panel/v2/wpgDomain.png)

## Install WordPress via WP Manager

OpenPanel's Site Manager lets you install WordPress in just a few clicks.

1. **Open Site Manager** and press the **+New Website"** button.
   ![SiteManager_1.png](/img/panel/v2/wpgSitemanager1.png)
2. Click **Install WordPress**.
   ![SiteManager_2.png](/img/panel/v2/wpgSitemanager2.png)
3. Fill in the **Website Name**, optionally add a **Site Description**, and choose your domain.
   Click **Start Installation** to begin.
   ![SiteManager_3.png](/img/panel/v2/wpgSitemanager3.png)
5. Once the installation is complete, you'll be redirected to the **WP Manager**, where you can manage all of your installed WordPress sites.
   ![SiteManager_4.png](/img/panel/v2/wpgSitemanager4.png)

## Install WordPress manually

The easiest way to download the official WordPress installation archive is through OpenPanel's File Manager tool.

First access the folder of your domain where you'll install a new WordPress instance.

![Manually_1.png](/img/panel/v2/wpgManual1.png)

When you're inside the domains directory press the Upload button on the top right.

![Manually_2.png](/img/panel/v2/wpgManual2.png)

On the Upload page press the "Download from URL Instead" button.

![Manually_3.png](/img/panel/v2/wpgManual3.png)

Paste the link https://wordpress.org/latest.zip to the URL field and press the "Download" button.

![Manually_4.png](/img/panel/v2/wpgManual4.png)

![Manually_5.png](/img/panel/v2/wpgManual5.png)

When the download finishes return to File Manager and extract the archive.

![Manually_6.png](/img/panel/v2/wpgManual6.png)

Access the "wordpress" folder, select All files using the "Select All" button and move them into your new domain's directory using the "Move" button.

![Manually_7.png](/img/panel/v2/wpgManual7.png)

![Manually_8.png](/img/panel/v2/wpgManual8.png)

![Manually_9.png](/img/panel/v2/wpgManual9.png)

![Manually_10.png](/img/panel/v2/wpgManual10.png)

Create a new database and database user with the Database Wizard tool, more info in our Database Wizard guide -> https://openpanel.com/docs/panel/mysql/wizard/ .

![Manually_11.png](/img/panel/v2/wpgManual11.png)

Start editing the wp-config-sample.php file by selecting it and pressing the "Edit" button.

![Manually_12.png](/img/panel/v2/wpgManual12.png)

Swap the values of DB_NAME, DB_USER and DB_PASSWORD with values you've set inside the Database Wizard, set the value of DB_HOST to 'mysql' and save the changes on the top right.

![Manually_config.png](/img/panel/v2/wpgManualFinal.png)

Finally, rename the wp-config-sample.php file to wp-config.php using the Rename button within the File Manager.

![Manually_configR.png](/img/panel/v2/wpgManualRename.png)

![Manually_configR2.png](/img/panel/v2/wpgManualRename2.png)

Your new WordPress instance is now created!

Finish the installation by accessing your domain via browser and completing the WordPress web installation wizard.

---

// File: articles/websites/how-to-set-or-increase-PHP-INI-memory-limit-or-other-values

# How to set or increase PHP INI memory_limit or other values?

There are multiple ways to manage PHP settings in OpenPanel. This guide walks you through the available methods and when to use each one.

## For OpenPanel users

Depending on which modules are enabled, users can manage PHP settings using one or more of the following interfaces:

- **PHP.INI Editor** – Available when the `php_ini` module is enabled. Provides full access to edit the php.ini file.
- **PHP Options** – Available with the `php_options` module. Lets users edit only pre-configured options from the ini file.

### Default PHP Version

The default PHP version used for new domains can be configured via:

**OpenPanel > PHP > Default version**

1. Select your desired PHP version.
2. Click 'Change' to apply.

![change default](/img/panel/v2/openpanel_cahnge_default_php_version.gif)

---

### PHP Options

This interface allows you to modify commonly used PHP settings—limited to those pre-configured by an Administrator.

[PHP Options Documentation](/docs/panel/php/options)

![php options page](/img/panel/v2/php_options.png)

---

### PHP.INI Editor

For full control, the **PHP.INI Editor** lets users directly modify the php.ini file for their selected PHP version.

[PHP.INI Editor Documentation](/docs/panel/php/php_ini_editor)

![openpanel_php_ini_editor](/img/panel/v2/openpanel_php_ini_editor.gif)

---

## For OpenAdmin users

Administrators can configure system-wide PHP defaults and manage what settings users can change.

### Default PHP version

Set the default PHP version for new users via:
[**OpenAdmin > Settings > User Defaults**](/docs/admin/settings/defaults/)

1. Choose the default PHP version.
2. Click 'Save' to confirm.

![default.png](/img/docs-content/cJNjVQPM-default.png)

---

### PHP Options

Users can only modify options that have been explicitly allowed by the administrator. These keys are pre-defined and applied from the system `.ini` files.

Administrators can manage these options in two ways:

From the panel:
[**OpenAdmin > Settings > PHP Settings**](/docs/admin/settings/php/) page.

![options.png](/img/docs-content/1zcTP8Qx-options.png)

Or via terminal:
- **Global default (all users)**: `/etc/openpanel/php/options.txt`
- **User-specific settings**: `/home/USERNAME/php.ini/options.txt`

---

### PHP.INI Editor

Administrators can configure the default php.ini files for all PHP versions.

From the panel:
[**OpenAdmin > Settings > PHP Settings**](/docs/admin/settings/php/) page.

![phpini.png](/img/docs-content/dVCpHWNV-phpini.png)

Or via terminal:
- **Global default (all users)**: `/etc/openpanel/php/ini/`
- **User-specific settings**: `/home/USERNAME/php.ini/`

---

// File: articles/websites/how-to-upload-wordpress-website-to-openpanel

# How to Migrate a WordPress® Installation to OpenPanel

This guide will walk you through the process of uploading your WordPress website to **OpenPanel**, including domain setup, database configuration, file uploads, and final testing.

If you’re starting fresh with a new site, follow: [How to Install WordPress® With OpenPanel](/docs/articles/websites/how-to-install-wordpress-with-openpanel/)

---

## 1. Domain

### 1.1 Add a Domain Name

1. Log in to your **OpenPanel** dashboard.
2. Navigate to **Domains** → **Add Domain**.
3. Enter your domain name (e.g., `example.com`).
4. Save.

![add domain](/img/docs-content/mkDT1Mhh-add-domain.png)

Make sure to point your domain’s DNS records (A record) to your OpenPanel server IP.

---

## 2. Database

### 2.1 Create Database and User

1. Go to **MySQL** → **Database Wizard**.
2. Set **Database Name**, **Database User** and set a strong password.
3. Click on the **Create DB, User and Grant Privileges** button.

![mysql db wizard](/img/docs-content/rm4Pnwbg-db-wizard.png)

### 2.2 Import SQL File to Database

There are two ways to upload a database:

- Using 'Import Database' option if available.
- Using phpMyAdmin interface.

**Import SQL file using Import Database**:

1. Go to **MySQL** → **Import Database**.
2. Select **Database** and choose file from your device.
3. Click on **Upload & Import**.

![import sql file](/img/docs-content/Vfwnd6sR-db-import.png)


**2.3 Import SQL file using phpMyAdmin**:

For uploading SQL files using phpMyAdmin interface, please follow this guide: [How to Import SQL Files](/docs/panel/mysql/phpmyadmin/#import-sql-files)

---

## 3. Files

### 3.1 Upload Files via File Manager

Before uploading, ensure your backup is archived (`.zip`, `.tar` or `.tar.gz`). If it isn’t, compress the files into one archive first.

1. Open **File Manager** in OpenPanel.
2. Navigate to your domain’s root directory (e.g., `/var/www/html/pejcic.rs/`).
3. Click the **Upload** button.
4. Select and upload your backup archive.
5. Once uploaded, go back to **File Manager**, select the archive, and click **Extract** → confirm extraction.
6. After extraction is complete, delete the uploaded archive by selecting it, clicking **Delete**, and confirming.

---

### 3.2 Change wp-config.php File

1. In File Manager, locate the **`wp-config.php`** file.
   ![edit wp config file](/img/docs-content/mkLgNk21-edit-wp-config.png)
2. Edit the database settings:

   ```php
   define('DB_NAME', 'your_database_name');
   define('DB_USER', 'your_database_user');
   define('DB_PASSWORD', 'your_database_password');
   define('DB_HOST', 'mysql'); // mariadb or mysql - depending on your current setting
   ```
   ![example wp config ph](/img/docs-content/3NtJLhdS-edit-wp-config-file.png)
3. Save changes.

---

## 4. Test

### 4.1 Test via Domain Name

1. Visit your domain (e.g., `https://example.com`).
2. If the DNS has propagated, your WordPress website should load.

### 4.2 Test via Live Preview

1. If DNS is not yet pointed, use OpenPanel’s **Live Preview** feature.
2. Go to WordPress Manager in OpenPanel → click **Scan for Existing Installation** and wait for process to complete.
3. Refresh the page and click on your website.
4. Click on the **Live Preview** button to check your website.

![wp scan](/img/docs-content/npmRW3S9-scan-wp.png)

---

// File: articles/websites/php-user-ini-files

# PHP settings per website (folder)

Using `.user.ini` files, you can set different PHP limits for each website or folder.

## Creating a `.user.ini` file

For example, to set custom PHP limits only for a specific website, such as `example.net`:

1. Open **OpenPanel > File Manager** and navigate to the domain's document root (the main folder for that site).
2. Click **New File**, enter `.user.ini` as the name, check **Open in File Editor after creation**, and then click **Create**.
3. In the editor, add the PHP configuration options you want to change. For example:

   ```
   upload_max_filesize = 64M
   post_max_size = 64M
   max_execution_time = 120
   ```
4. Save the file and exit the editor.

Finally, open your website and confirm the changes:

* For any PHP site, you can check via `phpinfo()`.
* For WordPress, go to **Tools > Site Health** and verify the new limits are applied.

---

> **NOTE**: Since the `.user.ini` is read from public directories, it's contents will be served to anyone requesting it and potentially show them sensitive configuration settings. Block access to it using .htaccess file in Apache, or via Vhost Editor for Nginx/OpenResty.

---

// File: articles/websites/purge-varnish-cache-from-terminal

# Purging Varnish Cache

If Varnish is enabled for a website, cache can be purged from the terminal or directly through OpenPanel.

## Purge from Terminal

You can purge cache entries manually using the `curl` command.

### Purge a Specific URL

This removes a single cached object (for a specific page, image, or file):
```bash
curl -X PURGE -H "Host: example.com" http://example.com/wp-content/uploads/test.jpg
```

### Purge a Specific Website

This removes **all cached objects** for one website (domain):
```
curl -X PURGE -H "Host: example.com" -H "X-Purge-Method: regex" http://example.com/.*
```

### Purge All Websites

To remove all cached objects across all domains handled by Varnish:
```
curl -X BAN http://localhost/.* 
```

:::info 
Alternatively, you can simply restart the Varnish service (see below).
:::

## Purge from Crons

To purge cache from a cronjob, simply use the above `curl` commands and make sure to use varnish/webserver or php for container when creating Crons on OpenPanel.

## Purge from WordPress

To purge a cache for a WordPress website, use the [CLP Varnish Cache plugin](https://wordpress.org/plugins/clp-varnish-cache/)

To configure the plugin:
1. Login to wp-admin and go to **Settings → CLP Varnish Cache**.
2. Set **varnish** as 'Varnish Server'then **Enable** again.

To purge cache using the plugin:
1. Login to wp-admin and go to **Settings → CLP Varnish Cache**.
2. Click on **Purge Entire Cache** button.

## Purge from Terminal

You can purge cache entries manually using the `curl` command.

---

### Notes

* The `Host` header is required because Varnish stores cache separately for each domain name.
* The `X-Purge-Method: regex` header allows purging multiple URLs using pattern matching.
* Purge requests must come from localhost (the website itself or php/webserver containers).

---

// File: articles/websites/sharing-htaccess-rules

# Sharing .htaccess rules

Shared .htaccess Across Multiple Domains/Subdomains

---

An .htaccess file may be shared across multiple domains or subdomains by being located in a common parent directory. Locating an .htaccess under `/var/www/html` will allow any domain or subdomain located under `/var/www/html/` to inherit these rules.

Example Directory Structure:
```
example.com        -> /var/www/html/example.com/
blog.example.com   -> /var/www/html/example.com/blog/
another-site.com   -> /var/www/html/another-site.com/
```

To apply a common `.htaccess` to all three, place the file in:

```
/var/www/html/.htaccess
```

This way, all domains and subdomains under that path will follow the shared rules automatically.

---

// File: articles/websites/wordpress-plugins-themes-sets-in-openpanel

# WordPress Themes and Plugins Sets

As an OpenPanel user, you can create **Theme Sets** and **Plugin Sets** for your account. Plugins and themes from these sets will automatically be installed on every new WordPress site you create using OpenPanel's WP Manager. This is especially handy if you frequently use the same plugins and themes across multiple sites, such as the Elementor theme with a child theme, Elementor plugin, and so on.

:::info
The 'filemanager' and 'wordpress' features need to be enabled for your account in order to use sets.
:::
---

## Themes Set

To create a Theme Set:

1. Go to **OpenPanel > WP Manager** and click on **Themes**.
2. A new page will open with a file editor, allowing you to configure the themes you want installed automatically.

**Instructions:**

* Add **one theme per line**.
* To install free themes from WordPress.org, simply use the theme slug:
  ![theme slug](/img/docs-content/JnRzksmy-theme-slug.png)

  ```
  startup-business-elementor
  ```
* To install premium or third-party themes, provide the direct download URL:

  ```
  http://s3.amazonaws.com/bucketname/my-theme.zip?AWSAccessKeyId=123&Expires=456&Signature=abcdef
  ```
* Lines starting with `#` are treated as comments and ignored.

**Example Theme Set file:**

```bash
# Free themes from wordpress.org
hello-elementor
startup-business-elementor

# Premium theme from a remote URL
http://s3.amazonaws.com/bucketname/my-theme.zip?AWSAccessKeyId=123&Expires=456&Signature=abcdef
```

You can add as many themes as you like. Once done, **click the 'Save' button**.

---

## Plugins Set

To create a Plugin Set:

1. Go to **OpenPanel > WP Manager** and click on **Plugins**.
2. A new page will open with a file editor, allowing you to configure the plugins you want installed automatically.

**Instructions:**

* Add **one plugin per line**.
* To install free plugins from WordPress.org, use the plugin slug:
  ![plugin slug](/img/docs-content/9fdf0d3G-plugin-slug.png)

  ```
  enable-wp-debug-toggle
  ```
* To install premium or third-party plugins, provide the direct download URL:

  ```
  https://github.com/envato/wp-envato-market/archive/master.zip
  ```
* Lines starting with `#` are treated as comments and ignored.

**Example Plugin Set file:**

```bash
# Free plugins from wordpress.org
akismet
bbpress
enable-wp-debug-toggle

# Premium plugin from GitHub
https://github.com/envato/wp-envato-market/archive/master.zip

# Plugin from S3 with access key
http://s3.amazonaws.com/bucketname/my-plugin.zip?AWSAccessKeyId=123&Expires=456&Signature=abcdef
```

You can add as many plugins as you like. Once done, **click the 'Save' button**.

---

// File: changelog/1.0.0

Released on February 07, 2025

### 🚀 Breaking changes
- **Custom Document Roots**: Users can now set custom document root when adding new domains.
- **Redesigned UI**: The user interface now uses Tailwind CSS and Alpine.js instead of Bootstrap, resulting in more static pages and fewer JavaScript-related bugs.  
- **Automatic SSL**: SSL certificates are now generated automatically when HTTPS is requested for a domain. There's no need to manually generate and reload configurations.  
- **Rootless Docker**: Each superuser runs their own isolated Docker container, preventing cross-container access via local Docker networks.  
- **Support for Java and Ruby**: The autoinstaller now supports setting up Ruby and Java applications.  
- **Domain Suspension**: Users can now suspend website access as needed.  
- **Coraza WAF**: ModSecurity has been replaced with the more modern Coraza Web Application Firewall (WAF).  
- **Caddy Web Server**: Nginx has been replaced with Caddy as the default web server.  
- **Docker Contexts**: Each user gets their own Docker context, allowing multi-server user management.  
- **Python 3.12 for User Panel**: The control panel is now built on Python 3.12, and the Docker image tag will reflect the panel version.  
- **LiteSpeed Support**: LiteSpeed is now supported - looking for maintainers!
- **No Storage Files**: User quotas can now be increased or decreased dynamically, eliminating the need to create and mount storage files.  
- **Install and Update from GitHub**: OpenPanel installation and updates are now hosted and downloaded directly from GitHub.

### 🐛 Bug fixes
- a lot

### 💅 Polish
- `domain_name` column is removed from the domains table.
- `--hostname` install flag is renamed to `--domain`.
- `storage_file` is removed from plans, disk_limit is the total size for all user files including their containers.
- Deprecated and removed OpenCLI commands: `server-on_startup`, `files-remount`, `recreate_hosts`, `user-disk`, `server-stats`.
- All SSL-related opencli commands are removed: `ssl-domain`, `ssl-user`, `ssl-hostname`, `ssl-webmail`, `ssl-cleanup` 
- `/json/show_usage_stats` route is removed.
- `/api/usage` and `/api/usage/stats` api endpoints are removed.
- `max_disk` option is removed from `opencli docker-limits` and  `--apply SIZE` is deprecated.
- `/var/lib/docker.img` is no longer created on installation and mounted on `/var/lib/docker`.
- Setting disk limits for [rootful containers](https://github.com/stefanpejcic/openpanel-configuration/blob/main/docker/compose/newer-docker-compose.yml) is no longer supported.
- 'OpenAdmin > Services > Resource Settings' page is removed.
- redis is now used to store user temporary sessions and data for [Flask-limiter](https://flask-limiter.readthedocs.io/en/stable/)
- `opencli domains-add` command now support setting document root.

---

// File: changelog/1.1.0

Released on March 03, 2025

### 🚀 Breaking changes
- usage of [docker containers per service](https://github.com/stefanpejcic/openpanel-configuration/blob/75aee2e5df9fcc3d1838343ef1161e86c97db93d/docker/compose/1.0/docker-compose.yml)
- removal of official openpanel docker images
- usage of [docker volumes for storing data](https://github.com/stefanpejcic/openpanel-configuration/blob/75aee2e5df9fcc3d1838343ef1161e86c97db93d/docker/compose/1.0/docker-compose.yml#L629)
- user plans no longer determine web server (nginx/apache) - instead it is globally configurable in: [/etc/openpanel/docker/compose/1.0/.env](https://github.com/stefanpejcic/openpanel-configuration/blob/75aee2e5df9fcc3d1838343ef1161e86c97db93d/docker/compose/1.0/.env#L10)
- user plans no longer determine usage of mysql type (mysql/mariadb) - instead it is globally configurable in: [/etc/openpanel/docker/compose/1.0/.env](https://github.com/stefanpejcic/openpanel-configuration/blob/75aee2e5df9fcc3d1838343ef1161e86c97db93d/docker/compose/1.0/.env#L10)
- 

### 💅 Polish
- disk and inodes quota can now be set to 0 for unlimited
- **docker** feature is added, allowing users to manage resource usage per containers, change versions, switch mysql type or webserver.

---

// File: changelog/1.1.1

Released on March 07, 2025

### 🐛 Bug Fixes
- Fixed an issue in the Nginx vhost file template with the `/pgadmin4` route.
- Resolved a bug with the `busybox` container that prevented the file manager from editing files.
- Fixed permission errors when starting the MySQL container.
- [OpenPanel UI (werkzeug error): Header values must not contain newline characters #333](https://github.com/stefanpejcic/OpenPanel/issues/333)
- [Problems adding websites on clean install server #335](https://github.com/stefanpejcic/OpenPanel/issues/335)
- [OpenAdmin > Users - limit disk usage and inode % to 2 decimals #334](https://github.com/stefanpejcic/OpenPanel/issues/334)
- Fixed warning *nginx: [warn] the "listen ... http2" directive is deprecated, use the "http2" directive instead” directive is deprecated*.
- Fixed a bug with the MySQL Configuration editor.
- [WordPress asking for FTP credentials #343](https://github.com/stefanpejcic/OpenPanel/issues/343)
- [WordPress unable to connect to redis instance #344](https://github.com/stefanpejcic/OpenPanel/issues/344)


### 💅 Polish
- PHP 8.4 is now the default version for new users.
- [nginxinc/nginx-unprivileged](https://hub.docker.com/r/nginxinc/nginx-unprivileged) is now used as image for Nginx.
- Minecraft has been added to the Docker Compose template for users.
- [Option to skip DNS server during installation #340](https://github.com/stefanpejcic/OpenPanel/issues/340)
- Removed the `--skip-ssl` flag from the installation script.
- All `/databases` URLs have been renamed to `/mysql`.
- A `?output=json` parameter can now be added to the following URLs to return plain JSON data instead of the GUI: `/php/options`, `/mysql/processlist`, `/mysql/configuration`, `/mysql/users`, `/mysql/remote-mysql`, `/mysql/processlist`.
- updated apexcharts on OpenAdmin > Dashboard page.

### 💡 New!

#### phpMyAdmin

A new page, `/databases/phpmyadmin`, has been added:

![phpmyadmin](/img/docs-content/8TqVvXrJ-2025-03-05-17-19.png)

#### DB Size Unit

Users now have the option to select the unit of measurement for displaying database size.

![db size units](/img/docs-content/rpjgMGZk-2025-03-05-19-47.png)

#### PHP Limits

The `/php/limits` page now enables users to adjust limits for all PHP versions simultaneously. The values set here will override any php.ini configurations and trigger a restart of the php-fpm container.

![edit php limits](/img/docs-content/qvwpnR1G-2025-03-05-21-11.png)

---

// File: changelog/1.1.2

Released on March 09, 2025

Note: This release was expedited to address critical bug fixes related to password resets, user creation, and two-factor authentication (2FA).

### 🐛 Bug Fixes
- warning *quotacheck: Your kernel probably supports ext4 quota feature but you are using external quota files. Please switch your filesystem to use ext4 quota feature as external quota files on ext4 are deprecated.* is no longer displayed when creating users.
- warning *WARNING: Insufficient disk space on the server.* is no longer displayed when creating users.
- warning */bin/bash: line 41: warning: here-document at line 21 delimited by end-of-file (wanted `EOF')* is no longer displayed when creating users.
- message *Connection to the local host terminated.*  is no longer displayed when creating users.
- fixed bug with `opencli user-resources` script causing cpu/ram limits not to save on OpenPanel UI > Containers page.
- fixed a bug where the 2FA `otp_secret` code was not being saved in the database, preventing users with 2FA enabled from logging in.

### 💅 Polish
- Adding domains is now quicker as containers are started in the background.
- User creation is faster thanks to the reuse of the docker-compose plugin and the docker-rootless-setup.sh script, eliminating the need to download them each time. This not only saves time but also approximately 70MB of disk space per user.
- caching is added to all openpanel UI routes.
- `services` module is renamed to `info`
- `/server/services` page is deprecated and remove from sidebar and dashboard pages.
- `user_service` (ubuntu container) is no longer started when user is created.
- New command: [opencli dev](https://dev.openpanel.com/cli/dev.html)
- New command: [opencli docker](https://dev.openpanel.com/cli/docker.html)
- Time in the OpenPanel UI container will now reflect timezone setting from OpenAdmin (system OS time).

### 💡 New!

#### Users Usage
The *OpenAdmin > Users* page now displays allocated limits for the user and actual current usage:

![new users limits](/img/docs-content/HjGXJc5Y-2025-03-07-17-45.png)


#### lazydocker
Remote SSH access for users is now limited to lazydocker only:
![ssh lazydocker](/img/docs-content/CwTzmtSV-2025-03-07-22-26.png)

---

// File: changelog/1.1.3

# 1.1.3

Released on March 14, 2025

### 🐛 Bug Fixes
- [Multiple problems with user panel #346](https://github.com/stefanpejcic/OpenPanel/issues/346)
- [Incorrect path on /domains for file manager #352](https://github.com/stefanpejcic/OpenPanel/issues/352)
- fixed bug with detecting version from mariadb.
- fixed bug with saving php version using opencli php-domain command.
- fixed bug with missing mysqli extension in php docker images.
- fixed bug with missing php.ini files.
- fixed bug with */json/page_speed/<path:domain>* page to refresh PageSpeed data from SiteManager.
- fixed bug with fetching DB size from WP-CLI.
- fixed bug detecting php version on WP Autoinstaller.
- fixed bug with setting php limits on */php/limits* page.
- fixed bug with *opencli error* command not returning any logs.
- fixed error saving values on */mysql/configuration*.
- fixed error saving Nginx/Apache configuration on */server/webserver_conf*.
- fixed css bug displaying avatar type on 'Nginx Configuration Editor' page.
-  


### 💅 Polish
- Resellers are now restricted in OpenAdmin only to Users and Plans.
- Updated [localization files](https://github.com/stefanpejcic/openpanel-translations/blob/main/en-us/messages.pot).

---

// File: changelog/1.1.4

Released on March 18, 2025

### 💅 Polish
- redesigned OpenAdmin interface.
- redis service is now listening on both TCP:*redis:6379* and socket:*/var/run/redis/redis.sock*.
- memcached service is now listening on both TCP:*memcached:11211* and socket:*/var/run/memcached/memcached.sock*.

### 🐛 Bug Fixes
- fixed bug with css overflow for table rows on */activity* page.
- [MariaDB: WP Installer stuck at Checking if MySQL service is running.. #358](https://github.com/stefanpejcic/OpenPanel/issues/358)
- fixe bug detecting php version on /php/domains page.
-

---

// File: changelog/1.1.5

Released on March 21, 2025

### 💅 Enhancements  
- The `healthcheck` MariaDB user is now excluded from *OpenPanel > MySQL > Users*.  
- Added a dark mode switch for users in OpenAdmin.
- [`opencli domains-ssl` command](https://dev.openpanel.com/cli/domains.html#SSL)

### 🐛 Bug Fixes  
- Fixed [WP installer stuck on 'Copying files to' #360](https://github.com/stefanpejcic/OpenPanel/issues/360)
- Resolved several CSS issues in OpenAdmin's light mode.  
- Fixed a search bug in *OpenAdmin > Emails > Accounts*.  
- Addressed an issue in *OpenPanel > Containers* when no containers are running.  
- Fixed [500 error on /mysql/configuration when MySQL is not running #348](https://github.com/stefanpejcic/OpenPanel/issues/348)  
- Resolved a port detection bug that caused consecutive user creations to receive the same port assignments.
- Fixed bug with read-only folder for php sockets, causing php services to restart.
- [Can't Save Global Settings #309](https://github.com/stefanpejcic/OpenPanel/issues/309)
- Fixed warning */bin/bash: line 33: warning: here-document at line 14 delimited by end-of-file (wanted EOF')* on user create.
- fixed typo in caddy vhost template causing Varnish to not connect to user webserver when https is used.
- fixed 500 error on OpenPanel > Dashboard when plan email limit is 0.

---

// File: changelog/1.1.6

Released on March 25, 2025

### 💅 Polish
- *OpenPanel UI > File Manager* is rewritten to no longer use busybox docker container.
- if ns3 and ns4 are set, on domain creation they will be replaced in template file.
- added search on *OpenAdmin > Domains*.
- added CorazaWAF status for domains on *OpenAdmin > Domains*.
- removed 250k minimum for inodes limit on *plan-edit* command, allowing users to set unlimited inodes if set to 0.
- Renaming Administrator or Reseller user will now also replace the username in all related log files.
- Added options to rename and change password for Admin users on *OpenAdmin > Administrators* page.
- Added options to rename and change password for Reseller users on *OpenAdmin > Resellers* page.
- removed install blocker for arm cpu from teh installation script.
- changed default collocation mysql database tables.
- added alternative mariadb docker image when arm cpu is detected.


### 🐛 Bug Fixes
- [Inconsistent memory unit for docker stats #362](https://github.com/stefanpejcic/OpenPanel/issues/362)
- fixed 500 error on OpenAdmin > Users when user has no running container and 0% causes division error.
- [PHP handler not working on Apache webserver #363](https://github.com/stefanpejcic/OpenPanel/issues/363)
- fixed bug editing file via file manager on apache.
- [WP installer stuck on 'Copying files to' #360](https://github.com/stefanpejcic/OpenPanel/issues/360)
- [OpenAdmin > Packages > Edit adds extra ' GB' for du, breaking inodes on user creation #356](https://github.com/stefanpejcic/OpenPanel/issues/356)
- edit and delete dropdown button on OpenAdmin > Plans are now full-width.
- [Can not set TimeZone #365](https://github.com/stefanpejcic/OpenPanel/issues/365)
- fixed bug with changing Bandwidth (port speed) on *OpenAdmin > Plans > Edit* page.
- fixed css bug on OpenAdmin sidebar for Community edition causing empty space for Backups item.
- [OpenPanel settings Default PHP version #375](https://github.com/stefanpejcic/OpenPanel/issues/375)
- [Can not activate phpMyAdmin #369](https://github.com/stefanpejcic/OpenPanel/issues/369)

---

// File: changelog/1.1.7

Released on March 27, 2025

### 💅 Polish
- config cache is now invalidated after changing update preferences on *OpenAdmin > Settings > Updates* page.
- changed font on *OpenPanel > Dashboard* icons.
- added `mod_rewrite` by default in httpd.conf template for Apache.
- added tooltips on *OpenAdmin > Users* table for CPU, Memory, Disk and Inodes usage.
- added timestamp when docker stats was last updated for user on *OpenAdmin > Users > single user* page.
- added Overview section on *OpenAdmin > Users > single user* page.
- added 'User Activity' and 'System Information' widgets to *OpenAdmin > Dashboard*.
- limited number of lines for flash messages after password change on *OpenAdmin > Resellers* page.
- *PM2* module is now disabled by default for new installations.
- added *backup* services for users, allowing them to backup volume data to: WebDAV, SSH/SFTP, Azure Blob, Dropbox or S3 compatible storage.

### 🐛 Bug Fixes
- fixed bug on *OpenPanel > FileManager* with option: *Open in File Editor after creation*.
- fixed css issue selecting *Up one folder* row on *OpenPanel > FileManager* table.
- fixed error *NameError: name 'webserver' is not defined* on */system/hosting/plan* page.
- fixed bug detecting php version from apache conf on WordPress autoinstall: *Starting PHP container: php-fpm-/:*.
- fixed bug *Starting PHP container: php-fpm-8.2* on WordPress autoinstall on Nginx due to WPCLI command not yet installed in container.
- fixed error on WordPress uninstall when wp-config.php is missing.
- fixed bug displaying folders on *Disk Usage* and *Inodes Explorer* pages.
- fixed bug with search on *OpenAdmin > Notifications* page.
- fixed error on *OpenAdmin > Users* with stats for suspended users.
- fixed bug restarting admin service on installation when license key is added.
- fixed error restarting OpenAdmin service from *OpenAdmin > License* page.
- fixed bug with *OpenAdmin > Plans > Edit* appending extra *g* at the end of Memory limit value.
- fixed bug with the search on *OpenAdmin > Domains* page.
- [Error 500 after login #383](https://github.com/stefanpejcic/OpenPanel/issues/383)

---

// File: changelog/1.1.8

Released on April 01, 2025

### 💅 Polish
- If docker feature is enabled, *OpenPanel > Dashboard > Statistics widget* will display number of running containers, PIDs, Block I/O and Network I/0.
- update logs are moved from */usr/local/admin* to */var/log/openpanel/updates*.
- successfull update will now remove previous notifications that update is available and/or started.
- added update logs to *OpenAdmin > Services > Logs Viewer*.
- added log files to *OpenAdmin > Settings > Update Preferences*.
- updated php detection method to read version from database on WordPress AutoInstaller and Auto-login.
- php-fpm containers now run processes with same ID as the docker context.

### 🐛 Bug Fixes
- fixed bug with update logs generated by `opencli update` command.
- fixed css bug with the *Latest News* widget on *OpenAdmin > Dashboard*.
- [e-mail account delete modal not redirecting #384](https://github.com/stefanpejcic/OpenPanel/issues/384)
- fixed bug with `/webmail` redirect on *OpenPanel > Emails* appending `:8080` when domain is set.
- fixed bug with *OpenAdmin > Emails > Settings* using removed `ssl-webmail` command to set webmail domain.
- [opencli domains-add does not check system domains #349](https://github.com/stefanpejcic/OpenPanel/issues/349)
- [Invalid SOA in DNS zone template #350](https://github.com/stefanpejcic/OpenPanel/issues/350)
- fixed bug with submit button on *OpenAdmin > Advanced > Change Root Password* page.
- fixed bug with `opencli license` command displaying `Error response from daemon: No such container: openpanel` message.
- fixed bug with mariadb service using `mysqladmin` instead of `mariadb-admin` command for health check.
- [Error: Command 'user/ip' not found - file '/usr/local/opencli/user/ip.sh' does not exist. #386](https://github.com/stefanpejcic/OpenPanel/issues/386)
-  fixed bug with script for changing user plan.
-  fixed bug with apache container not listening to https port.

---

// File: changelog/1.1.9

Released on April 05, 2025

### 💅 Polish
- added php-fpm auto-tuning on startup to all php containers.
- added [varnish](#varnish) module.
- added [my.cnf](https://github.com/stefanpejcic/openpanel-configuration/blob/main/mysql/user.cnf) template for new users.
- *MySQL Configuration* page is moved to separate module so it can be disabled from *OpenAdmin > Features*.
- added *redirect* option for Services in OpenAdmin, if provided, user will be redirected after action.
- rewritten *OpenAdmin > Emails > Settings* page.
- *Languages* page is moved to separate module so it can be disabled from *OpenAdmin > Features*.
- Optimized database queries on all OpenPanel UI pages.
- OpenPanel UI template redesign.
- added caching for *OpenPanel > Dashboard* page.
- titles and links changed for pages in UI.

### 🐛 Bug Fixes
- Fixed a bug in `opencli sentinel` where it incorrectly checked `ns2` twice instead of `ns2` and `ns1`.
- Fixed a bug in `opencli plan-create` setting 250k inodes limit when *0* is provided.
- Fixed bug in *OpenPanel > Dashboard > Statistics widget* when disk usage is unlimited.
- [Error changing permisisons on WordPress autoinstall #378](https://github.com/stefanpejcic/OpenPanel/issues/378)
- Fixed bug saving nginx/httpd configuration via *OpenPanel > WebServer Settings*.
- Fixed css bug in *OpenPanel > Domains > Edit DNS Zone* with comments.
- [MySQL Processes don't see Mariadb Processes #398](https://github.com/stefanpejcic/OpenPanel/issues/398)
- [MySQL Configuration do not sync. #401](https://github.com/stefanpejcic/OpenPanel/issues/401)
- [Switch from mariadb to mysql don't work #400](https://github.com/stefanpejcic/OpenPanel/issues/400)
- fixed typo on Memcached settings page.
- Fixed css bug in *OpenPanel > Domains > Edit DNS Zone*.



#### Varnish

Once `varnish` module is enabled by Administrator, the *OpenPanel > Cache > Varnish* settings page will be available to users.

[![varnish.png](/img/docs-content/8z975g8v-varnish.png)](/img/docs-content/8z975g8v-varnish.png)

Available actions:

- view current setting
- enable/disable Varnish cache
- toggle on/off per domain name
- view varnish service logs

To purge cache, simply stop and start service from *Containers* page.

- `opencli user-varnish` command can be used to enable/disable Varnish per user.
- `opencli domains-varnish` command can be used to enable/disable Varnish per domain.

---

// File: changelog/1.2.0

Released on April 08, 2025

### 💅 Polish
- [ Simplified Chinese translation](https://github.com/stefanpejcic/openpanel-translations)
- `redirect` module controls if Domain Redirects are enabled for users.
- faster php container startup time due to shared WP-CLI for all users.
- redis and memcached services no longer listen on sockets.
- removed *File Editor* link from the sidebar.
- rewritten crons to use [Ofelia](https://github.com/mcuadros/ofelia/blob/master/docs/jobs.md#job-exec) docker job scheduler (aka. crontab for docker).
- added usage examples to crontab editor.
- `remote_mysql` module controls if *Remote MySQL Access* can be used by users.
- added sticky action buttons on *OpenPanel > File Manager* page.
- optimized folder size checks in *OpenPanel > File Manager* table.
- added human-readable file sizes in *OpenPanel > File Manager* table.
- nginx container is now run as root user to avoid permission issues.
- excluded MariaDB's *healthcheck* user from MySQL Users list.

### 🐛 Bug Fixes
- fixed bug displaying mysql databases sizes on MariaDB.
- [fixed bug with empty password on user create](https://community.openpanel.org/d/148-cannot-login-with-new-created-user)
- fixed bug with user autologin option on admin panel when custom hostname is not set.
- fixed bug with ' MESSAGE:' text left in Notification title when message is empty.
- [Upload file always goes to /var/ww/html](https://community.openpanel.org/d/147-upload-file-always-goes-to-varwwhtml)
- [css bug: html interpreted from logs on OpenAdmin > Notifications #186](https://github.com/stefanpejcic/OpenPanel/issues/186)
- [Minor Issue During Install #337](https://github.com/stefanpejcic/OpenPanel/issues/337)
- [Account menu disappears on /activity in user panel #339](https://github.com/stefanpejcic/OpenPanel/issues/339)
- fixed 500 error changing password from *OpenPanel > Account > Settings* when email is missing.
- fixed bug with username missing on *OpenPanel > Account > Settings* page.
- fixed bug with domains missing on *OpenPanel > WordPress > Install* page.
- fixed error *system container is not running. Please allow a few moments for the initialization..* on *OpenPanel > Resource Usage* page
- fixed error on *OpenAdmin > Users >* when user is suspended.
- fixed error *Error saving file: name 'tmp_file_path' is not defined* when saving file via FileManager.
- fixed socket error when multiple php versions are running.
- fixed css issue on dark mode on *OpenPanel > PHP > Limits* table.
- fixed socket error on Redis and Memcached containers.
- fixed broken links on *Dashboard* and *Activity Log* pages.
- [opencli email-server install freezes during Enterprise installation #382](https://github.com/stefanpejcic/OpenPanel/issues/382)
- fixed bug with *opencli domains-docroot* command failing to create folder.
- fixed breadcrumb bug on CronJobs Editor page.
- fixed bug with `csrf_token` being added in enabled_modules when Features are edited via OpenAdmin.
- fixed broken link in sidebar menu for *VHosts File Editor*.
- fixed css bugs with light color theme on 404 and 500 error pages on OpenAdmin and OpenPanel UI.

---

// File: changelog/1.2.1

Released on April 11, 2025

### 💡 New!
- [OpenAdmin > Locales (Languages)](/docs/admin/settings/locales/)
- *OpenPanel > Containers > Logs*

### 💅 Polish
- log file from *OpenAdmin > Notifications* now links to Log Viewer.
- *opencli sentinel* will now use `iostat` when `iotop` is not installed, for detailed crash reports.
- added octal permissions on hover for table in *OpenPanel > File Manager* page.
- added *php_options* and *php_ini* modules to search.
- updated the install script to use IPv4 for all curl and wget commands.
- changed in the install script timeout for pip from 3600 to 300s.

### 🐛 Bug Fixes
- fixed bug with *opencli sentinel* checking only one IP address from the server against nameservers.
- fixed error on 404 template on OpenAdmin.
- fixed missing crashreports when high load is detected.
- fixed bug with heavy caching on *OpenPanel > FTP Accounts* causing data to be delayed for 30s.
- fixed 500 error in *OpenPanel > FileManager* when downloading archive with wget.
- fixed incorrect unit on *OpenPanel > MySQL Databases* caused by heavy caching.
- fixed 500 error on *OpenPanel > MySQL Settings*.
- fixed bug with install script setting 1.1.8 as the installed version. 
- fixed 500 error on *OpenPanel > Account > Language*.
- fixed incorrect paths in select on *OpenPanel > Files > Fix Permissions* page.
- [Can't see database in phpmyadmin #403](https://github.com/stefanpejcic/OpenPanel/issues/403)
- [CSS pagination on OpenPanel > Raw Access Logs #394](https://github.com/stefanpejcic/OpenPanel/issues/394)
- [Correct Timezone not selected #380](https://github.com/stefanpejcic/OpenPanel/issues/380)
- [Rename FTP sub-users on username rename #232](https://github.com/stefanpejcic/OpenPanel/issues/232)
- [FTP Settings missing from UI #381](https://github.com/stefanpejcic/OpenPanel/issues/381)
- fixed bug with the install script on contabo causing ipv6 to be used for downloading from github.
- fixed bug with basic_auth on OpenAmdin not enabled if configured directly in config file: */etc/openpanel/openadmin/config/admin.ini*
- [WordPress Autoinstaller creates files and database but doesn't finish the installation #411](https://github.com/stefanpejcic/OpenPanel/issues/411)

---

// File: changelog/1.2.2

Released on April 17, 2025

### 💡 New!
- [ 🇵🇹 Portuguese translation for OpenPanel](https://community.openpanel.org/d/154-fala-portugues-portuguese-translation-for-openpanel)
- added [an option for both users and administrators to provide Google PageSpeed API key](https://dev.openpanel.com/cli/websites.html#PageSpeed).
- added [OpenAdmin > Settings > Basic Auth](https://openpanel.com/docs/admin/security/basic_auth)
- [OpenResty](https://openresty.org/en/) is now supported.
- added *opensearch* module in *OpenAdmin > Feature Manager*.

### 💅 Polish
- increased CSF iframe height in *OpenAdmin > Firewall* page.
- all toasts now close automatically once data is fetched on *OpenPanel > Docker > Containers*.
- added right-click on *OpenPanel > Docker > Containers* buttons to force pull the image before starting.
- added `--force` flag to [opencli user-resources] for forcing image pull before starting service.
- added descriptive messages on *OpenPanel > Docker > Containers*.
- updated `default.vcl` Varnish template for all users. 
- added limits for Cron service to existing users.
- added verbose output to `/domains/temporary-link` when preview.openpanel.org is unreachable.
- added *Create User* in OpenPanel sidebar under Databases.
- enhanced user creation process from *OpenAdmin > Users > New* page.

### 🐛 Bug Fixes
- fixed bug with failing to create database on MariaDB during WordPress auto install
- added proper error handling for errors from Google PageSpeed API.
- fixed permissions issue for php containers.
- [OpenPanel DNS Editor DKIM Record doesn't wrap #418](https://github.com/stefanpejcic/OpenPanel/issues/418)
- [Bug editing .JSON files viaMonaco Editor in OpenPanel > FileManager #395](https://github.com/stefanpejcic/OpenPanel/issues/395)
- [Bug in OpenPanel UI on /cache/varnish #408](https://github.com/stefanpejcic/OpenPanel/issues/408)
- fixed css bug with breadcrumbs on Site Manager.
- fixed bug setting permissions for new files created via File Manager.
- fixed bug deleting vhost files when switching webserver.
- fixed bug with backups section not visible in the menu if FTP is not enabled.
- [WordPress Auto installer didn't create database #407](https://github.com/stefanpejcic/OpenPanel/issues/407)
- fixed error causing first and last item from enabled_modules to not be imported.
- fixed bug detecting user's ip address from ip.json file.
- fixed temporary link option not generating subdomain.
- [Copy function not working in OpenPanel > File Manager #376](https://github.com/stefanpejcic/OpenPanel/issues/376)
- fixed bug with permissions for opensearch container.
- [WordPress autologin link leads to /none #412](https://github.com/stefanpejcic/OpenPanel/issues/412)
- [Database wizard reports success even when MySQL container is not running #402](https://github.com/stefanpejcic/OpenPanel/issues/402)
- fixed error *Failed to set ownership for the..* in FileManager for: create folder, create file, download with wget, upload files.
- fixed bug enabling `usage` module in *OpenAdmin > Feature Manager*.
-

---

// File: changelog/1.2.3

Released on April 21, 2025

### 💡 New
- [OpenAdmin > Advanced > Process Manager](/docs/admin/server/process_manager/)

### 💅 Polish
- auto-remove unused openpanel/openpanel-ui images.
- openpanel/openpanel-ui image is now auto-pulled on install.
- max-length of OpenPanel username is increased from 16 to 20 characters.

### 🐛 Bug Fixes
- fixed bug in update script causing OpenAdmin service restart before downloading extra scripts.
- fixed css issue on `/sites/new` page with the button.
- fixed bug with plan edit and plan create allowing negative values for limits.
- fixed several issues with the [opencli report](https://dev.openpanel.com/cli/report.html) command.
- [WordPress cant install uploaded plugin #429](https://github.com/stefanpejcic/OpenPanel/issues/429)
- [Editing Hosting Plan Integer Error #443](https://github.com/stefanpejcic/OpenPanel/issues/443)
- [Duplicated label in email settings #440](https://github.com/stefanpejcic/OpenPanel/issues/440)
- [Suspending user does not pause it's container #434](https://github.com/stefanpejcic/OpenPanel/issues/434)
- [PHP INI and Options editor 404 #441](https://github.com/stefanpejcic/OpenPanel/issues/441)
- fixed bug with php options being shown in sidebar when php.ini module is enabled.

---

// File: changelog/1.2.4

Released on April 21, 2025

### 💡 New
- [OpenAdmin > Settings > Custom Code](/docs/admin/settings/custom_code/)
- [`opencli waf` command](https://dev.openpanel.com/cli/waf.html)
- added WAF under *OpenAdmin > Settings*.
- [OpenAdmin > Domains > Edit Zone Templates](/docs/admin/domains/dns_templates/)

### 💅 Polish
- added caching for news from [OpenPanel blog](https://openpanel.com/blog) on *OpenAdmin > Dashboard*.
- *OpenAdmin > Dashboard > System Information* widget links processes to [Process Manager](/docs/admin/server/process_manager/)
- `opencli docker-update_images` command is removed.
- the number of PIDs per user service is now restricted to *40* to prevent fork-bombs. This limit will be configurable once the issue [[BUG] 26.0.1 does not allow resources.limits.cpu to be a number #5009](https://github.com/docker/cli/issues/5009) is resolved.
- Added an option in the OpenPanel UI for users to disable WAF rules by ID or tag for each domain.
- theme changes: different colors on filemanager selected rows and dashboard widgets background.
- Table ID `fajlovi` on FileManager page is renamed to 'filemanager_table'.
- improvements to the 'OpenPanel > Advanced > Process Manager' table.
- view top processes by cpu and ram is removed from Resource Usage page.
- improvements to the permissions drawer on FileManager.
- ftp accounts and settings are now available from *OpenAdmin > Services > FTP Accounts*.
- certbot is removed from all OpenAdmin routes: logs, resources, app.py..

### 🐛 Bug Fixes
- [The "Custom CSS", "Code in Header" feature does not work - #444](https://github.com/stefanpejcic/OpenPanel/issues/444)
- fixed bug with default.vcl template for existing users containing html instead of template code.
- [OpenAdmin Settings SMTP Settings Missing Save Button #311](https://github.com/stefanpejcic/OpenPanel/issues/311)
- [Creating passwords with double $$ are converted to numbers #442](https://github.com/stefanpejcic/OpenPanel/issues/442)
- [Error creating package #445](https://github.com/stefanpejcic/OpenPanel/issues/445)
- fixed bug installing locale from *OpenAdmin > Settings > Locales*.
- fixed issue with caching on `/get-folder-size` route causing all folders Calculated to display the same size for 300s.
- fixed bug that returned ftp accounts passwords on */services/ftp?output=json*

---

// File: changelog/1.2.5

Released on April 29, 2025

### 💡 New
- `demo_mode` option is available - if enabled, user and admin panels are in read-only mode.
- [`opencli docker-logs` command](https://dev.openpanel.com/cli/docker.html#logs)

### 💅 Polish
- redesigned backups page.
- added `--no-restart` flag to [opencli proxy set](https://dev.openpanel.com/cli/proxy.html).
- added *capitalize_domains* feature that allows users to customize domain type case.
- `.md` extension can now also be edit/viewed from *OpenPanel > FileManager*.
- if a README.md file is present in the current directory on *OpenPanel > FileManager*, it will be displayed below the file list table.
- redesigned [OpenAdmin > Advanced > SSH](/docs/admin/server/ssh/) page.
- [added PIDs limits](https://github.com/stefanpejcic/openpanel-configuration/commit/68ab55dc558365a0a115a2205a02beb559315473) to OpenPanel system containers: openpanel, mysql, clamav, redis, ftp.
- added [notifications support](https://containrrr.dev/shoutrrr/v0.8/services/overview/) to OpenPanel user backups.
- compact formatting for disk usage alerts on *OpenAdmin > Notifications*.
- `/get_server_load` route on OpenAdmin is renamed to `/json/load`.
- added `/sse/<resource>` route on OpenAdmin for server sent events (sse): load, memory, cpu, disk.
- `/combined_activity_logs`  route on OpenAdmin is renamed to `/json/combined_activity` and optimized to better sort the data.

### 🐛 Bug Fixes
- fixed bug with [opencli proxy set](https://dev.openpanel.com/cli/proxy.html) preventing certain characters.
- fixed bug saving email on *OpenAdmin > Notifications > Settings*.
- fixed bug with crons.ini missing for existing users: `cron  | read /crons.ini: is a directory`.
- fixed bug with *OpenPanel > Crons* from not sending comments.
- [No ports on /system/hosting/ports #377](https://github.com/stefanpejcic/OpenPanel/issues/377)
- fixed css bug with description field being required on new plan form.
- fixed error *ZeroDivisionError: float division by zero* on *OpenAdmin > Users* when user has 0 limits.
- fixed css bug with tabs on *OpenAdmin > Advanced > SSH*.
- fixed bug causing delete actions from FileManager to be logged in activity logs with incorrect paths.
- [Initial Install admin user fails no OpenAdmin login #439](https://github.com/stefanpejcic/OpenPanel/issues/439)

---

// File: changelog/1.2.6

Released on May 2, 2025

### 💅 Polish
- improvements to fossbilling module: detailed errors and password fields.
- [Testing user-backups in OpenPanel 0.2.5 #456](https://github.com/stefanpejcic/OpenPanel/issues/456)
- [Backup and restore scripts for single user - full account #315](https://github.com/stefanpejcic/OpenPanel/issues/315)
- [Improvements to WP installer [FEATURE REQUEST] #253](https://github.com/stefanpejcic/OpenPanel/issues/253)
- Administrators can now edit services from *OpenAdmin > Services > Edit* page.
- optimized search on OpenAdmin.
- `/json/docker-info` route is removed from OpenAdmin.
- added link to manage rules from *OpenAdmin > Security > WAF*.
- better logging for `/delete_file` from FileManager.
- [crashlogs are now accessible trough notifications or *View Logs* page in OpenAdmin](/img/docs-content/M6PLKzsT-2025-05-01-08-30.png).
- user creation via api no longer returns docker-compose version.
- `/api/users` now also allows [setting *mysql_type* and *webserver*](/docs/articles/extensions/openpanel-and-fossbilling/#add-hosting-plan-for-openpanel).

### 🐛 Bug Fixes
- fixed error with cronjobs created from UI missing quotes around comments.
- fixed css bug on *OpenAdmin > Settings > API* causing logs to be invisible on light theme.
- fixed error `{"error":"CSRF error","message":"The CSRF token is missing."}` on api calls.
- [Archive extraction via FileManager results in wrong file owner #459](https://github.com/stefanpejcic/OpenPanel/issues/459)
- [Lack of description how to use backup commands #255](https://github.com/stefanpejcic/OpenPanel/issues/255)
- [Getting error 503 on nginx/varnish #430](https://github.com/stefanpejcic/OpenPanel/issues/430)
- [Csf Restart Message #338](https://github.com/stefanpejcic/OpenPanel/issues/338)
- fixed bug with domain detection by `opencli sentinel` - causing email alerts not to be sent when domain is set for accessing openadmin.
- fixed bug in OpenAdmin `line 1052: email_daily_report: command not found` with daily reports not being sent.
- fixed js error on *OpenAdmin > Users > username > Activity* causing activity logs to not display.
- fixed bug with `opencli sentinel` not recording hostname, load and mysql processes in crash reports.
- fixed bug with `opencli sentinel` not restarting monitored system services.
- fixed error starting docker after reboot on Alma 9.5: `error creating default "bridge" network: cannot create network`
- [FOSSBilling False error on successfully created user #2](https://github.com/stefanpejcic/FOSSBilling-OpenPanel/issues/2)
- [FOSSBilling User delete errors #3](https://github.com/stefanpejcic/FOSSBilling-OpenPanel/issues/3)

---

// File: changelog/1.2.7

Released on May 6, 2025

### 💅 Polish
- added *Edit Domain Templates* page under *OpenAdmin > Domains* for editing html templates and vhost files.
- pm2 interface is removed and replaced with installer that allows users to run containerized nodejs or python apps.
- added a new page in *OpenAdmin > Domains* to edit templates: Nginx/OpenResty/Apache VirtualHosts files, and HTML templates for: new domain, suspended website and suspended user.
- `/sites/new` page is removed in favor of `/auto-installer`.
- `/mautic`, `/pm2` and `/ip_blocker` pages are removed from OpenPanel search.
- `/backups/settings` and `/backups/destination` pages are added in OpenPanel search.
- `/get-folder-size` now accepts both relative and full paths with `/var/www/html/`.
- bun, flarum, mautic and java are completely removed from PM2.
- added cron for `opencli email-server pflogsumm` to generate email summary reports periodically.
- timezone, ssh and webterminal modules are removed.
- updated vhost templates to show custom page when domain is added without any files.
- notifications (flash messages) are now limited to 1 per page.
- added daemon.json template for new users.
- setting custom domain for panel will now also enforce ssl/tls on mailserver, setting ip instead will enforce plain-text.
- added *--debug* flag to [opencli domain](https://dev.openpanel.com/cli/domain.html) command.
- added [Server Reboot](/docs/admin/advanced/reboot/) option in OpenAdmin.
- added horizontal scroll to tables on OpenAdmin pages: CorazaWAF rules, ProcessManager, Locales, Notifications, Plans, Services Status, Email Accounts.

### 🐛 Bug Fixes
- [Testing and maintenance of FossBilling module #453](https://github.com/stefanpejcic/OpenPanel/issues/453)
- [Problems with Remove User access from Database #336](https://github.com/stefanpejcic/OpenPanel/issues/336)
- [Mailserver: mail mount is not removed when deleting a domain #447](https://github.com/stefanpejcic/OpenPanel/issues/447)
- [Crons don't appear on GUI #460](https://github.com/stefanpejcic/OpenPanel/issues/460)
- [screenshot image loaded 3x in OpenPanel UI on /website #426](https://github.com/stefanpejcic/OpenPanel/issues/426)
- [Bug adding docroot in OpenPanel in Cyrillic - not IDN #431](https://github.com/stefanpejcic/OpenPanel/issues/431)
- [Delete email accounts on domain removal #233](https://github.com/stefanpejcic/OpenPanel/issues/233)
- fixed bug with `"` showing around enabled modules on *OpenPanel > Advanced > Server Info*.
- fixed error *Invalid folder path* on `/get-folder-size` for WP Manager.
- fixed bug setting load, du and cpu thresholds on *OpenAdmin > Notifications* settings.
- [OpenPanel UI > Web Terminal keeps loading.. #359](https://github.com/stefanpejcic/OpenPanel/issues/359)
- [remove backup jobs from daily usage reports #464](https://github.com/stefanpejcic/OpenPanel/issues/464)
- fixed bug *Error fetching databases from the container.* on MySQL caused by missing env limits for CPU and Memory in template.
- [Can not access through SSH anymore #367](https://github.com/stefanpejcic/OpenPanel/issues/367)
- fixed bug with mailserver creating multiple mountpoints when domain is re-added.
- fixed bug with email accounts still being listed in gui when domain is deleted.
- fixed bug on domain creation failing to create custom docroot.
- fixed bug connecting to SMTP locally from within the php containers.
- fixed a bug with ssh login notifications where the IP address was not correctly detected when multiple sessions were active.

---

// File: changelog/1.2.8

Released on May 8, 2025

### 💅 Polish
- [Support for ARM (AArch64) [FEATURE REQUEST] #63](https://github.com/stefanpejcic/OpenPanel/issues/63)
- `opencli domain` command will now also enable/disable SSL for Roundcube based on domain or ip usage.
- added better health-check for Caddy webserver on opencli sentinel.
- [added check for docker command first before installing mysql](https://github.com/stefanpejcic/OpenPanel/commit/d031e07251552b44f6c913000bc00d1a37ca2d31)
- hostname on OpenAdmin sidebar menu is now truncated after 30 characters.
- added network access by default for nodejs and python applications.
- docker-compose plugin upgraded from v2.32.1 to v2.36.0



### 🐛 Bug Fixes
- fixed bug with roundcube unable to connect to mailserver when SSL is enforced for mailserver.
- fixed `Warning: failed detecting user id, permissions issue!` when adding new domains.
- fixed bug `Notifying Slave DNS server (}):` when adding new domains.
- fixed incorrect redirect to `/pm2` instead of `/sites` after installing python/nodejs app.
- fixed caching issue on *OpenAdmin > Plans* page.
- fixed bug on AlmaLinux installing Docker Compose for root user.
- fixed error `DEBUG: Invalid port detected: lsof` when creating first user on RHEL distributions.
- fixed error `ERROR: One or more required variables are not set.` when creating first user on AlmaLinux 9.5

---

// File: changelog/1.2.9

Released on May 15, 2025

### 💅 Polish
- added `backup` and `mysql_import` modules in features manager.
- admin panel no longer uses cdn for tailwindcss (see [#484](https://github.com/stefanpejcic/OpenPanel/issues/484))
- backups are now enabled by default for new installations.
- added [uptime-kuma](https://github.com/louislam/uptime-kuma) as another example for adding custom docker service for users.
- added support for adding .onion domains from *OpenPanel > Domains > Add Domain* page.
- excluded .onion domains from: dns, suspend, unsuspend, change docroot, goaccess, logs, redirect pages.
- [Onion-Location](https://support.torproject.org/onionservices/onion-location/) header is now passed in Varnish cache.
- added support for [*pre* and *post* command hooks](https://dev.openpanel.com/customize.html#Hooks) to execute custom code.
- backup container will now auto-restart on failure.
- Caddy Admin API is now disabled by default on new installations.

### 🐛 Bug Fixes
- [Custom nameservers on Hetzner prevent downloading docker images #471](https://github.com/stefanpejcic/OpenPanel/issues/471)
- [Incorrect directory owner when files are added before domains #472](https://github.com/stefanpejcic/OpenPanel/issues/472)
- [On delete modal not all selected files are visible #473](https://github.com/stefanpejcic/OpenPanel/issues/473)
- [SSH connection via IPv6 is disconnected on installation #468](https://github.com/stefanpejcic/OpenPanel/issues/468)
- [Service php_fpm_8_3 does not have CPU or RAM limits defined #477](https://github.com/stefanpejcic/OpenPanel/issues/477)
- [Service php_fpm_5_6 does not exist in the Docker Compose file #476](https://github.com/stefanpejcic/OpenPanel/issues/476)
- fixed css bug opening edit plan dropdown on *OpenAdmin > Plans*.
- fixed css bug with server hostname display in OpenAdmin sidebar.
- fixed incorrect ip detection causing `Admin account X was accessed from a new IP address: 127.0.0.1` notification.
- [No success notification in OpenPanel UI on /wordpress/install #481](https://github.com/stefanpejcic/OpenPanel/issues/481)
- [Unable to change existing user package #485](https://github.com/stefanpejcic/OpenPanel/issues/485)
- fixed bug with [multiple swap notifications due to swap number in title of notification](/img/docs-content/xTQVrbgp-2025-05-14-11-30.png)
- [A timeout occurred when trying to access PHP extensions page #488](https://github.com/stefanpejcic/OpenPanel/issues/488)
- [Unable to modify docker image tag #489](https://github.com/stefanpejcic/OpenPanel/issues/489)
- [Hosting package UI limit inconsistency #487](https://github.com/stefanpejcic/OpenPanel/issues/487)
- [Unable to change the allocate amount of any docker containers #492](https://github.com/stefanpejcic/OpenPanel/issues/492)
- [Unable to update PHP Options #491](https://github.com/stefanpejcic/OpenPanel/issues/491)
- [Initial limits for PHP in PHP Options and PHP Limits page have different values #490](https://github.com/stefanpejcic/OpenPanel/issues/490)
- [Editing wp-config.php file trigger cloudflare firewall #486](https://github.com/stefanpejcic/OpenPanel/issues/486)

---

// File: changelog/1.3.0

Released on May 18, 2025

### 💅 Polish
- [dev_mode](https://dev.openpanel.com/cli/config.html#dev-mode) now replaces locally build css/js files with cdn.
- Softaculous 'autoinstaller' module is removed as it is not production ready.
- `opencli admin off` will now create a lock file `/root/openadmin_is_disabled` that is checked on OpenAdmin startup.
- `/api/backups/settings` route is removed.
- title in FileManager pages will now display the path in order to allow setting folder as Favorite.
- added language switcher on OpenPanel login page.
- [Ukrainian and Russian translations](https://community.openpanel.org/d/165-govoris-po-russki-russian-and-ukrainian-translation-for-openpanel).

### 🐛 Bug Fixes
- fixed 'Aw Snap!' error on Chrome when accessing OpenAdmin.
- fixed css bug on OpenAdmin pages: process manager, ftp, locales.
- fixed css bug on openadmin new user creation output.
- fixed error `error mounting "/etc/timezone" to rootfs` when starting OpenPanel container on RockyLinux 9.3
- fixed css bug with favicon star icon on dark mode on *OpenPanel > Dashboard*.
- fixed 500 error on *OpenPanel > Databases* page.
- fixed css issue with all fields in drawers on *OpenPanel > FileManager*.
- fixed bug setting cpu/ram limits for services on *OpenPanel > Docker > Containers* when total limits are unlimited.
- fixed js error `Uncaught TypeError: Assignment to constant variable.` when editing wp-config.php file in FileManager.
- fixed [bug encoding OpenAdmin updates for ARM cpu](https://community.openpanel.org/d/162-error-on-oracle-free-tier-arm/4).
- fixed [Bug visible dropdown menu Administrators page](https://community.openpanel.org/d/163-bug-visible-dropdown-menu-administrators-page).

---

// File: changelog/1.3.1

Released on May 22, 2025

### 💅 Polish
- [Add confirmation for detach and uninstall wordpress button #482](https://github.com/stefanpejcic/OpenPanel/discussions/482)
- [Add Terminal in Openadmin [FEATURE REQUEST] #238](https://github.com/stefanpejcic/OpenPanel/issues/238)
- `sidebar_color` config is removed for OpenPanel UI.
- [Email-only, DNS-only, DB-only features are now possible for a server](https://github.com/stefanpejcic/OpenPanel/issues/493#issuecomment-2890913088).
- `backups` feature is removed from OpenAdmin and Sentinel.
- dropped support for Sogo and Snappymail.
- UFW is no longer supported and only CSF is installed.
- `opencli firewall-reset` command is deprecated.
- `opencli blacklist` and `opencli cloudflare` commands are removed.
- `1.1` branch is merged in `main` branch for OpenCli scripts.
- [keyboard shortcuts for OpenAdmin](/docs/articles/dev-experience/openadmin-keyboard-shortcuts) are back.
- added docker terminal for users to exec commands into containers.
- more descriptive error pages for OpenAdmin.
- singe user page and add new user pages on OpenAdmin will now display `∞` for 0 on plan settings.
- system report key can now be generated from *OpenAdmin > License* page.


### 🐛 Bug Fixes
- [Missing timezones on RockyLinux cause shorter session duration in user panel #497](https://github.com/stefanpejcic/OpenPanel/issues/497)
- fixed `Warning: option ssl_version is deprecated and it is ignored. Use ssl_context instead.` on OpenPanel UI restart.
- fixed error on installation: `/dev/fd/63: line 184: jq: command not found` on Ubuntu 22.04.
- fixed broken link on OpenAdmin > Security > Basic Auth.
- added cursor-pointer class to buttons on OpenAdmin.
- fixed error saving changes on OpenAdmin > Settings > OpenPanel due to invalid session_duration setting.
- fixed css bug with sidebar expanding on OpenAdmin.
- fixed bug with admin pages appearing for resellers on OpenAdmin in sidebar.
- fixed error on resellers login in OpenAdmin.
- [cant connect using https to my openpanel after clean install #500](https://github.com/stefanpejcic/OpenPanel/issues/500)
- fixed error enabling mysql import feature.
- fixed autoinstaller module missing from features.
- fixed css bug on OpenPanel > Dashboard > Statistics with the memory background.

---

// File: changelog/1.3.2

Released on May 25, 2025

### 💅 Polish
- features can now be configured per user.

### 🐛 Bug Fixes
- fixed several css bugs on *OpenAdmin > Users > single user* page.
- fixed false-positive error on restarting 'admin' service from  *OpenAdmin > Services* page.

---

// File: changelog/1.3.3

Released on May 28, 2025

### 💅 Polish
- [*copy* and *move* drawers on *OpenPanel > FileManager* now allow user to select a folder using the tree view.](/img/docs-content/vZB8SJ85-2025-05-27-17-05.png)
- [Script for add/remove slave DNS server [FEATURE REQUEST] #313](https://github.com/stefanpejcic/OpenPanel/issues/313)
- [stop using cdn and locally build css/js files #484](https://github.com/stefanpejcic/OpenPanel/issues/484)
- The *Users*, *Plans*, and *Domains* pages in *OpenAdmin* will now display distinct error messages when there is no data or when the MySQL service is down.
- added support for dovecot master user accounts.
- added auto-login to webmail option in *OpenAdmin > Emails > Accounts* table.
- [Google PageSpeed API errors are now displayed on WP Manager](/img/docs-content/1sjJJLmH-2025-05-27-19-26.png)
- default features set is now used as a fallback for new users.

### 🐛 Bug Fixes
- fixed css bugs in OpenPanel Dashboard, FileManager, Containers pages.
- fixed css bugs in OpenAdmin Dashboard, API Access, Locales.
- fixed bugs with FileManager, PHP, MySQL and Domains modules missing from OpenPanel sidebar menu.
- fixed broken links for translations on *OpenAdmin > Settings > Locales*.
- fixed bug with ip address not being displayed in *OpenPanel > Dashboard* widget.
- fixed broken link on *Average Load* widget in *OpenAdmin > Dashboard*.
- fixed `{"error": "Docker image or .env files are missing."}` on creating new users.
- fixed 500 error on view file action in *OpenPanel > File Manager* page.
- fixed css issues on *OpenPanel > WP Manager* page.

---

// File: changelog/1.3.4

Released on May 30, 2025

### 💅 Polish
- [added ansible playbook](/docs/admin/intro/#installation)
- [*OpenAdmin > Users* and *OpenAdmin > Users > single user* pages now display time when user was suspended](/img/docs-content/zBmj3QvP-2025-05-30-13-44.png).
- [*OpenAdmin > Users* now has additional columns: Email, Domains, 2FA, Containers, NetIO, PIDs](/img/docs-content/7HhCGmSm-2025-05-29-19-06.png).
- cpu and ram usage on *OpenAdmin > Users* table links to Process Manager where processes are sorted by the user.
- added filters for Suspended and Active users on *OpenAdmin > Users* table.
- Capitalize Domain feature will now exclude FileManager table and VHost Editor.
- added style `cursor: pointer` to all buttons in OpenPanel and OpenAdmin UI.
- [CPU and RAM usage are now rounded to two decimal places on *OpenAdmin > Users > Single User*](/img/docs-content/Hsynwt74-2025-05-28-13-06.png).
- [Users in Enterprise Edition can now be created on remote servers from *OpenAdmin > Users > Add New* page](/img/docs-content/Dwp6Zy6m-2025-05-28-17-19.png).
- added flash error messages in DNS Zone Editor when zone file for domain is missing.
- [OpenAdmin > Domains > DNS Zone Editor](/img/docs-content/CwNWBppg-2025-05-29-14-02.png).
- added percentage indicators for email quota on OpenPanel and OpenAdmin > Email Accounts.

### 🐛 Bug Fixes
- [Install on debian: The repository 'bookworm-backports InRelease' is not signed. #495](https://github.com/stefanpejcic/OpenPanel/issues/495)
- fixed 500 error on *OpenPanel > Server Information* page.
- fixed css bug with Capitalize option on *OpenPanel > Domains*.
- fixed issue detecting container name on *OpenPanel > Process Manager*.
- fixed css bugs on *OpenPanel > Crons > File Editor*.
- fixed css issues on *OpenPanel > Resource Usage History* page.
- fixed error `[rootlesskit:parent] error: failed to start the child: fork/exec /proc/self/exe: operation not permitted` creating user on slave server running AppArmor.
- fixed bug with 'Dns Zone Editor' not active on menu when `/domains/edit-dns-zone` is accessed.
- fixed bug on *OpenAdmin > Users > single user* displaying disk usage for renamed user.
- [Bug in OpenPanel UI on /domains/suspend: ERROR: Failed to validate conf after suspend, changes reverted. #433](https://github.com/stefanpejcic/OpenPanel/issues/433)

---

// File: changelog/1.3.5

Released on June 02, 2025

### 💅 Polish
- [Search with filtering for File Manager](/img/docs-content/M6Bt37vW-2025-05-30-20-58.png)
- [Additional columns on File Manager table: owner, group links, link target, type](/img/docs-content/TG8tL44h-2025-05-30-19-00.png)
- The pagespeed data check on the WP manager will no longer retry every 15 seconds if the pagespeed API returns an error.
- PM2, AutoInstaller, WordPress and Sites pages are now all located under Site Manager in the sidebar menu.

### 🐛 Bug Fixes
- fixed css bug with sidebar menu on light theme in OpenPanel UI.
- [IDN domain not displayed in OpenPanel UI in several pages #432](https://github.com/stefanpejcic/OpenPanel/issues/432)
- fixed error detecting mysql database size on WP Manager.
- [OpenPanel > SiteManager database backup error #379](https://github.com/stefanpejcic/OpenPanel/issues/379)

---

// File: changelog/1.3.6

Released on June 05, 2025

### 💅 Polish
- [*OpenPanel > Domains > SSL* page](/docs/panel/domains/ssl/).
- placeholder images are replaced with svg icons on FileManager and Edit Files.
- [Drag&Drop Site Builder with TailwindCSS blocks](/img/docs-content/3rwh6Kp8-2025-06-02-14-54.png)
- [Drag&Drop file upload in *OpenPanel > FileManager*](/img/docs-content/RSDpS9yV-2025-06-02-14-49.png) and *OpenPanel > Upload Files*.
- [Live html preview on *OpenAdmin > Domains > Edit Domain Templates* page](/img/docs-content/0j7nCVmX-25c1a2d63b4132.gif)
- [Block view action in FileManager for files over 10MB #505](https://github.com/stefanpejcic/OpenPanel/issues/505)
- login is now required on error pages: 403, 404, 413, 500.
- added move to Trash option on deleting files via File Manager.
- added setting `autopurge_trash` option where admin an specify days to keep files in Trash folder for user.
- added [`opencli files-purge_trash` command](https://dev.openpanel.com/cli/files.html#Purge-Trash) to purge trash for specific or all users.
- added [`websites-google_index` command](https://dev.openpanel.com/cli/websites.html#Google-Index) to check if websites are indexed on Google Search Engine.=
- [added table with docker stats history in *OpenAdmin > Users > single user*](/img/docs-content/vb27SffN-2025-06-03-14-30.png)
- email notifications feature is now disabled by default.
- default php version setting is removed from *OpenAdmin > Settings > OpenPanel* page.
- username is no longer random generated on *OpenAdmin > Users >  Add* form.
- [Varnish cache is now indicated on the Webserver field in *OpenAdmin > Users > Add* form](/img/docs-content/G2vq1GgH-2025-06-04-12-03.png).
- [*OpenAdmin > Settings > Edit Defaults* page is added for Administrators to configure defaults for new user accounts](/img/docs-content/qqbnf7rN-2025-06-04-12-04.png).
- fixed error running `opencli domain-ssl <DOMAIN> info` command.
- added 'Change Docroot', 'Suspend Domain' and 'Unsuspend Domain' icons to *OpenPanel > Dashboard*.

### 🐛 Bug Fixes
- [fixed bug with vercel blocking ip address checks on OpenAdmin login page](/img/docs-content/hGLQtNLG-2025-06-02-17-29.png).
- fixed css bug with score colors on *OpenPanel > WP Manager > PageSpeed* widget.
- fixed bug in Sentinel incorrectly reporting 'Hight Load Usage!' for SWAP.
- [fixed css issue when using ctrl key on Windows for selecting files in *OpenPanel > FileManager* table](/img/docs-content/QN7746YS-2025-06-02-18-18.png).
- fixed css issues with borders and sidebar on *OpenPanel > Dashboard* page.
- fixed css issues with colors on *OpenPanel > WP Manager > Speed* widget.
- fixed css issues with grids on *OpenPanel > Site Manager*.
- fixed issue in File Manager displaying files with space in their names.
- [fixed problems with auto-login,change plan from WHMCS to OpenPanel #507](https://github.com/stefanpejcic/OpenPanel/issues/507)
- fixed css issues with dropdown actions on *OpenPanel > Edit DNS Zone* page.
- fixed js bug editing MX record priority in *OpenPanel > DNS Zone Editor* on table view.

---

// File: changelog/1.3.7

Released on June 06, 2025

### 💡 New
- [`opencli user-list --over_quota`](https://dev.openpanel.com/cli/users.html#List-Users) and [`opencli user-list --quota`](https://dev.openpanel.com/cli/users.html#List-Users) commands.
- [Feature sets](/img/docs-content/ZKMCgGL0-2025-06-05-16-37.png) are introduced, enabling [configuration of pages and features in the OpenPanel UI on a global level, per plan, or per user](/img/docs-content/pXTmsW-zg-2025-06-05-16-38.png).
- [API for OpenPanel UI](https://dev.openpanel.com/openpanel-api/)

### 💅 Polish
- *Feature Manager* in OpenAdmin is renamed to *Settings > Modules*.

### 🐛 Bug Fixes
- fixed bug with percentage indicators on *OpenPanel > Email Accounts* page.
- [Compress items issues #508](https://github.com/stefanpejcic/OpenPanel/issues/508)
- [Basic auth on OpenAdmin prevents email alerts #509](https://github.com/stefanpejcic/OpenPanel/issues/509)

---

// File: changelog/1.3.8

Released on June 09, 2025

### 💅 Polish
- [CSRF protection](https://cheatsheetseries.owasp.org/cheatsheets/Cross-Site_Request_Forgery_Prevention_Cheat_Sheet.html) added to all OpenPanel UI pages.
- [`domain_link` class can now be used in OpenPanel UI templates to exclude Capitalize Domains feature](/img/docs-content/XqYQrJxk-2025-06-06-13-06.png).
- [certificate information added in *OpenPanel > Domains > SSL*](/img/docs-content/gjZ3TNFw-2025-06-06-15-53.png).
- `/api/domains` route is added on OpenAdmin API.
- added `/api/usage/disk/` API endpoint for returning disk usage of all users on the server.

### 🐛 Bug Fixes
- fixed broken screenshot url on WP Manager.
- fixed bug changing feature set from 'default' on *OpenAdmin > Edit Plan* form.
- fixed import error with domain_logs module.
- [fixed error with incorrect archive_path_logged on compression](/img/docs-content/wTGR8vNY-2025-06-06-13-27.png)
- fixed errors with `opencli domains-ssl <DOMAIN> info` command.
- fixed 404 error on `/api/mysql-size` route.
- fixed 500 error on Website Builder installation when subdirectory is not set.
- fixed css bugs on Inodes Explorer and Disk Usage pages.
- [fixed `Infinity %` error for Memory usage on *OpenAdmin > Users > single user* page](/img/docs-content/LXxqzWbz-2025-06-08-18-06.png).
- fixed 500 error on *OpenAdmin > Settings > Updates* page.

---

// File: changelog/1.3.9

Released on June 11, 2025

### 💡 New
- [*OpenPanel > PostgreSQL* BETA](/img/docs-content/4y3n59k3-2025-06-09-16-13.png).
- added option in WP Manager to view current cache type: *Memcached, Memcache, Xcache, WinCache, APC, Redis, WP LCache, W3TC memcached, W3TC memcache, W3TC apc, W3TC redis, W3TC wincache, Default, Unknown*
- [added an option to flush WP Cache from WP Manager](/img/docs-content/rw230vvh-2025-06-10-17-45.png).
- [added an option to enable/disable Maintenance Mode from WP Manager](/img/docs-content/W1cdtwTG-2025-06-10-18-54.png).

### 💅 Polish
- sidebar state in OpenPanel and OpenAdmin UI is now stored in browser storage.
- [better formatting on *OpenAdmin > Users > single user > Activity* table](/img/docs-content/B6gWG2Jc-2025-06-09-07-37.png).
- POST method for suspend and delete actions for users on OpenAdmin.
- support for SVG logo on OpenPanel.
- Databases section in OpePanel Ui is renamed to 'MySQL'.
- MySQL databases on Plans arenow renamed to just Databases as hte limit is shared between postgres and mysql.
- responsive design on *OpenAdmin > Users > single user* page.
- added placeholders for screenshots in WP Manager.


### 🐛 Bug Fixes
- fixed js bug `Uncaught SyntaxError: Identifier 'csrf_token' has already been declared` on *OpenPanel > WP Manager, WebsiteBuilder, Ruby, Flarum, FileManager* pages.
- fixed 500 error enabling modules on *OpenAdmin > Settings > Modules*.
- [fixed css bug on OpenAdmin sidebar causing DNS Zone Editor to be active on DNS Cluster page](/img/docs-content/G2VbfkK7-2025-06-09-07-48.png).
- fixed error adding logo in *OpenAdmin > Settings > OpenPanel* page.
- fixed CSP error loading logo images on OpenPanel from different domains.
- fixed css issue causing all icons on Dashboard page to be capitalized.
- fixed js issue causing Edit not to work on mobile devices for *OpenAdmin > Resellers, Administrators, Notifications, DNS Cluster* pages.
- fixed CSRF error changing locale on login page.
- fixed translation bug on FileManager for the 'Select all' button label.
- fixed several css bugs on WP Manager.
- fixed bug disabling Varnish cache per domain.
- [Bug in OpenPanel UI on /cache/varnish #408](https://github.com/stefanpejcic/OpenPanel/issues/408)

---

// File: changelog/1.4.0

Released on June 13, 2025

### 💡 New
- Keyboard shortcuts in *OpenPanel > FileManager*: `Ctrl+A` selects all files, `Del` opens delete dialog.
- added swap usage data on *OpenAdmin > Dashboard > Resource Usage* widget.
- [added an option to clear swap from the *OpenAdmin > Dashboard*](/img/docs-content/q7bB10KL-clear-sw-ap-openamdin.gif).
- [added an option to add custom icons in *OpenPanel > Dashboard*](/img/docs-content/x9PLb11V-2025-06-11-13-37.png).
- [How-to articles on *OpenPanel > Dashboard*, can now be edited via **OpenAdmin > Settings > Custom Code**](/img/docs-content/syH8H00t-2025-06-12-17-27.png).

### 💅 Polish
- [improvements to the memory usage chart on *OpenAdmin > Dashboard > Resource Usage* widget](/img/docs-content/nZnxLQxF-2025-06-11-11-44.png).

### 🐛 Bug Fixes
- fixed 500 error on *OpenPanel > 2FA* page.
- fixed css issue enabling checkbox on *OpenPanel > Advanced > WAF* page.
- fixed bug with cron container not restarting on failure.
- fixed 403 error on *OpenPanel > Account* page.

---

// File: changelog/1.4.1

Released on June 15, 2025

### 💡 New
- [PHP Options and PHP.INI files can now be edited via *OpenAdmin > Settings > PHP* page](/img/docs-content/cWVpLSHm-ini.png).

### 💅 Polish
- better formating on *OpenPanel > CronJobs* table.
- [notification settings are separated to *OpenAdmin > Settings > Notifications* page](/img/docs-content/KZ47HfKY-2025-06-13-20-43.png).
- locally hosted files for CodeMirror editor used on PHP.INI editor, CronJobs Editor, vHosts Editor.
- [added detailed disk information in *OpenAdmin > Dashboard > Resource usage* widget](https://github.com/stefanpejcic/OpenPanel/issues/511#issuecomment-2969716827).
- [added placeholder message when no emails yet, on *Emails > Summary Reports*](https://github.com/stefanpejcic/OpenPanel/issues/511)
- added validations on OpenPanel > PHP Options for numbers fields and separate selects for units.
- 'Demo Mode' on OpenAdmin is moved from Settings to Advanced.
- 'Disable OpenAdmin' on OpenAdmin is moved from Settings to Security.
- default swap alert treshold **for new installations** is increased from 40 to 85%.
- `/view_notifications` page on OpenAdmin is renamed to `/notifications`.

### 🐛 Bug Fixes
- [fixed bug with header and sidebar missing on *Emails > Summary Reports*](https://github.com/stefanpejcic/OpenPanel/issues/511)
- fixed bug saving email address under *OpenAdmin > Notifications > Settings*.
- fixed bug with demo-mode missing in search.
- fixed bug with false-positive alert: `Caddy container is not active. Users' websites are not working!` when users exist on the server but have no domains yet.
- [Toggling WAF returns JSON page #512](https://github.com/stefanpejcic/OpenPanel/issues/512)
- [Can't stop containers or change their assigned resources #514](https://github.com/stefanpejcic/OpenPanel/issues/514)

---

// File: changelog/1.4.2

Released on June 17, 2025

### 💡 New
- [System Cron Jobs can now be configured via *OpenAdmin > Advanced Cron Jobs* page](/img/docs-content/Y73qtX6n-crons.png).

### 💅 Polish
- [*Scan for Existing Installations* function in WP Manager is restored](/img/docs-content/Dw8SVz0j-ezgif-3d3bde1460d39b.gif).
- [smtp settings can now be edited from *OpenAdmin > Settings > Notifications* page](/img/docs-content/FF7NfzsG-2025-06-15-11-23.png).
- [Administrators can now edit list of forbidden usernames from *OpenAdmin > Settings > Custom Code* page](/img/docs-content/5fj7ZzKs-2025-06-15-11-32.png).
- [Administrators can now edit list of restricted domains from *OpenAdmin > Settings > Custom Code* page](/img/docs-content/vYmvCgzQ-2025-06-15-11-39.png).
- [added *restore default* buttons on *OpenAdmin > Domains > Edit Domain Templates*, OpenAdmin > Domains > Edit Zote Templates* and  *OpenAdmin > Settings > Custom Code* pages](/img/docs-content/Rv4dBDCC-2025-06-15-12-14.png).
- varnish tempalte default.vcl can now be edited from *OpenAdmin > Domains > Edit Domain Templates* page.
- [WordPress plugins and themes sets to be auto-installed, can now be configured from  *OpenAdmin > Domains > Custom Code* page](/img/docs-content/dwpB7V91-2025-06-15-12-54.png).
- `floatingip` service is removed on new installations.
- [improvements to *OpenAdmin > Security > CorazaWAF > Manage Rules* page](/img/docs-content/kqt2MQX2-2025-06-15-14-07.png).
- openpanel-ui docker image size is decreased for 50M.
- openpanel docker container restart will now purge all redis cache.
- `website_builder` feature is now enabled by default on new installations.
- *Import cPanel Account* is moved to *OpenAdmin > Advanced* menu.

### 🐛 Bug Fixes
- fixed cors error using EXM CDN on *OpenPanel > SSL* when custom domain name is configured.
- [Can't favorite pages #516](https://github.com/stefanpejcic/OpenPanel/issues/516)
- [Design bug #517](https://github.com/stefanpejcic/OpenPanel/issues/517)
- fixed csrf error uplaoding files.
- fixed issue with `Del` key triggering delete drawer when in input field on File Manager.
- fixed error saving options on *OpenAdmin > Settings > Custom Code* page.
- fixed CSS issue on *OpenAdmin > Settings > Modules* that caused inconsistent module heights.
- fixed incorrect section id *personal-information* on multiple OpenAdmin pages.
- fixed csrf error detaching WordPress installation from WP Manager.
- fixed bug on cPanel accpunt import: [SHELL="/bin/bash" is imported from cronjob #22](https://github.com/stefanpejcic/cPanel-to-OpenPanel/issues/22)

---

// File: changelog/1.4.3

Released on June 21, 2025

### 💅 Polish
- sortable columns on *OpenAdmin > Users* table.
- selected columns are now stored in user browser storage for *OpenAdmin > Users* table.
- [tooltips on *OpenAdmin > Settings > OpenPanel* page](/img/docs-content/zX0pQnFK-2025-06-17-12-33.png).
- [better formating of the 'CPU Usage' admin notification](/img/docs-content/T257Nkkb-2025-06-17-13-14.png).
- refractored template code on *OpenPanel > Dashboard* page.
- sections on *OpenPanel > Dashboard* page are now collapsible.
- document root paths are now perserved for all domains during cpanel account import.
- `opencli website-scan` now auto replaces 'localhost' in wp-config.php files with user's database service: MySQL or MariaDB
- the system now logs the timestamp in the user's activity log when users are imported from cPanel backup files.
- optimized crashreport script on high load alerts.
- [WP Manager now has options to Shuffle Salts, Verify WP core checksum and reinstall WP core files](/img/docs-content/1svHsNY4-2025-06-20-14-27.png).


### 🐛 Bug Fixes
- fixed `Error response from daemon: No such container:` when deleting domain for a user from terminal.
- fixed error importing mysql dumps from cpanel due to mysql_native_password plugin.
- fixed bug collectiong I/O usage on admin nitifications on high load.
- fixed issue comparing decimal load value with user configured float.

---

// File: changelog/1.4.4

Released on June 24, 2025

### 💅 Polish
- added quick actions to *OpenAdmin > Users* table.
- `opencli update` now also updates system packages, checks if reboot is needed and updates docker-compose plugin.
- auto-login functionality from OpenPanel to phpMyAdmin is restored.
- [translation files are now auto-updated on github](https://github.com/stefanpejcic/openPanel-translations) after each new release.
- `/php/check_install` page is removed.
- descriptive errors on *OpenPanel > Backups > Settings* page.
- Icons added to *OpenPanel > Dashboard*: Open phpMyAdmin, Resource Usage History, File Upload, Download Files.
- session cookie for OpenAdmin is renamed to 'OPEANDMIN'.

### 🐛 Bug Fixes
- [ClamAV Scanner - "Invalid directory" #522](https://github.com/stefanpejcic/OpenPanel/issues/522)
- [Can't open database in phpMyAdmin through button provided #521](https://github.com/stefanpejcic/OpenPanel/issues/521)
- [404 creating new containers #525](https://github.com/stefanpejcic/OpenPanel/issues/525)
- [Notification preferences produces error 500 on save #524](https://github.com/stefanpejcic/OpenPanel/issues/524)
- [Error message with PageSpeed Quota #519](https://github.com/stefanpejcic/OpenPanel/issues/519)
- [Deleting user shows error message although user seems to be deleted #518](https://github.com/stefanpejcic/OpenPanel/issues/518#issuecomment-2993597415)
- fixed css bug on OpenPanel > Dashboard > Usage widget with absolute position of percentage.
- fixed 404 error on 'wp-download-core' link in WP Manager.
- fixed bug with 'Reinstall Core Files' triggering twice on WP Manager.
- [Can't unsuspend users - Error 500 #531](https://github.com/stefanpejcic/OpenPanel/issues/531)
- [/pm2 Gives error 404 #530](https://github.com/stefanpejcic/OpenPanel/issues/530)
- [Removing domain shows JSON response #529](https://github.com/stefanpejcic/OpenPanel/issues/529)
- [Can't save PageSpeed API Key #527](https://github.com/stefanpejcic/OpenPanel/issues/527)
- [Error 500 on restart service + Browser console errors @ MySQL Process List Page #528](https://github.com/stefanpejcic/OpenPanel/issues/528)
-

---

// File: changelog/1.4.5

Released on June 28, 2025

### 💅 Polish
- [added disk IO information on OpenAdmin > Dashboard](/img/docs-content/LHnNj8kV-2025-06-25-18-11.png).
- [added network IO information on OpenAdmin > Dashboard](/img/docs-content/74cY3t41-2025-06-25-18-12.png).
- option to rollback openpanel ui from *OpenAdmin > Settings > Updates* page.
- option to delete feature set, enable all features or disable all features on *OpenAdmin > Hosting Plans > Feature Manager*.
- Page links and description tooltips for features table on *OpenAdmin > Hosting Plans > Feature Manager*.
- busybox container is no longer used in user panel operations.
- example services are removed from docker-compose.yml file: busybox, filebrowser, uptimekuma, mssql, minecraft.
- `SSH_PORT` and `TTYD_PORT` variables are renamed to `UNUSED_1_PORT` `UNUSED_2_PORT` and can be used for adding custom services for user.
- [documented guidelines for adding new services in OpenPanel](https://dev.openpanel.com/images/)
- rewritten Informations, Usage and Statistics widgets on *OpenPanel > Dashboard*.
- Statistics widget now displays when was data last updated.
- [Option to Enable/Disable containers on Services tab in OpenAdmin [FEATURE REQUEST] #523](https://github.com/stefanpejcic/OpenPanel/issues/523)
- added storage information on single user page OpenAdmin: Volumes, Containers and Images.
- `mail_debug` setting is added, allows storing all outgoing emails from the system (OpenAdmin and OpenPanel UI) to `/var/log/openpanel/admin/emails/` directory.
- added `restart: unless-stopped` policy for varnish service.
- OpenAdmin > Advanced > Migrate

### 🐛 Bug Fixes
- fixed error `/usr/local/admin/service/notifications.sh: line 730: bc: command not found` on AlmaLinux.
- fixed bud dispalying `0` instead of `∞` on *OpenAdmin > Users* table for unlimited usage.
- fixed bug preventing empty email on *OpenAdmin > Settings > Notifications*.
- [Can't switch WebServer #540](https://github.com/stefanpejcic/OpenPanel/issues/540)

---

// File: changelog/1.4.6

Released on July 01, 2025

### 💅 Polish

- removed minecraft and mssql volumes form backup source selection on user panel.
- new option `activity_lines_retention` is added, setting number of lines to keep in user activity log - default is 1500.
- file downloads from OpenPanel > FileManager are now sreamed in 8KB chunks and Admin configures the limits.
- added user_allowed dictionary representing features that user can access in openpanel ui, to output of `/api/dashboard`
- [Option to trigger a backup manually #539](https://github.com/stefanpejcic/OpenPanel/issues/539)
- added `?output=json` option for `/settings/modules` on OpenAdmin.
- *OpenAdmin > Settings > Modules* now indicates for each module if its Enterprise-only, Free or in BETA.
- *OpenAdmin > Feature Manager > Edit* now indicates for each feature if its Enterprise-only, Free or in BETA.
- improvements to singe users page in OpenAdmin.
- [added indicator in top-right corner on OpenAdmin when service restart is needed after configuration changes](/img/docs-content/ncsSLZw1-2025-06-27-21-01.png).
- [services on *OpenAdmin > Services > Status* now display if service restart is needed](/img/docs-content/9Fv8RS6H-2025-06-27-21-01-1.png).
* **New Settings for Administrators in OpenAdmin → OpenPanel Settings:**
  Admins can now configure the following:

  * Maximum file size for **Edit**, **View**, **Upload**, and **Download** actions
  * Automatic Trash cleanup after a specified number of days
  * Maximum time limit for **compress** and **extract** operations
  * List of extensions to allow **Edit** and **View** options for
  * List of extensions to allow **Compress** and **Extract** options for
  * 
    [View screenshot →](/img/docs-content/51x3ykqB-2025-06-27-18-43.png)

### 🐛 Bug Fixes
- fixed 500 error compressing files via FileManager inisde a sub-directory.
- fixed bug with Files and Account sections showing on OpenPanel dashboard when only Emails is set.
- fixed css bugs with `text-end` class on OpenPanel pages: Favorites, Inodes Explorer, Disk Usage, ClamAV Quarantine, Email Accounts. 
- [Can't "Login as Admin" on fresh installed Wordpress website #520](https://github.com/stefanpejcic/OpenPanel/issues/520)
- fixed bug with `opencli user-suspend` not stopping all user containers.
- fixed bug with `opencli user-unsuspend` not starting all user containers.
- fixe bug with `0` showing instead of `∞` on *OpenAdmin > Users > single page* for 'Cores' and 'Memory'.
- fixed js error on wget option in File Manager.
- [Downloaded arhive have no Extract enabled in File Manager #541](https://github.com/stefanpejcic/OpenPanel/issues/541#issuecomment-3013182649)

---

// File: changelog/1.4.7

Released on July 04, 2025

### 💅 Polish
- Inodes usage on *OpenAdmin > Users > single user* is now not rounded in millions if less than 1M.
- added option to restore default extensions in [*OpenAdmin > Settings > OpenPanel > File Manager*](/img/docs-content/rydPd9z4-2025-07-03-16-38.png).
- added logo preview on [*OpenAdmin > Settings > OpenPanel > Logo*](/img/docs-content/5xhYd4LM-2025-07-03-16-42.png).
- `repquota` is added to the list of restricted usernames.
- `opencli docker-images <USERNAME>` is implemented.
- user selected locale is now stored for the account.
- Web Terminals in both OpenAdmin and OpenPanel now support paste functionality and arrow key command history.

### 🐛 Bug Fixes
- [Error creating new Package #544](https://github.com/stefanpejcic/OpenPanel/issues/544)
- ["Forgot Password?" goes to 404 #543](https://github.com/stefanpejcic/OpenPanel/issues/543)
- [Updating User Package seems to hang/crash #546](https://github.com/stefanpejcic/OpenPanel/issues/546)
- fixed js error on OpenAdmin `/security/waf/view-rules?edit=/etc/openpanel/caddy/coreruleset/rules/REQUEST-941-APPLICATION-ATTACK-XSS.conf`
- fixed js issue with decimals on *OpenAdmin > Dashboard > resource usage* widget for Load.
- fixed bug with `opencli php-default` failing to change version.
- fixed bug with cPanel import failing to set custom docroot for domains.
- fixed bug with cPanel import failing to change nameservers in zone file.
- fixed bug with cPanel import logging each domain import twice.
- fixed bug with cPanel import failing due to low inodes or disk limit on the Hosting Package.
- fixed bug with `opencli user-change_plan` faiing to enforce disk limit form the plan.
- fixed bug in *OpenAdmin > Users > single user* for Storage resulting usage in Blocks instead of GB.
- [Bug in OpenAdmin UI: Users page shows incorrect inodes usage when account is over quota #548](https://github.com/stefanpejcic/OpenPanel/issues/548)
- fixed css issue on *OpenAdmin > Users > single user* activity table for admin actions.
- fixed css issue on *OpenAdmin > Users > single user* with disk and inodes usage represented over 100% on the graphs.
- fixed bug with json repsonse on suspending domains from OpenPanel UI.
- fixed multiple bugs with `opencli websites-scan` script.

---

// File: changelog/1.4.8

Released on July 09, 2025

### 💅 Polish
- [Improving the FTP logic #312](https://github.com/stefanpejcic/OpenPanel/issues/312)
- [Improvements to the NodeJS/Python App Manager interface](/img/docs-content/SmpVJF2f-2025-07-08-13-56.png).
- [Improvements to Domains page](/img/docs-content/KcjbpHxV-2025-07-08-17-18.png).
- 'FTP Connections' page is added in OpenPanel UI, allowing users to view active ftp sessions.
- Images are removed from *OpenPanel > Account > 2FA* page.
- Hosting Plan is now listed in *OpenPanel > Dashboard > Information* widget.
- cron service is now installed for new installations.
- start/stop of docker service by user will now trigger recalculating their cpu/ram usage.
- `/website/node_info/<path:site_name>` and `/website/py_info/<path:site_name>` routes are removed.
- `/manager/python.html` and `/manager/nodejs.html` templates are now merged in `python_node_apps.html`
- *OpenPanel > FTP Accounts* now displays UID and GID for each ftp account.
- [Update documentation #450](https://github.com/stefanpejcic/OpenPanel/issues/450)
- [Document OpenAdmin > Modules #538](https://github.com/stefanpejcic/OpenPanel/issues/538)

### 🐛 Bug Fixes
- fixed js error `Uncaught TypeError: Assignment to constant variable.` on PageSpeed when limits are reached.
- fixed bug with **MySQL > Import** missing in sidebar menu when `mysql_import` is enabled.
- fixed 500 bug on *OpenAdmin > Users* when `/etc/openpanel/openpanel/core/users/` directory is deleted.
- fixed error adding nodejs app in SiteManager: `1366 (HY000): Incorrect integer value: 'APPNAME_NODE' for column 'ports' at row 1`
- fixed missing port `:8080`from webmail url when domain is not configured.
- fixed `Error accessing file size: [Errno 2] No such file or directory` when trying to insert pagespeed api key usinf WP Manager.
- fixed bug with `root` owning nginx vhost files for new domains.

---

// File: changelog/1.4.9

Released on July 14, 2025

### 💅 Polish
- `opencli domains-user` and `opencli domains-all` scripts now accept optional flags to display document root or php version.
- `opencli domains-add` now accepts optional flags to skip creating virtualhost files, reverse proxy, dns zones, or starting services.
- optimized `/json/ips` page on OpenAdmin.
- changing ip address for user now immediately invalidates all cache.
- *OpenAdmin > Users* table now indicates dedicated ip address for user.
- [IP is no longer enforced for OpenPanel UI access when IP address is used](https://github.com/stefanpejcic/OpenPanel/discussions/553#discussioncomment-13733616)
- `opencli websites-google_indexed` is removed.
- [*OpenAdmin > Users > single user* page no longer displays 500 error when docker stats for user are missing](/img/docs-content/PT9gyNN9-2025-07-14-14-42.png).
- `/get_user_stats` route on OpenAdmin is removed.
- [[Enhancement] Make this date human readable #555](https://github.com/stefanpejcic/OpenPanel/issues/555)


### 🐛 Bug Fixes
- fixed several bugs on `/websites` page when IDN domain name is used.
- fixed issue preventing dedicated ip address to be displayed for users on *OpenAdmin > Users* table.
- fixed bug setting user's dedicated ip address in DNS zone for new domains.
- [Bug in OpenPanel UI on /website - delete Node/Py app not working #558](https://github.com/stefanpejcic/OpenPanel/issues/558)
- fixed *Warning: invalid webserver type selected: openresty. Must be 'nginx', 'apache', 'openresty', 'varnish+nginx', 'varnish+apache' or 'varnish+openresty'. Using the default instead..* when openresty is set.
- [Can't Enable/Disable container on user Services on OpenAdmin #566](https://github.com/stefanpejcic/OpenPanel/issues/566)
- [Showing old metric after resource update #565](https://github.com/stefanpejcic/OpenPanel/issues/565)
- fixed js bug `Uncaught SyntaxError: redeclaration of const files` preventing file uploads in File Manager.
- fixed css bug with actions dropdown not visible on *OpenPanel > Domains* by default.

---

// File: changelog/1.5.0

Released on July 22, 2025

### 💅 Polish
- [OpenPanel 2 OpenPanel migrations #21](https://github.com/stefanpejcic/OpenPanel/issues/21)
- added [support for 3rd party plugins](/docs/articles/dev-experience/custom-plugins) in OpenPanel UI.
- [example plugin for OpenPanel](https://github.com/stefanpejcic/traceroute)
- [*OpenPanel > FTP > Accounts* now offers users an option to download configuration files for Filezilla and Cyberduck](/img/docs-content/02WW2ktQ-2025-07-21-18-46.png).
- *OpenPanel > Emails > Accounts > Connect Devices* now offers users an option to download configuration files for Outlook and Thunderbird.
- new config `blacklist_useragents` is available, allowing administrators to [block useragents from accessing OpenPanel UI](https://raw.githubusercontent.com/stefanpejcic/openpanel-configuration/refs/heads/main/openpanel/conf/blacklist_useragents.txt).
- [redesigned *OpenAdmin > Login* page](/img/docs-content/7DJWpPRW-2025-07-22-15-41.png).
- [redesigned *OpenPanel > Emails > Connect Devices* page](/img/docs-content/J8TbzF4Z-2025-07-21-19-18.png).
- [`opencli transfer-user` command](https://dev.openpanel.com/cli/users.html#Transfer-User)
- [OWASP CRS](https://owasp.org/www-project-modsecurity-core-rule-set/) is now automatically updated monthly.
- [`opencli waf-update`](https://dev.openpanel.com/cli/waf.html#Update) and `opencli waf-update log` commands.
- improved `/json/user_activity_status` route on OpenAdmin.
- *OpenAdmin > Users* table now has indicators if user is currently online (session is active).
- hostname domain is now checked against user domains and restricted domains list.
- `security.txt` and `robots.txt` files are now published on every update.
- *ip_blocker* module is removed.

### 🐛 Bug Fixes
- [CSF Blocklists does not work as intended #573](https://github.com/stefanpejcic/OpenPanel/issues/573)
- fixed bug with `found_a_bug_link` missing in OpenPanel UI pages.
- [Cannot set Roundcube Webmail domain #568](https://github.com/stefanpejcic/OpenPanel/issues/568)
- [opencli commands does not work #571](https://github.com/stefanpejcic/OpenPanel/issues/571)
- [DNS Zone Editor does not display DKIM key properly #572](https://github.com/stefanpejcic/OpenPanel/issues/572)
- [fail2ban in email settings does not work #574](https://github.com/stefanpejcic/OpenPanel/issues/574)
- fixed css bug causing Notificaitons item to be displayed in OpenAdmin menu for Resellers.
- fixed bug that allowed setting panel domain to be already in use by OpenPanel account.
- fixed html bug on *OpenAdmin > Users > single user* Edit tab that restricted username to 16 characters.
- fixed css issue on *OpenPanel > Emails > Create New* form with the username field not being full-width.
- fixed incorrect redirect after email creation on *OpenPanel > Emails > Create New* page.
- fixed css bug with phpmyamdin link showing in WP Manager even when feature is disabled.
- fixed bug on WP Manager with 'Debugging' tab not returning information.
- [fixed bug on WP Manager with message 'Quota limit exceeded for Google PageSpeed API. Please add an API Key' not displayed](/img/docs-content/DwvnbQk6-2025-07-22-13-05.png).
-

---

// File: changelog/1.5.1

Released on July 25, 2025

### 💅 Polish
- *OpenPanel > Emails > Address Importer*.
- Optimized the processes for adding domains and installing WordPress.
- [Implement password strength indicator on all password fields #580](https://github.com/stefanpejcic/OpenPanel/issues/580)
- `opencli config update email` command will now also update the email for LFD alerts.
- [`opencli user-check` command](https://dev.openpanel.com/cli/users.html#Check) to analyze security and files for a user.
- admin service restart now validates if configuration files exist before starting OpenAdmin.
- faster auto-login to wp-admin from WP Manager.
- descriptive error messages for failed auto-login using WP Manager.
- 'Quota limit exceeded for Google PageSpeed API. Please add an API Key.' error on WPManager is now displayed once every 24h.
- redesigned 'Files' and 'Database' widgets on WP Manager.
- improvements to Site Manager interface.
- 'VirtualHost Editor' is now migrated to a separate module.
- Editing VirtualHost file for domain is now logged in user activity log.
- Opening *OpenPanel > Crons*, *OpenPanel > MySQL > Databases*, *OpenPanel > MySQL > Users* pages no longer waits for container to start in order to access the page.
- All `opencli` commands now purge cache for *OpenPanel > Dashboard* page.

### 🐛 Bug Fixes

- fixed bug with `x-model="username" on *OpenAdmin > Login* page.
- fixed error `Option g is ambiguous (gecos, gid, group)` when creating ftp users.
- fixed error `sh: usermod: not found` deleting ftp users. 
- fixed a bug that prevented deletion of FTP sub-accounts when deleting an OpenPanel account if the FTP service was not running.
- fixed bug with 404 errors on OpenAdmin not checking if user is logged in before rendering template.
- [Disabling email services does not work #577](https://github.com/stefanpejcic/OpenPanel/issues/577)
- [Emails randomly blocked, Suspend/Allow email does not work #28](https://github.com/stefanpejcic/OpenPanel/issues/578)
- fixed csrf error saving changes in GrapeJS editor.
- [Cannot remove Node app #567](https://github.com/stefanpejcic/OpenPanel/issues/567)
- [email 993 IMAP port does not work #575](https://github.com/stefanpejcic/OpenPanel/issues/575)
- fixed *Error loading speed data* on SiteManager.
- fixed bug that caused OpenAdmin files not to be updated if any files in `/usr/local/admin/` were modified.
- [Bug in OpenAdmin UI: search not working on Cron Jobs #576](https://github.com/stefanpejcic/OpenPanel/issues/576)
- fixed bug on WP Manager with showing backups for websites.
- fixed bug on Website Builder > Installer that allowed user to create multiple sites on same domain.
- fixed bug checking if files already exists before starting WordPress installation, when subdirectory is not used.
- [Error when creating email account #588](https://github.com/stefanpejcic/OpenPanel/issues/588)

---

// File: changelog/1.5.2

Released on July 30, 2025

### 💅 Polish
- Creating user will now pre-download docker images: webserver, mysql and default php version.
- auto-login from OpenAdmin is now possible for Reseller users as well.
- added search and enable/disable all toggles on *OpenAdmin > Settings > Modules*.
- [Switches UX improvement for Features #545](https://github.com/stefanpejcic/OpenPanel/discussions/545)
- [improved error messages on *OpenAdmin > Plans*](/img/docs-content/CLyhz4g6-2025-07-28-10-48.png).
- [Disk Usage Summary on *OpenAdmin > single user* page](/img/docs-content/8pwhSjLY-2025-07-28-11-28.png).
- When changing PHP version for a domain on *OpenPanel > PHP > Select PHP version*, service will not start if there are not enough resources.
- Added links to documentaiton for Backup Destinations on `/backups/destination`.
- improved email validation and more-descriptive error messages on `/emails/import`.
- `.xlsx` extension is now supported on `/emails/import`.
- [password generation in OpenCLI scripts to run containers #28](https://github.com/stefanpejcic/opencli/issues/28)
- added type filters on **OpenAdmin > Settings > Modules**
- improvements to **OpenAdmin > Plans**: new columns to display number of users on plan, ID and description. Select which columns to display. Plan with users can not be deleted.


### 🐛 Bug Fixes
- [Bug in OpenPanel UI on sidebar menu #605](https://github.com/stefanpejcic/OpenPanel/issues/605)
- fixed bug on FileManager that caused extract not to work if `filemanager_extract_max_time` value was modified.
- [Bug in OpenPanel UI on /emails/import doesn't accept semicolon separators #590](https://github.com/stefanpejcic/OpenPanel/issues/590#issuecomment-3121668773)
- fixed error `NameError: name 'nginx_conf_path' is not defined` when removing NodeJS/Python applications.
- fixed bug on `/php/domains` page when same php version is set for domain as the current version.
- fixed bug on 2FA widget button causing redirect to `/api/account/2fa`.
- fixed error on `/process-manager` when container is restarting.
- [Bug in OpenPanel UI on /domains/log #604](https://github.com/stefanpejcic/OpenPanel/issues/604)
- [Missing Breadcrumb in Process Manager #608](https://github.com/stefanpejcic/OpenPanel/issues/608)
- [CSS bug in OpenPanel UI on /server/usage #601](https://github.com/stefanpejcic/OpenPanel/issues/601)
- [Autologin from OpenAdmin UI not working when hostname -I is private IP #592](https://github.com/stefanpejcic/OpenPanel/issues/592)
- [Bug in OpenPanel /wordpress/install mysql container is not healthy #589](https://github.com/stefanpejcic/OpenPanel/issues/589)
- [Error when creating email account #588](https://github.com/stefanpejcic/OpenPanel/issues/588)
- [Issues while installing on AlmaLinux 9 #582](https://github.com/stefanpejcic/OpenPanel/issues/582)
- [FTP - does not allow to connect after path change #594](https://github.com/stefanpejcic/OpenPanel/issues/594)
- [FTP - cannot create subfolder in domain path #595](https://github.com/stefanpejcic/OpenPanel/issues/595)
- [Bug in OpenPanel UI on /ftp/new #587](https://github.com/stefanpejcic/OpenPanel/issues/587)
- [Autologin to phpmyadmin is failing #610](https://github.com/stefanpejcic/OpenPanel/issues/610)
- [FTP - password change does not work #596](https://github.com/stefanpejcic/OpenPanel/issues/596)
- [Bug with OpenPanel FTP when creating or uploading files/folder inside /var/www/html #613](https://github.com/stefanpejcic/OpenPanel/issues/613)

---

// File: changelog/1.5.3

Released on August 04, 2025

### 💅 Polish
- *backups* module is no longer enabled by default for new installations.
- *DNS Zone Editor* selector now displays only domains that have zones on the server.
- Apex domains can no longer be deleted if they are in use by a subdomain.
- public suffixes (TLDs) can no longer be added as domains.
- [Prevent usage of subdomains by other users #581](https://github.com/stefanpejcic/OpenPanel/issues/581)
- Improvements to *OpenPanel > Domains* page.
- [added type and websites count columns to Domains](/img/docs-content/kCj8Fcsz-2025-07-31-17-54.png).
- [Improvements to Database Wizard interface and validations](/img/docs-content/rVBfJ0tY-2025-07-31-19-08.png).
- Emails usage is now refreshed hourly for logged in OpenPanel users.
- watcher service is migrated from openadmin git repository to openpanel-configuration.
- sentinel service is migrated from openadmin git repository to opencli.
- [[Enhancement] Make this date human readable #555](https://github.com/stefanpejcic/OpenPanel/issues/555)

### 🐛 Bug Fixes
- [Bug in OpenPanel UI on /dashboard double path in sidebar for favorites #599](https://github.com/stefanpejcic/OpenPanel/issues/599)
- [Bug in OpenPanel UI on /wordpress/install #614](https://github.com/stefanpejcic/OpenPanel/issues/614)
- fixed error starting OpenPanel UI if `/etc/openpanel/openpanel/custom_code/in_footer.html` or `/etc/openpanel/openpanel/custom_code/in_header.html` files are missing.
- [install.sh: port output is doubled! #616](https://github.com/stefanpejcic/OpenPanel/issues/616)
- [install.sh: firewalld disable #615](https://github.com/stefanpejcic/OpenPanel/issues/615)
- [Bug in OpenPanel UI on /files - Ctrl + A in input fields triggers select-all on table #598](https://github.com/stefanpejcic/OpenPanel/issues/598)
- fixed csrf bug in DNS Zone Editor when deleting individual records.
- [Bug in OpenPanel UI on /domains/edit-dns-zone/in.rs - drawer height #597](https://github.com/stefanpejcic/OpenPanel/issues/597)
- fixed bug deleting user when no quotas exist */usr/local/opencli/user/delete.sh: line 121: /etc/openpanel/openpanel/core/users/repquota: No such file or directory*.
- fixed css bug with sidebar on OpenAdmin not showing 'Advanced' menu active when 'Demo Mode' page is opened.
- fixed bug on *OpenAdmin > License* displaying 'No License Key' in the field when no key is added.
- fixed css bug with progress bar on *OpenPanel > Email Accounts* showing 100% usage for unlimited quota.
- [Bug in OpenPanel UI on /cache/elasticsearch - status is Unknown #602](https://github.com/stefanpejcic/OpenPanel/issues/602)

---

// File: changelog/1.5.4

Released on August 07, 2025

### 💅 Polish
- [Administrators can now edit services from *OpenAdmin > Users > single user > Services* page](/img/docs-content/Fzk7dJMd-filem-2025-08-05-15-43-40-ezgif-com-video-to-gif-converter.gif).
- [Trash folder [FEATURE REQUEST] #526](https://github.com/stefanpejcic/OpenPanel/issues/526)
- cleanup on failure for WordPress Install will now delete only WP core files.
- [Option for users to add custom docker services [FEATURE REQUEST] #525](https://github.com/stefanpejcic/OpenPanel/issues/525)
- [OpenAdmin > Security > ImunifyAV](/img/docs-content/3KFwf2XR-2025-08-04-12-51.png)
- [`opencli imunify` command](https://dev.openpanel.com/cli/imunify.html).
-`opencli domains-all --json` and `opencli user-list --json` show dictionaries in order to be compatible with ImunifyAV scripts.
- the following actions on *Openpanel > Containers* are now logged to user's activity log: add/edit/delete service, update cpu/ram, execute terminal command, change image tag, pull image, switch mysql/webserver type.

### 🐛 Bug Fixes
- [Bug in OpenPanel UI on /files for Copy drawer #619](https://github.com/stefanpejcic/OpenPanel/issues/619)
- [Bug in OpenPanel UI on /files Unexpected error occurred while creating the folder. #623](https://github.com/stefanpejcic/OpenPanel/issues/623)
- [Bug in OpenAdmin UI on /users/1ssa#storage - data is not loaded on #storage until tab is clicked! #606](https://github.com/stefanpejcic/OpenPanel/issues/606)
- fixed 500 error on *OpenAdmin > Users > singe user > Services* and *OpenPanel > Containers* when `deploy` section is missing for services.
- fixed broken link for `Docker` on breadcrumbs.

---

// File: changelog/1.5.5

Released on August 08, 2025

### 💅 Polish
- [Option to set custom port for NODE and PYTHON apps [FEATURE REQUEST] #618](https://github.com/stefanpejcic/OpenPanel/issues/618)
- [Improvements to *OpenPanel > Dashboard > Usage* widget](/img/docs-content/PhmYgBBf-2025-08-08-12-23.png).
- [Improvements to *OpenPanel > PM2 > Install* page](/img/docs-content/44WNtCkb-2025-08-07-15-47.png).
- [`/api/auto-installer` endpoint](https://dev.openpanel.com/openpanel-api/#AutoInstaller).
- `/wp-verify-checksum` route is renamed to `/wp-cli/verify-checksum`.
- `/wp-download-core` route is renamed to `/wp-cli/download`.
- `/wp-shuffle-salts` route is renamed to `/wp-cli/shuffle-salts`.
- `/wp-cache` route is renamed to `/wp-cli/cache`.
- `/wp-maintenance-mode` route is renamed to `/wp-cli/maintenance-mode`.
- `/get_login_link` route is renamed to `/wp-cli/login`.
- [Added options to reinstall all plugins and check plugins checksum on WP Manager](/img/docs-content/mrq5V6Km-2025-08-07-19-16.png).
- *OpenPanel > Dashboard > Statistics* widget is merged with *OpenPanel > Dashboard > Usage* widget.
- Optimized WordPress Install process: adding autologin mu plugin is now performed in background.
- Removed timeout limit for `backup` command executed via *OpenPanel > Docker > Terminal* for `backup` service.

### 🐛 Bug Fixes
fixed bug with WP Manager always setting `domain/subdirectory` for installation instead of using `docroot/subdirectory`.
- [Bug in OpenPanel UI on /mysql/import OCI runtime exec failed: `exec failed: unable to start container process: exec: "mysql": executable file not found in $PATH: unknown #624`](https://github.com/stefanpejcic/OpenPanel/issues/624)
- [fixed bug with `MemPerc` returning incorrect values on  *OpenPanel > Dashboard > Usage* widget](/img/docs-content/TwsjyyFH-2025-08-08-12-46.png).
- fixed bug with `how_to_topics` widget not displaying on *OpenPanel > Dashboard*.
- fixed css bug with table head on *OpenPanel > PHP > Extensions*.
- fixed title and sidebar active state for 'PHP Extensions' and 'PHP.INI Editor'.
- fixed bug with 'Open phpMyAdmin' icon on Dashboard not opening in new tab.
- fixed bug uninstall WP from WP Manager due to CSRF token missing.
- fixed bug installing WordPress from WP Manager if mysql/mariadb container was previously stopped.

---

// File: changelog/1.5.6

Released on August 15, 2025

### 💅 Polish
- [BETA support for OpenLitespeed](https://community.openpanel.org/d/180-beta-testers-wanted-openlitespeed-openpanel)
- [Added RNAME to default DNS zone templates](/docs/admin/domains/dns_templates/#available-template-variables) - suggested by Dominik.
- added descriptive error messages for failed auto-login on WP Manager.
- added [*OpenAdmin > Services > Limits*](/docs/admin/services/limits) page where Administrators can set limits for webserver, dns, openpanel UI and other system services.
- `fonts.googleapis.com`, `gstatic.com`, `api.github.com`, `app.grapesjs.com`, `fonts.bunny.net` and `fonts.gstatic.com` removed from CSP header.
- added html IDs to all sections in *OpenPanel > Dashboard* to be used for custom css.
- `Failed to load speed data` is removed from /sites when data is missing.
- [password reset functionality is restored](https://openpanel.com/docs/panel/intro/#password-reset).
- *restart needed* button on OpenAdmin > Dashboard is now visible to Reseller users as well.
- [Added resource usage widget on top-right of OpenAdmin](/docs/admin/dashboard/#sse-usage).


### 🐛 Bug Fixes
- [Bug in OpenPanel UI: VHost Editor shows in search when module is disabled #627](https://github.com/stefanpejcic/OpenPanel/issues/627)
- [Error on /domains/redirect NameError: name 'get_redirect_url' is not defined. Did you mean: 'set_redirect'? #629](https://github.com/stefanpejcic/OpenPanel/issues/629)
- [Bug in OpenPanel UI on / when adding to Favorites - Link and title must be provided #628](https://github.com/stefanpejcic/OpenPanel/issues/628)
- [WP Autologin not working after 1.5.5 update #631](https://github.com/stefanpejcic/OpenPanel/issues/631)
- [WordPress Uninstall not working after 1.5.5 update #630](https://github.com/stefanpejcic/OpenPanel/issues/630)
- fixed bug with `opencli imunify install` downloading imunify via IPv6.
- fixed startup bug `ERROR importing module 'action': No module named 'modules.action'`
- fixed bug on WP auto-login when subdirectory is used but docroot is passed from frontend.
- fixed css bugs with breadcrumbs on *OpenAdmin > Security > ImunifyAV* page.
- [Can't disable services for user #632](https://github.com/stefanpejcic/OpenPanel/issues/632)
- fixed typo causing redirects module not to load on UI.
- fixed css bug with resource usage flickering on page load on *OpenAdmin > Dashboard* page.
- fixed issue detecting redirects for domain, causing each domain to show `redirects` text.
- fixed error saving redirects: `TypeError: cannot pickle 're.Match' object` when dev_mode is enabled.
- fixed bug redirecting to `/api/domains` after creating a redirect from `/domains`.
- fixed bug with redirects field accepting only https and not http links.
- [On Export DNS Zone option, error is logged #655](https://github.com/stefanpejcic/OpenPanel/issues/655)

---

// File: changelog/1.5.7

Released on August 22, 2025

### 💅 Polish
- 'mariadb' is now set as default database server for new installations.
- '8.3' is now set as default php version for new installations.
- [Support for OpenLiteSpeed [FEATURE REQUEST] #321](https://github.com/stefanpejcic/OpenPanel/issues/321)
- [Domains > Redirects - add support for custom ports [FEATURE REQUEST] #646](https://github.com/stefanpejcic/OpenPanel/issues/646)
- `/domains/ssl` and `/domains/docroot` pages are now in separate modules: `ssl` and `docroot`.
- Refactored `goaccess` module.
- `/phpmyadmin/manage` route is removed.
- ['mautic' module is added, allowing users to Auto-install Mautic](/docs/articles/websites/how-to-install-mautic-with-openpanel/).
- Fixed bug starting php and webserver when domain is added, on plan that has DNS only features.
- [Improvements to *OpenAdmin > Settings > User Defaults* page](/img/docs-content/LHnv8McC-2025-08-20-16-08.png).
- `--csf` flag is removed from install script.
- Administrators can now edit Caddyfile or VirtualHosts files for domains from *OpenAdmin > Domains*.
- added descriptive error messages to all `/domains` pages on OpenAdmin.
- all `/wordpress/site/` routes are renamed to `/wordpress/wp-cli/`.
- 'Import Database' page now displays mysql_type: MariaDB or MySQL.
- Added 'Show Debug' option on *OpenPanel > Domains > Add New* page.

### 🐛 Bug Fixes
- [WP Autologin for OpenLitespeed is 404 #647](https://github.com/stefanpejcic/OpenPanel/issues/647)
- [Bug in OpenPanel UI on /website: fail to restore database backups #583](https://github.com/stefanpejcic/OpenPanel/issues/583)
- ['Debugging' tab on WP Manager does not fetch data #653](https://github.com/stefanpejcic/OpenPanel/issues/653)
- [Only first domain is working in OpenLitespeed #643](https://github.com/stefanpejcic/OpenPanel/issues/643)
- [xterm fixed width on OpenAdmin > Terminal #644](https://github.com/stefanpejcic/OpenPanel/issues/644)
- [Bug in OpenPanel UI on /account/notifications - email not sent #638](https://github.com/stefanpejcic/OpenPanel/issues/638)
- [WordPress asking for FTP credentials (Litespeed) #636](https://github.com/stefanpejcic/OpenPanel/issues/636)
- [Bug on /sites - tooltip not showing on hover over pagespeed #635](https://github.com/stefanpejcic/OpenPanel/issues/635)
- [Domains > Redirects work only for HTTP and not for HTTPS #645](https://github.com/stefanpejcic/OpenPanel/issues/645)
- [Error adding domain after 1.5.6 update: ERROR 2026 (HY000): TLS/SSL error: self-signed certificate in certificate chain #640](https://github.com/stefanpejcic/OpenPanel/issues/640)
- [Bug after 1.5.6 update on *Dashboard > 2FA widget* #641](https://github.com/stefanpejcic/OpenPanel/issues/641)
- [Caddy Logs in OpenAdmin: The log file is empty. #648](https://github.com/stefanpejcic/OpenPanel/issues/648)
- [FTP sub-user can no longer modify files after adding domain in same dir #609](https://github.com/stefanpejcic/OpenPanel/issues/609)
- Fixed bug `/entrypoint.sh: line 27: echo [!] Creating include section for domain: josjedan.rs: command not found` when adding domains for openlitespeed webserver.
- Fixed bug on *OpenAdmin > Advanced > System Cron Jobs* with 'opencli sentinel' commands.
- [Bug in OpenAdmin UI on /settings/open-panel #642](https://github.com/stefanpejcic/OpenPanel/issues/642)
- fixed bug with SSL and Docroot icons missing in *OpenPanel > Dashboard*.
- fixed bug with 'MySQL Version' text on WP Manager when MariaDB is used.
- fixed error generating files backup from WP Manager when subdomain is used.
- fixed caching issue on `/temporary-link` from WP Manager causing same link to be displayed for all websites for 15min.
- fixed bug with SSL missing in OpenPanel UI search.
- fixed bug with ImunifyAV missing in OpenAdmin UI search.
- fixed bug with `docker` service not started on install if `--rapair` flag is used to retry installation.
- fixed css bugs with log sectiosn on *OpenAdmin > Services > Logs*.
- [Bug in OpenAdmin UI on *Settings > Emails* after updating webmail domain #634](https://github.com/stefanpejcic/OpenPanel/issues/634)
- fixed 404 error on `/cache/varnish` page.

---

// File: changelog/1.5.8

Released on August 25, 2025

### 💅 Polish
- [Advanced option for *OpenAdmin > Settings > User Defaults* page](/docs/admin/settings/defaults).
- [`domain_log_per_page`](https://dev.openpanel.com/cli/config.html#domain-log-per-page) value for new installations is reduced from `1000` to `500`.
- [Added `permit_username_change_by_user` option that allows administrators to disable username change by end-users](https://dev.openpanel.com/cli/config.html#permit-username-change-by-user).
- Added `permit_subdomain_sharing` option that allows administrators to allow subdomain sharing among different accounts.
- added timeout to slave dns zone creation when adding domains.
- [MySQL connection details are now displayed in both *Databases* and *Remote MySQL* pages](/img/docs-content/S4ZCzNkk-2025-08-25-16-20.png).
- Enhanced domain ownership validation on *varnish*, *dns*, *capitalize_domains*, *docroot*, *domain_logs*, *edit_vhost*, *redirects*, *ssl*, *domains*, *emails*, *goaccess*, *screenshots*, *mautic*, *php*, *pm2*, *temporary_links*, *waf*, *website_builder*, *websites*, and *wordpress* modules.
- added descriptive error messages for `403` pages in OpenPanel UI.
- install.sh will now dispaly status of cron service and if cronfile was added.
- [Documented system cronjobs](https://dev.openpanel.com/crons.html).
- added note on *OpenAdmin > Settings > Modules* for ClamAV that ARM CPU is not supported.
- removed classes `file:-my-2 file:-ml-2.5 file:cursor-pointer file:rounded-l-[5px] file:rounded-r-none file:border-0 file:px-3 file:py-2 file:outline-none focus:outline-none disabled:pointer-events-none file:disabled:pointer-events-none file:border-solid file:border-gray-300 file:bg-gray-50 file:text-gray-500 file:hover:bg-gray-100 file:dark:border-gray-800 file:dark:bg-gray-950 file:hover:dark:bg-gray-900/20 file:disabled:dark:border-gray-700 file:[border-inline-end-width:1px] file:[margin-inline-end:0.75rem] file:disabled:bg-gray-100 file:disabled:text-gray-500 file:disabled:dark:bg-gray-800` from all OpenPanel UI templates.
- Improvements to the update script.
- System, kernel and docker-compose update are now performed only on *MAJOR* version updates.
- Percona MySQL server is tested as drop-in replacement, and documented: [How to set MySQL, MariaDB, or Percona per user](https://openpanel.com/docs/articles/docker/how-to-set-mysql-mariadb-per-user-in-openpanel/)

### 🐛 Bug Fixes
- [WP autoinstall does not generate salts #662](https://github.com/stefanpejcic/OpenPanel/issues/662)
- [How can end-users view rule ID for WAF? #657](https://github.com/stefanpejcic/OpenPanel/issues/657)
- [When MariaDB is used, visiting dashboard logs Error response from daemon: No such container: mysql #656](https://github.com/stefanpejcic/OpenPanel/issues/656)
- fixed css bug preventing saving "how_to_guides", "found_a_bug_link", "ip_county_flag", "twofa_nag", "password_reset", "weakpass", "permit_subdomain_sharing" from *OpenAdmin > Settings > OpenPanel*.
- [WP autoinstall exits on: Shuffling WordPress Salts in wp-config.php file #661](https://github.com/stefanpejcic/OpenPanel/issues/661)
- [OpenAdmin > FTP accounts list empty after 1.4.8 update #658](https://github.com/stefanpejcic/OpenPanel/issues/658)
- fixed bug that causes user's files in *FileManager > Trash* to be owned by `root` user.
- fixed js bugs on *FileManager* and *Trash* pages with saving column preferences for user.

---

// File: changelog/1.5.9

Released on August 29, 2025

### 💅 Polish
- Added '[How to setup your email client](/docs/articles/email/how-to-setup-your-email-client)' link on *OpenPanel > Emails > Connect Devices*.
- [Default screenshot API is migrated from `http://screenshots-api.openpanel.com/screenshot` to `http://screenshots-v2.openpanel.com/api/screenshot`](https://github.com/stefanpejcic/OpenPanel/commit/b2359dd7efe3ddfec9573be21e3d7fe028a8039b).
- `/json/services/<username>` route on OpenAdmin is removed.
- `/login/token?username=<username>` route on OpenAdmin is renamed to: `/login/token/<username>`.
- `/core/search_filter` route on OpenAdmin is renamed to: `/search/pages`.
- `/core/search_users` route on OpenAdmin is renamed to: `/search/users`.
- `/core/search_websites` route on OpenAdmin is renamed to: `/search/websites`.
- Documented `?output=json` pages and resonses in OpenAdmin.
- install script will no longer exit if quotas install failed, instead will just display a warning.
- for new installations on AlmaLinux, mariadb client will be used instead of mysql.
- edited install script to remove usage of `$HOME` so that it can be used by Hossted.

### 🐛 Bug Fixes
- [Selecting files class missing until row is clicked on Files > Trash #664](https://github.com/stefanpejcic/OpenPanel/issues/664)
- Fixed 500 error `File "<frozen 2087.modules.notifications>", line 290, in view_notifications TypeError: unhashable type: 'list'` on OpenAdmin > Notifications when `?output=json`.
- Fixed bug with `opencli sentinel` reporting ssh connections count as ip addresses.
- Fixed bug in *OpenPanel > Containers* with max value for cpu/memory preventing edit.
- Fixed bug `Warning: WEB_SERVER must be 'nginx', 'apache', 'openlitespeed', 'litespeed', or 'openresty', got 'openlitespeed'` when creating user.
- [*Domain X added successfully* message displayed twice when adding domain #660](https://github.com/stefanpejcic/OpenPanel/issues/660)
- fixed 404 error editing domain VirtualHost from *OpenAdmin > Domains > Edit Vhost* option.

---

// File: changelog/1.6.0

Released on September 12, 2025

### 💅 Polish
- Updated CSF download source to use [SentinelFW](https://github.com/stefanpejcic/sentinelfw) - fork of ConfigServer Firewall & Security.
- [Added descriptive error messages to OpenAdmin](/img/docs-content/BbVs5HdR-2025-09-05-19-31.png).
- [added status flag for `opencli user/varnish` command](https://dev.openpanel.com/cli/users.html#Varnish).
- added 'New Service' button in *OpenPanel > Containers* page allowing users to add new docker services.

### 🐛 Bug Fixes
- [500 Error on OpenAdmin auto-login with domain using sustom SSL #671](https://github.com/stefanpejcic/OpenPanel/issues/671)
- [Bug deleting feature set in OpenAdmin #670](https://github.com/stefanpejcic/OpenPanel/issues/670)
- [Login to OpenPanel Button - Error 500 #671](https://github.com/stefanpejcic/OpenPanel/issues/671)
- fixed CORS errors loading website favicons on Site Manager when custom domain and SSL is used.
- [CSRF error deleting favorite on /account/favorites #672](https://github.com/stefanpejcic/OpenPanel/issues/672)
- [phpmyadmin login link: redirected you too many times. #668](https://github.com/stefanpejcic/OpenPanel/issues/668)
- fixed 403 error on phpmyadmin autologin for users created before 1.4.5 update.
- fixed [500 error on OpenPanel UI autologin from OpenAdmin](https://community.openpanel.org/d/191-500-error-on-openpanel-ui-autologin-from-openadmin)
- [fixed error in install script with setting SWAP size on installation](https://github.com/stefanpejcic/OpenPanel/pull/682/files)
- [fixed bug with `opencli imunify` command not updating panel version](https://github.com/stefanpejcic/opencli/pull/40/files).
- [fixed bug with `opencli faq` command not properly detecting custom ssl](https://github.com/stefanpejcic/Opencli/issues/41).
- [fixed bug with varnish starting if run from terminal, regardless of users resource limits](https://github.com/stefanpejcic/opencli/issues/2).
- [Cache widget on WPManager displays php warnings #681](https://github.com/stefanpejcic/OpenPanel/issues/681)
- [Bug in OpenAdmin UI: saving email client results in 404 #678](https://github.com/stefanpejcic/OpenPanel/issues/678)

---

// File: changelog/1.6.1

Released on September 23, 2025

### 💅 Polish
- [Debian 13 is now suported](https://github.com/stefanpejcic/OpenPanel/issues/674)
- Added print statements for all core modules in OpenPanel and OpenaAdmin, detailed debug information is now visible when `dev_mode=on`.
- [ImunifyAV is no longer installed automatically](https://community.openpanel.org/d/193-dont-install-imunifyav-by-default), instead [optional `--imunifyav` flag](/install) is available to install it.
- implemented success and error messages on *OpenAdmin > Settings > General*.
- openpanel error log will now on startup display domain and ssl certificates used.
- Responsive tables on OpenAdmin pages: Administrators, Resellers, Cluster, Domains, Email Accounts, Notifications, Hosting Packages, WAF Rules, System CronJobs, FTP Accounts, Services Status, Feature Manager, Process Manager.
- `geoip` is no longer used on OpenAdmin and OpenPanel.
- Adjusted notification text on /domains/new failure to provide accurate info.
- Example OpenPanel plugins: [dns-visualizer](https://github.com/stefanpejcic/dns-visualizer) and [domain-diagnostics](https://github.com/stefanpejcic/domain-diagnostics).
- Added tooltips on *OpenAdmin > Settings > Modules* to indicate that plugins are auto-activated and enterprise license is required for premium features.
- Added optional '--debug' flag to [`opencli user-resources` command](https://dev.openpanel.com/cli/users.html#Resources), displaying commands used if service start/stop fails from OpenAdmin.
- Improvements to the OpenAdmin > Users > Resellers pages.

### 🐛 Bug Fixes
- [Sidebar missing on OpenAdmin > Emails > Summary - when mailserver not running #695](https://github.com/stefanpejcic/OpenPanel/issues/695)
- [FTP Server Passive mode incorrectly configured #680](https://github.com/stefanpejcic/OpenPanel/issues/680)
- [OpenAdmin > Service table not responsive #694](https://github.com/stefanpejcic/OpenPanel/issues/694)
- [On install architecture can not be detected if locale is not en_US #689](https://github.com/stefanpejcic/OpenPanel/issues/689)
- fixed error installing on debian when `linux-image-amd64` package is missing.
- fixed error detecting ip address on install.sh
- fixed bug `log_debug: command not found` when installing mail server.
- fixed typo in *OpenAdmin > Emails* when mailserver is not running.
- fixed bug in `opencli admin` command with http always being used in admin_url.
- fixed `Error during email import: Failed to run opencli: /usr/local/opencli/email/setup.sh: line 51: /usr/local/admin/opencli/enterprise.sh: No such file or directory` when accessing Dashboard.
- [Install script failes on CentOS 9 for dbus-user-session #698](https://github.com/stefanpejcic/OpenPanel/issues/698)
- fixed `CSS bug: PHP.INI Editor not highlighted in menu when on: /php/php_ini_editor`
- fixed issue with enabling *New OpenPanel update is available* notifications in OpenAdmin > Notifications settings
- fixed issue where a negative value was sometimes displayed for time since last measurement in Openpanel > Dashboard
- [CSS bugs in OpenAdmin UI on SSH keys #691](https://github.com/stefanpejcic/OpenPanel/issues/691)
- [OpenAdmin > Settings > Update Preferences: '>' not supported between instances of 'str' and 'NoneType' #700](https://github.com/stefanpejcic/OpenPanel/issues/700)
- [Bug in Inodes Explorer module: /bin/sh: 1: cd: can't cd to X #686](https://github.com/stefanpejcic/OpenPanel/issues/686)
- fixed error installing imunifyAV on ARM CPU.
- [Imunify av, no service deamon ? #685](https://github.com/stefanpejcic/OpenPanel/issues/685)
- fixed bug fetching system packages on *OpenAdmin > Dashboard* for Debian-based distros.

---

// File: changelog/1.6.2

Released on September 30, 2025

### 💅 Polish
- Improvements to reseller mode: feature sets per reseller, option for reseller to change password from OpenAdmin, Dashboard page for resellers.
- OpenAdmin login page now includes custom code in header and footer (from *openadmin > settings > custom code*).

### 🐛 Bug Fixes
- Fixed bug that allowed reseller to view all plans if they currently have no assigned plans.
- Fixed bug dispalying notifications count on OpenAdmin dashbaord to reseller users.
- Fixed error `list object has no element 0` on *OpenAdmin > Users > New* when reseller has no plans assigned.
- fixed error `cannot access local variable 'e' where it is not associated with a value` on *OpenAdmin > Services Status > Edit*.
- [Error in /services #704](https://github.com/stefanpejcic/OpenPanel/issues/704)
- fixed bug in `opencli user-add` that prevented updating current accounts count for resellers.
- [phpMyAdmin fails with 500 error (service not starting automatically) #707](https://github.com/stefanpejcic/OpenPanel/issues/707)

---

// File: changelog/1.6.3

Released on October 17, 2025

### 💅 Polish
- Added [flock](https://linux.die.net/man/1/flock) to `opencli update` command.
- Improvements to `opencli plan-apply`: the system now checks whether the new plan’s RAM limit is lower than the combined RAM usage of all running services. If so, a warning will be logged.
- https://php.watch/api/v1/versions is replaced in *OpenPanel > PHP* and *OpenAdmin > Setitngs > PHP* with https://php-versions-api.openpanel.org/
- Documented [Setting default user locale](https://openpanel.com/docs/articles/accounts/default-user-locales/#4-default-locale) and [added option in *OpenAdmin > Settings > Locales* to set a default locale](/img/docs-content/px5kmYYX-slika.png).
- [Added option in in *OpenAdmin > Settings > Custom Code* to execute bash script before starting OpenPanel UI](/img/docs-content/CwzSfxJM-slika.png) using [`/root/openpanel_run_on_startup`](https://dev.openpanel.com/customize.html#Before-startup) file.
- [Added option to view cronjob execution log on *OpenPanel > Advanced > CronJobs*](/img/docs-content/zXx0LDMm-slika.png).
- Improvements to *OpenPanel > AutoInstaller* backend logic.
- Improvements to 'Information' widget on *OpenPanel > Dashboard*.
- [Added `--docroot` flag to opencli domains-whoowns command](https://github.com/stefanpejcic/opencli/commit/f9bc92781bc68a2046ede74ab712ecc1cbd4b3ae)
- [`opencli domains-edit` command](https://dev.openpanel.com/cli/domains.html#Edit-domains) to cd into domain's docroot, or edit it's VirtualHosts file from the terminal.

### 🐛 Bug Fixes
- [Bug in OpenPanel UI on /files: error opening file unl.rs/og-image.png #724](https://github.com/stefanpejcic/OpenPanel/issues/724)
- [Creating and deleting Node.js app causes container start error #726](https://github.com/stefanpejcic/OpenPanel/issues/726)
- [Bug in OpenAdmin search if there is only a single account for reseller #705](https://github.com/stefanpejcic/OpenPanel/issues/705)
- [Bug in OpenPanel UI on File Editor for Windows characters #725](https://github.com/stefanpejcic/OpenPanel/issues/725#event-20315260100)
- [Bug in OpenPanel UI on /files when compressing files #727](https://github.com/stefanpejcic/OpenPanel/issues/727)
- [Node.js app deletion does not remove proxy from Nginx config, causing domain failure #717](https://github.com/stefanpejcic/OpenPanel/issues/717)
- [Bug in OpenAdmin UI - Changes to reseller's limits are not being applied #721](https://github.com/stefanpejcic/OpenPanel/issues/721)
- [Node.js app deletion does not remove proxy from Nginx config, causing domain failure #717](https://github.com/stefanpejcic/OpenPanel/issues/717)
- [Bug in OpenAdmin UI > OpenAdmin Basic Auth - 500 | name 'username' is not defined #710](https://github.com/stefanpejcic/OpenPanel/issues/710)
- [Bug in OpenPanel UI: 500 error on Manage website in SiteManager #709](https://github.com/stefanpejcic/OpenPanel/issues/709)
- [Bug in OpenPanel > SiteManager - incorrect path for requirements.json when NodeJS app is setup in a subdirectory #711](https://github.com/stefanpejcic/OpenPanel/issues/711)
- [fixed bug saving SMTP settings on *OpenAdmin > Settings > Notifications* due to incorect input type on sender field](https://discord.com/channels/1205652108213485568/1205652108213485571/1423569978912800828).
- fixed css bug on OpenAdmin and OpenPanel templates: `/templates/system/license_error.html`.
- fixed error `Invalid tempfile ownership [$file]` when loading [Sentinel Firewall](https://sentinelfirewall.org/) UI inside OpenAdmin if linux user named `openpanel` already exists.

---

// File: changelog/1.6.4

Released on October 23, 2025

### 💅 Polish
- Added ['services' module](/img/docs-content/08pmwZFG-slika.png), enabling users to view system service statuses, start or stop services, and monitor current resource usage.
- When mysql conneciton fails, OpenAdmin will now display a generic message: *Error Establishing a Database Connection*.
- Removed dummy cronjob example from new installations.
- All required input fields on OpenPanel forms are now marked with an asterisk.
- 'healthcheck' mysql user is now considered a system user from 'OpenPanel > MySQL > Users'.
- Added jinja template caching on OpenPanel.
- Improved locale functions on OpenPanel.
- [Redis, Memcached, Elasticsearch, Opensearch and Varnish pages will now display real-time resurce usage if service is active and 'docker' feature enabled for user](/img/docs-content/MxCWSDrj-2025-10-22-17-22.png).

### 🐛 Bug Fixes
- [Can't use special chars on Administrator password #737](https://github.com/stefanpejcic/OpenPanel/issues/737)
- [Node js website unable to install requirements #730](https://github.com/stefanpejcic/OpenPanel/issues/730)
- [visual bug in /website?domain #735](https://github.com/stefanpejcic/OpenPanel/issues/735)
- fixed css bug with backgound on hover over icons in *OpenPanel > Dashboard*.
- [fixed css bug on *Firewall* widget on Site Manager](/img/docs-content/qqGKZ1Cm-2025-10-20-14-11.png).
- [Bug in OpenPanel UI on /cronjobs - Cronjob preset for every minute actually runs every second #729](https://github.com/stefanpejcic/OpenPanel/issues/729)
- [unable to Delete/Detach Website Builder /website?domain= #739](https://github.com/stefanpejcic/OpenPanel/issues/739)
- [after creating new user will not send email/user/new #738](https://github.com/stefanpejcic/OpenPanel/issues/738)
- fixed caching issue on nodejs/python app logs, causing logs to be cached for 60s.
- [opencli error](https://dev.openpanel.com/cli/error.html#Error) command can now be used only when dev_mode is enabled.

---

// File: changelog/1.6.5

Released on October 24, 2025

💅 Polish
- docker compose plugin for new installations is now updated from v2.30.3 to [v2.40.2](https://docs.docker.com/compose/releases/release-notes/#2402).
- improved `opencli imunify install` command to display errors and abort if imav service install failed (unsupported os or CPU by Imunify).
- [Option to add a custom startup command for Node apps #733](https://github.com/stefanpejcic/OpenPanel/discussions/733)
- Added tooltips to all options when [editing Python/Node applications](/img/docs-content/VmkXHfjV-2025-10-24-15-04.png) and for [WordPress Installer](/img/docs-content/W3BN207m-2025-10-24-15-27.png).
- Added option in *OpenAdmin > Settings > Notifications* to disable checking if configured nameservers resolve to the server.
- OpenAdmin no longer displays editing options for DNS when 'dns' module is disabled.
- Improved templates: header and footer are in separate html files.

### 🐛 Bug Fixes
- Fixed several bugs in install script - thanks to NeoNomad to reporting!
- fixed css bug on 'service status' widget in top-right corner of OpenPanel UI pages.
- fixed error saving ssh settings on openadmin: ` "500 name 'command' is not defined"`
- fixed 500 errors on 'MySQL > Users', 'PHP > Settings' and 'PHP > PHP.INI Editor' pages.
- fixed js bug on login form: *Uncaught ReferenceError: convertToLowerCase is not defined*.
- fixed js bug importing punnycode cdn: *module is not defined*.
- fixed incorect tooltip ids on openadmin > sse widget.

---

// File: changelog/1.6.6

Released on October 29, 2025

💅 Polish
- [PostgreSQL support #501](https://github.com/stefanpejcic/OpenPanel/issues/501)
- [added an option for 'PMA_ABSOLUTE_URI' per user to be used in their phpmyadmin service](https://discord.com/channels/1205652108213485568/1205652108213485571/1432304746647261205).
- [option to specify PNPM or NPM for nodejs apps #734](https://github.com/stefanpejcic/OpenPanel/discussions/734)
- CSS improvements to MySQL & PostgreSQL Wizard pages.

### 🐛 Bug Fixes
- [WordPress autologin plugin fails to install #748](https://github.com/stefanpejcic/OpenPanel/issues/748)
- [DNS resolve not working for user's www network #750](https://github.com/stefanpejcic/OpenPanel/issues/750#issuecomment-3456613420)
- [WordPress installation doesn't appear in site manager after installing, shows up after scan #747](https://github.com/stefanpejcic/OpenPanel/issues/747)
- fixed error `/usr/local/opencli/sentinel.sh: eval: line 979: unexpected EOF while looking for matching ''`
- Fixed CSS issue with table columns on Domains page.
- Fixed 500 error on POST request when creating mysql users: */mysql/user*.
- [Fresh install can't list users #736](https://github.com/stefanpejcic/OpenPanel/issues/736)
- Fixed js error on WP Manager causing PHP version and database login not to display.

---

// File: changelog/1.6.7

Released on November 05, 2025

### 💅 Polish
- [Complete Spanish translation](https://github.com/stefanpejcic/OpenPanel/pull/760) - thank you [Santi Casals](http://casa.ls/)
- Improvements to DNS Clustering feature.
- [150+ actions inside OpenPanel UI are now recorded in user's activity log](/docs/panel/account/account_activity).
- [Improvements to *OpenAdmin > Dashboard* page](/img/docs-content/R4Yd6DTg-2025-10-30-18-13.png).
- [Add option to edit php limits for phpmyadmin #563](https://github.com/stefanpejcic/OpenPanel/discussions/563)
- Same 'Logs' section is now reused on all pages: Redis, ElasticSearch, OpenSearch, Memcached, Varnish, phpMyAdmin, pgAdmin, Services.
- Added [`favorites_items` option](https://dev.openpanel.com/cli/config.html#favorites-items).
- 'BETA' filter is hidden on *OpenAdmin > Settings > Modules* as currently there are no beta modules available.
- Added [`favicons` option](https://dev.openpanel.com/cli/config.html#favicons) allowing user to specify api to use for favicons.
- fix_permissions module is no longer auto-active on new installs.
- Localization for all Backups templates: Settings, Destinations, Overview.
- Template macros for common elements in Inodes Explorer and Disk Usage modules.
- File Editor now supports setting fullscreen via url, example: `&fullscreen=false` `&fullscreen=true`.
- Command `opencli server-motd` is removed.
- Added missing Usage and Description for opencli commands.
- Actions bar on *OpenPanel > FileManager* is now sticky on scroll.
- 'link' and 'websites' columns on *OpenPanel > Domains* are now visible by default.

### 🐛 Bug Fixes
- [Configure new file/folder name in File Manager on Copy/Move actions #759](https://github.com/stefanpejcic/OpenPanel/issues/759)
- [Adding server to DNS Clustering causes syntax errors in named.conf.options #751](https://github.com/stefanpejcic/OpenPanel/issues/751)
- [Change username field is shown when option is disabled #757](https://github.com/stefanpejcic/OpenPanel/issues/757)
- Fixed css bug on toast notifications when mobile.
- Fixed error *ERROR:openpanel:UnboundLocalError: cannot access local variable 'mail_services_running' where it is not associated with a value* on OpenPanel > Webmail when mailserver module is enabled but not installed.
- Fixed bug deleting dns zone on domains deletion.
- Fixed bug showing full source/destination paths in User Activity Log for move and copy actions using File Manager.
- Fixed error sending email to new user: *Bad recipient address syntax*.
- Fixed CSS bug with column width on activity table in *OpenAdmin > Users > single user > Activity Log*.
- Fixed error *name 'tempalte_name' is not defined* on OpenAdmin > Dashboard when dismissing widgets.
- Fixed css bug with icons on *OpenPanel > Dashboard* page.
- Fixed css bug on *OpenPanel > FileManager* with copy path icon.

---

// File: changelog/1.6.8

Released on November 15, 2025

### 💅 Polish
- [WAF widget on Site Manager now displays number of challenged and blocked requests on this domain for the last 60 minutes](/img/docs-content/jq7xfJ0C-wp-waf.png)
- Added 'Visitors' widget to Site Manager - showing live visitors for the website.
- Added [`terminal_timeout` setting](https://dev.openpanel.com/cli/config.html#terminal-timeout) allowing Administrators to specify max execution time for *OpenPanel > Docker > Terminal* commands.
- Added [`activity_max_size_bytes` setting](https://dev.openpanel.com/cli/config.html#activity-max-size-bytes)allowing Administrators to set file size in bytes to keep for user's Activity Log.
- *OpenPanel > Docker > Terminal* and *OpenAdmin > Advanced > Terminal* will now display info tooltip that terminal is non-interactive and show current `terminal_timeout` value.
- [SSH connection is now validated before adding a slave DNS server in *OpenAdmin > Domains > DNS CLuster*](https://github.com/stefanpejcic/OpenPanel/discussions/756#discussioncomment-14882105).
- 'Websites' menu item added in OpenPanel sidebar.
- Mautic is restored in *OpenAdmin > Settings > Modules* as a 'BETA' module.
- 'SSH login' settting is now available under *OpenAdmin > Settings > Notificaitons*.
- *blacklist_useragents* setting is Off for new installations.
- username, db_name and password generators on all forms are now using unified fucnitons from `static/js/generator.js`.
- errors in *docker logs -f openpanel* are now always shown, regardless of dev_mode setting.
- 'You are currently impersonating user..' message on OpenPanel UI is moved from header to footer.
- Added missing translations on AutoInstaller, Site Manager, Upload Files, Service.
- SSE_wdget on OpenAdmin no longer uses SSE but ajax requests for polling resource usage from backend.
- 'Recent' widget on OpenAdmin - session based.

### 🐛 Bug Fixes
- [Bug in OpenPanel UI on /server/info - memory limits on plan are missing #771](https://github.com/stefanpejcic/OpenPanel/issues/771)
- [Bug in OpenPanel UI on /mysql/wizard #752](https://github.com/stefanpejcic/OpenPanel/issues/752)
- Fixed bug displaying html websites count on *OpenPanel > Auto Installer* page.
- [Bug in OpenPanel UI on /mysql/phpmyadmin #761](https://github.com/stefanpejcic/OpenPanel/issues/761)
- [Can't use single quotes (') on website description on Wordpress installation #763](https://github.com/stefanpejcic/OpenPanel/issues/763)
- [Firewall has contradictory information, and displays an error when trying to change it #762](https://github.com/stefanpejcic/OpenPanel/issues/762)
- Fixed error generating database backup for WordPress website from WP Manager: *Error during backup: Error: Backup request failed.*.
- [Several problems on Wordpress Delete #765](https://github.com/stefanpejcic/OpenPanel/issues/765)
- Fixed bug in `opencli domain` command that caused wget to freeze if network is unreachable.

---

// File: changelog/1.6.9

Released on November 16, 2025

### 💅 Polish
- Updated WP-CLI to support PHP 8.4
- Added more detailed error messages on auto-login from OpenAdmin to OpenPanel user.


### 🐛 Bug Fixes
- [Error setting password in GUI #776](https://github.com/stefanpejcic/OpenPanel/issues/776)
- [Bug in OpenPanel UI on /files #775](https://github.com/stefanpejcic/OpenPanel/issues/775)

---

// File: changelog/1.7.0

Released on November 20, 2025

### 💅 Polish
- Changing a domain’s PHP version via *OpenPanel > PHP > Settings* will now attempt to disable the previous version, provided it’s not used by any other domain and isn’t set as the default version.
- *OpenAdmin > Services > Status* now shows ports for openpanel UI, Caddy webserver and SSH service.
- Added a unified template for '[Error establishing database connection message](https://openpanel.com/docs/articles/databases/error-establishing-a-database-connection)' on OpenAdmin > Users, Plans, Domains, New User, Import cPanel, DNS Zone Editor, Caddy Editor.
- *OpenAdmin > Services > View Log Files* will now parse url for log_name and lines, example: http://demo.openpanel.org:2087/services/logs?log_name=Caddy%20Logs&lines=20
- Removed classes from all input fields on OpenAdmin: `file:-my-2 file:-ml-2.5 file:cursor-pointer file:rounded-l-[5px] file:rounded-r-none file:border-0 file:px-3 file:py-2 file:outline-none focus:outline-none disabled:pointer-events-none file:disabled:pointer-events-none file:border-solid file:border-gray-300 file:bg-gray-50 file:text-gray-500 file:hover:bg-gray-100 file:dark:border-gray-800 file:dark:bg-gray-950 file:hover:dark:bg-gray-900/20 file:disabled:dark:border-gray-700 file:[border-inline-end-width:1px] file:[margin-inline-end:0.75rem] file:disabled:bg-gray-100 file:disabled:text-gray-500 file:disabled:dark:bg-gray-800`.
- [Relax password validations on inputs #4](https://github.com/stefanpejcic/openadmin/pull/4) for OpenAdmin.
- 'ssl' module is now available in the Community edition.
- Added tooltips on *OpenAdmin > Settings > General* and *OpenAdmin > Plans > Edit*.
- Added log options on SiteManager for Python & NodeJS applications: [view raw log, copy to clipboard, open in new tab](/img/docs-content/QCJzGZLT-2025-11-19-15-31.png).
- User's activity log will now indicate for autologin if it occured using openpanel API or OpenAdmin auto-login.
- 'activity_items_per_page' value for new installations is increased from 25 to 100.
- Pressing **Enter** in the search input field under *OpenPanel > Account > Activity Log* will search all logs, while typing without pressing Enter will search only the rows on the current page.
- Start, Stop and Restart actions on any service in *OpenAdmin > Services > Status* will now block further actions on all other services.
- Added timestamps in docker logs for openpanel service.
  
### 🐛 Bug Fixes
- [Bug in OpenPanel UI on /file-manager/upload #783](https://github.com/stefanpejcic/OpenPanel/issues/783#event-21023211444)
- ["Login as Admin" on Wordpress Manager general view doesn't work #772](https://github.com/stefanpejcic/OpenPanel/issues/772)
- [WordPress prettypermalinks not working on OpenLitespeed until its restarted #782](https://github.com/stefanpejcic/OpenPanel/issues/782)
- [Editing WordPress maintenance template produces errors #773](https://github.com/stefanpejcic/OpenPanel/issues/773)
- [Error shown on toast after saving general settings on WordPress Manager #774](https://github.com/stefanpejcic/OpenPanel/issues/774)
- [WordPress Restore From Plesk to OpenPanel Causing Permission Issues and ERR_HTTP2_PROTOCOL_ERROR on Elementor #770](https://github.com/stefanpejcic/OpenPanel/issues/770)
- Fixed bug with `opencli locale` script always initializing a locale instead of updating it, if command is run miltiple times.
- Fixed bug with `opencli sentinel` failing to check actual caddy service status and send admin notification.
- Fixed bug on *OpenAdmin > Settings > General* that always submitted the *Redirect* option.
- [Bug in OpenPanel UI on /account/activity pagination #786](https://github.com/stefanpejcic/OpenPanel/issues/786)
- Fixed bug on *OpenAdmin > Services > Status* that caused *G* to be stripped from memory limit field if value was not an intiger.
- Fixed js bug on *OpenPanel > Docker > Containers* that cause the input fields for CPU and RAM limits to not be editable.
- Fixed 500 error on api call to `/api/account/activity`.

---

// File: changelog/1.7.1

Released on November 25, 2025

### 💅 Polish
- Changing the default PHP version via *OpenPanel > PHP > Default version* will now attempt to disable the previous version, provided it’s not used by any other domain.
- Upgraded ConfigServer Firewall & Security to [Sentinel Firewall](https://sentinelfirewall.org/).
- *OpenAdmin > Security > Disable OpenAdmin*, *OpenAdmin > Advanced > Change Root Password* and *OpenAdmin > Advanced > Terminal* are now limited to Super-Admin only.
- Added option to set custom favicon in *OpenAdmin > Settings > OpenPanel*.
- Removed classes from all input fields on OpenPanel: `file:-my-2 file:-ml-2.5 file:cursor-pointer file:rounded-l-[5px] file:rounded-r-none file:border-0 file:px-3 file:py-2 file:outline-none focus:outline-none disabled:pointer-events-none file:disabled:pointer-events-none file:border-solid file:border-gray-300 file:bg-gray-50 file:text-gray-500 file:hover:bg-gray-100 file:dark:border-gray-800 file:dark:bg-gray-950 file:hover:dark:bg-gray-900/20 file:disabled:dark:border-gray-700 file:[border-inline-end-width:1px] file:[margin-inline-end:0.75rem] file:disabled:bg-gray-100 file:disabled:text-gray-500 file:disabled:dark:bg-gray-800`.
- Added random session secret keys for both OpenPanel and OpenAdmin UI.
- Added .htaccess templates for WordPress (OpenLitespeed and Apache).
- *OpenAdmin > Users > single user* page will no longer display error *'str object' has no attribute 'disk_used'* if 'quotas' are not installed on the server.
- Improvements to the install script: `--no-ssh` flag is removed, --post-install` flag can now also contain url to download a bash file before executing it.
- *OpenPanel > Advanced > Services* will no longer display disabled webservers and mysql type for the user.
- *OpenAdmin > Advanced > Process Manager* now displays 'sorted by' in page title.
- *OpenAdmin > Users > single user > Overview* now displays: user ID (UID), home directory, web server type, mysql type, varnish caching.
- Added optional flags: `--admin` and `--cli` to [opencli update](https://dev.openpanel.com/cli/update.html)

### 🚨 Security fixes
- Remote code execution (RCE)* triggered by specially crafted HTTP requests that manipulate parameters passed to the server-side command wrapper.
  
### 🐛 Bug Fixes
- [Changing PHP Version not showing error message #777](https://github.com/stefanpejcic/OpenPanel/issues/777)
- Fixed js bug on *OpenAdmin > Users > single user > Services* that cause the input fields for CPU and RAM limits to not be editable.
- [No option to change SuperAdmin password #791](https://github.com/stefanpejcic/OpenPanel/issues/791)
- [Bug in OpenAdmin UI on Password strength indicators - yellow css class missing #793](https://github.com/stefanpejcic/OpenPanel/issues/793)

---

// File: changelog/1.7.2

Released on December 02, 2025

### 💅 Polish
- Added PHP 8.5 as option for default version in *OpenAdmin > Settings > Edit User Defaults*.
- `opencli php-ioncube` command is removed.
- Added [ioncube loader for php 5.6 7.0 7.1 7.2 7.3 7.4 8.1 8.2 8.3 8.4](https://github.com/stefanpejcic/openpanel-configuration/commit/d28d06dc5901dc34abb6350c2c032e68f60a9aa3)
- Default webserver for new installations is now Apache.
- Varnish Caching is now disabled by default for new installations.
- Added [Google Safe Browsing status widget on WP Manager](/img/docs-content/HnWTTjTd-2025-11-25-19-36.png).
- Added [option to disable Web Terminal feature in OpenAdmin](/docs/articles/dev-experience/disable-openadmin-web-terminal/).
- Restart timeout on *OpenAdmin > License* after adding a license key is decreased from 30 to 10 sec.
- Enhanced WP Manager to deliver up to 300× faster response times on Debug, Update, and Maintenance tabs.
- 'password changed using email confirmation' is now logged in user's [activity log](/docs/panel/account/account_activity/).
- Added [log file for admin defined backups](https://openpanel.com/docs/articles/backups/configuring-backups/#1-admin-configured): `/var/log/openpanel/admin/docker-backup.log`

### 🐛 Bug Fixes
- [Able to create admin/reseller in free tier #795](https://github.com/stefanpejcic/OpenPanel/issues/795)
- [CORS error when domain is set and custom screenshots and favicons APIs are used. #769](https://github.com/stefanpejcic/OpenPanel/discussions/769)
- Fixed error `name 'abort' is not defined` on *OpenAdmin > Server > Change Root Password*.
- Fixed js error on PageSpeed widget in OpenPanel Site Manager that caused data to not be shown.
- Fixed css bug with input width on phpmyadmin and pgadmin pages.
- Fixed error `ERROR 2026 (HY000): TLS/SSL error: SSL is required, but the server does not support it` when executing mysql operations on Debian13.
- Fixed js bug on *OpenAdmin > Users > single user > Services* table with the `containerID` used in */stop/* and */terminal/* links.

---

// File: changelog/1.7.3

Released on December 13, 2025

### 💅 Polish
- Added [option to disable Server Reboot feature in OpenAdmin](/docs/articles/dev-experience/disable-openadmin-server-reboot/).
- Updated OpenAdmin UI to include missing page titles and breadcrumbs across all pages.
- Added 'View Logs' link on *OpenAdmin > Emails > Email Settings*.
- Log paths for *OpenAdmin > Services > Log Viewer* can now specify [container name instead fo path](https://github.com/stefanpejcic/openpanel-configuration/blob/main/openadmin/config/log_paths.json).
- Admins can now edit the log files displayed in *OpenAdmin > Services > Log Viewer*  using the 'settings' button.
- Added check for webmail domains: [check if domain is in use by system or user before saving](https://github.com/stefanpejcic/opencli/commit/e668a67df914b4026c0fb40894d6e55114abb950)
- Added a new [setting that determines where emails will be stored on the server](https://github.com/stefanpejcic/openpanel-configuration/commit/f1fd99600947e75a9ac84027ea9d4caa780d5f3e).
- Removed `type="email"` for smtp_username field on *OpenAdmin > Settings > Notifications*.
- If dev_mode is enabled, password will no longer be shown in openamdin error log when creating user via GUI.
- Sogo and SnappyMail are removed as webmail options.

### 🐛 Bug Fixes
- [Can't edit User Packages on smaller screens #804](https://github.com/stefanpejcic/OpenPanel/issues/804)
- [mailserver files are missing SSL configuration #799](https://github.com/stefanpejcic/OpenPanel/issues/799)
- Fixed 'Warning: invalid webserver type selected' when setting any webserver via *OpenAdmin > Users > New*.
- Fixed bug *Service 'mariadb' does not exist.* on Services > MariaDB.
- Fixed redirect issues for new WP installations on Apache caused by [.htaccess template for WP Manager](https://github.com/stefanpejcic/openpanel-configuration/commit/57259d359e093669a5221eb3b88e9aa2ba7f5f52).

---

// File: changelog/1.7.4

Released on December 30, 2025

### 💅 Polish
- User panel (`:2083`) now auto-starts on installation.
- [Add Domain related actions to API [FEATURE REQUEST] #809](https://github.com/stefanpejcic/OpenPanel/issues/809)
- OpenPanel API Endpoints: [`/api/domains`, `/api/domains/new`, `/api/domains/delete`](https://dev.openpanel.com/openpanel-api/#Domains)
- OpenAdmin API Endpoints: [`/api/domains`, `/api/domains/new`, `/api/domains/suspend/`, `/api/domains/usnsuspend/`, `/api/domains/delete/`](https://dev.openpanel.com/openadmin-api/domains.html)
- [View all graphs all at once on Resource Usage page [FEATURE REQUEST] #808](https://github.com/stefanpejcic/OpenPanel/issues/808)
- removed `email` input type for username field on *OpenAdmin > Settings > Notifications*.
- [PHP 8.5 is now the default version for new installations](https://github.com/stefanpejcic/openpanel-configuration/commit/c7328d92f0fed19321c089601820d97e03911008)
- removed 'new' badge from *Recent* on OpenAdmin sidebar.
- Improvements to *OpenAdmin> Domains* page.
- [Added an option to add domains from OpenAdmin](/img/docs-content/V1hRyC2v-2025-12-29-15-11.png).

### 🐛 Bug Fixes
- [Varnish status per domain cannot be changed (ON/OFF not working) #823](https://github.com/stefanpejcic/OpenPanel/issues/823)
- [WP Manager > Scan: login plugin did not install #814](https://github.com/stefanpejcic/OpenPanel/issues/814)
- [False-positive messages for admin logins when behind Cloudflare proxy #819](https://github.com/stefanpejcic/OpenPanel/issues/819)
- [Changing pgAdmin email & password gives HTTP 500 error #816](https://github.com/stefanpejcic/OpenPanel/issues/816)
- [AutoInstaller fails when using Apache #820](https://github.com/stefanpejcic/OpenPanel/issues/820)
- [CPU usage progress bar doesn't match percentage #815](https://github.com/stefanpejcic/OpenPanel/issues/815)
- [Pagination bug on Resource Usage History #810](https://github.com/stefanpejcic/OpenPanel/issues/810)
- [2FA not working with Authy #805](https://github.com/stefanpejcic/OpenPanel/issues/805)
- [Enabling/Disabling Redis gives error 500 #807](https://github.com/stefanpejcic/OpenPanel/issues/807)
- [Reseller accounts page gives 404 error #806](https://github.com/stefanpejcic/OpenPanel/issues/806)
- [Fixed bug in `user-add` script](https://github.com/stefanpejcic/opencli/commit/b23d7f452c7604c23cf42edaa605600513dc3d79) rounding down GB, so 5.8GB was showing as 5 instead of 6G.
- Fixed bug authenticating using JWT in user panel, due to JWT version missmatch.
- Fixed bug on user delete that failed to kill all user processes if username was changed.
- [CPANEL IMPORT: Crontab supports seconds, so add one more * on import #26](https://github.com/stefanpejcic/cPanel-to-OpenPanel/issues/26)
- [Fixed bug setting litespeed as webserver](https://community.openpanel.org/d/239-no-such-container-openlitespeed/5)
- [Install script now handles if `/etc/hosts` is missing](https://community.openpanel.org/d/235-caddy-restarting-when-etchosts-is-missing)

---

// File: changelog/1.7.41

Released on January 29, 2025

### 💅 Polish
- The [opencli user-login](https://dev.openpanel.com/cli/users.html#Login-as-User) command no longer logs into a user container; it now generates an auto-login link for the OpenPanel UI.
- [OpenAdmin Keyboard Shortcuts #834](https://github.com/stefanpejcic/OpenPanel/issues/834)
- Option to view raw activity log and download it from *OpenAdmin > Users > single user > Activity* page.
- Commands 'opencli user-redis', 'opencli user-memcached', 'firewall-reset', 'php-available_versions' 'php-installed_versions' and 'php-ini' are removed.
- 'opencli api-list' is renamed to 'opencli api' and [extended to support: on|off|status|list](https://dev.openpanel.com/cli/api.html).
- `--ssh` flag is removed from 'opencli user-password' command.
- [Added option to delete notifications on OpenAdmin > Notifications](/img/docs-content/MWHJK2nv-2026-01-28-12-19.png).
- Improvements to the user deletion and suspend processes.

### 🐛 Bug Fixes
- [ Fix opencli faq failing to detect panel domain (#62) #64 ](https://github.com/stefanpejcic/opencli/pull/64)
- [Bug displaying progress for wget #818](https://github.com/stefanpejcic/OpenPanel/issues/818#event-21795034137)
- [Adding same domain multiple times creates a problem #828](https://github.com/stefanpejcic/OpenPanel/issues/828)
- [Bug - user able to change webserver without removing all domains first #825](https://github.com/stefanpejcic/OpenPanel/issues/825)
- Fixed bug detecting panel domain and using https in `opencli api-list` command.
- Fixed broken link in OpenPanel login email template.
- [Install: jq: parse error: Invalid numeric literal at line 1, column 10 #835](https://github.com/stefanpejcic/OpenPanel/issues/835#event-22290722545)
- [Memory Usage not correct #830](https://github.com/stefanpejcic/OpenPanel/issues/830)
- [500 error for WP Scan action on OpenLitespeed webserver #837](https://github.com/stefanpejcic/OpenPanel/issues/837)
- Fixed bug in `opencli php-default` script failing to update version if username was renamed.
- Fixed error running 'opencli faq' command: [`/usr/local/opencli/faq.sh: line 250: syntax error: unexpected end of file`](https://github.com/stefanpejcic/opencli/commit/75afd5c177668aa946f55294ea354163133d81ee)
- [Fixed bug with `opencli license` commands failing to save license key](https://github.com/stefanpejcic/opencli/commit/4e31f27b850bab4aaf07b8142f0ec19669782a67).
- [Fixed bug with `opencli user-email` command refusing to set email for user if already set for another user](https://github.com/stefanpejcic/opencli/commit/abac6804505cd447ba280755f868e244357510e4).
- [JS bug in OpenAdmin UI for 'Recent' menu when 404 #840](https://github.com/stefanpejcic/OpenPanel/issues/840)
- [Suspended users should be excluded in OpenAdmin > Domains when addin a new domain #842](https://github.com/stefanpejcic/OpenPanel/issues/842)
- Fixed bug on pgAdmin with the default user not having permissions to access the 'public' schema.
- Fixed bug with pgadmin failing to start if no email address is defined.
- Fixed bug on WP Manager showing console error for major WP version format (`N.N`).

---

// File: changelog/1.7.42

Released on February 9, 2025

### 💅 Polish
- Added 'max_email_quota' setting for hosting plans.
- The server resource usage widget in top right corner in OpenAdmin is now automatically refreshed only when the tab is active in the browser.
- Added [`--panel` flag to `opencli update` command](https://dev.openpanel.com/cli/update.html).
- Added [update support for custom OpenPanel UI images](https://github.com/stefanpejcic/opencli/commit/9f3fc88685da31ecccf4a73506009aa33ca93e74).
- Added [`/api/notifications` endpoint on OpenAdmin](https://dev.openpanel.com/openadmin-api/notifications.html).
- `/api/usage/disk/<username>` api endpoint is renamed to: `/api/usage/disk`
- Refactored [WHMCS module for account provisioning on OpenPanel server](https://github.com/stefanpejcic/OpenPanel-whmcs-module).
- Cron file size is limited to `100KB`.
- MySQL Import file is limited to `1GB`.
- `varnish.html`, `elasticsearch.html` `redis.html` `opensearch.html` `memcached.html` templates are merged in `service.html`.
- [`--debug` flag on install script is removed](https://github.com/stefanpejcic/OpenPanel/commit/0cd2cc0bc9bdfd6fe5e7d0f11d45453bce29f6a3).
- [Added optional `--selfsigned` flag to install script](https://github.com/stefanpejcic/OpenPanel/commit/8c532da7c945597796d039151e2e4d379f402456).
- [Added fallback PageSpeed API license key for enterprise users](https://github.com/stefanpejcic/opencli/commit/e2e27b5d13c0a0f92d3d482c6cb42a9c25baeae3).
- Added [`filemanager_buttons_style` option](https://dev.openpanel.com/cli/config.html#filemanager-buttons-style).
- Bootstrap icons font is removed from all OpenAdmin pages.
- Clicking 'Go back to OpenAdmin' on OpenPanel wehn impersonating a user will firt terminate the openpanel user session, then redirect to OpenAdmin.
- The visitor count in WP Manager now automatically refreshes only when the tab is active in the user's browser.
- Added inline comments on all OpenPanel templates, to help developers determine html template locations.

### 🐛 Bug Fixes
- Fixed an auto-login bug on WordPress when user ID 1 is missing.
- Fixed bug on *OpenAdmin > Settings > Edit User Defaults*that stripped `G` from `_RAM` keys if value is a float.
- [User Disk and Inodes quotas not supported on AlmaLinux 10 #744](https://github.com/stefanpejcic/OpenPanel/issues/744#issuecomment-3859583653)
- Fixed JS bug in WP Manager that caused cache info  to be fetched twice.
- [Fixed bug with pagespeed report generation producing invalid JSON if invalid api key is provided](https://github.com/stefanpejcic/opencli/commit/a4d90a4d53bd5aaaf58ab8093f662f835ee4db8b).
- [`mysql > TLS/SSL error: SSL is required, but the server does not support it`](https://community.openpanel.org/d/236-openpanel-is-broken-on-debian-13-stay-on-debian-12/10)
- [Wordpress Manager not showing PHP/MySQL information #850](https://github.com/stefanpejcic/OpenPanel/issues/850)
- [opencli ftp-delete also deletes the folder #841](https://github.com/stefanpejcic/OpenPanel/issues/841)
- Fixed bug with `load1min` value empty on *OpenAdmin > Advanced > Resource Usage* page.
- Fixed bug with values showing comments on *OpenPanel > PostgreSQL > Configuration Editor*.
- Fixed bug with postgres that caused the custom settings added via *OpenPanel > PostgreSQL > Configuration Editor* to be lost on postgres version update.
- [Bug saving custom values on PostgreSQL Configuration page #843](https://github.com/stefanpejcic/OpenPanel/issues/843)
- [Fixed bug deleting OpenPanel user from database on account termination](https://github.com/stefanpejcic/opencli/commit/33b5779301499b1df6c3cfc3fe480afa250da4ca).
- Fixed bug on ProcessManager with displaying container names.
- [Fixed bug deleting suspended user from database](https://github.com/stefanpejcic/opencli/commit/5076c36486663a000c647b2c07fd4ca8ca565ed4).
- Fixed CSS bugs on Varnish and Services pages that caused the 'edit limits' button to be displayed even when `docker` module is not enabled.
- [opencli php-domain fails for OpenLitespeed #68](https://github.com/stefanpejcic/opencli/issues/68)
- [Fixed error `sed: can't read /etc/openpanel/caddy/domains/*.conf: No such file or directory` on install](https://github.com/stefanpejcic/opencli/commit/a013d8378ae9b5126e804c7d51dad92d4ac1f499])
- [Fixed error: `ln: failed to create symbolic link '/usr/local/bin/opencli': File exists` on install with `--repair` flag](https://github.com/stefanpejcic/OpenPanel/commit/960c22b158a98f98fb564697bde3b1fccdc5ed5d).
- Fixed bug on 'OpenAdmin > Emails > New' that allowed user to create unlimited email accounts regardles of plan limit.
- [Bug in OpenPanel UI on /file-manager/upload #854](https://github.com/stefanpejcic/OpenPanel/issues/854)

---

// File: changelog/1.7.43

Released on February 14, 2025

### 💅 Polish
- [German language support update#18](https://github.com/stefanpejcic/openpanel-translations/pull/18)
- [Bulgarian translation](https://community.openpanel.org/d/246-govoris-li-blgarski-bulgarian-translation-for-openpanel)
- [Fix translation warnings, update Spanish & Chinese locales, and ignore compiled files#14](https://github.com/stefanpejcic/openpanel-translations/pull/14)
- [Add Spanish translations for various messages#16](https://github.com/stefanpejcic/openpanel-translations/pull/16)
- [Add Spanish translations for domain and email messages#17](https://github.com/stefanpejcic/openpanel-translations/pull/17)
- Added [option to toggle dev_mode from *OpenAdmin > Settings > General* page](/img/docs-content/jsfHnmZY-2026-02-09-14-14.png).
- [local captcha options besides cloud #856](https://github.com/stefanpejcic/OpenPanel/discussions/856)
- Added ['cron_max_file_size_kb' setting](https://dev.openpanel.com/cli/config.html#cron-max-file-size-kb).
- [Enhanced the *OpenAdmin > Domains* page: added **ID** and **Docroot** columns, made columns user-configurable, introduced sorting functionality, option to mange SSL, configure HSTS, disable WAF and suspend/uspuspend domains.](/img/docs-content/hcVKf04H-2026-02-11-14-07.png)
- Optimized resource usage for user and admin panel services.
- [`opencli websites-vulnerability` command](https://dev.openpanel.com/cli/websites.html#Vulnerability)
- Configured a workflow to validate Python code using [Pyright](https://github.com/microsoft/pyright) prior to each version release.


### 🐛 Bug Fixes
- [CSS bug in OpenAdmin UI on Administrators table #862](https://github.com/stefanpejcic/OpenPanel/issues/862)
- [Bug in OpenPanel UI on /dashboard - data is cached when switching between users #863](https://github.com/stefanpejcic/OpenPanel/issues/863)
- Fixed bug on *OpenPanel > Dashboard > Usage* widget that caused the data to be fetched twice.
- [Bug in sentinel.sh - unix timestamp in swap notification #865](https://github.com/stefanpejcic/OpenPanel/issues/865)
- Fixed bug on plan edit that caused the `max_email_quota`  to be saved as `{35}` in the database.
- [Changing "Mailbox quota: " value will alway return the value "{15}" #866](https://github.com/stefanpejcic/OpenPanel/issues/866)
- [Can't create Email account and can't modify quota #864](https://github.com/stefanpejcic/OpenPanel/issues/864)
- Fixed bug on *OpenAdmin > Settings > General* that caused the procy value to update even when not provided.
- [Installation fails on Debian 13 (possibly Hetzner-specific) #851](https://github.com/stefanpejcic/OpenPanel/issues/851)
- [Bug in OpenPanel UI on /ftp/password/ #859](https://github.com/stefanpejcic/OpenPanel/issues/859)
- [OpenAdmin log is redirected to systemd service instead of error.log #860](https://github.com/stefanpejcic/OpenPanel/issues/860)
- Fixed 500 error on PHP and Crons pages.
- Fixed bug with 'Custom startup command' field being required on Site Manager.
- Fixed bug with 'Startup file needs to be a .js file' message displayed when editing Python aplications startup file in Site Manager.
- Fixed bug on PgAdmin page that caused inalid email address to be set if email field is left blank.
- Fixed bug with `load1min` value empty on *OpenAdmin > Advanced > Resource Usage* page.
- Fixed bug that was causing *license invalid* messages on OpenAdmin pages with multi-core servers.
- Fixed CSS bug on *OpenAdmin > Dahsboard > Activity widget* that did not truncate long text.
- Fixed bug on email creation that caused quota to be displayed as unlimited in user panel.
- Fixed bug with user panel logs showing messages per worker, resulting in duplicate messages.

---

// File: changelog/1.7.44

Released on February 20, 2025

### 💅 Polish
- Configured a workflow to spell-check Python and templates code using [CodeSpell](https://github.com/codespell-project/codespell) prior to each version release.
- `--skip-themes` flag is added to all wp-cli commands in WP Manager.
- [WP Vulnerabilities in Site Manager](/img/docs-content/QXnfmvV6-2026-02-19-15-28.png).
- [Last login log is now visible on *OpenAdmin > Users > single user* page](/img/docs-content/k78mv7Tq-admin-login-log.png).
- All WP-CLI commands in WP Manager are now optimized to run with `php -d memory_limit=-1 -d open_basedir=none -d disable_functions= -d display_errors=0 -d error_log=/dev/null`.
- Removed duplicate call to `/plugins` on the *OpenPanel > Dashboard* page.
- Removed duplicate call to `/shortcuts.json` on the *OpenAdmin > Dashboard* page.
- Include custom.css and custom.js on OpenPanel pages only if Admin adds custom code.
- Plugin imports are now optimized during startup.
- The database size on the `/api/mysql-size` route is now rounded to 2 decimal places.
- `docker-usage_stats_cleanup` command is removed.
- `/plugins` on OpenPanel are now loaded ont when custom plugins are installed by Administrator.
- *OpenAdmin > Users > single user* page will now accept and update hash in the url to open tabs.
- [Added `logs` flag to `opencli domains-ssl` command](https://dev.openpanel.com/cli/domains.html#logs).
- [Option to view SSL-related logs for domain from *OpenAdmin > Domains* page](/img/docs-content/Z4rtMp9V-2026-02-20-14-41.png).


### 🐛 Bug Fixes
- Fixed bug in File Manager with 'Calculate' link when uri has `?` or `#` params.
- [Bug in /file-manager/upload - upload percentage stuck on 1% #861](https://github.com/stefanpejcic/OpenPanel/issues/861)
- Fixed caching bug on `/api/database_info` and `/api/database-size`.
- Fixed 500 error on email edit page.
- `/usr/local/opencli/sentinel.sh: line 64: 2026-02-18 17:59:52: syntax error in expression (error token is "17:59:52")`
- `[1] [CRITICAL] WORKER TIMEOUT (pid:75)`
- Fixed bug executing wp-cli command on WP Manager > Options.
- Fixed bug generating auto-login link for WP Manager when website was added (scanned) and mu-plugins directory does not exist.
- Fixed bug with resource usage retention in user panel.
- `/usr/local/opencli/plan/create.sh: line 35: TEXT: No such file or directory`
- Fixed CSS bug with mobile menu on *OpenAdmin > Users > single user* page.

---

// File: changelog/1.7.45

Released on March 06, 2026

### 💅 Polish
- [Hungarian translation](https://community.openpanel.org/d/262-goviris-magyar-hungarian-translation-for-openpanel)
- Added option to delete domains from *OpenAdmin > Domains* page.
- Enhanced MySQL user password restrictions: [all characters are now supported](/docs/articles/accounts/forbidden-usernames/#mysql--mariadb).
- Added 'SSH Allowlist' on *OpenAdmin > Notifications* page.
- Changing password for user from OpenAdmin, now terminates all sessions for the user.

### 🐛 Bug Fixes
- Fixed CORS error saving changes using Crontab File Editor.
- Fixed error 'Domain not found' on *OpenAdmin > Domains > VHost Editor*.
- [Fixed bug with WP Auto-installer on OpenLitespeed](https://github.com/stefanpejcic/openpanel-configuration/commit/ce7414784f79a668d9186966350363373d41e34a).
- Fixed bug enabling maintenance_mode for WordPress from WP Manager.
- Fixed false-positive bug detecting maintenance_mode for WordPress in WP Manager, when `wp-content/maintenance.php` template is present.
- Fixed bug in `opencli user-suspend` script that caused user's containers to continue working when suspended.
- [Fixed bug enabling Varnish proxy for user in Vhosts file](https://github.com/stefanpejcic/opencli/commit/cf216bfccd2f6ea37c3f7a561097a017d1a8a1d8).
- Fixed `mysql: [ERROR] mysql: option '-e' requires an argument.` on `opencli admin suspend` and `opencli admin unsuspend` commands.
- [Error on link on PostgreSQL Create User view #869](https://github.com/stefanpejcic/OpenPanel/issues/869)
- [Too many redirects on wp-admin when varnish enabled for user AFTER creating a WP website #853](https://github.com/stefanpejcic/OpenPanel/issues/853)
- Fixed bug generating database backup in WP Manager.

---

// File: changelog/1.7.46

Released on March 11, 2026

### 💅 Polish
- [One-click WordPress Staging #873](https://github.com/stefanpejcic/OpenPanel/issues/873#issuecomment-4039245434)
- Install script now supports optional `--user-port=` and `--admin-port=` flags.
- [Added support for Webhooks on *OpenAdmin > Notifications* page](/img/docs-content/yKT2wPjb-2026-03-06-19-18.png).
- `opencli port` command now automatically opens the new user panel port on Firewall.
- `opencli admin port` shows current OpenAdmin port, `opencli admin port NEW_PORT` updates OpenAdmin port.
- commands `opencli faq`, `opencli sentinel`, `opencli user-add` and `opencli admin` now check for custom OpenAdmin port.
- *Login Failure Daemon (LFD)* is added as managable service from *OpenAdmin > Services* page.
- [Added 30+ user-actions on *OpenAdmin > Settings > Notifications* page.](/img/docs-content/mTyfwQh7-2026-03-09-20-50.png)
- Optimized WAF and HSTS toggle process on *OpenAdmin > Domains* page.
- Refactored `opencli report` command.
- Refactored `opencli user-delete` command.
- [`autoIndex` is now enabled for OpenLitespeed](https://github.com/stefanpejcic/openpanel-configuration/commit/26219d64e398811c78859a8e8a4d4b07ac761a27) on new installations.
- `dev_mode` is now automatically disables when running future updates.

### 🐛 Bug Fixes
- Fixed bug enabling HSTS for a domain when custom SSL is set.
- Fixed error `unknown directive \"secrequestbodyjsondepthlimit\"","line":40` starting Caddy webserver. 
- Fixed bug on `opencli port` failing to update `/etc/openpanel/nginx/vhosts/openpanel_proxy.conf` file.
- Fixed bug with logrotate config on Ubuntu.
- Fixed bug on `opencli user-resources` command caused by Windows-like return characters in user's .env file.
- Fixed bug creating map for domains added on OpenLitespeed webserver.
- Fixed bug changing WAF status ( enable/disable ) from *OpenAdmin > Security > WAF* page.
- Fixed 500 error on `/api/system/hosting/plan` in OpenPanel.
- Removed 'undefined' text on bottom of *OpenPAnel > Advanced > Server Info* page.
- Fixed bug with incorrect docroot on WP Manager actions caused by `lstrip('/var/www/html/')`.
- Fixed false-positive error on WP *Manager > Security > Vulnerabilities* where there are no vulnerabilities detected for a website.
- [Disk usage notification is not properly saved in notifications.ini #877](https://github.com/stefanpejcic/OpenPanel/issues/877)
- Fixed FOUC (flash of unprocessed content) on *OpenAdmin > Domains > SSL* and *OpenPanel > Domains > SSL* pages.
- Fixed bug on *OpenAdmin > License* with flash message missing when 'report' button is clicked.
- Fixed CORS error when using CF turnstile via [captcha plugin](https://github.com/stefanpejcic/captcha)
- Fixed an issue where deleting a domain would leave rotated domain logs on the server.
- Fixed a problem where deleting a user did not remove associated Coraza WAF rules and domain logs.
- Fixed bug that prevented terminating active sessions when suspending a user.
- Fixed a bug where custom SSL files were not removed when deleting a domain or user.
- Fixed an error in *WP Manager → Clone* when using MariaDB, caused by unsupported flags `--column-statistics=0` and `--set-gtid-purged=OFF`.
- Fixed a bug in *WP Manager* that caused duplicate sites to be added each time a website was cloned.

---

// File: changelog/1.7.47

Released on March 20, 2026

### New
- [Import account from CyberPanel backup](https://github.com/stefanpejcic/CyberPanel-to-OpenPanel)
- [🇷🇴 Romanian (RO)](https://community.openpanel.org/d/270-vorbesti-romana-romanian-translation-for-openpanel)
- [`opencli websites-secure`](https://dev.openpanel.com/cli/websites.html#Secure) and [`opencli user-block_ip`](https://dev.openpanel.com/cli/users.html#Block-IP) commands.

### 💅 Polish
- Added check on **OpenPanel > MySQL > Databases** if there are enough resources on the plan to start service.
- Added sorting to the table on *OpenAdmin > Plans* page.
- Added *OpenAdmin > Security > Blacklist UserAgents* page.
- The Cron service no longer starts automatically when opening the CronJobs page; it now starts only after a cron job is added, edited, or deleted.
- [Changing PHP Version not showing error message if not enough resources to start the service #794](https://github.com/stefanpejcic/OpenPanel/discussions/794)
- For 'Forceful Server Reboot' on **OpenAdmin > Advanced > Server Reboot** page, the `reboot -f` command is replaced with `echo b > /proc/sysrq-trigger`.
- **Updated [log rotation](https://github.com/stefanpejcic/opencli/blob/main/server/logrotate.sh):** `opencli reports` deleted after 7 days, `opencli update` logs after 3 months, and panel logs rotated except `notifications.log`.
- [Example Python (flask) application](https://github.com/stefanpejcic/python-helloworld)
- [Example NodeJS (express) application](https://github.com/stefanpejcic/nodejs-helloworld)
- Added the ability to set a custom database username and password when creating a WordPress clone.
- Optimized domain suspend and unsuspend processes.
- [Security Measures in WP Manager](/img/docs-content/h4x88drH-security-measures.png)
- `opencli php-domain` will now stop previous PHP version **IF** not used by other domains **AND** not set as a default.
- Caddy, BIND9, OpenPanel, MySQL services on new installations will now automatically inherit Timezone from the server.
- Added [postfwd](https://www.postfwd.org/) service and `max_hourly_email` limit on hosting plans.
- Improved regex email validation on all Emails pages in OpenPanel.
- Removed `shell=True` from all subprocess.run executed on OpenAdmin and OpenPanel.
- Extended optional `--dry-run` flag to `opencli user-resources` command.
- For new installations, custom CSS and JS code, HTML in header and footer, Custom section on dashbaord and How-to guides are no longer loaded on OpenPanel Community edition and can't be edited from *OpenAdmin > Settings > Custom Code* page.

### 🐛 Bug Fixes
- [E-mail passwords don't allow special chars #881](https://github.com/stefanpejcic/OpenPanel/issues/881)
- [Webmail Domain Setup Fails Silently for Existing Domain #888](https://github.com/stefanpejcic/OpenPanel/issues/888)
- Fixed a bug in the WP Autoinstaller where, if the provided username or database name contained the table prefix, the installer would replace the prefix in them, causing database connection failures due to incorrect login data in the configuration file.
- Fixed bug on user delete that failed to remove mountpoint on master is user is created on slave server.
- [disk usage % shown in OpenAdmin > SSE tab is showing average if multiple mounts #880](https://github.com/stefanpejcic/OpenPanel/issues/880)
- Fixed an issue in the Redis, Elasticsearch, OpenSearch, and Memcached modules that allowed services to start even when doing so could exceed plan limits.
- Fixed error `Invalid command 'default_page.html', perhaps misspelled or defined by a module not included in the server configuration` for apache when adding a NodeJS/Python Application.
- Fixed error `UnboundLocalError: cannot access local variable '_var_var_27' where it is not associated with a value` for apache when deleting a NodeJS/Python Application.
- Fixed bug checking if .js or .py file exists when adding path on NodeJS/Python Application Installer page.
- Fixed bug importing SSL certificates from cPanel backups in [the Importer module](https://github.com/stefanpejcic/cPanel-to-OpenPanel/commit/a2e79ffe0d6a026eea41384f009de4d9ef4c176c).
- [WP uninstall removes MySQL user, breaking original site if Cloned #879](https://github.com/stefanpejcic/OpenPanel/issues/879)
- [invalid literal for int() with base 10: '#' error in OpenPanel UI on /process-manager #878](https://github.com/stefanpejcic/OpenPanel/issues/878)
- Fixed bug on adding custom SSL that reloaded caddy webserver twice.
- Fixed `Using a path in a site address is deprecated; please use the 'handle' directive instead","address":"http://localhost/check"} ` warning on caddy reload.
- [FileManager: Error renaming files with spaces in the name on versions <1.4.74 #885](https://github.com/stefanpejcic/OpenPanel/issues/885)
- Fixed bug on *OpenPanel > Emails > Manage* that tried to set quota for email account on every action: password change, send/receive suspend..
- Fixed bug with activity page links showing on 'Login History' page when `activity` module is disabled.
- Fixed bug on *OpenAdmin > Settings > General* page that always updated dev_mode regardless of previous value.
- Fixed bug on *OpenPanel > Emais > Import Addresses* that caused entire import process to fail when a user with unlimited quota (`0`) is parsed from the file.

---

// File: changelog/1.7.48

Released on March 23, 2026

### 💅 Polish
- [OpenAdmin now supports importing account from CyberPanel backup](/img/docs-content/R9kKvzHM-2026-03-12-21-08.png)
- On the MySQL Users and Databases pages, the service status is now validated. If the service is not running, the system checks whether the current plan has sufficient resources to start it. If not, a message is displayed to inform the user, improving the overall UX.
- [Interactive terminal on *OpenAdmin > Web Terminal*](/img/docs-content/NgB4dbms-Snimak-ekrana-napravlen-dana-2026-03-20-12-21-13.png).
- Interactive terminal on *OpenPanel > Containers >Terminal* page.
- Added domain and username validation on the form for adding new domain from *OpenAdmin > Domains* page.
- Added validation of DNS zone file and Caddyfile before reloading the service, when saving file for domain from *OpenAdmin > Domains* page, along with [temporary files that can be restored if validation fails](/img/docs-content/QhWrpgQG-Snimak-ekrana-napravlen-dana-2026-03-20-13-56-41.png).
- Optimized and refactored user-delete process.
- added optional `--email` flag to `opencli plan-apply` command.
- CPU and Memory restrictions for OpenPanel UI will not be enforced by default for new instalations.
- Added CI/CD integrations on docker image build to check if `shell=True` present in python modules or commands formatted as strings.
- Enabled Features on *OpenPanel > Advacned > Server  Info* now link to their docs pages on OpenPanel website


### 🐛 Bug Fixes
- [Critical Protocol Mismatch and Port Configuration Issues in v1.7.47 #832](https://github.com/stefanpejcic/OpenPanel/issues/892)
- Fixed bug adding domain in user-panel.
- [incorrect link on phpmyadmin > edit domain #889](https://github.com/stefanpejcic/OpenPanel/issues/889)
- [On plan change and plan-apply, if user is created on a slave node, cpu&ram limits are still checked on the master #891](https://github.com/stefanpejcic/OpenPanel/issues/891)
- [Fixed a bug with `:ro` volume for caddy that caused user-panel to fail to use SSL if domain is set](https://github.com/stefanpejcic/openpanel-configuration/commit/ae582320e2a1cdba1a9db2aaa957e3abc4841ad5).
- Fixed multiple errors on OpenAdmin running OpenCLI commands, patch is available with: `opencli update --admin`.
- Fixed JS bug in pflogsumm reports shown on *OpenAdmin > Emails > Reports* page.
- Fixed error changing root mysql user password from OpenPanel UI.
- Fixed bug on MySQL Import fialing to set owner for the uploaded .sql file.
- Fixed a bug on user-delete that caused email accounts for the user to not be deleted.
- Fixed error `No such file or directory: 'opencli domain ip'` when setting IP on *OpenAdmin > Settings > General* page.
- Fixed bug on user-change_plan and webserver-get_webserver_for_user commands that caused them to fail reading docker-compose.yml file for a user if username was changed (renamed).
- Fixed bug on user-change_plan that failed to change plan for suspended user.
- Fixed bug on user-panel that still enforced Talisman even when domain is not set for panel access, causing the panel to enforce `https://IP:2083`.
- Fixed css bug on *OpenAdmin > Settings > Edit User Defaults* that prevented saving until `PGADMIN_MAIL` is set.
- Fixed bug that prevented user quotas to show on OpenPanel UI if `quotaset` command produced any warnings.
- Fixed 500 error on *OpenAPnel > Emails > Manage Filters* page when no emails are created yet.
- Fixed bug that prevented OpenPanel UI container to see the user's docker context if user was added after user-panel started

---

// File: changelog/1.7.49

Released on March 25, 2026

### 💅 Polish
- Deleting a user now removes all mailbox data for every email account owned by that user.
- Deleting a domain now removes all mailbox data for every email account under that domain.
- cPanel import now supports importing email accounts and PostgreSQL databases.
- Temporary `.cpanel.site` domains are no longer imported from cPanel backups.
- **OpenAdmin > Users > [Single User] > Overview** now displays the user’s locale.
- Optimized the update preferences process in WP Manager to execute a single command for updating WordPress core, themes, and plugins together.
- Optimized the debug preferences update process in WP Manager to run a single command for all options.
- Sections on Dashboard page are now sortable.

### 🐛 Bug Fixes
- [Failed to start phpmyadmin: Started phpmyadmin - confusing error on /mysql/phpmyadmin #893](https://github.com/stefanpejcic/OpenPanel/issues/893)
- Fixed bug on WordPress Autoinstaller that caused the process to stuck on *Writing database logins to wp-config.php* IF table prefix starts with a number.
- Fixed error creating database on WordPress Autoinstall.
- [Can not create ftp user in user panel #896](https://github.com/stefanpejcic/OpenPanel/issues/896)
- Fixed error `list object has no element 1` on *OpenAdmin > Notifications* if message is malformed in the log file.
- Fixed bug 'unrecognized backup format' on cpanel backup import.
- Fixed bug on cpanel backup import: if admin panel is restarted, import process was killed.
- Fixed 500 error on *WP Manager > Scan* when db is not available.
- Fixed error generating auto-login link on WP Manager for installations in subdirectories.
- Fixed bug on OpenPanel startup that caused empty custom.css or custom.js files to be loaded on all pages.
- Fixed JS console errors on Dashboard page: `Alpine Expression Error: files is not defined Expression: "'section-icons-' + files"`.

---

// File: changelog/1.7.50

Released on April 01, 2026

### 💅 Polish
- `opencli phpmyadmin` command to set a custom domain for user's phpmyadmin.
- User can now set view mode for Dashboard page (show icons before the names or on top).
- if `screenshots=local` playwright install on OpenPanel UI startup is no longer render blocking.
- `SCREENSHOTS_API_URL` is now set to 'local' for new installations, screenshots in WP Manager wil be locally generated using playwright.
- If `SCREENSHOTS_API_URL` is set to 'local', domains are resolved locally to the IP address assigned to teh user, allowing screenshots to reflect the local webiste, not resolved by DNS.
- Added success/error messages on *OpenPanel > Varnish* when caching is toggled for a domain.
- Improvements to the 'OpenPanel > Containers' page: Net I/O, Block I/O and PIDs are now displayed, columns can now be set by the user, link to logs page.
- `impersonate=no` for new installations.
- when deleting mysql users from *OpenPanel > MySQL > Users* page, usernames are checked against `mysql_restricted_usernames` setting.
- users can now choose to enable autoogin for phpmyadmin (default) or require username/password on phpmyadmin login form.
- Elasticsearch version is updated to `9.3.2` for new installations.
- `stable-alpine` tag will be used for nginx on new installations, this decreases the image size for users running nginx from 240 to just 62MB.
- `alpine` tag will be used for apache on new installations, this decreases the image size for users running nginx from 117 to just 67MB.
- `8.6.2-alpine` tag will be used for redis on new installations, this decreases the image size for users running nginx from 140 to just 97MB.
- `1.6.41-alpine` tag will be used for memcached on new installations, this decreases the image size for users running nginx from 85 to just 13MB.
- Cloudflare turnstile from [the Captcha module](https://github.com/stefanpejcic/captcha) on login form is now [full-width](https://developers.cloudflare.com/turnstile/get-started/client-side-rendering/widget-configurations/#widget-sizes).
- phpmyadmin absolute uri can no longer be set by the user.
- *OpenPanel > Containers > Terminal* can now be disabled by creating a file `/etc/openpanel/disable_openpanel_terminal_ui`.
- [Set a separate domain for OpenPanel UI](/docs/articles/dev-experience/separate-domain-for-openpanel-access).
- [Removing the Port for OpenAdmin](/docs/articles/dev-experience/remove-custom-port-for-openadmin)
- [Removing the Port for OpenPanel](/docs/articles/dev-experience/remove-custom-port-for-openpanel)
- File `/etc/openpanel/openpanel/core/users/repquota` is replaced with `/etc/openpanel/openpanel/quota_report.json` for user quotas displayed in UI.
- [`--over-quota` flag removed from `opencli user-list` command](https://github.com/stefanpejcic/opencli/commit/588d833329ef16e7fd018d740523ddd3849a6a6b).
- `opencli user-resources` command is deprecated.
- When starting services, the user’s total CPU and memory limits are no longer enforced; instead, the system throttles services once these limits are reached.
  

### 🐛 Bug Fixes
- [postgresql db creation fails #908](https://github.com/stefanpejcic/OpenPanel/issues/908)
- [404 on /postgresql/pgadmin #903](https://github.com/stefanpejcic/OpenPanel/issues/903)
- [On OpenPanel > PHP > Select version all domains show / #899](https://github.com/stefanpejcic/OpenPanel/issues/899)
- Fixed a JS bug in WP Manager where the Refresh Screenshot button failed to regenerate screenshots.
- Fixed broken websites link in search results: `/website/<domain>` to `/website?domain=<domain>`.
- Fixed error `An error occurred: name 'table_names' is not defined` in WP Manager when generating database backup.
- [Custom admin port is not detected by 'Back to OpenAdmin' button when impersonating a user #898](https://github.com/stefanpejcic/OpenPanel/issues/898)
- Fixed bug on PHP Options page that caused CSRF token to show in the URL.
- Fixed error on user-delete: `/usr/local/opencli/user/delete.sh: line 144: syntax error near unexpected token }'`
- Fixed bug deleting domain from terminal.
- Fixed 500 errors on MySQL pages, Favorites and WAF pages.
- Fixed 500 error on Email when email server is not installed.
- Fixed 500 error on Webmail caused by license scirpt not adding required volumes to openpanel container when license is added.
- Fixed bug applying new limits to suers when plan is edited.
- Fixed an issue in WP Manager where *X time ago* displayed a negative number when the browser/device time was ahead of the server time.
- Fixed JS error `Uncaught SyntaxError: Identifier 'toastMessage' has already been declared (at emails:48:10261)` on Emails.
- Fixed bug on user and doamin delte that cuased the email accounts to NOT be deleted.
- [Editing php.ini for not active version starts it #902](https://github.com/stefanpejcic/OpenPanel/issues/902)
- Fixed bug showing correct unit on *OpenPanel > Emails > Accounts > edit* page.
- Fixed bug setting disk quota on *OpenPanel > Emails > Accounts > edit* page.
- [/wordpress/secure not working for a subfolder installations #907](https://github.com/stefanpejcic/OpenPanel/issues/907)

---

// File: changelog/1.7.51

Released on April 05, 2026

### 💅 Polish
- [phpMyAdmin willl now use socket instead of TCP for connecting to MySQL/MariaDB containers](https://github.com/stefanpejcic/openpanel-configuration/commit/ccb979e6477daf853ddf1e67c6e65f429cb08cce).
- 'Demo Mode' page is no longer shown in OpenAdmin sidebar.
- Error is logged on too many failed logins if CSF is not instaleld and OpenPanel failed to temporary block the IP address.
- Redesign of the Dashboard widgets.
- [User can now select desired code editor when editing files: Monaco (default), Ace, CodeMirror or Plain Text](/img/docs-content/Xv0sPDG6-2026-04-02-19-57.png).
- `/php/limits` and `/php/extensions` pages are removed.
- Status shown on the services page now displays the exact Docker status (Created, Up, Up (Paused), Up (Restarting), Up (Healthy), Up (Unhealthy), Exited, Restarting, Removing, Dead).
- Refactored pages: redis, memcached, opensearch, elasticsearch, varnish, services.

### 🐛 Bug Fixes
- [fix: assign static IPs to openpanel_network to prevent stale iptables DNAT rules on port 2083](https://github.com/stefanpejcic/OpenPanel/pull/911#event-24199953913)
- [Changing php to EOL version breaks OpenLiteSpeed service #910](https://github.com/stefanpejcic/OpenPanel/issues/910)
- [After new e-mail created stats show wrongly #883](https://github.com/stefanpejcic/OpenPanel/issues/883)
- [Mailserver not starting - just created #904](https://github.com/stefanpejcic/OpenPanel/issues/904)
- Fixed js bug showing resource usage on *OpenAdmin > Users > single user > Services* page.
- [When services module is enabled the API call `/api/services?name=service` is doubled on some pages #900](https://github.com/stefanpejcic/OpenPanel/issues/900)
- Fixed error on WP Autoinstaller stuck on importing tables if php container did not start yet.
- Fixed bug on *Process Manager* page displaying container names.
- Fixed error `An error occurred: 'None' has no attribute 'cpu'` on *Advanced > Resource Usage* page when data was not collected yet for a new user.
- [Bug in OpenPanel UI on `/services` - Unable to start or stop services from user panel #909](https://github.com/stefanpejcic/OpenPanel/issues/909)
- Fixed bug with access log and failed login logs of OpenPanel not being stored.
- Fixed broken links for Usage widget on Dashboard page.

---

// File: changelog/1.7.52

Released on April 08, 2026

### 💅 Polish
- Path on Edit File page now leads to file manager.
- command `opencli server-ips` is removed.
- `GRANT ALL PRIVILEGES ON db. TO user@localhost` is no longer shown on Postgres and MySQL Database wizard pages.
- Optimized actions on WP Manager: checking maintenance-mode status, checking cahce type, flush cache, verify-checksum, wp core download.
- system databases set by Administrator are now checked on /mysql/databases
- Optimized database list process on MySQL Databases page.
- https://php-versions-api.openpanel.org/ is replaced with https://api.openpanel.org/php-versions/
- https://usage-api.openpanel.org/ is replaced with https://api.openpanel.com/statistics/
- cronjobs can now be added to backup.
- for new users, container logs are auto-rotated at 20mb.
- `--enable-dev-mode` and `--screenshots` flags are removed from install script.
- [refactored install script](https://github.com/stefanpejcic/OpenPanel/commit/c2873ef66604ea05e331e6eca493bbd4040f951a).
- /mysql/change-password page is separated into `mysql_root_password` module.
- /mysql/processlist page is separated into `mysql_processlist` module.
- Autoinstallers for NodeJS, Python, WordPress, SiteBuilder now enforce websites_limit from the plan.
- Optimized service status detection process on *OpenAdmin > Services > Status*.
- command `opencli user-resources` is removed.
- APScheduler is repalced with mysql EVENT.

### 🐛 Bug Fixes
- [Code in e-mail templates breaks HTML #887](https://github.com/stefanpejcic/OpenPanel/issues/887)
- Fixed bug on WP Clone: files fail to copy when subdirectory is set for destination.
- Fixed incorrect path shown on Activity Log whn user renames a file.
- Fixed bug with websites count shown on Dashboard page showing max 100 sites.
- Fixed bug that caused `/domains/stats` to show in search results when just domains module is enabled and not goaccess.
- Fixed error `invalid WAF config from string: failed to parse string: unknown directive "secrxprefilter"` on caddy restart.
- Fixed bug that caused domain dns zones to stay on the server when user is deleted.
- Fied bug on UI for subdomains check where fakeexample.com was considered a subdomain of example.com

---

// File: changelog/1.7.53

Released on April 15, 2026

### 💅 Polish
- Improvements to OpenPanel template to avoid Flash of Unstyled Content (FOUC) caused by the sidebar.
- Admin panel is now limited to a single worker if cpu cores are less or equal 2.
- Added validations on *OpenPanel > DNS > Edit DNS File* page.
- `alpine` tag will be used for OpenResty webservers of new users, disk size needed is decreased from 511MB to 222MB.
- Improvements to WPManager Updates section.
- [ProxyPass should be used for all domains on account transfer #897](https://github.com/stefanpejcic/OpenPanel/issues/897)
- CPU% and Memory Usage are no longer shown in OpenAdmin UI if user is suspended.
- 'Containers' column is removed from OpenAdmin > Users table.
- Improvements to *OpenPanel > MySQL > Remote Access* page.
- The MariaDB/MySQL database type is now clearly displayed on all database pages.
- Added host validation on all MySQL user pages.
- Improvements to OpenAdmin > Advanced > SSH page.
- Sessions on OpenAdmin are now IP-based - if a user's IP address changes, they will be logged out.
- Added fallback IP check servers for OpenPanel and OpenAdmin.
- Optimized OpenAdmin > Settings > Notifications page when saving.

### 🐛 Bug Fixes
- [Cannot delete Authorized Keys SSH](https://community.openpanel.org/d/282-cannot-delete-authorized-keys-ssh)
- [SSL for hostname wont generate if hostname is set to a subdomain of an existing user domain #915](https://github.com/stefanpejcic/OpenPanel/issues/915)
- [Generate Report on *OpenAdmin > License* does not shows the id message #919](https://github.com/stefanpejcic/OpenPanel/issues/919)
- [Renaming a user with opencli user-rename throws an error #917](https://github.com/stefanpejcic/OpenPanel/issues/917)
- [Bug in OpenAdmin UI - Renaming User results in 500 error #916](https://github.com/stefanpejcic/OpenPanel/issues/916)
- [Incorrect link on admin login page when using separate domains #918](https://github.com/stefanpejcic/OpenPanel/issues/918)
- Fixed `mysql: [ERROR] mysql: option '-e' requires an argument.` on `opencli admin suspend` command.
- Fixed bug on Sentinel that auto-started BIND9 service if zone files exist even whne 'dns' module is disabled.
- Fixed `time data 'for' does not match format '%Y-%m-%d'` on `/json/combined_activity` in OpenAdmin caused by long strings in the long when suer adds a DNS record.
- Fixed bug with screenshots generation in SiteManager when subdirectories are used.
- Fixed bug with Google PageSpeed data checks in SiteManager when subdirectories are used.
- Fixed error on OpenAdmin > Users > Create New when 'send email' option is enabled and no custom port is used for OpenPanel.
- Fixed 404 error on OpenPanel > WP Manager > Security > Harden option after applying the rules, when subdirectory is used.
- Fixed error on OpenPanel > WP Manager > Clone action when subdirectory is set as source domain.
- Fixed JS bug generating random database name on MySQL Databases and Postgres Databases pages.
- Fixed syntax error in Sentinel terminal commands.

---

// File: changelog/1.7.54

Released on April 17, 2026

### 💅 Polish
- AlpineJS is no longer loaded from CDN, instead its self hosted on OpenPanel and OpenAdmin.
- `--cli` and `--csf` flags are removed from `opencli report` command.
- mysql access is restricted to localhost on new installations.
- Database sizes on MySQL page are no longer auto-fetched, instead amn option is presented to user to display size.
- [Added an option to export databases from MySQL Databases page](/img/docs-content/SS1gHLK8-2026-04-16-13-48.png).
- File Editor now prompts when closing if user has unsaved changes.
- [Cronjob Logs are now displayed on the Cronjobs page](/img/docs-content/y7H8bxNy-2026-04-16-15-04.png).
- [Varnish Cache page now displays usage stats](/img/docs-content/1mV3nqtf-2026-04-16-15-31.png).
- Added `validate_ip_address_cookie` option which validates IP that user logged in from vs the IP they are accessing from.
- Added `email_plaintext_passwords` option that disables sending plain text passwords in Welcome emails when new users are created.
- [Added OOM error checks on Sentinel service and notifications on OpenAdmin](/img/docs-content/8DC1ZbJN-2026-04-16-19-09.png).
- DNS resolution checks by sentinel service are disabled by default on new installations.
- [Added website traffic checks on Sentinel service and notifications on OpenAdmin](/img/docs-content/4JNtfS4M-2026-04-16-20-39.png).
- Valkey service is added for new installations.
- Improved healthchecks for MySQL, MariaDB and Memcached services.
- Implemented bandwidth (port speed) for users.
- Resource Usage Hisotry page now also includes bandwidth usage.

### 🐛 Bug Fixes
- Fixed bug on File Manager accepting files in uri param as directories.
- Fixed bug on File Editor breadcrubms links that linked file name as a directory.
- Fixed error `Unterminated string starting at: line 1 column 188 (char 187)` on Cronjob Logs when line is invalid JSON.
- [Fixed bug on plan edit when applying Memory limit ot user](https://github.com/stefanpejcic/opencli/commit/4fd578013d3560f34df53792284cadffe8ab7ca1).
- Fixed bug on user-unsuspend that caused the domains to remain suspended.
- Fixed bug in sentinel using https:// when IP is set for panel access.

---

// File: changelog/1.7.55

Released on April 18, 2026

### 💅 Polish
- SSL support for shortlived Let's Encrypt certificates on IPv4 address for OpenPanel and OpenAdmin UI.

### 🐛 Bug Fixes
- [alpine.js error in OpenAdmin UI after the 1.7.54 update #922](https://github.com/stefanpejcic/OpenPanel/issues/922)

---

// File: changelog/1.7.56

Released on April 29, 2026

### 💅 Polish
- https:// and shortlived SSL is now used on new isntallations if public IPv4 is present on the server and custom domain is not provided by user.
- Improvements to Bandwidth (port speed) restrictions.
- Improvements to plan-apply and users-add scripts.
- `opencli commands` is renamed to `opencli help`.
- `opencli webserver-get_webserver_for_user` command is deprecated.
- Commands: `opencli php-domain`, `opencli domains-edit`, `opencli domains-delete`, `opencli domains-docroot`, `opencli domains-add`, `opencli user-varnish` no longer use the deprecated `opencli webserver-get_webserver_for_user` command.
- CSS improvements on user-panel: auto-height for logo image, close/open cursors for closing sidebar
- Users can now be created with resources exceeding the server physical cpu and memory.
- `/api/database-size` no longer uses user defined ini file for executing wp cli command.
- WP-CLI updated to v2.12.0
- UI changes in user panel: search moved to top-right corner, 'Dahsboard' removed from menu items, added expand/collapse button on the menu.
- Added `/mysql/import`, `/domains/new`, `/domains/suspend`, `/domains/unsuspend`, `/services` links to search filter.
- Cronjob service is now auto-disabled for user if no cronjobs exist.
- Added 60s timeout for `/root/openpanel_run_on_startup` executed on UI startup.
- Added 5s timeout for opencli scripts executed on UI startup.
- Added 10s timeout for purging redis cache on UI startup.
- Added caching for mysql type on MySQL pages.
- Default login ratelimit is increased from 5 to 20 attempts per minute.
- Added redis caching to Favorites and Capitalize modules.
- `/api/container/df` page removed from user panel.

### 🐛 Bug Fixes
- Fixed bug with MOTD on root login that still used http:// wven when IP with SSL is set.
- Fixed bug on domain-add that failed to detect webserver for user, causing vhost files to not be created.
- Fixed bug on `opencli user-login` failing to format url when IP is set for panel access and no SSL.
- Fixed bug on OpenAdmin > Settings > API with loading examples.
- Fixed bug on domain suspend/unsuspend status not shoed in user panel for 30s.
- Fixed bug on `opencli email-server install` that used http for IP even if SSL is available.
- Fixed a bug in FileManager where creating a new file incorrectly reported success even if the file already existed.
- Fixed `EventSource's response has a MIME type ("text/plain") that is not "text/event-stream". Aborting the connection. ` on OpenAdmin > Process Manager > Strace.
- Fixed bug with Inodes Explorer not showing in search results.
- Fixed bug on healtcheck for Elasticsearch returning Unhealthy due to `xpack.security.enabled` in versions 8+
- Fixed bug on docroot change with webserver not being restarted.
- Fixed bug: dns zone not reloaded on DNS record edit
- Fixed bug on DNS zone restart: rpemail not being set.
- Fixed error on plan edit when applying limits to suspended users.
- Fixed warning `/usr/local/lib/python3.12/site-packages/urllib3/connectionpool.py:1097: InsecureRequestWarning: Unverified HTTPS request is being made to host '185.193.66.252'. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.io/en/latest/advanced-usage.html#tls-warnings` when IP and https are used for shortlived SSL.
- Fixed notification sending bug due to hardcoded port 2087.

---

// File: changelog/1.7.57

Released on May 08, 2026

### 💅 Polish
- [Ubuntu 26.04 Support #872](https://github.com/stefanpejcic/OpenPanel/issues/872)
- Added 1h caching for user data in user panel: username, plan_id, context, plan_name, email address.
- MySQL: replaced all subprocess docker exec calls with direct mysql.connector pooled connections per user using socket paths for cross-container access.
- MySQL Database Wizard [now shows login credentials after creation](/img/docs-content/JnDHDkLM-2026-05-04-12-17.png), along with [code snippets for WordPress, Laravel, Django, Node.js, PHP PDO](/img/docs-content/LXYgY1pH-2026-05-04-12-17-1.png).
- Added options to run Optimize and Repair on tables from the MySQL page.
- Refactored modules: files, emails, dashboard, mysql.
- Added validations to file manager's 'Download from URL' option to prevent local links.
- Added locale flags on OpenPanel login form.
- Nameservers are no longer shown on Dashboard page when user does NOT have the 'domains' module enabled.
- Active Sessions are moved from MySQL database to Redis cache. TODO: https://github.com/search?q=repo%3Astefanpejcic%2Fopencli%20active_sessions&type=code
- [2x faster mysql database imports from cPanel](https://github.com/stefanpejcic/CyberPanel-to-OpenPanel/commit/b61b677f2a5ae0eec04d73f4b6725e79fdb2b881) and CyberPanel backups.
- Disk and Inodes usage is now refreshed every 5m for new installaitons.
- Disk and Inodes usage in OpenPanel UI is now refreshed after creating a user.
- Removed 'required' attribute on input field for plan description in OpenAdmin > Plans > New/Edit pages.
- Install script now checks package locks and waits for apt/dnf.
- [Refactored user-add script](https://github.com/stefanpejcic/opencli/commit/d227703d044a4a8066a7a99de8276693f459323d).

### 🐛 Bug Fixes
- Fixed css bug with text wrap on 'Service' widget in top-right corner.
- [AutoSSL does not include www subdomain by default #931](https://github.com/stefanpejcic/OpenPanel/issues/931)
- Fixed bug with 'Max hourly email' on OpenAdmin forms accepting negative values.
- Fixed bug wioth service name displayed in top-right corner when 'services' module is disbaled.
- [Allow creating a user with the same username as a suspended user #932](https://github.com/stefanpejcic/OpenPanel/issues/932#event-25162408050)
- [Warning: sch_htb: quantum of class 10010 is big. Consider r2q change. #927](https://github.com/stefanpejcic/OpenPanel/issues/927#event-25162678002)
- Fixed CSRF error on removing website builder.
- Fixed bug with WP Manager > Enable Maintenance Mode not working for subdirectories.
- Fixed bug on cPanel backup import failing to import postgres databases.
- [Email accounts migrate but mailbox data/content not transferred from cPanel to OpenPanel #28](https://github.com/stefanpejcic/cPanel-to-OpenPanel/issues/28)
- Fixed bug on OpenAdmin > Dashboard > User Activity when user was imported from cpanel backup file.
- Fixed bug deleting redis cache when user ip address is changed.
- [test: extract files in File Manager fails on 1.7.57 #934](https://github.com/stefanpejcic/OpenPanel/issues/934)

---

// File: changelog/1.7.58

Released on May 17, 2026

- Openadmin test: sync_existing_zones_to_slave(slave_ip, master_ip)

### 💅 Polish
- Added auto-login to webmail from *OpenPanel > Emails* and *OpenAdmin > Emails* pages.
- Added option for admins to set custom path (partition) on *OpenAdmin > Emails > Settings* for mailbox storage.
- OpenAdmin > Process Manager now uses `SIGKILL` instead of `SIGTERM` to kill pid.
- ElasticSearch and OpenSearch data now persists on service restart.
- [Use ZeroSSL as fallback when Let's Encrypt fails #940](https://github.com/stefanpejcic/OpenPanel/issues/940)
- [Increased cpu/ram defaults for services](https://github.com/stefanpejcic/openpanel-configuration/commit/6ccc97ae42639abbe939b42a6f46ada6a29b996f).
- Webmail is removed from OpenPanel Dashboard page, search results and menu items.
- Added option for admins to set which services autostart for users.
- `opencli docker` command no longer uses lazydocker.

### 🐛 Bug Fixes
- [On mobile: plan Edit - Save Burton not visible #951](https://github.com/stefanpejcic/OpenPanel/issues/951)
- [Email files NOT counted in DU for the user #941](https://github.com/stefanpejcic/OpenPanel/issues/941)
- [SMTP error when sedning emails from webmail via openpanel autologon #942](https://github.com/stefanpejcic/OpenPanel/issues/942)
- Fixed `Error establishing a Redis connection` for redis connection on  WP Redis Object Cache plugin.  
- Fixed bug with login to user panel when http is used.
- [Doesn't allow to allocate storage and other settings on account creation #884](https://github.com/stefanpejcic/OpenPanel/issues/884)
- [UI for e-mail forwarders/aliases missing? #937](https://github.com/stefanpejcic/OpenPanel/issues/937)
- [Emails > Accounts page is empty for user after panel restart, refreshes on new account creation #939](https://github.com/stefanpejcic/OpenPanel/issues/939)
- [Emails > Connect Devices page shows non-ssl when IP is set #938](https://github.com/stefanpejcic/OpenPanel/issues/938)
- Fixed `time=2026-05-11T16:45:56.225Z level=ERROR msg="Fatal error running command: <html><body><h1>403 Forbidden</h1>\nRequest forbidden by administrative rules.\n</body></html>" error="main.(*command).runAsCommand: error running script: main.runScript.func4: error running script: main.(*script).stopContainersAndServices: error determining swarm state: main.isSwarm: error getting docker info: Error response from daemon: <html><body><h1>403 Forbidden</h1>\nRequest forbidden by administrative rules.\n</body></html>"` for backup mysql.
- Fixed bug on OpenAdmin > Advanced > Process Manager with strace process remaining after user navigates away from the page.
- Fixed bug with backup unable to resolve remote ssh destinations.
- Fixed bug with module names appearing in search results on user panel when user does not have the feature enabled on plan.
- [Error fetching databases: Can not reconnect to MySQL after 1 attempt(s): 1045 (28000): Access denied for user 'root'@'localhost' (using password: YES) #943](https://github.com/stefanpejcic/OpenPanel/issues/943)
- [Bug in OpenAdmin UI -> Delete User Confirmation bug #948](https://github.com/stefanpejcic/OpenPanel/issues/948)
- [Some menu items are missing from search results #926](https://github.com/stefanpejcic/OpenPanel/issues/926)
- Fixed bug on `/server/waf/log/<domain>` infinite loading when domain has millions of logs.
- [FileManager: clicking on 'Calculate Size' multiple times shows an error #945](https://github.com/stefanpejcic/OpenPanel/issues/945)
- Fixed bug in `opencli email-ratelimit` script that cuased hourly limits for user domains not to be set.
- Fixed cache issue when email is deleted causing the email to still be visible on Emails page.

---

// File: changelog/1.7.59

Released on June 03, 2026

### 💅 Polish
- gzip is now enabled by default for new domains.
- DynamicDNS module is out of BETA.
- Added support for user@domain FTP accounts.
- FTP accounts are now supported on import from cPanel account backup.
- Added option to specify reseller user on account creaton and cpanel/cyberpanel backup import.
- Added storage usage to Resellers table on OpenAdmin.
- Added `/emails/export` in OpenPanel that allows users to export list of all emails.
- Added `/php/php<version>/info` in OpenPanel that allows users to view `php -i` for selected version.

### 🐛 Bug Fixes
- [I hadn’t specified an IP address on a user account, which caused the Flask API to crash. #961](https://github.com/stefanpejcic/OpenPanel/issues/961)
- [OpenPanel Sentinel Swap Cleanup Triggers OOM and Server Freeze #959](https://github.com/stefanpejcic/OpenPanel/issues/959)
- [Daily Usage email style broken #954](https://github.com/stefanpejcic/OpenPanel/issues/954)
- Fixed bug on *WAF > Logs* page with columns missing rule IDs and tags: https://openpanel.com/docs/panel/advanced/waf/
- Fixed `2026-05-17 21:25:35 File "<frozen 2083-x86.modules.mysql>", line 100, in check_mysql_inside_container: TypeError: '<' not supported between instances of 'int' and 'str'` on WP autoinstall if MySQL/Mariadb not initialized yet.
- Fixed bug on Crons page fetching containers for new suers, due to [syntax error in compose file](https://github.com/stefanpejcic/openpanel-configuration/commit/0b5aa2a5bbb62ebf38fa7b99751e892d87e635ef).
- Fixed bug on mailserver install that caused Postfix to fail if IP is used with SSL.
- [Caching issues with Usage widget on Dashboard page #955](https://github.com/stefanpejcic/OpenPanel/issues/955)
- [Create Database button on MySQL page after installation is still cached for X seconds #946](https://github.com/stefanpejcic/OpenPanel/issues/946)
- Fixed bug on delete and plan edit for user from OpenAdmin.
- Fixed bug on domlogs not being generated for domains when https is not enforced.
- Fixed bug with FTP connections empty on user panel.
- [Reseller user created a plan and cant view it #964](https://github.com/stefanpejcic/OpenPanel/issues/964)
- Fixed bug with 'OpenAdmin > Emails > Reports' being empty on update until `opencli email-server pflogsumm` runs again.
- Fixed bug with `opencli email-server pflogsumm` script deleting reports before saving them.
- [WHMCS module issues reported via ticket #5](https://github.com/stefanpejcic/openpanel-whmcs-module/issues/5)

### Security Advisories

> NOTE: these vulnerabilities affect only the [phpmyadmin](/docs/admin/settings/modules/#phpmyadmin) and [temporary_links](/docs/admin/settings/modules/#temporary-links) modules.

- [Hardcoded SSO token in phpMyAdmin pma.php](https://github.com/stefanpejcic/OpenPanel/security/advisories/GHSA-m8fv-5cx3-qxm2)
- [SSRF in preview proxy via missing private-IP filter ](https://github.com/stefanpejcic/OpenPanel/security/advisories/GHSA-328g-rjrj-4h73)
- [Unauthenticated PHP Code Injection in preview proxy service leads to Remote Code Execution ](https://github.com/stefanpejcic/OpenPanel/security/advisories/GHSA-c47r-33rm-gg85)

---

// File: changelog/1.7.60

Released on June 06, 2026

### Polish
- Shared phpMyAdmin service for all users to access their mysql/mariadb databases.
- MongoDB service is added in compose template for new installations.
- [Enhancements to MySQL/MariaDB and PSQL imports from cPanel backup #972](https://github.com/stefanpejcic/OpenPanel/pull/972)
- DMARC is now added by defualt in DNS zone template for new installations.
- ClamAV is removed for new installations.
- Auto-start phpmyadmin service if user mysql/mariadb services detected.

### 🐛 Bug Fixes
- [Bug with email quotas over 100% in OpenPanel UI on /emails](https://github.com/stefanpejcic/OpenPanel/issues/967)
- [CentOS 10 install bug: use cronie instead of cron #971](https://github.com/stefanpejcic/OpenPanel/issues/971)

---

// File: changelog/1.7.61

Released on June 18, 2026

### Improvements
- Added 2FA for OpenAdmin, options for resellers and admins to configure their 2FA, and option for admins to view stauts for users, and option for Super Admin to disable per user.
- Refactored search functionality in OpenPanel UI.
- reduced Redis writes by ~95% for active users by adding 1 expired check per 60s.
- default limits are now shown on *OpenAdmin > Services > Service Limits* and *OpenAdmin > Services > Edit Defaults* pages.
- Added `twofa_enforce` option that forces users to configure 2FA before accessing any other pages.
- Env variables that contain passwords are now hidden on **OpenAdmin > Users > *single user* > Services** page.
- Sentinel service will now check if systemd service was disabled by Administrator before performing restart.
- Added option in **OpenAdmin > Users > *single user* > Permissions** to edit permissions just for this user.
- Added OS installation test tasks to automatically verify OpenPanel installation across all supported operating systems and update [the README](https://github.com/stefanpejcic/OpenPanel/blob/main/README.md#supported-os) with the latest validation status, including the most recent check timestamp.
- Improvements to `opencli sentinel` script.
- [Separate /api/ calls to API.py module #949](https://github.com/stefanpejcic/OpenPanel/issues/949)
- [`max_email_quota` and `max_hourly_email` are now visible in WHMCS module for plan details](https://github.com/stefanpejcic/openpanel-whmcs-module/commit/7ab4ba90fd1d6335737b97c5f357f57714f26ca3)
- [extend user/transfer script to also use new columsn we ahve for plans #158](https://github.com/stefanpejcic/opencli/issues/158)
- [Added warning messages on install for RHEL10 when iptables are missing](https://github.com/stefanpejcic/OpenPanel/commit/d998db9875c23978fe3cc2ec89a2d3035dfd730d) for [969](https://github.com/stefanpejcic/OpenPanel/issues/969) and [#970](https://github.com/stefanpejcic/OpenPanel/issues/970).
- Added `/server/resource-usage/history` on OpenAdmin that allows admins to view reosurce usage history for last 30 days.
- Refactored domains-add process.
- Added options to vlaidate connection to slave server and remove it from *OpenAdmin > Domains > DNS Cluster* page.
- Implemented [rndc-based notification](https://www.ibm.com/docs/en/aix/7.2.0?topic=security-transaction-signatures-bind-version-94) instead of SSH.
- Added support for TLSA DNS records in OpenPanel > Zone Editor and option to auto-generate record from the current SSL certificate for a domain.
- Added options to bulk-edit email accounts from *OpenAdmin > Emails > Accounts*: change password, restrict sending/receiving, change quota, delete.
- Refactored FileManager front-end code.
- jQuery is removed from all OpenPanel UI templates.
- Added 'no data' messages to ftp connections and dynamic dns pages.
- Added frontend validations for VHosts Editor.
- Added `reseller_rename` option for OpenAdmin notifications.
- [skip ssh welcome message on openadmin terminal](https://github.com/stefanpejcic/openpanel-configuration/commit/23fd4e0ee6f640118dc98987a7226d90bc7cbdd2).
- Added hard-enforced 10 results limits for file and folders search in FileManager.
- Cached disk usage and inodes data for user's Dashboard page is now invalidated after FileManager actions: upload, extract,copy, compress, delete, edit and for MySQL Database import process.
- `phpmyadmin_port` removed from Server Information page.
- Improvements to WP Autoinstaller page.
- Redesigned installer pages for WordPress, NodeJS/Python and WebsiteBuilder.
- Mautic module is removed for new installations.

### Security
- Bump [flask](https://github.com/pallets/flask) from 3.1.2 to 3.1.3
- Bump [idna](https://github.com/kjd/idna) from 3.11 to 3.15
- Bump [werkzeug](https://github.com/pallets/werkzeug) from 3.1.4 to 3.1.6
- Bumps [pyjwt](https://github.com/jpadilla/pyjwt) from 2.10.1 to 2.13.0
- Bump [requests](https://github.com/psf/requests) from 2.32.5 to 2.33.0
- Bumps [mysql-connector-python](https://github.com/mysql/mysql-connector-python) from 8.3.0 to 9.1.0
- Bumps [filelock](https://github.com/tox-dev/filelock) from 3.20.1 to 3.20.3



### 🐛 Bug Fixes
- [Logo not visible on mobile #950](https://github.com/stefanpejcic/OpenPanel/issues/950)
- [Daily Usage email style broken #954](https://github.com/stefanpejcic/OpenPanel/issues/954)
- [Option to change reseller user for OpenPanel account #962](https://github.com/stefanpejcic/OpenPanel/issues/962#issuecomment-4647426701)
- Fixed bugs on `opencli ftp-` commands failing if username and docker context are not the same (user was renamed).
- [WHMCS module installation returned an error #6](https://github.com/stefanpejcic/openpanel-whmcs-module/issues/6)
- [Node/Py auto-installer fails if app anme starts with a number #963](https://github.com/stefanpejcic/OpenPanel/issues/963)
- [Extend user-transfer to detect email folder setting from admin.ini and then to sync that user mail folders if out of their homedir #159](https://github.com/stefanpejcic/opencli/issues/159)
- [some actions dont trigger admin notifications #924](https://github.com/stefanpejcic/OpenPanel/issues/924)
- Fixed `OCI runtime exec failed: exec failed: unable to start container process: exec: "bash": executable file not found in $PATH` on `opencli docker <USERNAME> backup` command.
- [Editing backup settings in GUI shows 3 notifications #973](https://github.com/stefanpejcic/OpenPanel/issues/973)
- [Editing backup settings in GUI stops&starts the backup process, interrupting any backups in progress #974](https://github.com/stefanpejcic/OpenPanel/issues/974)
- Fixed css bugs on *OpenAdmin > Domains* > Delete modal.
- [Sites page shows invalid relative time (-1 days ago) with timezone mismatch #93](https://github.com/stefanpejcic/OpenPanel/issues/933)
- [Bug in OpenPanel UI on /emails/new #975](https://github.com/stefanpejcic/OpenPanel/issues/975)
- [OpenLiteSpeed: WordPress cannot install plugins/themes (wp-content not writable, upgrade dir not created) #925](https://github.com/stefanpejcic/OpenPanel/issues/925)
- Fixed crrash on /files.trash/deleteall in File Manager (trash_dir is a string but the code calls .iterdir() and string division on it as if it were a Path object).
- Fixed error on `opencli dev` on RHEL9 installing fzf.
- Fixed bug in `validate_wget_url` - that didn't block all internal ranges (SSRF).
- Fixed issue in `files()` route builds directory path without `secure_user_path`.
- Fixed bug with `UPLOAD_LIMIT` for phpmyadmin service not being set due to the missing unit.
- Fixed bug on file eidt that caused the activity log to show file was edited wven if saving teh content fails.
- [File operations executed via admin autologin into user panel have root privileges #976](https://github.com/stefanpejcic/OpenPanel/issues/976)
- Fixed bug on reseller rename that failed to update owner for exisiting users owned by that reseller.
- Fixed [bug deleting system user on RHEL due to `deluser` command](https://github.com/stefanpejcic/opencli/commit/438a80a4a7ddbb17c66d6b2feb3c4db8249152be).
- Fixed bug `/usr/local/opencli/user/add.sh: line 594: /etc/apparmor.d/home.testinguser.bin.rootlesskit: No such file or directory` on user creation on RHEL.
- Fixed bug on install when license key is set failing to setup docker volumes for emails causing [permission issues](https://github.com/stefanpejcic/OpenPanel/issues/978).
- Fixed syntax error on creating ftp users.
- Fixed bug: rndc.key key is missing for bind when installed with `--skip-dns-server` and Admin later enables the DNS module.
- Fixed error on changing ftp suer password.

---

// File: changelog/1.7.62

Released on June 22, 2026

### 🚀 New
- [🇷🇸 Serbian translation](https://community.openpanel.org/d/301-pricaj-srpski-da-te-ceo-svet-razume-serbian-translation-for-openpanel).
- Added proactive health-check toast notifications across OpenPanel pages: domains, emails, dashboard, mysql, postgresql, email deliverability.
- [Passkey support for admin and user web control panels #966](https://github.com/stefanpejcic/OpenPanel/discussions/966)
- [Option for end-users to generate DKIM for a domain and insert it into DNS zone #768](https://github.com/stefanpejcic/OpenPanel/discussions/768)
- [Change file permissions in bulk / for multiple files [FEATURE REQUEST] #848](https://github.com/stefanpejcic/OpenPanel/discussions/848)
- [Whitelisted IPs for Remote MySQL [FEATURE REQUEST] #846](https://github.com/stefanpejcic/OpenPanel/discussions/846)
- [OpenPanel account notes #876](https://github.com/stefanpejcic/OpenPanel/discussions/876)
- On WP Manager added option to auto-login as a specific user.

### 🎨 Polish
- Emails module is split into 8 modules: emails, email_deliverability, email_filters, email_aliases, email_import, email_export, email_default, webmail.
- Domain suspend/unsuspend is moved from domains module to a new module: domain_suspend.
- File Manager > Trash is moved from filemanager module to a new module: trash.
- Added custom wpmu plugin for autologin functionality.
- Added `/wp-cli/users?domain=<DOMAIN>&docroot=/var/www/html/<DOMAIN>&php_version=7.4&role=administrator` route that retrieves WordPress users.
- Added 60sec timeouts to installing WPMU Autologin plugin on autologin from WP Manager.
- Added missing translations for 250+ strings accross 70 templates for OpenPanel UI.
- In OpenPanel templates, Flowbite nad Alpine-colapse plugins are now scoped only to the pages that they are acutually used on.
- Optimized containers resource usage information (docker stats) on containers page.
- Added 'generate certificate' button on SSL page.
- New actions are now recorded in user's activity log: changing backup config, switching backup destination, restoring from a backup, generate SSL, create/edit/delete dynamic DNS records, change domain docroot, capitalize a domain, creating a default (catch-all) address, importing mysql database, importing postgresql database, editing php.ini file, editing nginx/apache config, changing locale..
- Sentinel now checks if enough available RAM on the server to clear RAM, if swap was turned off, and cleanup is performed only once per 24h.
- Added 'Forward to' and 'Autoresponder' options in Email Filters GUI.

### 🐛 Bug Fixes
- Fixed bug on `opencli user-quota` that failed to show data for users that are over their plan quota.
- [Starting phpmyadmin from admin > services errors #989](https://github.com/stefanpejcic/OpenPanel/issues/989)
- [NumPy was built with baseline optimizations: (X86_V2) but your machine doesn't support: (X86_V2)  #994](https://github.com/stefanpejcic/OpenPanel/issues/994)
- [OpenAdmin 500 error on new install of 1.7.61: (sqlite3.OperationalError) no such column: user.totp_secre  #993](https://github.com/stefanpejcic/OpenPanel/issues/993)
- Fixed bug editing multi-line DKIM records from DNS Editor.
- [/sites has 404 link when autoinstaller not enabled
 #988](https://github.com/stefanpejcic/OpenPanel/issues/988)
- [in Trash: Calculate Size for directories shows for folders outside of trash #990](https://github.com/stefanpejcic/OpenPanel/issues/990)
- Fixed bug fetching options on WP Manager.
- Fixed bug showing used disk usage on Dashboard over 100%.
- Fixed bug showing inodes usage on Dashboard in rounded unites.
- Fixed bug editing .htaccess file from File Manager.
- [NumPy was built with baseline optimizations: (X86_V2) but your machine doesn't support: (X86_V2) #994](https://github.com/stefanpejcic/OpenPanel/issues/994#issuecomment-4763033834)
- Fixed 500 error on WP Manager > Autologin for openlitespeed webserver.
- Fixed [JS error *containers:6678 Error fetching container stats: TypeError: Cannot read properties of null (reading 'value')* on Containers page](https://discord.com/channels/1205652108213485568/1205652108213485571/1517622784031981743).
- [Bug in OpenPanel UI on /domains/new #986](https://github.com/stefanpejcic/OpenPanel/issues/986)

---

// File: changelog/1.7.63

Released on June 23, 2026

### 🎨 Polish
- *MB* is now the default unit size for Database Size in MySQL and PostgreSQL pages.
- Disabled the *WordPress Options loaded.* on WP Manager > Options tab.
- Added 'Address Exporter' to Dashboard icons.
- Added shared Postgres pool for executing postgresql from user panel.
- Added an option to change php version directly in WP Manager.
- Added shared js for converting dates in human-readable format accross the UI pages.

### 🐛 Bug Fixes
- [WebsiteBuilder backup restore is 500 #987](https://github.com/stefanpejcic/openpanel/issues/987)
- Resolved 404 error on `/json/postgresql-size`.
- Added missing translations to flash messages sent from backend, and toasts generated on the frontend.
- Fixed warning on user-delete: `/usr/local/opencli/user/delete.sh: line 208: : No such file or directory`.
- [OpenAdmin fails to start after updating to 1.7.62  #998](https://github.com/stefanpejcic/OpenPanel/issues/998)

---

// File: changelog/1.7.64

Released on June 30, 2026

### 🎨 Polish
- Added guided tours on OpenAdmin and OpenPanel UI.
- Added Backup Wizard module to OpenPanel.
- [PHP Extensions UI #996](https://github.com/stefanpejcic/OpenPanel/discussions/996)
- [Service status disabled/enabled is misleading #679](https://github.com/stefanpejcic/OpenPanel/discussions/679)
- [Extend password support for admin/reseller users #741](https://github.com/stefanpejcic/OpenPanel/discussions/741)
- [Private notes on OpenAdmin can now be added when creating an account via terminal](https://github.com/stefanpejcic/opencli/commit/ba64b54821a47d3f892cd0a0012ef2e215acbb7e).
- Added automation tests to login to webmail and test sending/receiving emails, assuring that Webmail service is working on each update.
- Added rate limiting to OpenAdmin API - reuses same limits set on OpenAdmin.
- Installed locales are now auto-updated on update process.
- Added optional `--json` flag to `opencli ftp-list <OPENPANEL_USERNAME> [--json]` command.

### 🔒 Security
- Fixed command injection in *OpenAdmin > Timezone* settings: the submitted timezone is now validated against the list of known `pytz` timezones.
- Removed shell injection risk in Notifications settings (`/settings/notifications`) by switching every `opencli` call from a shell-quoted string to a direct argument list.
- Removed shell injection risk in the Firewall (CSF) UI proxy and the Roundcube version check in *OpenAdmin > Service status* by switching from shell strings to argument lists.
- Fixed stored XSS in flash messages on OpenAdmin: they were rendered with Jinja2's `|safe` filter, so user-supplied values (domain names, usernames, IPs, webmail domains, etc.) echoed back in error/success messages could execute as HTML/JS.
- The JWT signing key on OpenAdmin now reuses the file-based secret key.
- License key actions on OpenAdmin no longer leak raw subprocess error output to API clients: errors are now logged server-side only.



### 🐛 Bug Fixes
- [Database restore in WP Manager works only for openlitespeed #983](https://github.com/stefanpejcic/OpenPanel/issues/983)
- [Bug in OpenPanel UI on search, empty feature set [] on tests #1005](https://github.com/stefanpejcic/OpenPanel/issues/1005)
- [Enabling remote MySQL gives an internal server error #1007](https://github.com/stefanpejcic/OpenPanel/issues/1007)
- [Bug in OpenPanel UI on /mysql Assigning existing db user to another db removes im from the previous #1001](https://github.com/stefanpejcic/OpenPanel/issues/1001)
- [When WAF Is disabled alert per domain is shown in WAF page #995](https://github.com/stefanpejcic/OpenPanel/issues/995)
- Fixed bug on *File Manager > Edit file* - if file did not exist it was created as root user.
- Fixed bug on *File Manager > Download from URL* - if file already existed it was overwritten.
- [Bug in OpenPanel UI on /website Checking options from WP-CLI.. #1004](https://github.com/stefanpejcic/OpenPanel/issues/1004)
- [Bug in OpenPanel UI on /website -11791 seconds ago #1003](https://github.com/stefanpejcic/OpenPanel/issues/1003)
- [On WAF Is disabled alert per domain is shown in WAF page #995](https://github.com/stefanpejcic/OpenPanel/issues/995)
- [Bug in OpenPanel UI on /domains/new : Uncaught ReferenceError: punycode is not defined #1000](https://github.com/stefanpejcic/OpenPanel/issues/1000)
- [Bug in OpenPanel UI on /mysql Assigning existing db user to another db removes im from the previous #1001](https://github.com/stefanpejcic/OpenPanel/issues/1001)
- [Bug in OpenPanel UI on /postgresql Error fetching databases: set_session cannot be used inside a transaction #1002](https://github.com/stefanpejcic/OpenPanel/issues/1002)
- Fixed bug with fix permissions script on Debian.
- Fixed bug deleting system user when account is terminated on CentOS 10.
- [error on CentOS10 of OpenAdmin > Advanced > System time #1006](https://github.com/stefanpejcic/OpenPanel/issues/1006)
- Fixed a broken `abort` call on the admin-to-user autologin route that silently fell through instead of aborting when no username was provided.
- For OpenAdmin license checks: added a request timeout, a 24h grace-period cache of the last successful check, and a background recheck that escalates from hourly to every 6h, 12h, then daily the longer the outage persists.
- Fixed bug saving cpu/ram limits via Containers page for php-fpm services.

---

// File: changelog/1.7.65

Released on July 09, 2026

### 🚀 New
- [🇱🇦 Lao (lo-LA) translation](https://github.com/stefanpejcic/openpanel-translations/pull/27)
- [160 endpoints for OpenPanel API](/docs/panel/api/)
- [OpenPanel MCP (Model Context Protocol)](/docs/panel/mcp/)
- [90 endpoints for OpenAdmin API](/docs/articles/dev-experience/openadmin-api)
- [*OpenPanel > Account > API Reference* page](/docs/panel/account/api/)
- Keyboard shortcuts in OpenPanel: `Ctrl`/`Cmd`+`S` save in OpenPanel > File Manager > Editor, `Ctrl`/`Cmd`+`B` toggles sidebar in OpenPanel UI, `n` opens the Create New page in OpenPanel when on pages: Crons, File Manager, Domains, Databases, Emails, `?` lists available shortcuts in OpenPanel UI.

### 🎨 Polish
- Default cpu/ram limits for new python/nodejs apps is now 1.0.
- Search results in OpenPanel UI for Enterprise edition now include: domains, websites, emails, ftp accounts, databases, crons, files, folder, containers, services.
- When `dev_mode` is enabled, all `docker logs openpanel` entries now include the module name, making it easier to identify which component generated each log or error. For example: `MYSQL - Checking database sizes...`.
- OpenAdmin Admin login notifications now check logins agains the ssh whitelist.
- Improvements to the OpenPanel UI sidebar.
- Private notes for users are now editable from OpenAdmin > Users table.
- Added loading/double-submit protection to on all form submissions in OpenPanel UI pages.
- [OpenAdmin service restart breaks UI #1014](https://github.com/stefanpejcic/OpenPanel/issues/1014)
- Added unified 'Password Strength' setting for all password fields in OpenPanel UI pages.
- Added validation messages to all input fields in OpenPanel UI pages.
- OpenPanel restart is no longer needed when changing permisisons for a single user or editing feature sets.
- Editing plan limits, changing plan for user, and changing IP for user no longer drop all redis cache.
- Removed 'rounded-lg' class from all input fields and selects in OpenPanel and OpenAdmin templates.
- `opencli domains-suspend` command now accepts optional `--comment='reason'` flag.
- User can now specify a reason why domain is suspended when suspending domain from OpenPanel. Reason is visible later on OpenPanel > Domains table.
- Added confirmation prompts for all text-area forms on OpenPanel and OpenAdmin templates.
- Removed 'select-none' class from all tables on OpenPanel and OpenAdmin templates.
- Added an option to delete images from *OpenPanel > Containers > Image Updates*.
- [Default cpu/ram limits are increased form 0.5 to 1.0 for php versions on new installs](https://github.com/stefanpejcic/openpanel-configuration/commit/feaf57d90660e6d83cda5d1e12ec697be6fd8919).
- [opcache is now enabled by default on new installs and execution limits increased](https://github.com/stefanpejcic/openpanel-configuration/commit/a9e7097576160dd7f92e4e31010d71103616d6cb).
- Optimized default configuration files for services: PHP, Nginx, OpenLitespeed, Apache, MariaDB, PostgreSQL on new installs.
- Added option to restore defualt webserver conf from *OpenPanel > Configuraton Editor* page.
- added an option to restore OpenPanel acocunts from full account backup in *OpenAdmin > Advanced > Import backup*.

### 🐛 Bug Fixes
- [User is able to create a database when MySQL installation is still underway #1019](https://github.com/stefanpejcic/OpenPanel/issues/1019)
- [Guided tour message keeps popping back up #1018](https://github.com/stefanpejcic/OpenPanel/issues/1018)
- Fixed [`user-add: pasta failed with exit code 1: netns dir open: Permission denied` on Almalinux when SELinux is used](https://community.openpanel.org/d/302-user-add-pasta-failed-with-exit-code-1-netns-dir-open-permission-denied).
- Fixed error that caused OpenPanel Enterprise edition to keep restarting if mailserver is running but no email accounts exist yet and webmail mofule is enabled.
- Fixed bug with plugins shown on *OpenAdmin > Feature Sets > Edit*.
- Fixed bug with fix-permissions module.
- Fixed error adding IDN domains via the UI.
- Fixed bug on user-suspend/unsuspend when user does not exist.
- Fixed bug with Type column on Domains table: it showed type if dns zone exists, instead of actually checking if apex or subdomain.
- Fixed bug that caused email filters (.sieve files) to not be persistent and deleted on service restart.
- Fixed css bug on search results for long domain names.

---

// File: changelog/1.7.66

Not yet released.

### 🐛 Bug Fixes

---

// File: changelog/1.8.0

Not yet released.

### 🐛 Bug Fixes
- [Feature Request: Cloudflare proxy compatibility — DNS-01 or temporary grey-cloud to fix SSL issuance failures #912](https://github.com/stefanpejcic/OpenPanel/issues/912)

---

// File: changelog/intro

# Changelog

### Upcoming version

| Version| Release date | 
|---|---|
|__[1.7.66](/docs/changelog/1.7.66)__| July 25, 2026 |
|__[1.8.0](/docs/changelog/1.8.0)__| September 10, 2026 |

### Latest

| Version| Release date | 
|---|---|
|__[1.7.65](/docs/changelog/1.7.65)__| July 09, 2026 |

### Previous versions

| Version| Release date | 
|---|---|
|__[1.7.64](/docs/changelog/1.7.64)__| June 30, 2026 |
|__[1.7.63](/docs/changelog/1.7.63)__| June 23, 2026 |
|__[1.7.62](/docs/changelog/1.7.62)__| June 22, 2026 |
|__[1.7.61](/docs/changelog/1.7.61)__| June 18, 2026 |
|__[1.7.60](/docs/changelog/1.7.60)__| June 06, 2026 |
|__[1.7.59](/docs/changelog/1.7.59)__| June 06, 2026 |
|__[1.7.58](/docs/changelog/1.7.58)__| May 17, 2026 |
|__[1.7.57](/docs/changelog/1.7.57)__| May 08, 2026 |
|__[1.7.56](/docs/changelog/1.7.56)__| May 01, 2026 |
|__[1.7.55](/docs/changelog/1.7.55)__| April 18, 2026 |
|__[1.7.54](/docs/changelog/1.7.54)__| April 17, 2026 |
|__[1.7.53](/docs/changelog/1.7.53)__| April 15, 2026 |
|__[1.7.52](/docs/changelog/1.7.52)__| April 08, 2026 |
|__[1.7.51](/docs/changelog/1.7.51)__| April 05, 2026 |
|__[1.7.50](/docs/changelog/1.7.50)__| April 01, 2026 |
|__[1.7.49](/docs/changelog/1.7.49)__| March 25, 2026 |
|__[1.7.48](/docs/changelog/1.7.48)__| March 23, 2026 |
|__[1.7.47](/docs/changelog/1.7.47)__| March 19, 2026 |
|__[1.7.46](/docs/changelog/1.7.46)__| March 11, 2026 |
|__[1.7.45](/docs/changelog/1.7.45)__| March 06, 2026 |
|__[1.7.44](/docs/changelog/1.7.44)__| February 25, 2026 |
|__[1.7.43](/docs/changelog/1.7.43)__| February 14, 2026 |
|__[1.7.42](/docs/changelog/1.7.42)__| February 09, 2026 |
|__[1.7.41](/docs/changelog/1.7.41)__| January 29, 2026 |
|__[1.7.4](/docs/changelog/1.7.4)__| December 30, 2025 |
|__[1.7.3](/docs/changelog/1.7.3)__| December 25, 2025 |
|__[1.7.2](/docs/changelog/1.7.2)__| December 02, 2025 |
|__[1.7.1](/docs/changelog/1.7.1)__| November 25, 2025 |
|__[1.7.0](/docs/changelog/1.7.0)__| November 20, 2025 |
|__[1.6.9](/docs/changelog/1.6.9)__| November 16, 2025 |
|__[1.6.8](/docs/changelog/1.6.8)__| November 14, 2025 |
|__[1.6.7](/docs/changelog/1.6.7)__| November 05, 2025 |
|__[1.6.6](/docs/changelog/1.6.6)__| October 29, 2025 |
|__[1.6.5](/docs/changelog/1.6.5)__| October 24, 2025 |
|__[1.6.4](/docs/changelog/1.6.4)__| October 23, 2025 |
|__[1.6.3](/docs/changelog/1.6.3)__| October 17, 2025 |
|__[1.6.2](/docs/changelog/1.6.2)__| September 30, 2025 |
|__[1.6.1](/docs/changelog/1.6.1)__| September 23, 2025 |
|__[1.6.0](/docs/changelog/1.6.0)__| September 12, 2025 |
|__[1.5.9](/docs/changelog/1.5.9)__| August 29, 2025 |
|__[1.5.8](/docs/changelog/1.5.8)__| August 25, 2025 |
|__[1.5.7](/docs/changelog/1.5.7)__| August 22, 2025 |
|__[1.5.6](/docs/changelog/1.5.6)__| August 15, 2025 |
|__[1.5.5](/docs/changelog/1.5.5)__| August 08, 2025 |
|__[1.5.4](/docs/changelog/1.5.4)__| August 07, 2025 |
|__[1.5.3](/docs/changelog/1.5.3)__| August 04, 2025 |
|__[1.5.2](/docs/changelog/1.5.2)__| July 30, 2025 |
|__[1.5.1](/docs/changelog/1.5.1)__| July 25, 2025 |
|__[1.5.0](/docs/changelog/1.5.0)__| July 22, 2025 |
|__[1.4.9](/docs/changelog/1.4.9)__| July 14, 2025 |
|__[1.4.8](/docs/changelog/1.4.8)__| July 09, 2025 |
|__[1.4.7](/docs/changelog/1.4.7)__| July 04, 2025 |
|__[1.4.6](/docs/changelog/1.4.6)__| July 03, 2025 |
|__[1.4.5](/docs/changelog/1.4.5)__| July 03, 2025 |
|__[1.4.4](/docs/changelog/1.4.4)__| June 25, 2025 |
|__[1.4.1](/docs/changelog/1.4.1)__| June 25, 2025 |
|__[1.3.9](/docs/changelog/1.3.9)__| June 25, 2025 |
|__[1.3.7](/docs/changelog/1.3.7)__| June 25, 2025 |
|__[1.3.6](/docs/changelog/1.3.6)__| June 04, 2025 |
|__[1.3.5](/docs/changelog/1.3.5)__| June 04, 2025 |
|__[1.3.4](/docs/changelog/1.3.4)__| June 04, 2025 |
|__[1.3.3](/docs/changelog/1.3.3)__| June 04, 2025 |
|__[1.3.2](/docs/changelog/1.3.2)__| May 29, 2025 |
|__[1.3.1](/docs/changelog/1.3.1)__| May 29, 2025 |
|__[1.3.0](/docs/changelog/1.3.0)__| May 29, 2025 |
|__[1.2.9](/docs/changelog/1.2.9)__| May 15, 2025 |
|__[1.2.8](/docs/changelog/1.2.8)__| May 08, 2025 |
|__[1.2.7](/docs/changelog/1.2.7)__| May 06, 2025 |
|__[1.2.6](/docs/changelog/1.2.6)__| May 06, 2025 |
|__[1.2.5](/docs/changelog/1.2.5)__| May 06, 2025 |
|__[1.2.4](/docs/changelog/1.2.4)__| April 25, 2025 |
|__[1.2.3](/docs/changelog/1.2.3)__| April 22, 2025 |
|__[1.2.2](/docs/changelog/1.2.2)__| April 22, 2025 |
|__[1.2.1](/docs/changelog/1.2.1)__| April 11, 2025 |
|__[1.2.0](/docs/changelog/1.2.0)__| April 11, 2025 |
|__[1.1.8](/docs/changelog/1.1.8)__| April 11, 2025 |
|__[1.1.7](/docs/changelog/1.1.7)__| March 27, 2025 |
|__[1.1.6](/docs/changelog/1.1.6)__| March 27, 2025 |
|__[1.1.5](/docs/changelog/1.1.5)__| March 20, 2025 |
|__[1.1.3](/docs/changelog/1.1.3)__| March 18, 2025 |
|__[1.1.2](/docs/changelog/1.1.2)__| March 18, 2025 |
|__[1.1.1](/docs/changelog/1.1.1)__| March 09, 2025 |
|__[1.1.0](/docs/changelog/1.1.0)__| March 03, 2025 |
|__[1.0.0](/docs/changelog/1.0.0)__| March 03, 2025 |

---

// File: panel/000_intro

# Get Started

OpenPanel is the main control panel for managing your web services. From OpenPanel, you can create and manage domains, email accounts, website content, SQL databases, and other server-related services.

## Log in to OpenPanel

By default, OpenPanel is accessible via your server’s IP address on port `2083`. Administrators may also configure a custom domain and port.  

To log in:

1. Open the link provided by your hosting provider.
2. Enter your assigned **username** and **password**.

## Password Reset

If you forget your password, follow these steps:

1. Click the **Forgot password?** link on the login page.  

   ![password reset link](/img/docs-content/rpCvZ1VP-2025-08-14-13-47.png)


   > **NOTE:** If the **Forgot Password?** link does not appear on the login form, email-based password reset is disabled by your hosting provider. In this case, you must either:
   >
   > 1. Log in automatically to OpenPanel through their billing panel and reset your password via [Account > Settings](/docs/panel/account/#changing-password)
   > 2. Contact your hosting provider to reset the password for you.

2. Enter your **email address** and click **Send Reset Link**.  

   ![password reset form](/img/docs-content/rV9kfkzw-2025-08-14-13-48.png)

3. If your email is associated with an account, you will receive a password reset email (link valid for 15 minutes).  

   ![password reset sent](/img/docs-content/DvhhQZvN-2025-08-14-13-49.png)

4. Open the email and click the reset link.  

   ![password reset email](/img/docs-content/KZBFgL2L-2025-08-14-13-50.png)

5. Enter your **new password**, confirm it, and click **Change Password**.  

   ![set new password form](/img/docs-content/9XFjSnqt-2025-08-14-13-50-1.png)

You can now log in using your newly set password.

---

---

// File: panel/999_api

# OpenPanel API

OpenPanel exposes a full REST API that mirrors all web UI functionality. Every feature available in the panel can be accessed programmatically.


## Authentication

All API requests require a Bearer token obtained via the login endpoint.

**Step 1 — Get a token:**

```bash
curl -s -X POST https://panel.example.com/api/login \
  -H "Content-Type: application/json" \
  -d '{"username": "stefan", "password": "yourpassword"}'
```

**Response:**

```json
{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "expires_in": 86400
}
```

**Step 2 — Use it on every request:**

```bash
curl https://panel.example.com/api/account \
  -H "Authorization: Bearer eyJhbGciOi..."
```

Tokens expire after **24 hours**. Both `api` feature AND the specific feature must be enabled in the user's plan.

---

## MySQL

### List databases and users

```bash
GET /api/mysql
Authorization: Bearer <token>
```

```json
{
  "databases": ["mydb", "shop"],
  "users": [{"username": "myuser", "host": "%"}]
}
```

### Create a database

```bash
POST /api/mysql
Content-Type: application/json

{"name": "newdb"}
```

### Get database info

```bash
GET /api/mysql/mydb
```

### Drop a database

```bash
DELETE /api/mysql/mydb
```

### List users for a database

```bash
GET /api/mysql/mydb/users
```

### Add user to database

```bash
POST /api/mysql/mydb/users
Content-Type: application/json

{"username": "dbuser", "password": "securepass"}
```

### Remove user from database

```bash
DELETE /api/mysql/mydb/users/dbuser
```

---

## PostgreSQL

### List databases and users

```bash
GET /api/postgresql
```

### Create a database

```bash
POST /api/postgresql
Content-Type: application/json

{"name": "pgdb"}
```

### Drop a database

```bash
DELETE /api/postgresql/pgdb
```

### List all users

```bash
GET /api/postgresql/users
```

### Create a user

```bash
POST /api/postgresql/users
Content-Type: application/json

{"username": "pguser", "password": "securepass"}
```

### Drop a user

```bash
DELETE /api/postgresql/users/pguser
```

### Assign user to database

```bash
POST /api/postgresql/pgdb/assign/pguser
```

### Revoke user from database

```bash
DELETE /api/postgresql/pgdb/revoke/pguser
```

---

## Domains

### List all domains

```bash
GET /api/domains
```

```json
{
  "domains": [
    {"domain_id": 1, "domain_url": "example.com", "docroot": "/var/www/html"}
  ]
}
```

### Add a domain

```bash
POST /api/domains
Content-Type: application/json

{"domain": "newdomain.com"}
```

### Remove a domain

```bash
DELETE /api/domains/olddomain.com
```

### Get SSL status

```bash
GET /api/domains/example.com/ssl
```

### Issue / renew SSL

```bash
POST /api/domains/example.com/ssl
```

---

## Email

### List mailboxes

```bash
GET /api/emails
```

### Create mailbox

```bash
POST /api/emails
Content-Type: application/json

{"email": "info@example.com", "password": "mailpass123"}
```

### Get mailbox details

```bash
GET /api/emails/info@example.com
```

### Change mailbox password

```bash
PATCH /api/emails/info@example.com
Content-Type: application/json

{"password": "newpass456"}
```

### Delete mailbox

```bash
DELETE /api/emails/info@example.com
```

### List aliases

```bash
GET /api/emails/aliases
```

### Create alias

```bash
POST /api/emails/aliases
Content-Type: application/json

{"source": "alias@example.com", "destination": "real@example.com"}
```

### Delete alias

```bash
DELETE /api/emails/aliases/alias@example.com
```

### Get catch-all address

```bash
GET /api/emails/default/example.com
```

### Set catch-all address

```bash
PUT /api/emails/default/example.com
Content-Type: application/json

{"address": "catchall@example.com"}
```

### Check deliverability (all domains)

```bash
GET /api/emails/deliverability
```

### Check deliverability for a domain

```bash
GET /api/emails/deliverability/example.com
```

### Get Sieve mail filters

```bash
GET /api/emails/filters/user@example.com
```

### Update Sieve filters

```bash
PUT /api/emails/filters/user@example.com
Content-Type: application/json

{"rules": "require [\"fileinto\"];\nif header :contains \"Subject\" \"SPAM\" { fileinto \"Junk\"; }"}
```

---

## FTP

### List FTP accounts

```bash
GET /api/ftp
```

### Create FTP account

```bash
POST /api/ftp
Content-Type: application/json

{"username": "ftpuser", "password": "ftppass", "path": "/var/www/html"}
```

### Delete FTP account

```bash
DELETE /api/ftp/ftpuser
```

### Change FTP password

```bash
PATCH /api/ftp/ftpuser/password
Content-Type: application/json

{"password": "newftppass"}
```

### Change FTP home path

```bash
PATCH /api/ftp/ftpuser/path
Content-Type: application/json

{"path": "/var/www/html/subdir"}
```

### List active FTP connections

```bash
GET /api/ftp/connections
```

---

## Cron Jobs

### List all cron jobs

```bash
GET /api/crons
```

```json
{
  "jobs": [
    {"schedule": "0 * * * *", "command": "/usr/bin/php /var/www/html/cron.php", "valid": true}
  ]
}
```

### Create a cron job

```bash
POST /api/crons
Content-Type: application/json

{"schedule": "*/5 * * * *", "command": "/usr/bin/php /var/www/html/run.php"}
```

### Edit a cron job

```bash
PATCH /api/crons
Content-Type: application/json

{
  "original_schedule": "*/5 * * * *",
  "original_command": "/usr/bin/php /var/www/html/run.php",
  "schedule": "0 */2 * * *",
  "command": "/usr/bin/php /var/www/html/run.php"
}
```

### Delete a cron job

```bash
DELETE /api/crons
Content-Type: application/json

{"schedule": "*/5 * * * *", "command": "/usr/bin/php /var/www/html/run.php"}
```

### Get raw crontab

```bash
GET /api/crons/raw
```

### Save raw crontab

```bash
PUT /api/crons/raw
Content-Type: application/json

{"content": "0 * * * * /usr/bin/php /var/www/html/cron.php\n"}
```

### Tail cron log

```bash
GET /api/crons/log?lines=50&job=cron.php
```

---

## Cache Services

Each cache service exposes two endpoints: status and action.

### Redis

```bash
GET  /api/cache/redis
POST /api/cache/redis
Content-Type: application/json

{"action": "enable"}   # enable | disable | restart
```

### Valkey / Memcached / Elasticsearch / OpenSearch

Same pattern, replace `redis` with the service name:

```bash
GET  /api/cache/valkey
POST /api/cache/valkey   {"action": "disable"}

GET  /api/cache/memcached
POST /api/cache/memcached {"action": "restart"}

GET  /api/cache/elasticsearch
POST /api/cache/elasticsearch {"action": "enable"}

GET  /api/cache/opensearch
POST /api/cache/opensearch {"action": "enable"}
```

### Varnish

```bash
# Status + domain list
GET /api/cache/varnish

# Enable/disable
POST /api/cache/varnish
{"action": "enable"}

# Hit ratio and traffic stats
GET /api/cache/varnish/stats

# Per-domain Varnish status
GET /api/cache/varnish/domains

# Toggle Varnish for a specific domain
POST /api/cache/varnish/domains/example.com
{"status": "On"}
```

---

## Docker / Containers

### List compose services

```bash
GET /api/containers
```

### List running containers

```bash
GET /api/containers/status
```

### Get single container state

```bash
GET /api/containers/nginx/status
```

### Start / stop / restart

```bash
POST /api/containers/nginx/start
POST /api/containers/nginx/stop
POST /api/containers/nginx/restart
```

Start with optional pull:

```bash
POST /api/containers/nginx/start
{"pull": true}
```

### Update CPU/RAM limits

```bash
PATCH /api/containers/myapp/resources
Content-Type: application/json

{"cpu": "1", "ram": "512m"}
```

### Tail container logs

```bash
GET /api/containers/nginx/logs?lines=200
```

---

## WAF (Web Application Firewall)

### Status for all domains

```bash
GET /api/waf
```

### Status for a domain

```bash
GET /api/waf/example.com
```

### Toggle WAF on/off

```bash
POST /api/waf/example.com
Content-Type: application/json

{"status": "On"}
```

### Update excluded rules

```bash
PUT /api/waf/example.com/rules
Content-Type: application/json

{
  "remove_by_id": ["920170", "941100"],
  "remove_by_tag": ["attack-sqli"]
}
```

### Paginated WAF log

```bash
GET /api/waf/log/example.com?page=1&per_page=25
```

### WAF stats

```bash
GET /api/waf/stats/example.com?seconds=3600
```

### List rule IDs / tags

```bash
GET /api/waf/ids/ids
GET /api/waf/ids/tags
```

---

## IP Blocker

### List blocked IPs

```bash
GET /api/ip-blocker
```

### Block IPs

```bash
POST /api/ip-blocker
Content-Type: application/json

{"ips": ["1.2.3.4", "10.0.0.0/8"]}
```

### Unblock all IPs

```bash
DELETE /api/ip-blocker
```

---

## PHP

### List installed PHP versions

```bash
GET /api/php/versions
```

### Get php.ini content

```bash
GET /api/php/8.2/ini
```

### Save php.ini

```bash
PUT /api/php/8.2/ini
Content-Type: application/json

{"content": "memory_limit = 256M\nupload_max_filesize = 64M\n..."}
```

### Get PHP option keys and values

```bash
GET /api/php/8.2/options
```

### Update specific PHP options

```bash
PUT /api/php/8.2/options
Content-Type: application/json

{"memory_limit": "256M", "upload_max_filesize": "64M", "max_execution_time": "300"}
```

### List extensions with state

```bash
GET /api/php/8.2/extensions
```

```json
{
  "extensions": [
    {"name": "imagick", "state": "active"},
    {"name": "redis", "state": "disabled"},
    {"name": "swoole", "state": "not_installed"}
  ]
}
```

### Toggle extension

```bash
POST /api/php/8.2/extensions
Content-Type: application/json

{"extension": "imagick", "action": "enable"}
```

### List all supported extensions

```bash
GET /api/php/8.2/extensions/available
```

### Install an extension

```bash
POST /api/php/8.2/extensions/install
Content-Type: application/json

{"extension": "swoole"}
```

```json
{"install_id": "swoole_1704067200", "message": "Installation started"}
```

### Poll install status

```bash
GET /api/php/8.2/extensions/install/status?install_id=swoole_1704067200
```

---

## Account

### Get account info

```bash
GET /api/account
```

```json
{
  "username": "stefan",
  "email": "stefan@example.com",
  "plan_id": 1,
  "context": "stefan"
}
```

### Update account

```bash
PATCH /api/account
Content-Type: application/json

{"email": "new@example.com"}
# or
{"password": "newpass"}
# or
{"username": "newname"}
```

### List active sessions

```bash
GET /api/account/sessions
```

### Terminate a session

```bash
DELETE /api/account/sessions/<token>
```

---

## Resource Usage

### Latest snapshot

```bash
GET /api/usage
```

```json
{
  "cpu": {"usage": {"pct": 12.5}},
  "memory": {"usage_pct": 45, "used": {"human": "900MB"}, "total": {"human": "2GB"}},
  "bandwidth": {"usage_pct": 5, "limit": {"human": "100GB"}}
}
```

### Paginated history

```bash
GET /api/usage/history?page=1&per_page=25
```

---

## Disk Usage & Inodes

### Disk usage (root)

```bash
GET /api/disk-usage
```

### Disk usage for a path

```bash
GET /api/disk-usage/public_html
```

```json
{
  "directory": "public_html",
  "entries": [
    {"size": "120M", "path": "wp-content"},
    {"size": "3.2M", "path": "wp-includes"}
  ]
}
```

### Inode count (root)

```bash
GET /api/inodes
```

### Inode count for a path

```bash
GET /api/inodes/public_html
```

---

## Malware Scanner

### List quarantined files

```bash
GET /api/malware-scanner/quarantine
```

### Run a scan

```bash
POST /api/malware-scanner/scan
Content-Type: application/json

{"directory": "/var/www/html"}
```

```json
{
  "directory": "/var/www/html",
  "infected_files": [],
  "infected_count": 0,
  "summary": ["Scanned files: 1234", "Infected files: 0"],
  "return_code": 0
}
```

---

## Webserver Config

### Get config

```bash
GET /api/webserver-conf
```

```json
{
  "web_server": "nginx",
  "label": "Nginx",
  "filename": "nginx.conf",
  "content": "server { ... }"
}
```

### Save config

```bash
PUT /api/webserver-conf
Content-Type: application/json

{"content": "server {\n  listen 80;\n  ...\n}"}
```

---

## Process Manager

### List running processes

```bash
GET /api/process-manager
```

```json
{
  "processes": [
    {"container": "nginx", "pid": "1234", "cmd": "nginx: master process", "uid": "0"}
  ],
  "count": 1
}
```

### Kill a process

```bash
DELETE /api/process-manager/1234
```

---

## Sites & Websites

### List all websites

```bash
GET /api/sites
```

### Get website details

```bash
GET /api/sites/example.com
```

### Google Safe Browsing check

```bash
GET /api/sites/example.com/safebrowsing
```

```json
{"status": "safe", "url": "http://example.com", "threats": []}
```

### Get PageSpeed data

```bash
GET /api/sites/example.com/pagespeed
```

### Trigger PageSpeed refresh

```bash
POST /api/sites/example.com/pagespeed
```

### Get WP vulnerability data

```bash
GET /api/sites/example.com/wp-vulnerability
```

### Run vulnerability scan

```bash
POST /api/sites/example.com/wp-vulnerability
```

---

## WordPress

### List all WordPress installations

```bash
GET /api/wordpress
```

### List backups

```bash
GET /api/wordpress/example.com/backups
```

```json
{
  "backups": [
    {"date": "2025-01-15_12-00-00", "hasDbBackup": true, "hasFilesBackup": true}
  ]
}
```

### Create backup

```bash
POST /api/wordpress/example.com/backups
Content-Type: application/json

{"backup_database": true, "backup_files": true}
```

### Restore a backup

```bash
POST /api/wordpress/example.com/restore
Content-Type: application/json

{"backup_date": "2025-01-15_12-00-00"}
```

### List available hardening rules

```bash
GET /api/wordpress/secure
```

```json
{"rules": ["wp_manager_xmlrpc", "wp_manager_user_enum", "wp_manager_wlwmanifest"]}
```

### Get active hardening rules

```bash
GET /api/wordpress/example.com/secure
```

### Apply hardening rules

```bash
PUT /api/wordpress/example.com/secure
Content-Type: application/json

{"rules": ["wp_manager_xmlrpc", "wp_manager_wlwmanifest"], "disable_all": false}
```

Disable all rules:

```bash
PUT /api/wordpress/example.com/secure
{"disable_all": true}
```

### Uninstall WordPress

Removes files and drops the database.

```bash
DELETE /api/wordpress/sites/42
```

### Detach from WordPress Manager

Removes from manager, keeps files.

```bash
POST /api/wordpress/sites/42/detach
```

### Reload WP data from filesystem

```bash
POST /api/wordpress/reload
```

### WP-CLI actions

Available actions: `core_update`, `core_update_check`, `plugin_update_all`, `theme_update_all`, `list_plugins`, `list_themes`, `cache_flush`, `cron_run`

```bash
POST /api/wp-cli/plugin_update_all
Content-Type: application/json

{"domain": "example.com"}
```

```json
{
  "action": "plugin_update_all",
  "domain": "example.com",
  "stdout": "Success: Updated 3 of 3 plugins.",
  "returncode": 0
}
```

---

## Node.js / Python Apps (PM2)

### Tail app logs

```bash
GET /api/pm2/example.com/logs?lines=100
```

### Start application

```bash
POST /api/pm2/example.com/start
```

### Stop application

```bash
POST /api/pm2/example.com/stop
```

### Restart application (pull + restart)

```bash
POST /api/pm2/example.com/restart
```

### Update app settings

```bash
PATCH /api/pm2/example.com
Content-Type: application/json

{
  "version": "20",
  "startup_file": "/var/www/html/index.js",
  "cpu": "1",
  "ram": "1"
}
```

### Delete app

Stops container, reverts webserver config, removes from `docker-compose.yml`, and deletes from DB.

```bash
DELETE /api/pm2/example.com
```

---

## Auto Installer

### List installed apps

```bash
GET /api/autoinstaller
```

```json
{
  "sites": [{"site_name": "example.com", "type": "WordPress"}],
  "counts": {"wordpress": 1, "node": 0, "python": 0},
  "technologies": ["wordpress", "drupal", "node", "python", "...]
}
```

---

## Dynamic DNS

### List all entries

```bash
GET /api/dynamic-dns
```

```json
{
  "domains": {
    "example.com": [
      {"subdomain": "home", "record": "1.2.3.4", "token": "abc123xyz", "last_updated": "2025-01-15T12:00:00Z"}
    ]
  }
}
```

### Create entry

```bash
POST /api/dynamic-dns
Content-Type: application/json

{"domain": "example.com", "subdomain": "home", "ip": "0.0.0.0"}
```

```json
{"entry": {"subdomain": "home", "record": "0.0.0.0", "type": "A", "token": "abc123xyz"}}
```

### Update entry

```bash
PUT /api/dynamic-dns
Content-Type: application/json

{
  "domain": "example.com",
  "line_number": 42,
  "subdomain": "home",
  "ip": "1.2.3.4",
  "token": "abc123xyz"
}
```

### Delete entry

```bash
DELETE /api/dynamic-dns
Content-Type: application/json

{"domain": "example.com", "line_number": 42}
```

### Auto-update IP (no auth required)

Called by your router or DDNS client to update the record with the caller's IP:

```bash
GET /dynamic-dns/update?token=abc123xyz
```

---

## DNS Zone Editor

### List domains with zone status

```bash
GET /api/dns
```

### Get parsed DNS records

```bash
GET /api/dns/example.com
```

```json
{
  "domain": "example.com",
  "serial": "2025011501",
  "records": [
    {"line_number": 12, "end_line_number": 12, "line": "www 3600 IN A 1.2.3.4", "multiline": false}
  ]
}
```

### Get raw zone file

```bash
GET /api/dns/example.com/raw
```

### Save raw zone file

```bash
PUT /api/dns/example.com/raw
Content-Type: application/json

{"content": "$ORIGIN example.com.\n$TTL 3600\n..."}
```

### Add a DNS record

```bash
POST /api/dns/example.com/records
Content-Type: application/json

{"name": "www", "ttl": "3600", "type": "A", "record": "1.2.3.4"}
```

MX example:

```bash
{"name": "example.com.", "ttl": "3600", "type": "MX", "priority": "10", "record": "mail.example.com."}
```

TXT / SPF example:

```bash
{"name": "example.com.", "ttl": "3600", "type": "TXT", "record": "v=spf1 include:_spf.example.com ~all"}
```

### Update a record by line number

```bash
PATCH /api/dns/example.com/records/12
Content-Type: application/json

{"content": "www 3600 IN A 5.6.7.8", "serial": "2025011501"}
```

The `serial` field prevents concurrent-edit conflicts — pass the serial you read when fetching the zone.

### Delete a record

```bash
DELETE /api/dns/example.com/records/12
```

Multi-line record (e.g. DKIM):

```bash
DELETE /api/dns/example.com/records/15
Content-Type: application/json

{"end_row_id": 18}
```

### Reset zone to default template

```bash
POST /api/dns/example.com/reset
```

### Export zone file

```bash
GET /api/dns/example.com/export
```

---

## Traffic Stats (GoAccess)

### List domains with stats availability

```bash
GET /api/stats
```

### Get GoAccess report for a domain

```bash
GET /api/stats/example.com
```

```json
{
  "domain": "example.com",
  "available": true,
  "html": "<!DOCTYPE html>..."
}
```

Stats are generated every 24 hours by the GoAccess daemon.

---

## System Services

### List all services

```bash
GET /api/services
```

```json
{
  "services": [
    {"service": "nginx", "container_state": "running", "health_status": "healthy"},
    {"service": "mysql", "container_state": "running", "health_status": "healthy"}
  ]
}
```

### Get service status

```bash
GET /api/services/nginx
```

```json
{
  "service": "nginx",
  "container_state": "running",
  "health_status": "healthy",
  "available_actions": ["disable"]
}
```

### Start or stop a service

```bash
POST /api/services/nginx
Content-Type: application/json

{"action": "enable"}   # enable | disable | restart
```

---

## Webmail

### Get webmail info

```bash
GET /api/webmail
```

```json
{"is_running": true, "webmail_url": "https://webmail.example.com/"}
```

### Generate auto-login token

Creates a 30-second single-use token for automatic Roundcube login.

```bash
POST /api/webmail/user@example.com
```

```json
{
  "email": "user@example.com",
  "token": "abc123...",
  "autologin_url": "https://webmail.example.com/autologin.php?token=abc123...",
  "webmail_url": "https://webmail.example.com/"
}
```

---

## Website Builder

### Get HTML and CSS content

```bash
GET /api/website-builder/example.com
```

```json
{
  "domain": "example.com",
  "html": "<!DOCTYPE html>...",
  "css": "* { box-sizing: border-box; }"
}
```

### Save content

```bash
PUT /api/website-builder/example.com
Content-Type: application/json

{
  "html": "<!DOCTYPE html><html>...</html>",
  "css": "body { margin: 0; }"
}
```

### Create a new site

```bash
POST /api/website-builder
Content-Type: application/json

{"domain_id": 1, "subdirectory": ""}
```

```json
{"message": "Website created successfully on example.com", "site_name": "example.com"}
```

### Remove a site (deletes files)

```bash
DELETE /api/website-builder/sites/7
```

### Detach a site (keeps files)

```bash
POST /api/website-builder/sites/7/detach
```

---

## Error Responses

All endpoints return standard HTTP status codes:

| Code | Meaning |
|------|---------|
| `200` | OK |
| `201` | Created |
| `202` | Accepted (async operation started) |
| `400` | Bad request / missing required field |
| `401` | Unauthorized (missing or invalid token) |
| `403` | Forbidden (feature not enabled or domain not owned) |
| `404` | Resource not found |
| `409` | Conflict (e.g. serial mismatch, resource already exists) |
| `500` | Internal server error |
| `503` | Service unavailable |
| `504` | Timeout |

Error responses always include an `error` field:

```json
{"error": "You do not own this domain"}
```

---

// File: panel/account/account

# Account
OpenPanel offers a unique feature that allows you to change your username, unlike standard control panels that require hosting support for such modifications.  

![account.png](/img/panel/v2/account.png)

On this page, you can:  
- Change your login password and username.  
- Update your email address to receive notifications at a new address.  

### Changing Email Address  
To update your email address:  
1. Enter your new email in the email field.  
2. Click **Update** to save the changes.  

### Changing Username  
To change your username:  
1. Enter your desired username in the username field.  
2. Click **Update** to apply the changes.  

### Changing Password  
To change your password:  
1. Enter your new password in the **Password** field.  
2. Confirm it by entering the same password in the **Confirm Password** field.  
3. Click **Update** to save the new password.  

Note: Once you update your password, you will be **immediately logged out**. All existing sessions will be **terminated**, and you will need to log in again with your new credentials.

---

// File: panel/account/language

# Change Language

You can customize your experience by selecting your preferred language.  

![openpanel chaneg language](/img/panel/v2/openpanel_change_language.gif)

## Changing Your Language  
1. Navigate to **Account > Change Language**.
1. Select your desired language from the dropdown menu.  
2. The interface will **immediately update** to reflect your selection.  



## Available Languages
Languages are configured by Administrator from [OpenAdmin > Settings > Locales](/docs/admin/settings/locales/)

## Missing a Language?  
If your language is not available, you can help translate OpenPanel [here](/docs/admin/settings/locales/#edit-locale) to improve accessibility for everyone.

---

// File: panel/account/notifications

# Notifications

Users can set actions for which to receive email notifications:

![notifications.png](/img/panel/v2/notifications.png)

:::info
If you do not see the Notifications page, ask your provider to enable the [notifications module](/docs/admin/settings/openpanel/#notifications).
:::

| Value                                          | Description                                  | Default |
|------------------------------------------------|----------------------------------------------|---------|
| notify_account_login                           | Notify on new logins                         | 1       |
| notify_account_login_for_known_netblock        | Notify on new login from known netblock      | 1       |
| notify_account_login_notification_disabled     | Notify when login notifications are disabled | 1       |
| notify_autossl_expiry                          | Notify when SSL certificate is soon expiring | 0       |
| notify_autossl_expiry_coverage                 | Notify when SSL certificate is expired       | 0       |
| notify_autossl_renewal_coverage                | Notify when certificate renewal failed   | 0       |
| notify_autossl_renewal_coverage_reduced        | Notify when certificate renewal failed   | 0       |
| notify_autossl_renewal_uncovered_domains       | Notify when certificate renewal fails for custom SSL| 0   |
| notify_contact_address_change                  | Notify when email address is changed             | 1       |
| notify_contact_address_change_notification_disabled | Notify when notifications for email address change are disabled | 1   |
| notify_disk_limit                              | Notify when account reached disk limit                         | 1       |
| notify_email_quota_limit                       | Notify when email accounts reach their quota limit                  | 1       |
| notify_password_change                         | Notify when password is changed                    | 1       |
| notify_password_change_notification_disabled   | Notify when notifications for password change are disabled      | 1       |
| notify_ssl_expiry                              | Notify when SSL certificate is expired                      | 1       |
| notify_twofactorauth_change                    | Notify when two-factor authentication is disabled/enabled   | 1       |
| notify_twofactorauth_change_notification_disabled | Notify when notifications for two-factor authenticatin change are disabled | 1 |


User does not receive notifications for actions performed through the OpenAdmin interface (such as impersonating a user, changing a password, disabling 2FA, etc.) or from API calls (e.g., from WHMCS, Blesta, FOSSBilling).


## Email notifications

![new_login.png](/img/panel/v1/account/new_login.png)

![2fa_disabled.png](/img/panel/v1/account/2fa_disabled.png)

![2fa_enabled.png](/img/panel/v1/account/2fa_enabled.png)

![email_changed.png](/img/panel/v1/account/email_changed.png)

![pass_changed.png](/img/panel/v1/account/pass_changed.png)

![preferences_changed.png](/img/panel/v1/account/preferences_changed.png)

---

// File: panel/account/2fa

# Two-Factor Authentication

The Two-Factor Authentication is a recommended security feature that allows you to set up a second factor device. Essentially, during login, it requires not only your password but also a code from an application on your mobile phone.

## Enable 2FA

To enable 2FA for your account click on the 'Enable 2FA' button.

![2fa enable on openpanel](/img/panel/v2/openpanel_enable_2fa.gif)

A QR code will be displayed that you can scan with your phone using a selected application such as Google Authenticator or DuoMobile. Alternatively, you can click on the 'Display OTP code' link to show a code that you can manually type in or copy into the application.

Once you have set the QR code or OTP code in your application, it's essential to click on the 'Confirm' button to permanently hide the OTP and QR codes. Otherwise, anyone who accesses your account can view these codes and set them in their application.

---

// File: panel/account/active_sessions

# Active Sessions

Displays current active sessions for the user account.

![active session](/img/panel/v2/openpanel_sessions.png)

---

// File: panel/account/passkeys

# Passkeys

Passkeys are a modern, phishing-resistant alternative to passwords. Instead of typing a password, you authenticate using your device — via biometrics (fingerprint or face), a PIN, or a hardware security key.

## Enable Passkeys

To add a passkey to your account, click the 'Add Passkey' button.

Your browser will prompt you to authenticate using your device's built-in method — such as Touch ID, Face ID, Windows Hello, or a hardware security key. Once confirmed, the passkey is registered to your account.

## Using a Passkey to Log In
On the login page, click 'Sign in with a Passkey'. Your browser will ask you to verify your identity using the same device method you used during registration. No password is required.

## Managing Passkeys
You can register multiple passkeys: for example, one on your laptop and one on your phone. Each registered passkey is listed in your account settings, where you can remove any that are no longer needed.

---

// File: panel/account/favorites

# Favorites

Users can add a page to favorites by left-clicking the star in the top-right corner of any page and remove it either from this page or by right-clicking the same star.

![favorites.png](/img/panel/v2/favorites.png)

---

// File: panel/account/account_activity

# Activity Log

The Account Activity page provides a log record of all your actions performed on the OpenPanel, along with the timestamp and IP address from which the action was executed. The primary objective of this page is to offer insights into who carried out specific actions, such as deleting a file, adding domains, resetting WordPress admin passwords, and more.

![account_activity_log.png](/img/panel/v2/activity.png)


## Recorded actions:

The OpenPanel interface records the following account activities:

* Added item to favorites
* Removed item from favorites
* Password changed
* Email address changed
* Username changed
* Forgot password requested (via email)
* Password reset (via email)
* Logged in with password
* Logged in using 2FA code
* Logged in via API call
* Logged out
* Changed notification preferences
* Terminated active session
* Enabled or disabled Two-Factor Authentication (2FA)
* Enabled or disabled **ElasticSearch**
* Enabled or disabled **Memcached**
* Enabled or disabled **OpenSearch**
* Enabled or disabled **Redis**
* Enabled or disabled **Varnish**
* Enabled or disabled **Varnish caching** for a domain
* Added new DNS record for a domain
* Updated DNS record for a domain
* Deleted DNS record for a domain
* Reset DNS zone for a domain
* Exported DNS zone for a domain
* Added, edited, or deleted a custom Docker service
* Switched MySQL type
* Switched webserver type
* Changed image tag for Docker service
* Changed CPU or Memory limit for Docker service
* Enabled or disabled Docker service
* Force-pulled image for Docker service
* Executed command via web terminal
* Edited VirtualHosts file for a domain
* Created or deleted redirect link for a domain
* Added domain
* Deleted domain
* Suspended or unsuspended domain
* Enabled or disabled WAF for a domain
* Updated WAF rules for a domain
* Added email address
* Modified email address (password, quota, suspend/unsuspend inbound or outbound traffic)
* Downloaded email configuration for Outlook/Thunderbird
* Deleted email address
* Accessed webmail for an email
* Edited sieve filter for an email
* Created file or folder
* Uploaded files
* Downloaded files from URL
* Created archive
* Extracted archive
* Renamed file or folder
* Deleted files to Trash
* Restored files from Trash
* Emptied Trash
* Permanently deleted files
* Changed file/folder permissions
* Copied or moved files/folders
* Edited file using File Editor
* Created or deleted FTP account
* Changed FTP account password
* Changed FTP account path
* Downloaded FTP configuration (FileZilla/Cyberduck)
* Initiated ClamAV scan for folder
* Created MySQL database
* Created MySQL database user
* Assigned or revoked all privileges for a user on a MySQL database
* Changed MySQL root user password
* Deleted MySQL database or user
* Changed password for MySQL database user
* Edited MySQL configuration
* Enabled or disabled remote MySQL access
* Created PostgreSQL database
* Created PostgreSQL database user
* Assigned or revoked all privileges for a user on a PostgreSQL database
* Deleted PostgreSQL database or user
* Changed password for PostgreSQL database user
* Edited PostgreSQL configuration
* Enabled or disabled remote PostgreSQL access
* Enabled or disabled **pgAdmin**
* Edited version, password, or email for **pgAdmin**
* Enabled or disabled **phpMyAdmin**
* Edited Max Execution Time, Memory Limit, Upload Limit, Version, or Absolute URI for **phpMyAdmin**
* Changed default PHP version for new domains
* Changed PHP version for a domain
* Edited limits for PHP versions
* Edited PHP configuration via PHP Selector
* Created new Python / NodeJS application
* Started, stopped, or restarted application
* Edited application
* Deleted application
* Executed `pip`, `npm`, or `pnpm install` command
* Installed, detached, or uninstalled WordPress
* Restored WordPress files or database from a backup
* Generated full/files/databases WordPress backup
* Initiated scan for WordPress installations
* Generated auto-login link for wp-admin
* Flushed WP cache
* Executed `wp-cli` commands
* Initiated PageSpeed data refresh
* Updated WordPress debug options
* Updated WordPress site information
* Edited WordPress auto-update preferences
* Installed, detached, or uninstalled Website Builder
* Terminated process using Process Manager
* Enabled or disabled a service
* Refreshed resource usage for the account
* Changed backup config
* Switched backup destination
* Restored from a backup
* Generated SSL
* Created/edited/deleted dynamic DNS record
* Changed domain docroot
* Capitalized a domain
* Created a default (catch-all) email address
* Imported into a MySQL database
* Imported into a PostgreSQL database
* Edited PHP.INI file
* Edited webserver configuration
* Changed locale (language)


You can search for these actions by IP, username, date, or specific action.

By default only 25 actions will be shown per page, you can navigate pages using the pagination links or click on 'Show all activity' to display all actions.

---

// File: panel/account/login_history

# Login History

By default, OpenPanel records your IP address when you log in and displays the last login IP address on the Dashboard page.

The Login History page displays a list of up to the last 20 logins in a table format. It includes the IP address, the time of the successful login, a two-letter country code representing the country of the IP address, and a flag icon to visualize the country.

![login_history.png](/img/panel/v2/loginhistory.png)


The purpose of this page is to help you determine if your account has been compromised. If you notice an IP address that you do not recognize, check the [Activity logs](/docs/panel/analytics/account_activity) for that IP to review the actions it performed on your account. If you notice any suspicious activity, immediately [change your account password](/docs/panel/account/login#password-reset) and contact your hosting provider.

---

// File: panel/account/api

# API Reference

On **Account > API Reference** page in the UI, you can view all available API endpoints and examples:

![api reference page screenshot](/img/panel/v2/api_reference.png)

[OpenPanel API documentation](/docs/panel/api/)

---

// File: panel/account/mcp

# MCP

OpenPanel exposes an [MCP](https://modelcontextprotocol.io) server at `/mcp`. Once connected, Claude (or any other MCP client) can manage your account directly: list and create databases, manage domains, DNS records, cron jobs, email accounts, and everything else available under `/api/`.

On **Account > MCP** page in the UI, you can generate and manage tokens to be used with Claude (MCP).

[OpenPanel API documentation](/docs/panel/api/)


## Requirements

- Server must be running the [Enterprise edition](/enterprise/).
- Your plan must have both the **API** and **MCP** features enabled. If `/account/mcp` isn't  visible in your account sidebar, ask your host to enable them.

## 1. Generate a token

1. Go to **Account → MCP** (`/account/mcp`).
2. Give the token a name (e.g. `Laptop - Claude Desktop`) and click **Generate new token**.
3. Copy the token immediately: it's only shown once, right after creation.

When generating a token you can also set:

- **Expiry**: never, 30 days, 90 days, or 1 year. By default tokens don't expire, so set one of the time limits if you'd rather it stop working on its own after a while.
- **Read-only**: restricts the token to GET/HEAD requests only, so Claude can look things up (list sites, check disk usage, read DNS records, etc.) but can't create, change, or delete anything. Recommended for anything other than your own trusted assistant.

Both settings are shown next to each token afterwards, and revoking a token any time from the same page takes effect immediately if it's no longer needed or you think it leaked.

## 2. Connect

The panel's MCP endpoint is `https://<your-panel-domain>:<port>/mcp` (also shown on `/account/mcp`).

### Claude Code (CLI)

```
claude mcp add --transport http openpanel https://<your-panel-domain>/mcp \
  --header "Authorization: Bearer <your-token>"
```

### Claude Desktop

Add this to `claude_desktop_config.json`:

```json
{
  "mcpServers": {
    "openpanel": {
      "url": "https://<your-panel-domain>:<port>/mcp",
      "headers": { "Authorization": "Bearer <your-token>" }
    }
  }
}
```

Restart Claude Desktop after saving. OpenPanel's tools should now show up in the tool picker.

## 3. Using it

Once connected, just ask Claude in plain language, e.g.:

- "List all my websites and their status"
- "Create a new MySQL database called `shop` and a user for it"
- "Add an A record for `shop.example.com` pointing to 1.2.3.4"
- "Show me disk usage for example.com"
- "Create a daily cron job that runs `/var/www/html/backup.sh` at 2am"

Every action Claude takes runs through the exact same `/api/` endpoints and permission checks as the panel UI and REST API: Claude only ever operates within your account and your plan's enabled features. If a request fails with a permission error, it usually means that feature isn't enabled on your plan. With a read-only token, anything beyond looking things up will be blocked instead.

## Troubleshooting

| Symptom | Likely cause |
|---|---|
| `/account/mcp` not visible | The `mcp` (or `api`) feature isn't enabled on your plan. |
| Client can't connect / 401 | Token is wrong, was revoked, expired, or the header isn't set correctly. |
| Tool call returns "Access denied" | The specific feature it needs (e.g. `mysql`, `dns`) isn't enabled on your plan, even though MCP itself is. |
| Tool call returns "This token is read-only" | The token was created with the read-only option and the action needs to create, change, or delete something. Generate a new, non-read-only token instead. |
| Tool list is empty or very short | The panel admin hasn't enabled the `api` module panel-wide, so most `/api/*` routes don't exist yet. |

## Security notes

- Treat an MCP token like a password: anyone with it can act on your account through every
  enabled `/api/` endpoint (unless it's read-only).
- Prefer a read-only token and/or a short expiry for anything other than your own trusted assistant: it meaningfully limits what a leaked token could do.
- Tokens are stored hashed; support cannot recover a lost token, only issue a new one.
- Revoking a token takes effect immediately.

---

// File: panel/advanced/advanced

# Advanced

The Advanced page allows you to view and edit server configuration. 

:::danger
This section is for advanced users only. Exercise caution while making changes, as improper configurations can impact server performance and functionality."
:::

Available pages:

- [CronJobs](/docs/panel/advanced/cronjobs)
- [Process Manager](/docs/panel/advanced/process_manager)
- [Server Settings](/docs/panel/advanced/server_settings)

---

// File: panel/advanced/cronjobs

# Cron Jobs

A cron job is a Linux command used to schedule tasks for future execution. It allows you to automate repetitive tasks, such as sending notifications or running scripts at specific intervals.

![cronjobs.png](/img/panel/v2/cronjobsmain.png)

On the CronJobs page you can view currently scheduled tasks, create new, edit or delete them.


## Add

To create a new cronjob click on the 'Create CronJob' button and in the new form set the script to be executed, choose a container to execute the script and the desired schedule.

![cronjobs_new.png](/img/panel/v2/cronjobs.png)

The first field allows you to choose the container which is going to be running the script.

![cronjobs_container.png](/img/panel/v2/cronjobs_container.png)

The second field allows you to set a predefined (common) schedule:

- Every 30s
- Every minute
- Every 5 minutes
- Every 30 minutes
- Hourly
- Daily
- Weekly
- Monthly
- Yearly

![cronjobs_new_predefined.png](/img/panel/v2/cronjobs_common.png)

you can also set a standard cron expression representing set of times, using **6** space-separated fields:

| Field name   | Mandatory? | Allowed values      | Allowed special characters |
| ------------ | ---------- | ----------------- | ------------------------- |
| Seconds      | Yes        | 0-59               | `*` `/` `,` `-`           |
| Minutes      | Yes        | 0-59               | `*` `/` `,` `-`           |
| Hours        | Yes        | 0-23               | `*` `/` `,` `-`           |
| Day of month | Yes        | 1-31               | `*` `/` `,` `-` `?`       |
| Month        | Yes        | 1-12 or JAN-DEC    | `*` `/` `,` `-`           |
| Day of week  | Yes        | 0-6 or SUN-SAT     | `*` `/` `,` `-` `?`       |

:::info
There are 6 fields instead of the usual 5 found in standard Unix cron. This is because OpenPanel cron jobs also support scheduling by seconds.
:::

For more information, check [CRON_Expression_Format](https://pkg.go.dev/github.com/robfig/cron#hdr-CRON_Expression_Format)

## Edit

To edit an existing cronjob, click on the 'Edit' button next to it. This action will allow you to edit that specific cron job.

![cronjobs_edit.gif](/img/panel/v2/cron_edit_v2.gif)

To modify the schedule for when the script is executed you can use a tool such as https://crontab.guru/.

When you're done click on the 'Save' button to update the crontab file with your changes.

## Delete

To delete a cronjob, click on the 'Delete' button next to it. This action will open a modal asking you to confirm the deletion.

![cronjobs_delete.gif](/img/panel/v2/cron_delete.gif)

## Logs

Each cron job execution is recorded in JSON format.

To view the logs, click the *“View Logs”* button. This will open a new tab displaying all cron job logs.

To filter logs by a specific job name (comment), append the following parameter to the URL:
`?job=` followed by the job name. Example: `/cronjobs/log?job=whmcs-cron`

## File Editor

The *File Editor* option allows you to edit the file where crons are stored. File format is:

```
[job-exec "JOB_NAME"]
schedule = 
container = 
command =
```

Example:
```
[job-exec "example"]
schedule = @daily
container = nginx
command = curl https://ip.openpanel.com
```

Another Example:
```
[job-exec "whmcs-cron"]
schedule = @every 5m
container = php-fpm-8.4
command = php -q /var/www/html/whmcs-paths/crons/cron.php
```

:::info
You can also set `no-overlap` for a cronjob, to avoid running the job multiple times in parallel if the previous execution did not finish.
:::


## Import / Export

Cronjobs can be bulk-edited through a file, making it easy to edit multiple jobs at once or transfer them between servers.
Simply click the *“Switch to File Editor”* button to open the editor.

![file editor](/img/docs-content/zXx0LDMm-slika.png)

---

// File: panel/advanced/process_manager

# Process Manager

The **Process Manager** interface allows you to monitor all currently running processes on your server. You can search, view detailed command information, and terminate (kill) individual processes directly from the OpenPanel interface.

Processes are **sorted by CPU usage**, making it easy to identify and act on resource-intensive tasks.

## Key Features

- 🔍 **Search:** Quickly filter processes by container name, PID, or command.
- 🧾 **Detailed Info:** View key process metadata such as:
  - Container name
  - UID / PID / PPID
  - CPU %
  - Start Time (STIME)
  - TTY (Terminal)
  - Total Execution Time
  - Full Command (expandable)
- 🛑 **Kill Processes:** Force-stop any non-critical process.

:::danger
⚠️ **Warning:** Stopping core services like `MySQL`, `PHP-FPM`, or `Nginx/Apache` will cause your websites to go offline. Only terminate processes you are certain about.
:::

---

## How to Use

1. **Go to** `Advanced > Process Manager` in the OpenPanel sidebar.
2. Use the **search box** to find a specific process by PID, command, or container name.
3. Click **"View full command"** to expand long-running command strings.
4. Click the **Kill** button to immediately terminate the process.

## Interface Details

Each row in the table provides:

| Column | Description |
|--------|-------------|
| **Container** | The container/service where the process is running |
| **UID** | User ID of the process owner |
| **PID** | Unique Process ID |
| **PPID** | Parent Process ID |
| **CPU %** | CPU usage percentage |
| **STIME** | Process start time |
| **TTY** | Associated terminal (`?` means detached/background) |
| **TIME** | Total CPU time consumed |
| **CMD** | The command being executed |
| **Action** | Button to kill the process |

---

## Kill Process Behavior

When you click **Kill**, the following happens:

1. A notification appears: _“Terminating PID: xxxx...”_
2. A `POST` request is sent to the backend with the `PID` to terminate.
3. Upon success or failure, you’ll receive a follow-up toast with the result.

> This interface only shows filtered user-level processes. Internal or system-level maintenance commands (like `/etc/entrypoint.sh` or `ps -eo`) are excluded automatically.

---

## Tips

- For suspicious or high CPU usage processes, inspect the **full command** before taking action.
- Use the **Refresh Processes** button to reload the process list at any time.
- Killing a parent process (PPID) may also terminate its child processes.

---

Still have questions? Reach out to your server administrator or consult the system logs for deeper insights into recurring processes.

---

// File: panel/advanced/services

# Services

The Services page allows you to view current real-time resource usage for your services and manage them.

:::info
The Services page appears only if the 'services' module is enabled on the server and included as a feature in your hosting plan.
To start or stop services, use the Docker feature (if available) or contact your hosting provider.
:::

To manage a service, select it's name from the select options.

On the single service page you can view:

- current service status
- resource usage (CPU%, Memory%, Disk I/O, PIDs..)
- container name (to be used to connect to service from other containers)
- manage options: enable/disable
- container logs

---

// File: panel/advanced/webserver_settings

# WebServer Settings

The **WebServer Settings** interface enables OpenPanel users to edit the primary webserver configuration file directly using a text editor.

These settings are **global** and apply to **all domains** (i.e., affect the virtual hosts configuration).

> ⚠️ **Important:** Always create a backup of the configuration file before making any changes.

- For **Apache**, you can edit the `httpd.conf` file.  
- For **Nginx** and **OpenResty**, you can edit the `nginx.conf` file.
- For **OpenLitespeed** and **Litespeed**, you can edit the `openlitespeed.conf` file.

---

// File: panel/advanced/resource_usage

# Resource Usage

Resource Usage provides real-time information about your server's CPU, RAM, and other performance metrics. You can monitor your server's resource consumption and access historical data to make informed decisions.

![resource_usage.png](/img/panel/v2/usage.png)

## CPU Usage

The CPU Usage section displays the current CPU usage of your server. It provides essential details about the percentage of CPU utilization and allows you to track historical CPU usage.

### Current CPU Usage

The gauge shows the current CPU usage as a percentage. It helps you quickly assess how much of your CPU resources are in use.

### Historical Data

To view past CPU usage data, click the Arrow button on the top right corner of the CPU gauge block.

This will open the Historical Resource Usage page that allows you to track historical CPU and memory usage, enabling you to make informed decisions and analyze your server's performance over time.

![resource_usage_history.png](/img/panel/v2/usage_history.png)

## RAM Usage

The RAM Usage section provides insights into your server's memory consumption. It displays the current memory usage, memory limit, and historical data.

### Current RAM Usage

The gauge illustrates the current RAM usage, including the percentage used and the actual memory usage in relation to the memory limit.

- Current Memory usage
- Memory Usage
- Memory Limit

### Historical Data

Access historical RAM usage data by clicking the Arrow button on the top right corner of the RAM gauge block.

This will open the Historical Resource Usage page that allows you to track historical CPU and memory usage, enabling you to make informed decisions and analyze your server's performance over time.

![resource_usage_history.png](/img/panel/v2/usage_history.png)

## Network I/O

The Network I/O section provides insights into network input and output for your server.

## Block I/O

Monitor block input and output operations in the Block I/O section.

## Process IDs (PIDs)

The PIDs section displays the number of running processes on your server.

---

By monitoring and managing your server's resource usage effectively, you can ensure optimal performance and make informed decisions to address any resource-related challenges.

---

// File: panel/advanced/mysql_conf

# MySQL Configuration

On the **Edit MySQL Configuration** page, you can modify settings for your database service (MySQL or MariaDB).

> **NOTE**: Leaving a field empty means the system will use the default value for your database version.

The configurable options include:

- max_allowed_packet	
- max_connect_errors	
- max_connections	
- open_files_limit	
- performance_schema	
- sql_mode	
- thread_cache_size	
- interactive_timeout	
- wait_timeout	
- log_output	
- log_error	
- log_error_verbosity	
- general_log	
- general_log_file	
- long_query_time	
- slow_query_log	
- slow_query_log_file	
- join_buffer_size	
- key_buffer_size	
- read_buffer_size	
- read_rnd_buffer_size	
- sort_buffer_size	
- innodb_log_buffer_size	
- innodb_log_file_size	
- innodb_sort_buffer_size	
- innodb_buffer_pool_chunk_size	
- innodb_buffer_pool_instances	
- innodb_buffer_pool_size	
- max_heap_table_size	
- tmp_table_size

Administrators have full control to adjust these settings as needed.

:::info
Please note: Applying changes will restart the database service.
:::

---

// File: panel/advanced/waf

# WAF

The Web Application Firewall (WAF) interface allows OpenPanel users to toggle Coraza WAF on or off for each domain individually.

![waf.png](/img/panel/v2/waf.png)

## Manage domain

Clicking a domain name opens the rule management page where you can disable individual rules for that domain.

![waf.png](/img/panel/v2/waf_rules.png)

Rules can be disabled by ID (`SecRuleRemoveById`):

![waf.png](/img/panel/v2/waf_rulesID.png)

Or by tag name (`SecRuleRemoveByTag`):

![waf.png](/img/panel/v2/waf_rulesTag.png)

The OWASP Core Rule Set is enabled by default for all newly added domains.

![waf.png](/img/panel/v2/waf_logs.png)


## WAF Logs

WAF logs can be viewed by clicking the **View Logs** button for domain.

![waf.png](/img/panel/v2/waf_logs.png)

### Reading the Logs

Coraza logs all checked requests, not just blocked ones. The key columns are:

**`is_interrupted`**: whether the request was blocked. `true` means blocked.
**`messages.rule_ids`**: the IDs of rules that fired, for example: 
  ```
  932370, 941100, 941160, 949110, 980170
  ```
  These are the IDs you can paste into the *Disable by ID* field for that domain.
**`messages.tags`** — the tags associated with triggered rules, for example:
  ```
  application-multi, language-shell, platform-windows, attack-rce, paranoia-level/1, OWASP_CRS, OWASP_CRS/ATTACK-RCE, capec/1000/152/248/88
  ```
  When disabling by tag, use the attack category tags such as `attack-rce` or `attack-xss`. Avoid broad tags like `OWASP_CRS` or `paranoia-level/1` as they would disable large portions of the ruleset.
  Disabling rules by tag removes them globally for the entire domain. For false positives on specific pages (e.g. `/wp-admin`), disabling by ID is the safer approach as it can be scoped more precisely.

**`messages.msg`** — the human-readable reason the rule fired, for example:
  ```
  Remote Command Execution: Windows Command Injection
  ```

---

// File: panel/advanced/server_info

# Server Information

View current server specification and system usage.

## Server Information

- Hostname
- Average Load
- Uptime
- IP Address
- OS
- Release
- Version
- Processor
- Nameservers

## Hosting Plan Information

- Hosting Plan Name
- Plan Description
- Context
- Bandwidth Limit
- CPU Limit
- Database Limit
- Websites Limit
- Disk Limit
- Domains Limit
- Email Limit
- Inodes Limit
- MySQL Server
- Web Server

## OpenPanel Information

- OpenPanel Version
- Enabled Modules

---

// File: panel/advanced/ip-blocker

# IP Blocker

Using th IP blocker page you can block IP addresses from accessing your websites.

---

// File: panel/applications/applications

# Applications

The Applications section provides access to the PM2 and WP Manager interfaces where you can install and manage WordPress, NodeJS or Python Applications.

![screenshots](/img/panel/v2/new_site_popup.png)

Available pages:

- Site Manager
- [WordPress Manager](/docs/panel/applications/wordpress)
- [Auto Installer](/docs/panel/applications/autoinstaller)
- [Website Builder](/docs/panel/applications/builder/)

---

// File: panel/applications/wordpress

# WordPress Manager

![wp_manager_grid.png](/img/panel/v2/wpmanager.png)

The WordPress Manager is your all-in-one tool inside OpenPanel for installing and managing WordPress websites — without ever needing to log in to wp-admin. It makes handling multiple sites fast, simple, and efficient.

## Manage WordPress sites

The WordPress Manager lets you adjust settings, create backups, update plugins, toggle debugging, and more — all directly from OpenPanel. No need to open multiple dashboards or remember dozens of logins.
Perfect for agencies, developers, and anyone managing several WordPress sites at once.

### WP Manager

On the main WP Manager page you can:

- [View installations](#wp-manage): see the domain, WordPress version, install date, admin email.
- [Refresh website data](#refresh-website-data): if you’ve changed a domain, updated WordPress manually, or modified the admin email.
- [Manage themes and plugins sets](#themes-and-plugins-sets): define which themes and plugins are auto-installed on every new site.
- [Install WordPress](#install-wordpress): set up a fresh WordPress installation in a few clicks.
- [Scan for existing installations](#scanning-importing-installations): detect and import manually installed WordPress sites.
- [Change to Table/Grid view](#grid-vs-table-view): display sites in either Grid (default) or Table mode.

### Install WordPress

Installing WordPress is quick and automatic. OpenPanel takes care of everything — downloading WordPress from WordPress.org, creating the database, linking it to your domain, and configuring your new site.

1. Add your **domain name** first.
2. Open **Site Manager** from the sidebar and click **+ New Website**.
3. Choose I**nstall WordPress**.

![new_site_popup.png](/img/panel/v2/wpinstall.png)

Then fill in the form:

- Website name
- Site description (optional)
- Domain name (optionally a subfolder)
- Admin username
- Admin password
- WordPress version


Click **Start Installation** and you’re done.

![wp_install.png](/img/panel/v2/wpinstall2.png)

📘 Read the full guide: [How to Install WordPress® With OpenPanel](/docs/articles/websites/how-to-install-wordpress-with-openpanel/#install-wordpress-via-wp-manager)

### Scanning (Importing) Installations

If you already have WordPress installed manually, you can import it into the WP Manager.
The system scans your hosting files for `wp-config.php` and automatically adds the found websites.

📘 Read the full guide: [How to Migrate a WordPress® Installation to OpenPanel](/docs/articles/websites/how-to-upload-wordpress-website-to-openpanel/)

### Themes and Plugins Sets

Tired of installing the same setup every time?
Create **Theme Set** and **Plugin Set** that automatically apply to new WordPress installs.

For example, you might set up a default combo like:

- Elementor theme + child theme
- Elementor plugin
- Classic Editor plugin

Every time you install a new site — boom, it’s ready with your preferred setup.

📘 Read the full guide: [WordPress Plugin & Theme Sets in OpenPanel](/docs/articles/websites/wordpress-plugins-themes-sets-in-openpanel/)

### Refresh Website Data

If you’ve made manual changes to your site (like updating WordPress core or changing the admin email), click **Refresh Data** to sync everything with WP Manager.

### Grid vs. Table View

You can view your sites in a **grid with screenshots** or a **simple table** view.
Switch views anytime using a button.

---

## Site Manager

![wp_manager_site.png](/img/panel/v2/wpmanage.png)


### Auto Login to wp-admin

Use **Login as Admin** for one-click secure access to your WordPress dashboard — no password needed.

![wp_manager_autologin](/img/panel/v2/wpautolog.png)

### Temporary Link

Preview your site even before your domain is connected or SSL is ready.
Temporary links last 15 minutes.

Click **Live Preview** to generate one:

![website_temporary_url_openpanel.gif](/img/panel/v2/wppreview.png)

### Screenshot

Website screenshots refresh automatically every 24 hours.
Need it sooner? Click the refresh icon over the screenshot.

### Versions

* **WordPress Version** – The WordPress version is retrieved from the database and verified via an AJAX request to the website itself, ensuring the displayed version is accurate. If an update is available, a badge will appear next to the version number.
* **PHP Version** – The PHP version is read from the domain’s VirtualHost configuration file, guaranteeing that the version shown matches the one actually configured for the domain.
* **MySQL/MariaDB Version** – Displays whether the site uses MySQL or MariaDB, along with the version number obtained directly from the terminal.
* **Created** – Indicates the date and time when the website was first added to WP Manager.

![general](/img/panel/v2/general.png)

### Speed

Website performance is monitored daily using **Google PageSpeed Insights**. For both mobile and desktop devices, you can view the check time along with key metrics such as **First Contentful Paint**, **Speed Index**, and **Time to Interactive**.

You can also [add your own PageSpeed Insights API key](/docs/articles/websites/google-pagespeed-insights-api-key/#adding-the-api-key-in-openpanel) to customize the data collection.

![speed](/img/panel/v2/speed.png)

### Cache

Cache widget displays the current [wp cache type](https://developer.wordpress.org/cli/commands/cache/type/) on your website and an option to purge the cache.

![wp_cache](/img/panel/v2/wp_cache.png)

### Firewall

If CorazaWAF is enabled on the server, and your account has access to the WAF feature, you will see a *Firewall* widget displaying current status for the domain, an option to change it and number of denied/challenged requests in the last hour.

![wp_waf](/img/panel/v2/wp_waf.png)


### Overview

Under *Overview* tab you can view:
- Files: Folder path and Folder Size
- Database: Size, Host, Name, Table Prefix, User, Password and link to open phpMyAdmin

![overview](/img/panel/v2/overview.png)

### Options

*Options* tab displays current WordPress settings and allows you to change them.

Available options:

- Site URl
- Homepage URL
- Site Name
- Blog Description
- Administrator Email
- Enable New User Registration
- Enable SEO Visibility
- Enable Pingbacks

![options](/img/panel/v2/options.png)

### Maintenance mode

Enable or disable maintenance mode directly from WP Manager.
You can even edit the maintenance.php file right from the panel.

![wp_manager_maintenance](/img/panel/v2/wpmaint.png)

### Security

Keep your site safe with built-in security tools.

From here, you can:
- Shuffle WordPress salts
- Check core file integrity
- Reinstall WordPress core if needed

![wp_manager_security.png](/img/panel/v2/wpsec.png)

### Updates

Control how WordPress handles updates for the core, plugins, and themes.
By default, only minor core updates are auto-enabled.

![wp_manager_site_edit_2.png](/img/panel/v2/wpupdate.png)

If a newer WordPress core version is available, you will see 'Click to update WordPress core' button which when clicked will perform WordPress update to the newest version available.

### Debugging

Toggle WordPress’s built-in debugging tools (WP_DEBUG, WP_DEBUG_LOG, etc.) directly from WP Manager.

These are great for testing or development sites — not recommended for production.
For details, check [Debugging in WordPress](https://wordpress.org/documentation/article/debugging-in-wordpress/) for more information on these options.

![wp_manager_site_edit_3.png](/img/panel/v2/wpdebug.png)

### Backups

Create and restore backups anytime — files, database, or both.

Create a Backup:
- Choose what to back up (files, database, or both).
- Click **Generate Backup**.

![wp_manager_site_backup_1.png](/img/panel/v2/wpbackup.png)

Restore a Backup:
To restore, click Restore, pick a backup date, and confirm.

### Clone

Create a clone (copy files and database tables, replace links in database, fluch wp cache and rewrite rules).

Create a clone:
- Under 'Target' select the desired domain and optionally 'Database' to be used.
- Click **Clone Website**.

![wp_manager_site_clone.png](/img/panel/v2/wp_clone.png)

### Remove

Want to stop managing a site in WP Manager (without deleting it)?

Use **Detach** — your files and database remain untouched.

![detach](/img/panel/v2/detach.png)

To completely remove a website — files, database, and all — click **Uninstall**, then confirm.

![uninstall](/img/panel/v2/uninstall.png)

---

// File: panel/applications/pm2

# Node.js and Python

Containerized [Node.js](https://nodejs.org) and [Python](https://python.org/) applications can be created and managed in **OpenPanel Enterprise Edition**.

---

## Create an Application

To create a new Python or Node.js application, navigate to **OpenPanel > AutoInstaller** and select **Python** or **NodeJS**.

![screenshot](/img/docs-content/HmZh5ZMJ-new-tab.png)

On the next page, you can configure the following settings:

* **Name** – The name of the application and container as displayed in OpenPanel.
* **Port** – Set a custom port (e.g., 3000 or 5000) if your app uses one. Otherwise, port 80 is used by default.
* **Domain Name / Subfolder** – The domain (and optional subfolder) where the application will be publicly accessible.
* **Startup File** – The file executed at startup with the `node` or `py` command.
* **Custom Startup Command** – Use a custom startup command instead of the default `node` or `py`.
* **Type** – Choose between Node.js or Python.
* **Version** – Select any available version from Docker Hub.
* **Run Install** – Run `npm install` or `pip install` before starting the application.
* **CPU Cores** – Number of CPU cores allocated to the application.
* **Memory** – Amount of memory (in GB) allocated to the application.

![screenshot](/img/docs-content/x0PBW9qB-new-app.png)

After completing the form, click **Start Installation**.
The installation process will be displayed below the form. Once complete, you’ll be redirected to the management page where you can view all your applications.

### NodeJS Example App

An example NodeJS (express) application that is running on http://nodejs.openpanel.org/

Example settings:
![example](/img/docs-content/cdC3Jxdp-example-nodejs-settings.png)

Example `app.js` file:

```js
const express = require('express');
const app = express();
const port = 3000;

app.get('/', (req, res) => {
  res.send('Hello World from Node.js on port 3000!');
});

app.listen(port, () => {
  console.log(`Server is running at http://localhost:${port}`);
});
```

Example `package.json` file:

```json
{
  "name": "helloworld-node",
  "version": "1.0.0",
  "description": "Simple Node.js Hello World app using Express",
  "main": "app.js",
  "scripts": {
    "start": "node app.js"
  },
  "author": "Stefan Pejcic",
  "license": "MIT",
  "dependencies": {
    "express": "^4.18.2"
  }
}
```

### Python Example App

An example Python (Flask) application that is running on http://python.openpanel.org/

Example settings:
![example](/img/docs-content/D2Z3DNdW-example-python-settings.png)

Example `app.py` file:

```py
from flask import Flask

app = Flask(__name__)

@app.route('/')
def hello():
    return "Hello World from Flask on port 5000!"

if __name__ == '__main__':
    app.run(host='0.0.0.0', port=5000)
```

Example `requirements.txt` file:

```json
Flask==2.3.3
```

---

## Manage Applications

Once your application is created, you can manage it from **OpenPanel > Site Manager**.

![screenshot](/img/docs-content/vYbbVP6T-manage-apps.png)

Click **Manage** next to the application name to open its management page.

![screenshot](/img/docs-content/bzMFXdpg-single-app.png)

On this page, you can view important details such as:

* **Screenshot** – Preview of the application’s domain.
* **Status** – Current container status.
* **Version** – Node.js or Python version in use.
* **CPU Limit** – Configured CPU allocation.
* **Memory Limit** – Configured memory allocation.
* **Speed** – Google PageSpeed Insights data for the website.
* **Files** – Current folder path and size.
* **Firewall** – WAF (Web Application Firewall) status for the domain (if enabled).

You also have several management options:

* **Actions** – Start, stop, or restart the container.
* **Overview** – Modify startup file or command, working directory, package installation settings (NPM/PIP), version, and resource limits (CPU, Memory, PIDs).
* **Install Packages** – View and manage `package.json` or `requirements.txt`, and run NPM/PNPM or PIP installations.
* **Logs** – View container logs for troubleshooting.
* **Remove** – Delete the application.

---

// File: panel/applications/builder

# Website Builder

[GrapeJS](https://grapesjs.com/) is a drag & drop website builder integrated into OpenPanel that you can use to create static HTML websites with [tailwindcss](https://tailwindcss.com/).

---

## Create a Website

To create a new website using [GrapeJS](https://grapesjs.com/) access the **Auto Installer** page and under **Website Builder** click on the "Create website" button.

The first step is choosing a domain and optionally a subdirectory where your new website will be installed.

When you're done click on the "Open Website Builder" button to finish setup and start creating with the website builder.

---

## Edit Website

You can access the website builder to edit your websites at any time through **Site Manager** page on your OpenPanel account.

Click **Open Editor** to launch the GrapeJS editor interface.

Clicking on any element will display its options on the right side of the screen. You can use the icon in the top-right corner to browse and insert available blocks.

For additional information on how the GrapeJS website builder works we recommend consulting [the official documentation](https://grapesjs.com/docs/).

---

## Backup & Restore

To back up a static website created with OpenPanel's Website Builder, simply archive the directory in **File Manager**, making sure to include the `index.html` and `style.css` files.

To restore the website, extract the archived files back into the same directory using **File Manager**, replacing any existing files if necessary.

---

## Delete Website

To delete a website, first open it from **Site Manager** page and then click on **Remove** tab. Then click on 'Delete website' and finally 'Confirm Delete'.

---

// File: panel/applications/autoinstaller

# Auto Installer

Auto Installer allows you to one-click install applications.

![screenshot](/img/panel/v2/autoisntaller_page.png)

## Available Applications

For an application to appear on the Autoinstaller page, the corresponding module must be enabled.

- WordPress
- NodeJS Applications*
- Python Applications*
- Mautic (DEPRECATED)
- Website Builder

`*` Indicates that the feature is available only in Enterprise editon.

---

// File: panel/caching/caching

# Caching

Utilizing the array of out-of-the-box features provided by OpenPanel can significantly enhance your website's performance and security. Features such as PHP-FPM, Redis, Memcached, and Opcache have the potential to dramatically boost your website's speed and efficiency.

## REDIS

Redis serves as a persistent object cache backend cache server, primarily accelerating database and website-related calls and queries by storing them in RAM memory. RAM is known for its high-speed performance, surpassing even NVMe and UFS, making Redis caching a powerful tool to optimize your website's performance. Leveraging Redis cache can significantly benefit your website.

[REDIS settings and usage](/docs/panel/caching/Redis)

## Memcached

This in-memory (RAM) object cache is designed specifically to reduce the database load, making it ideal for dynamic websites. It caches only the queries related to the database.

We don't recommend using it in conjunction with other caches like Redis. However, it can be effectively used alongside PHP OPcache for improved website performance.

[Memcached configuration and usage](/docs/panel/caching/Memcached)

## Elasticsearch

Enhance your website's search capabilities and overall performance with Elasticsearch. OpenPanel provides seamless integration with Elasticsearch, a powerful search engine that allows for efficient and quick retrieval of information.

Configure and optimize Elasticsearch settings to tailor it to your website's needs. Learn about the various features and functionalities offered by Elasticsearch to make the most out of this robust search engine.

[Elasticsearch settings and usage](/docs/panel/caching/elasticsearch)

## Opcache
OPcache is a valuable tool for enhancing PHP performance. It works by storing precompiled script code in shared memory, eliminating the need for PHP to reload and analyze scripts with each request. In simpler terms, OPcache caches previously executed PHP code, reducing CPU load and improving website performance.

**This feature is enabled by default when using PHP and requires no additional settings.**

---

// File: panel/caching/valkey

# Valkey

![Valkey_disabled.png](/img/panel/v2/redismain.png)

Valkey is a high-performance, open-source in-memory key–value store designed as a community-driven fork of Redis for fast caching and data structure operations.

With its capability to store and serve data from RAM, it minimizes the need for time-consuming database queries, significantly enhancing website performance.

## Enable / Disable

You have the option to enable or disable the Valkey service container as necessary. Choosing to disable it will promptly clear (delete) all existing Valkey data from memory.

Enabling the Valkey service container will initiate the Valkey container service on the default port, which is _6379_.

![redis_enabled.png](/img/panel/v2/redisenabled.png)

## Set Memory Limits

Upon initialization the Valkey container has default memory limits set, it is advisable to set memory limits appropriate to your use case and needs.

You can set these limits on the /containers interface which is accessible through the user panel navigation on Docker/containers .

![redis_limits.png](/img/panel/v2/redislimits.png)

:::info
Modifying the memory limit will require the Valkey container to be restarted to apply the new restrictions, resulting in the removal of all existing data from the cache.
:::

## Connect to Valkey

To establish a connection to your Valkey instance, use the following details:

- Server address: **valkey** (not 127.0.0.1)
- Port: **6379** (the default Valkey port)

For testing the connection to the Valkey server, you can use the 'telnet' command in your terminal or refer to example scripts bellow.

### Test connection with PHP

1. Using FileManager enter the directory of your website
2. Create a new file named _valkey-test.php_
3. Add the following code in the newly created file and save:
```php
<?php 
   //Connecting to Valkey server on localhost 
   $redis = new Redis(); 
   $redis->connect('redis', 6379); 
   echo "Connection to server successfully"; 
   //check whether server is running or not 
   echo "Server is running: ".$redis->ping(); 
?>
```

4. In your browser navigate to your website and add /valkey-test.php for example, if your website is example.com you should open example.com/valkey-test.php

You should see the _Server is running message.._ indicating that the Valkey service is active and connection is established.


### WordPress plugins

To incorporate Valkey caching into your WordPress website, a WordPress plugin is required. Below are some of the WordPress plugins we evaluated for Valkey/Redis caching:

- [Redis Object Cache](https://wordpress.org/plugins/redis-cache/)
- [Use Redis](https://plugins.club/premium-wordpress-plugins/use-redis/)
   
## View Logs

You have the option to view the Valkey service logs. By doing so, you can identify any service errors or, for instance, determine whether memory limits have been reached.

![redis_log.png](/img/panel/v2/redislogs.png)

---

// File: panel/caching/Redis

# Redis

![redis_disabled.png](/img/panel/v2/redismain.png)

REDIS stands as a robust and persistent object cache solution, purpose-built to efficiently retain frequently accessed website data within the RAM memory.

With its capability to store and serve data from RAM, it minimizes the need for time-consuming database queries, significantly enhancing website performance.

## Enable / Disable

You have the option to enable or disable the REDIS service container as necessary. Choosing to disable it will promptly clear (delete) all existing Redis data from memory.

Enabling the REDIS service container will initiate the Redis container service on the default port, which is _6379_.

![redis_enabled.png](/img/panel/v2/redisenabled.png)

## Set Memory Limits

Upon initialization the Redis container has default memory limits set, it is advisable to set memory limits appropriate to your use case and needs.

You can set these limits on the /containers interface which is accessible through the user panel navigation on Docker/containers .

![redis_limits.png](/img/panel/v2/redislimits.png)

:::info
Modifying the memory limit will require the Redis container to be restarted to apply the new restrictions, resulting in the removal of all existing data from the cache.
:::

## Connect to REDIS

To establish a connection to your REDIS instance, use the following details:

- Server address: **redis** (not 127.0.0.1)
- Port: **6379** (the default REDIS port)

For testing the connection to the REDIS server, you can use the 'telnet' command in your terminal or refer to example scripts bellow.

### Test connection with PHP

1. Using FileManager enter the directory of your website
2. Create a new file named _redis-test.php_
3. Add the following code in the newly created file and save:
```php
<?php 
   //Connecting to Redis server on localhost 
   $redis = new Redis(); 
   $redis->connect('redis', 6379); 
   echo "Connection to server successfully"; 
   //check whether server is running or not 
   echo "Server is running: ".$redis->ping(); 
?>
```

4. In your browser navigate to your website and add /redis-test.php for example, if your website is example.com you should open example.com/redis-test.php

You should see the _Server is running message.._ indicating that the REDIS service is active and connection is established.


### WordPress plugins

To incorporate REDIS caching into your WordPress website, a WordPress plugin is required. Below are some of the WordPress plugins we evaluated for REDIS caching:

- [Redis Object Cache](https://wordpress.org/plugins/redis-cache/)
- [Use Redis](https://plugins.club/premium-wordpress-plugins/use-redis/)
   
## View Logs

You have the option to view the REDIS service logs. By doing so, you can identify any service errors or, for instance, determine whether memory limits have been reached.

![redis_log.png](/img/panel/v2/redislogs.png)

---

// File: panel/caching/Memcached

# Memcached

![memcached_disabled.png](/img/panel/v2/memcmain.png)

Memcached is a high-performance, distributed memory caching system. It is often used to speed up dynamic database-driven websites and applications by caching data in memory.

It is commonly used to reduce the load on a database server and improve the responsiveness of websites by caching frequently accessed data, such as database query results or API responses.

## Enable / Disable

You have the options to enable or disable the Memcached service as needed. Disabling it will promptly clear all existing Memcached data from memory.

Enabling the Memcached service will start the service using the default Memcached port, which is _11211_.

![memcached_enabled.png](/img/panel/v2/memcenabled.png)

## Set Memory Limits

Upon initialization the Memcached container has default memory limits set, it is advisable to set memory limits appropriate to your use case and needs.

You can set these limits on the /containers interface which is accessible through the user panel navigation on Docker/containers .

:::info
Changing the memory limit will necessitate the service to restart to apply the new restrictions, resulting in the removal of all existing cache data.
:::

![memcached_limits.png](/img/panel/v2/memclimits.png)

## Connect to Memcached

To establish a connection to your Memcached instance, use the following details:

- Server address: **memcached** (not 127.0.0.1)
- Port: **11211** (the default Memcached port)

For testing the connection to the Memcached server, you can use the following tools or scripts.

### Test Connection with PHP

1. Navigate to your website directory using a File Manager.
2. Create a new file named _memcached-test.php_.
3. Add the following PHP code to the newly created file and save it:

```php
<?php 
   // Connect to Memcached server on localhost 
   $memcached = new Memcached(); 
   $memcached->addServer('memcached', 11211); 
   echo "Connection to server successful"; 
   // Check whether the server is running or not 
   echo "Server is running: ".$memcached->getVersion(); 
?>
```

Access your website in a browser and append /memcached-test.php. For example, if your website is example.com, you should open example.com/memcached-test.php

You should see the "Server is running.." message, indicating that the Memcached service is active, and the connection is established.


### WordPress Plugins

To implement Memcached caching for your WordPress website, you'll need a dedicated plugin. Here are some WordPress plugins we've tested for Memcached caching:

- [Memcached Object Cache](https://wordpress.org/plugins/memcached/)

## View Logs

You have the option to access the Memcached service logs. By doing so, you can identify any service errors or check for memory usage and limits.

![memcached_log.png](/img/panel/v2/memclogs.png)

---

// File: panel/caching/elasticsearch

# Elasticsearch

[Elasticsearch](https://www.elastic.co/elasticsearch/) is a powerful open-source search and analytics engine commonly used for:

- Full-text search  
- Log analytics  
- Real-time data exploration  

Use **OpenPanel > Caching > Elasticsearch** to manage the Elasticsearch service, enabling fast and scalable search functionality across your applications and systems.

---

## Status

Enable or disable the Elasticsearch service.

- The current status is displayed.  
- Use the toggle option to **enable** or **disable** the service as needed.

---

## TCP

Connection details for accessing the Elasticsearch API:

- **Server:** `elasticsearch`  
- **Port:** `9200`

Use these settings in external tools like `curl`, Kibana, Grafana, or application SDKs to query or manage data.

---

## Logs

Monitor service activity and debug issues by viewing ElasticSearch logs.

- Click **View service log** to open the service log file and inspect output in real time.

---

// File: panel/caching/opensearch

# OpenSearch

[OpenSearch](https://opensearch.org) is an open-source search and analytics engine, fully compatible with Elasticsearch. It is ideal for:

- Full-text search  
- Log analytics  
- Real-time data exploration  

You can manage the OpenSearch service through **OpenPanel > Caching > OpenSearch**, enabling fast, scalable search capabilities for your applications and systems.

---

## Status

Enable or disable the OpenSearch service.

- The current status is displayed.  
- Use the toggle option to **enable** or **disable** the service as needed.

---

## TCP

Connection details for accessing the OpenSearch API:

- **Server:** `opensearch`  
- **Port:** `9200`

Use these settings in external tools like `curl`, Kibana, Grafana, or application SDKs to query or manage data.

---

## Logs

Monitor service activity and debug issues by viewing OpenSearch logs.

- Click **View service log** to open the service log file and inspect output in real time.

---

// File: panel/caching/varnish

# Varnish

[Varnish](https://varnish-cache.org/) is a reverse caching proxy that acts as an HTTP accelerator, optimizing content-heavy dynamic websites and APIs.

Use **OpenPanel > Caching > Varnish** to manage the Varnish service, enable or disable it per domain, and view service logs.

---

## Status

Enable or disable the Varnish service globally.

- The current service status is displayed.  
- Use the toggle to **enable** or **disable** Varnish as needed.

---

## Domains

Control Varnish caching on a per-domain basis.

- Each domain has a toggle showing its current status.  
- Click the toggle to enable or disable Varnish caching for that specific domain.

---

## Logs

Monitor Varnish activity and troubleshoot issues by viewing service logs.

- Click **View service log** to open and follow the log output in real time.

---

// File: panel/containers/containers

# Containers

The **Containers** page in OpenPanel allows you to manage Docker services defined via Docker Compose files by your Administrator.

This section provides a clear overview of your containerized services and their resource usage.

:::info 
To access this feature:
- The **Docker** module must be enabled **server-wide** by an Administrator.
- Your account must have the **Docker** feature enabled.
:::

## Overview

At the top of the page, you'll see:

- **Running Containers / Total Containers** – Indicates how many services are currently active.
- **Total CPU** – Number of CPU cores assigned to your hosting plan.
- **Total Memory** – Amount of RAM (in GB) assigned to your hosting plan.

You can allocate portions of these total resources to individual services.

## Container Table

Each row in the table represents a containerized service and displays:

- **Name** – Name of the Docker service, along with the image used and its tag (version).
- **CPU Usage**  
  - **Graph** – Real-time usage as a percentage of the allocated CPU.  
  - **Usage** – How much CPU the container is using from its allocated amount.  
  - **Allocated** – Number of CPU cores allocated to the service.
- **Memory Usage**  
  - **Graph** – Real-time usage as a percentage of the allocated memory.  
  - **Usage** – RAM used by the service from its allocated amount.  
  - **Allocated** – Memory (in GB) allocated to the service.
- **Actions**  
  - Shows whether the service is **Enabled** or **Disabled**.  
  - Clicking the status toggles it.  
  - If the service is running, a **Terminal** link appears — click it to open a web terminal (`docker exec`) for that container.

## Editing Resources

To change CPU or Memory limits for a service:

1. Hover over the **Allocated** value in the table.
2. Click the **pencil** icon.
3. Adjust the value in the input field.
4. Click **Save**.

> OpenPanel will check whether you have available resources to make this change. If valid, the container will restart automatically with the new limits.

## Adding New Services

To add a new Docker service (container), fill in the **Add Service** form with the required details.  

- **Service Name** – Unique name for the container.  
  - Must start with a letter, contain only lowercase letters and digits, and be at least 3 characters long.  
  - Example: `webapp`, `redis1`  

- **Image** – Docker image to use.  
  - Example: `nginx:latest`, `redis:7.2`  

- **Environment Variables** – Optional. Provide variables in `KEY=value` format, one per line.  
  - Example:  
    ```
    REDIS_PASSWORD=secret
    DEBUG=true
    ```

- **CPU Limit** – Maximum CPU allocation for the container. Must be a positive number.  
  - Example: `0.5`, `1`  

- **RAM Limit** – Maximum memory allocation. Must be a number followed by `M` or `G`.  
  - Example: `512M`, `1.5G`  

- **Network** – Docker network to attach the container to.  
  - Example: `backend_network`  

- **Healthcheck (optional)** – YAML block defining container health checks.  
  - Example:  
    ```yaml
    test: ["CMD", "curl", "-f", "http://localhost"]
    interval: 30s
    timeout: 10s
    retries: 3
    ```  

**Validation Rules**:

- **Service Name** – Must be unique and follow format rules.  
- **CPU Limit** – Must be a positive number.  
- **RAM Limit** – Must end with `M` or `G`.  
- **Environment Variables** – Must be in `KEY=value` format.  
- **Healthcheck** – Must be valid YAML.  

Each service automatically uses an **uppercase prefix** for environment variable keys.  
CPU and RAM values are also stored as environment variables for each service.  

For example, a service named `nginx` will have the following environment keys:

  ```
  NGINX_CPU
  NGINX_RAM
  ``` 

> Once the form is submitted and validated, the service is added to the Docker Compose configuration and environment variables are automatically updated.

---

// File: panel/containers/terminal

# Terminal

The **Terminal** page provides a web-based terminal (`docker exec`) for interacting with your running containers directly through the OpenPanel interface.

## Requirements

To access the Terminal:

- The **Docker** module must be enabled **server-wide** by an Administrator.
- Your account must have the **Docker** feature enabled.
- [`/etc/openpanel/disable_openpanel_terminal_ui` file should not exist](/docs/articles/dev-experience/disable-openpanel-web-terminal/).


## Accessing the Terminal

1. In the OpenPanel menu, go to **Docker > Terminal**.
2. Click on **Select Service** to display a list of currently running services.
3. Click on the service you want to access.
4. The terminal window will open, allowing you to run commands inside the container.

You can switch the shell type between `sh` and `bash` using the selector in the top-right corner of the terminal.

---

> 💡 This feature uses `docker exec` under the hood, giving you direct access to the container's shell environment in real-time.

---

// File: panel/containers/logs

# Logs

The **Docker > Logs** page allows you to view container logs (`docker logs`) directly from the OpenPanel interface.

## Requirements

To access this feature:

- The **Docker** module must be enabled **server-wide** by an Administrator.
- Your account must have the **Docker** feature enabled.

## Accessing Logs

1. In the OpenPanel menu, go to **Docker > Logs**.
2. Click on **Select Container** to display a list of all available services.
3. Select the service you want to view logs for.
4. The log output for the selected container will appear below.

You can optionally adjust the number of log lines shown using the dropdown menu in the top-right corner of the logs panel.

> 💡 Logs are fetched using `docker logs` and show the real-time output of the container’s stdout and stderr streams.

---

// File: panel/containers/image

# Image Updates

The **Docker > Image Updates** page allows you to check if image updates are available for your images.

## Requirements

To access this feature:

- The **Docker** module must be enabled **server-wide** by an Administrator.
- Your account must have the **Docker** feature enabled.

---

// File: panel/containers/change

# Change Image Tag

The **Docker > Change Image Tag** page allows you to update the Docker image tag (version) used by your services.

## Requirements

To access this feature:

- The **Docker** module must be enabled **server-wide** by an Administrator.
- Your account must have the **Docker** feature enabled.

## Usage

To change the tag for a Docker image:

1. First, check the available tags for the image on [Docker Hub](https://hub.docker.com/).
2. In the OpenPanel menu, go to **Docker > Change Image Tag**.
3. Under **Select Service**, choose the service for which you want to change the image tag.
4. Enter the **New Image Tag** in the input field.
5. Click the **Change Tag** button to apply the change.

After confirmation:

- The service will be automatically stopped.
- The new image tag will be pulled.
- The service will be restarted with the updated image.

> ⚠️ Make sure the new tag exists and is compatible with your current configuration to avoid service disruption.

---

// File: panel/containers/webserver

# Switch Web Server

The **Docker > Switch Web Server** page allows you to switch your current web server between available options: **Nginx**, **OpenResty**, and **Apache**.

The currently active web server is displayed in the top-right corner of the page.

## Requirements

To access this feature:

- The **Docker** module must be enabled **server-wide** by an Administrator.
- Your account must have the **Docker** feature enabled.

## Usage

Before switching the web server, please ensure the following:

- **All existing domains must be removed.**
- The current web server container must be **stopped** before the new one can be started.

> ⚠️ If you already have domains configured, **back up all configurations**, remove all domains one by one, then proceed with switching the web server.  
> To avoid downtime, it's best to make this change **before adding any domains**.

### Steps to Switch

1. In the OpenPanel menu, navigate to **Docker > Switch Web Server**.
2. From the dropdown menu, select the new web server you want to use.
3. Click the **Switch** button to initiate the process.

After confirmation:

- The existing web server container will be stopped and its data will be removed.
- The new web server will be started.
- You can then re-add your domains under the new web server configuration.

---

// File: panel/containers/mysql

# Switch MySQL Type

The **Docker > Switch MySQL Type** page allows you to switch your current mysql service between available options: **MySQL** and **MariaDB**.

The currently active type is displayed in the top-right corner of the page.

## Requirements

To access this feature:

- The **Docker** module must be enabled **server-wide** by an Administrator.
- Your account must have the **Docker** feature enabled.

## Usage

Before switching the database type, please ensure the following:

- **All existing databases and users must be removed.**
- The current mysql container must be **stopped** before the new one can be started.

> ⚠️ If you already have databases configured, **back up all data**, remove all databases and users, then proceed with switching the mysql server.  
> To avoid downtime, it's best to make this change **before adding any databases**.

### Steps to Switch

1. In the OpenPanel menu, navigate to **Docker > Switch MySQL Type**.
2. From the dropdown menu, select the new type you want to use.
3. Click the **Switch** button to initiate the process.

After confirmation:

- The existing database container will be stopped and its data will be removed.
- The new mysql type server will be started.
- You can then re-add your database and users under the new server.

---

// File: panel/dashboard/dashboard

# Dashboard

The OpenPanel interface is the central hub of your user account, providing access to all available tools, usage information, and notifications.

The OpenPanel dashboard interface is divided in two sections:

- Features: listing all available options
- Widgets: 2FA, Information, Statistics, Usage and How-to guides

## Information

This section displays general server information:

- Username
- Shared or Dedicated IP address
- Last login IP address
- Nameservers (if configured)

## Statistics

This widget displays the current usage (soft limits):

- Number of websites
- Number of domain names
- Number of emails accounts
- Number of FTP accounts
- Number of MySQL databases
- Current disk usage
- Current inodes usage
- Current CPU % usage
- Current RAM usage

## Usage

This widget displays the current usage (hard-limits):

- Storage
- Inodes
- CPU Usage
- Memory Usage
- Number of running Containers
- Block I/O
- Network I/O
- Number of running PIDs
- Time when the data was last updated

## How-to Guides

If enabled, the How-to guides section will display links to articles from the hosting providers knowledgebase RSS feed or the official OpenPanel documentation.

## Favorites

When [Favorites feature](/docs/admin/settings/openpanel/#enable-features) is enabled by Administrator, users can bookmark up to 10 pages from the OpenPanel interface. These pages will appear in the sidebar menu. To add a page to favorites, simply left-click the star icon in the top-right corner of any page. To remove a page, right-click the same icon.

---

// File: panel/dashboard/dark-mode

# Dark Mode

![dashboard_dark.png](/img/panel/v2/darkmode1.png)

OpenPanel theme offers a built-in Dark Mode, which can be activated with a single click using the options located at the bottom left of the sidebar:

![Dark mode switch](/img/panel/v2/darkmodes.gif)

When Dark Mode is activated, it will apply to all OpenPanel pages, including the login page.

Your Dark Mode preference is saved in your browser.

---

// File: panel/domains/domains

# Domains

To create a website, the first step is to [add a domain name](/docs/panel/domains/#create-a-new-domain).

If the **Domains** module is enabled on the server and your user account has access to it, you'll see a table listing all current domains, the total number of domains, a search bar, and an option to add a new domain.

From this interface, you can view:

* **Domain Status**: Active or Suspended
* **Document Root** (folder where website files will be stored)
* **SSL Settings**: Automatic or Custom
* **Domain Management Options**: Based on enabled features

## Available Actions

Depending on the features enabled on your server, the following actions are available per domain:

* **Edit DNS Zone** — if the DNS feature is enabled
* **Manage WAF** — if the WAF feature is enabled
* **Change Document Root**
* **Edit VirtualHosts**
* **Redirect** — if the Redirect feature is enabled
* **Capitalize** — if the Capitalize feature is enabled
* **Suspend / Unsuspend Domain**
* **Delete Domain**

## Create a New Domain

To add a new domain:

1. Click the **"Add Domain"** button.
2. Enter the domain name.
3. Click **"Add Domain"** to save.

Unlike other panels, OpenPanel treats all domains equally. From this single interface, you can add **primary domains**, **addon domains**, or **subdomains**.

Once added, the system will automatically attempt to issue a free [Let’s Encrypt](https://letsencrypt.org/getting-started/) SSL certificate. If successful, the certificate will be applied immediately.

## Delete a Domain

To delete a domain:

1. Click the **"Delete Domain"** option from the domain's dropdown menu.
2. A confirmation page will appear. Click **"Delete"** to proceed.

> If the domain is linked to active applications (e.g. [PM2](/docs/panel/applications/pm2) or [WP Manager](/docs/panel/applications/wordpress)), deletion will be blocked until those applications are removed.
> This prevents accidental removal of domains tied to running websites.

Deleting a domain will **permanently remove** the following:

1. Nginx configuration file
2. DNS zone file
3. SSL certificate
4. IP Blocker rules for the domain
5. Redirects associated with the domain

## Redirects

### Add Redirect

To create a redirect:

1. Click the **"Create Redirect"** button next to the domain.
2. Enter the full URL (must start with `http://` or `https://`).
3. Click **"Save"** to apply or **"Cancel"** to discard.

### Edit Redirect

Click the **pencil icon** next to an existing redirect URL to modify it.

### Delete Redirect

Click the **cross icon** next to the redirect URL to remove it.

## Edit VirtualHosts File

The **VirtualHosts** file defines the configuration for the domain within Nginx or Apache. It includes settings such as:

* Access logs
* PHP version
* Application runners
* Redirect rules
* Custom directives

To edit this file:

1. Click **"Edit VirtualHosts"** from the domain’s dropdown menu.
2. A new page will open with the Vhost file content.
3. Make your changes and click **"Save"**.

Once saved, OpenPanel will automatically restart the webserver to apply changes.

---

// File: panel/domains/new

# Add new domain

To add a new domain, simply enter the domain name and click **Add Domain**:

![add domain](/img/panel/v2/openpanel_add_domain.gif)

Optionally, you can specify a custom **Document Root** - folder where website files will be stored.

Once submitted, OpenPanel will display a detailed log of all actions performed. Example:

```bash
Using document root: /var/www/html/another-website
Checking if domain already exists on the server
Checking domain against system domains list
Adding another.com to the domains database
Purging cached list of domains for the account
Creating document root directory /var/www/html/another-website
Checking webserver configuration
Checking IPv4 address for the account
Starting apache container..
Creating another.com.conf
Creating vhosts proxy file for Caddy with ModSecurity OWASP Coreruleset
Caddy is running, validating new domain configuration
Domain successfully added and Caddy reloaded.
Creating DNS zone file with A records: /etc/bind/zones/another.com.zone
DNS service is running, adding the zone
Adding the newly created zone file to the DNS server
Starting container for the default PHP version 8.4
Domain another.com added successfully
```

Because OpenPanel starts services on demand to conserve resources, adding your first domain may take slightly longer - it will start the necessary webserver and PHP containers.
Subsequent domains will be added much faster.

---

// File: panel/domains/redirects

# Redirects

If the **Domain Redirects** feature is enabled, you can create and manage domain-level redirects from the Domains page.

For each domain, you can specify a destination URL to redirect traffic to. The URL must begin with `http://` or `https://`. All traffic to the domain will be redirected to this URL *before* reaching your web server.

---

// File: panel/domains/dns

# DNS


The DNS Zone Editor enables you to manage and edit Domain Name System (DNS) zone files, which are essential for mapping domain names to IP addresses and handling various DNS records such as A, CNAME, MX, and TXT records.

On the main _DNS Zone Editor_ page, you can choose a domain name to view and modify its records.

## Edit record

To modify an existing record, click on the 'Edit' button next to it. This will make the row editable, allowing you to save changes by clicking the 'Save' button or discard them by selecting the 'Cancel' button.

## Create record

To create a new DNS record, click on the 'Add Record' button.

This will add a new row at the top of the table where you can enter the record.

Supported DNS types: `A`, `AAAA`, `CAA`, `CNAME`, `MX`, `SRV`, `TXT`

## Delete record

To remove an existing DNS record, click the delete button next to it. The button text will change to 'Confirm', and on the second click, it will permanently delete the record.

## Export Zone
To export a DNS zone, click on the 'Export Zone' button. The button text will change to 'Confirm', and on the second click, the zone will be exported.

## Reset Zone

Resetting the zone will delete all existing records and create a default DNS zone, as if the domain had just been added again.

## Advanced Editor

The Advanced Editor allows direct editing of the DNS zone file, including adding custom records or comments. It can also be used to import a DNS zone by pasting content from another server.

---

// File: panel/domains/dynamic-dns

# Dynamic DNS


Keep your DNS records automatically in sync with changing IP addresses using a secure token URL.

---

## Overview

Dynamic DNS lets you point a subdomain (e.g. `home.yourdomain.com`) to a device whose IP address changes over time, such as a home server or router. Instead of manually updating the record, you call a unique URL and the DNS record updates instantly.

## How It Works

1. Create a Dynamic DNS entry for a subdomain you own.
2. You receive a unique **update URL** containing a secret token.
3. Whenever your IP changes, make a simple HTTP GET request to that URL: from a cron job, router, or any HTTP client.
4. The DNS A record is updated to the caller's IP address automatically.

## Creating an Entry

1. Go to **OpenPanel > Domains > Dynamic DNS**.
2. Click **Add Entry**.
3. Fill in the form:

   | Field | Description |
   |---|---|
   | **Domain** | The base domain you own (e.g. `yourdomain.com`) |
   | **Subdomain** | The subdomain to update (e.g. `home`) — letters, numbers, and hyphens only |
   | **Initial IP** | Starting IP address. Defaults to `0.0.0.0` and is replaced on the first update call |

4. Click **Create**. Your entry will appear in the table with its update URL.

## Updating Your IP

Make a plain HTTP GET request to your update URL:

```
https://OPENPANEL_URL:2083/dynamic-dns/update?token=YOUR_TOKEN
```

The record is updated to the **IP address of the machine making the request**.

Example curl request:
```bash
curl "https://OPENPANEL_URL:2083/dynamic-dns/update?token=YOUR_TOKEN"
```

Example response:
```json
{
  "status": "updated",
  "host": "home.yourdomain.com",
  "ip": "203.0.113.42",
  "updated": "2025-06-07T14:32:00Z"
}
```

## Managing Entries

From the Dynamic DNS page you can:

- **Copy the update URL**: click the copy icon next to the truncated token.
- **Edit an entry**: change the subdomain or manually set the IP address. The token is preserved.
- **Delete an entry**: removes the DNS record and permanently invalidates the token. This cannot be undone.

## Notes

- All Dynamic DNS records have a fixed TTL of **300 seconds** (5 minutes).
- Records are **A records** (IPv4) only.
- The update endpoint requires no authentication so keep your token private.
- If you suspect a token has been compromised, delete the entry and create a new one.

## Troubleshooting

**The IP isn't updating.**
Confirm the GET request returns a `200` response. A `404` means the token is invalid or the entry was deleted. A `400` means the token parameter was missing.

**The wrong IP is being recorded.**
If your device is behind a proxy or NAT, `request.remote_addr` reflects the proxy IP. Make the update request from the device whose IP you want to register, or configure your router to call the URL directly.

**DNS changes aren't propagating.**
The TTL is 300 seconds. Allow up to 5 minutes for resolvers to pick up the new record after an update.

---

// File: panel/domains/ssl

# SSL

OpenPanel automatically generates and renews SSL certificates for all domains using **Let's Encrypt** or **ZeroSSL**.

You can also configure a **custom SSL certificate** for any domain via **OpenPanel > Domains > SSL**.

## Custom SSL

To use your own SSL certificate:

1. Upload your certificate files via **OpenPanel > FileManager**.
2. Go to **OpenPanel > Domains**, then click **SSL** next to the domain.
3. Under **Configure custom SSL**, enter the file paths for:
   * Certificate file (`.crt`)
   * Private key file (`.key`)
4. Click **Configure**.

Once configured, your custom certificate details will appear on the same page.

![screenshot of domain with custom ssl](/img/panel/v2/openpanel_customssl.png)


## AutoSSL

**AutoSSL** is the default option in OpenPanel.
If you're adding a new domain, no action is required.

To switch **from a custom certificate back to AutoSSL**:

1. Navigate to **OpenPanel > Domains** and click **SSL** for the domain.
2. Click **Switch back to AutoSSL**.

The certificate will be re-issued automatically after the domain is accessed via `https://`. Once generated, it will be displayed on the same page.

![screenshot of domain with autossl](/img/panel/v2/openpanel_autossl.png)


### Requirements

To ensure successful SSL generation:

* The **A record** for the domain must point to the server's **IPv4 address**.
* The DNS must be **fully propagated**. Use tools like [whatsmydns.net](https://www.whatsmydns.net/#A) to check.
* The domain must be accessed via `https://` at least once to trigger certificate generation. Open the domain in a browser using `https`.

If:

* The domain was just added,
* DNS is not yet pointed to the server, or
* The domain has not been accessed over `https://`,

Then the SSL section will show **“No certificate found.”**

![screenshot of domain with autossl but no ssl yet](/img/panel/v2/openpanel_autossl_no_ssl.png)

---

// File: panel/domains/vhosts

# Edit VHosts File

A *Virtual Host* (or *vhost*) is a domain-specific configuration file used by the web server.

The **Edit VHosts File** feature is designed for advanced users and experienced administrators. It allows you to directly view and edit the configuration file for each domain.

You can modify various settings such as:

- Resource limits
- Access restrictions
- Custom redirects
- Performance tuning

Depending on your web server -**Nginx**, **OpenResty**, **OpenLiteSpeed**, or **Apache** - different syntax is used, for official guidance, refer to:

- [Apache Virtual Host Documentation](https://httpd.apache.org/docs/current/vhosts/)
- [Nginx Admin Guide](https://docs.nginx.com/nginx/admin-guide/web-server/)
- [Configure OpenLiteSpeed Guide](https://docs.openlitespeed.org/config/)


:::info
⚠️ **Important:** Always create a backup of the configuration file before making any changes.
While OpenPanel performs basic validation on save (including syntax checks and automatic rollback on failure), you should not rely solely on this safeguard. Maintaining your own backups ensures you can manually restore the configuration if needed.
:::

---

// File: panel/domains/suspend

# Suspend a domain

You can temporarily suspend a domain from the **Domains** page. When a domain is suspended, its website content is replaced with a *Suspended Website* page, as configured by the Administrator.

This feature is useful for quickly disabling a website while keeping all other services—such as email, FTP, and more - fully functional.

---

// File: panel/domains/docroot

#  Change Docroot

The **Change Docroot** option allows you to set a custom document root (docroot) for your domain.

By default, OpenPanel serves websites from the `/var/www/html/{domain}` directory. However, advanced users may want to change this location—for example, to serve a subdirectory like `/var/www/html/{domain}/public` or to point to a different folder entirely.

This is useful when:
- Hosting multiple applications under the same domain.
- Serving static content from a specific folder.
- Using a framework that requires a `public/` or `htdocs/` root.

## Changing document root

To change a document root for a domain in OpenPanel:

1. Go to the **Domains** page.
2. Select the domain you want to modify.
3. Click on **Change Docroot**.
4. Enter the new path starting with the `/var/www/html/`.
5. Save your changes.

OpenPanel will automatically update your web server configuration to reflect the new docroot.

---

// File: panel/domains/unsuspend

# Unsuspend a domain

To restore access to a suspended website, you can unsuspend the domain from the **Domains** page.

Unsuspending a domain will remove the *Suspended Website* page and restore the original website content, making it publicly accessible again. All other services - such as email and FTP - will continue to function as they did during suspension.

---

// File: panel/domains/capitalize

# Capitalize Domains

The **Capitalize** feature allows you to change the letter casing of your domain names for display purposes in the OpenPanel UI. This affects how domains are shown across all pages, without altering the actual DNS or domain configuration.

To capitalize a domain:

Navigate to **Domains** and open the **Actions** menu for the desired domain, then click on *Capitalize*.

![capitalize action option](/img/panel/v2/capitalize_1.png)

Click on any letter in the domain name to toggle its case (uppercase/lowercase).

![capitalize action demo](/img/panel/v2/openpanel_capitalize_domains.gif)

Once you've made your changes, click the **Save** button.

You can capitalize individual domains or update all of them as needed.

---

// File: panel/domains/goaccess

# GoAccess

OpenPanel integrates [GoAccess](https://github.com/allinurl/goaccess), a powerful open-source log analyzer, to provide detailed visual traffic reports for each domain.

The **GoAccess** feature is available in your OpenPanel dashboard only if the **GoAccess module** is enabled on the server and your account has permission to access it.

Each domain has its own individual report. To view the report for a specific domain, simply choose it from the dropdown menu on the GoAccess page. A new tab will open in your browser displaying the analytics report.

![goaccess-bright](/img/docs-content/gh-08daa724-c726-4633-9be6-0063e7cd051d.png)

Reports are generated daily by default, but this frequency can be customized by the server administrator. You can check the last refresh time in the top-right corner of the report page.

---

// File: panel/domains/logs

# Raw Access Logs

The **Raw Access Logs** feature is available in your OpenPanel dashboard only if the **Domain Logs** module is enabled on the server and your user account has the necessary permissions.

From the **Domain Logs** page, you can view raw access logs generated by the **Caddy** web server for your domain.

Caddy is used to manage SSL, handle proxy configurations, and forward traffic to your containerized services (e.g., Varnish, Nginx, OpenResty, Apache).

Each log entry contains detailed information, including:

* **Timestamp** – The exact time of the request
* **Client IP** – The IP address from which the request originated
* **Log Level** – Log severity (e.g., info, warning, error)
* **HTTP Method** – Request method (GET, POST, PUT, etc.)
* **Status Code** – HTTP response code (200, 301, 403, 500, etc.)
* **URI** – The requested path
* **Logger** – Internal Caddy logger identifier
* **Message** – Details about the request handling or errors
* **Size** – Request size in bytes
* **Duration** – Time taken by Caddy to process and forward the request to your web server

By default, 1,000 results are shown per page. This limit is configurable by the server administrator.

---

// File: panel/emails/emails

# Email Accounts

If the **Emails** module is enabled on the server and your user account has access, you'll see a table listing all current email domains, the total number of domains, a search bar, and an option to add a new domain.

- The total number of email accounts is displayed at the top left.  
- A search bar is available on the top right for quick filtering.

From this interface, you can view all your email accounts and their details:

* **Email Address**  
* **Storage Used**: size in GB  
* **Manage**: Options for Webmail, Account Management, and Device Connections

---

## Create Email

To create a new email account, click the **New Email** button.

---

## Webmail

Clicking the **Webmail** link autologins you into an email address and opens the RoundCube Webmail client in a new tab.

---

## Manage

Clicking **Manage** for an account opens the management screen where you can:

- Change the account password  
- Update storage quota  
- Suspend incoming and/or outgoing emails

---

## Connect Devices

Click **Connect Devices** to view the email server settings for that account.

Specific guides on how to set an email client using a specific device or service:

- [How to setup email on iPhone](/docs/articles/email/how-to-setup-email-on-iphone)
- [How to setup email on Android](/docs/articles/email/how-to-setup-email-on-android)
- [How to setup email on Apple Mail app](/docs/articles/email/how-to-setup-email-on-apple-mail-app)
- [How to setup email on Thunderbird](/docs/articles/email/how-to-setup-email-on-thunderbird)
- [How to setup email on Outlook 365 desktop app](/docs/articles/email/how-to-setup-email-on-outlook-365-desktop-app)
- [How to setup email on Gmail using desktop / browser](/docs/articles/email/how-to-setup-email-in-gmail)

---

// File: panel/emails/new

# Create New Account

To create a new email account, go to **OpenPanel > Emails > Create an Email**.

Fill in the form:

| Field | Description |
|---|---|
| **Domain** | Select the domain for the account |
| **Username** | The local part of the address (e.g. `info` → `info@yourdomain.com`) |
| **Password** | A password is auto-generated on page load. Use the shuffle icon to generate a new one, or type your own. The strength indicator shows if the password is weak, medium, or strong |
| **Storage quota** | Maximum mailbox size. Set to `0` for unlimited. Unit can be KiB, MiB, GiB, or TiB |

Click **Create Email** when done.

Notes:
- Username cannot contain spaces.
- Password must be at least 8 characters.
- If a maximum quota is set by your hosting plan, you cannot exceed it.

---

// File: panel/emails/import

# Address Importer

The **Address Importer** page allows you to create multiple email accounts at once by uploading an `.xls`/`xlsx` or `.csv` file.

### How to Import Email Addresses

1. Navigate to **OpenPanel > Emails > Address Importer**.
2. Select the `.xls`, `.xlsx` or `.csv` file from your device and click **Upload**.

### File Format Requirements

* Supported delimiters: `,` (comma) or `;` (semicolon)
* Required columns: `username`, `password`
* Optional column: `quota`

  * If included, the quota should specify a unit: `K`, `M`, `G`, or `T`.
  * If no unit is specified, the default is **MB**.

### Example File

```csv
email,password,quota
alice@example.com,pass123,500M
bob@mydomain.com,s3cr3t,1G
charlie@other.com,charliepwd,
diana@example.com,d1@n@pwd,0
eve@unauthorized.com,evepass,100T
new@example.com,ssaaasa2,10M
```

### Review & Confirmation

After uploading the file:

* You’ll see a preview of the email accounts to be created, along with their passwords and quota (if provided).
* The system will flag entries if they will be skipped during the import:

  * Email addresses that already exist
  * Domains that are not associated with your account

### Final Step

Click **Start Upload** to begin the import process. A log will appear below the table to show the progress and status of the operation.

Once completed, all valid email accounts will be successfully imported.

---

// File: panel/emails/filters

# Email Filters

OpenPanel uses [Sieve](http://sieve.info/) (via Dovecot) to filter incoming email messages for your accounts.

Each email address can have its own set of filters. Filters are applied in order, top to bottom, and can match on headers, body content, spam status, and more.

## Creating a Filter

1. Go to **OpenPanel > Emails > Email Filters**.
2. Select the email address you want to manage filters for.
3. Click **Add filter** and give the filter a name.
4. Configure one or more **conditions** — the fields and values that must match.
5. Add one or more **actions** to perform when conditions are met.
6. Click **Save filters**.

### Conditions

Each filter can match on **any** or **all** of its conditions:

| Field | Description |
|---|---|
| **From** | Sender address |
| **Subject** | Email subject line |
| **To** | Primary recipient |
| **Any recipient** | To, Cc, or Bcc |
| **Body** | Message body text |
| **Any header** | Any email header field |
| **Spam status** | SpamAssassin spam flag |
| **Spam score** | SpamAssassin numeric score |
| **List ID** | Mailing list identifier header |

Each condition supports: `contains`, `does not contain`, `equals`, `begins with`, `ends with`, `matches regex`, `does not match regex`.

### Actions

When conditions are met, one or more actions are executed:

| Action | Description |
|---|---|
| **Deliver to folder** | Move the message into a specific mailbox folder |
| **Redirect to email** | Forward the message to another address |
| **Discard message** | Silently delete the message |
| **Reject with message** | Bounce the message with a custom reason |
| **Mark as read** | Mark the message as seen |
| **Flag / star** | Add a flag to the message |
| **Stop processing** | Skip any remaining filters |

---

// File: panel/emails/aliases

# Aliases

An alias forwards mail from a non-existing address to one or more destinations. Recipients can be local or external.

Aliases are managed via Postfix. Each alias has one source address and one or more destination addresses. Mail sent to the alias is forwarded to all configured destinations: the alias itself does not store any mail.

## Creating an Alias

1. Go to **OpenPanel > Emails > Aliases**.
2. Click **New Alias**.
3. Fill in the form:

   | Field | Description |
   |---|---|
   | **Domain** | The domain the alias will belong to (e.g. `yourdomain.com`) |
   | **Alias address** | The local part of the alias (e.g. `info` → `info@yourdomain.com`) |
   | **Destination address** | The address that mail will be forwarded to |

4. Click **Create Alias**.

The destination can be any valid email address, either on this server or external.

## Managing an Alias

Click **Manage** next to any alias to open its detail page. From there you can:

- **Add a destination**: enter an email address and click **Add Destination**. A single alias can forward to multiple addresses simultaneously.
- **Remove a destination**: click **Remove** next to any destination. If all destinations are removed the alias stops delivering mail.
- **Delete the alias**: permanently removes the alias address and all its destinations. This cannot be undone.

---

// File: panel/emails/delete

# Delete Accounts

Navigate to **OpenPanel > Emails > Delete Accounts** to delete an email account.

1. Select the email address to delete.
2. Click on **Confirm Delete**.

---

// File: panel/emails/default_address

# Default Email Address

A default (catch-all) address receives any email sent to an invalid or non-existent address at your domain.

When a catch-all is configured, mail sent to `anything@yourdomain.com` that does not match an existing mailbox is forwarded to the destination you set. Without a catch-all, unmatched emails are rejected (this is the default in OpenPanel).

## Setting a Catch-all

1. Go to **OpenPanel > Emails > Default Email Address**.
2. Select the domain to configure.
3. Enter the **Destination address**: any valid email address, local or external.
4. Click **Save**.

## Removing a Catch-all

If a catch-all is already set, a **Remove Catch-all** button appears in the danger zone. Clicking it deletes the rule and unmatched emails for that domain will be rejected.

Alternatively, clear the destination field and click **Save** to achieve the same result.

---

// File: panel/emails/webmail

# Webmail

Click in Webmail link next to email address to autologin to Roundcube webmail.

---

// File: panel/emails/email_deliverability

# Email Deliverability

Shows current and suggested DNS records for email deliverability: SPF, DKIM, DMARC.

---

// File: panel/files/files

# File Manager 

The **File Manager** interface allows you to manage files for all your domains located inside the `/var/www/html/` directory.

In the table, you can see the following information:

* **Name**
* **Size** – Displays the size for files. For folders, click **Calculate** to fetch their size.
* **Last Modified** – Shows the timestamp of the last modification.
* **Permissions** – Displays symbolic file permissions (e.g., `drwxr-xr-x`). Hover over them to view the octal (numeric) equivalent (e.g., `0755`).

Clicking the **Toggle** icon reveals additional details:

* **Owner** – The UID of the file or folder owner.
* **Group** – The GID of the group that owns the file or folder.
* **Links** – The number of hard links to the file or directory.
* **Link Target** – If it’s a symlink, this shows the target it points to.
* **Type** – Indicates whether it's a directory, file, or symbolic link.


## Create File

To create a new file, navigate to the desired directory and click the **New File** button. In the modal, enter the filename and click **Create**.

Optionally, if you want to open the file in the Editor immediately after creation, check the **Open in File Editor after creation** option.

## Create Folder

To create a new folder, navigate to the desired directory and click the **New Folder** button. In the modal, enter the folder name and click **Create**.

## Upload Files

The File Manager allows you to upload multiple files at once. You can upload files using one of the following methods:

- **Drag&Drop in File Manager**: Navigate to the desired folder and drag and drop files into the file list table.
- **Upload from device**: Click the 'Upload' button, then drag and drop or select files from your device on the new page.
- **Download from URL**: Click 'Download from URL instead', then enter the link to the file you want to download.

Upload size limits are configurable by the Administrator.


## Select all

Use your mouse cursor to select multiple files and folders. Click and drag, then click again to release the selection.

To select multiple files, one by one, click and hold `Ctrl` key while clicking on the rows.

To select all files in the directory at once, click on the 'Select All' button. To deselect all files, click on the 'Deselect' button.


## Delete

To delete files or folders click on the 'Delete' button. If multiple files or folders are selected, you will see the list in the modal and click 'Delete' to permanently delete the selected files.

## Download File

To download a file, click on the **Download** button when the file is selected.

:::info
Downloading multiple files at once is not supported. Instead, the 'Compress' option should be used to create an archive of files, and then download that archive.
:::

## View File

To view the content of a file that can be edited in a text editor or opened as an image, click on the file, then on the **View** button.

## Edit File

To edit the content of a file that can be edited in a text editor, click on the file, then on the **Edit** button. A new page will open with a text editor where you can edit the file content.

Using the button in top-right corner you can switch between one of the 4 available editors: Monaco (defualt), Ace, CodeMirror, Plain Text.

![code editor](/img/docs-content/Xv0sPDG6-2026-04-02-19-57.png)

## Rename File

To rename a file or folder, click on it, then click on the **Rename** button, and set the new name.

## Copy Files

To copy files from one folder to another, first select the desired files and click on the **Copy** button. The new modal will display a list of all selected file names and allow you to set the destination name of the folder where the files will be copied.

To initiate the copying process, click on the 'Copy' button in the modal. A progress bar will appear, indicating the progress made, and a 'Copy complete' message will be displayed when the process is finished.


## Move Files

To move files from one folder to another, first select the desired files and click on the **Move** button. The new modal will display a list of all selected file names and allow you to set the destination name of the folder where the files will be moved to.

To initiate the move process, click on the 'MOve' button in the modal. A progress bar will appear, indicating the progress made, and a 'Complete' message will be displayed when the process is finished.

## Extract Archive

To extract an uploaded archive (`.zip`, `.tar`, `.tar.gz`), select the file, and then click on the 'Extract' button in the menu.

In the modal, set the name of the folder where files will be extracted, and click on **Confirm** to start the process.

## Compress to Archive

To create an archive of files, first, select the desired files or folders, and then click on the **Compress** button. The new modal will display a list of all selected file names and allow you to set the archive name and extension (`.zip`, `.tar`, or `.tar.gz`).

## Empty Folder

If a folder is empty, you will see the 'No items found.' message and the menu with file options will be hidden. Only the options to create a new file, folder, or upload files will be available.

## Search Files and Folders

To activate the search field, click on the Search icon in the top right corner. Clicking on the Toggle icon will display options to search only files or only folders, and path to search in.

For performance reasons, search results are limited to a maximum of 10 results for files and 10 results for folders.

---

// File: panel/files/FTP

# FTP

OpenPanel accounts can create FTP sub-users that share the FTP service with all other FTP users on the server. Connect using the server IP address and port `21`.

:::info
FTP is available in the [OpenPanel Enterprise](/enterprise/) edition. Administrator setup guide: [How to setup FTP in OpenPanel](/docs/articles/user-experience/how-to-setup-ftp-in-openpanel/)
:::

---

## View Users

Go to **OpenPanel > Files > FTP** to see all FTP accounts, the directory each account is restricted to, and connection details including the server IP.

## Create User

1. Go to **OpenPanel > Files > FTP** and click **Add Account**.
2. Fill in the form:

   | Field | Description |
   |---|---|
   | **Domain** | Select one of your domains |
   | **Username** | The local part of the FTP username: the full username will be `username@domain.com` |
   | **Password** | Password for the FTP account |
   | **Path** | Directory the account is restricted to: must start with `/var/www/html/` |

3. Click **Add Account** to create the user.

:::info
FTP usernames may only contain letters, numbers, and the characters `-`, `_`, `@`, `.`. [FTP username requirements](/docs/articles/accounts/forbidden-usernames/#ftp)
:::

## Change Password

1. Go to **OpenPanel > Files > FTP** and click **Change Password** next to the account.
2. Enter the new password and click **Change Password**.

:::info
FTP passwords must contain at least one uppercase letter (`A-Z`), lowercase letter (`a-z`), digit (`0-9`), and special character. [FTP password requirements](/docs/articles/accounts/forbidden-usernames/#ftp)
:::

## Change Path

1. Go to **OpenPanel > Files > FTP** and click **Change Path** next to the account.
2. Enter the new directory path and click **Change Path**. The path must start with `/var/www/html/`.

## Delete User

Go to **OpenPanel > Files > FTP** and click **Delete** next to the account, then confirm the deletion.

## Download Client Configuration

On the FTP accounts page you can download a ready-to-import configuration file for:

- **FileZilla**: downloads an `.xml` connection file
- **Cyberduck**: downloads an `.ftpbookmark` file

Both files are pre-filled with the correct server IP, port, username, and remote directory.

## View Active Connections

Go to **OpenPanel > Files > FTP** and click **View Connections** to see all currently active FTP sessions for your account.

---

// File: panel/files/upload

# Upload from Device

The **Upload from Device** page allows you to easily upload files from your local device to a selected directory on the server.

To upload:

1. Navigate to the desired directory.
2. Click the **Upload** button.
3. Drag and drop files or select them manually from your device.
4. Click **Upload** to begin.

A progress bar will display the status of each file. You can upload multiple files at once.

> ⚠️ The upload size limit is configured by the administrator.

For large files (over 1GB), we recommend using **FTP** or the **Download from URL** feature instead.

---

// File: panel/files/wget

# Download from URL

The **Download from URL** feature allows you to fetch files directly from the internet into your selected directory.

To use:

1. Navigate to the desired directory.
2. Click the **Upload** button.
3. Select **Download from URL instead**.
4. Enter the direct download link (URL) to the file.
5. Click **Download** to begin.

The file will be downloaded using `wget` and saved with the same name as on the remote server.

If a file with the same name already exists in the directory, it will not be overwritten—instead, a version with a `+1` suffix will be created.

> ✅ This is especially useful for large files or when direct device uploads are slow or limited.

---

// File: panel/files/disk_usage

# Disk Usage


Disk usage refers to the amount of space occupied by the content of your websites, including databases, files, videos, images, emails, and web pages. Monitoring disk usage is crucial to ensure efficient resource management and to prevent storage-related issues.

## Disk Usage Chart

The Disk Usage Chart provides a visual representation of disk usage per directory. It allows you to quickly assess which directories are consuming the most storage space.

## Browsing Directories

The "Browse Directories" section displays a table listing directories and their respective sizes. You can navigate through directories and view their sizes.

To navigate to a specific directory, click on the directory name in the table.

To return to the parent directory, click on "Up One Level."


## Usage Example
Suppose you want to check the disk usage of a specific directory. Follow these steps:

1. Navigate to the "Browse Directories" section.
2. Click on the directory you want to explore.
3. View the directory's size and content.

## Lowering Disk Usage

Managing disk usage is essential to maintain the performance and stability of your hosting environment. Here are some tips and best practices for reducing disk usage within OpenPanel:

### Regularly Clean Up Unused Files
- Remove Temporary Files: Periodically delete temporary files, such as log files, cache files, and old backups. These files can accumulate and consume valuable disk space over time.
- Empty Trash: Ensure that you regularly empty the trash or recycle bin to permanently remove files that are no longer needed.
- Unused Website Assets: Identify and remove unused images, videos, or other assets from your websites. Hosting unnecessary files can quickly fill up your disk space.

### Optimize Database Usage
- Database Cleanup: Regularly optimize and clean up your databases by removing outdated or unnecessary data. This can help reduce the database's size and improve its performance.
- Use Database Compression: If your hosting service supports it, enable database compression to reduce the storage space required by your databases.

### Monitor and Limit Email Attachments
- Attachments: Encourage users to be mindful of email attachments. Large attachments can quickly consume disk space. Consider setting attachment size limits for email accounts to prevent oversized files from being stored.

### Manage Log Files
- Log Rotation: Implement log rotation to prevent log files from growing indefinitely. Older log files can be archived or deleted to free up space.
- Log Level Adjustment: Adjust the verbosity or log level of your applications to generate fewer log entries, which can help reduce disk usage.

### Offload Large Media
- External File Hosting: Consider offloading large media files, such as videos or high-resolution images, to external hosting services or Content Delivery Networks (CDNs). This reduces the load on your server and conserves disk space.

## Troubleshooting
If you encounter any issues while using the Disk Usage feature, consider the following steps:

1. Ensure that you have appropriate permissions to access the directories.
2. Verify that the disk usage data source is correctly configured.
3. Clear your browser cache if you experience any display issues with the chart or table.

---

By following these guidelines and regularly managing your disk usage, you can maintain a healthy hosting environment and avoid unexpected issues related to storage limitations.

---

// File: panel/files/inodes_explorer

# Inodes

Inode usage is a critical aspect of managing your hosting environment. Inodes are data structures that store information about files and directories on your server. Monitoring and optimizing inode usage is vital to prevent issues related to inode limits.

## Inode Usage Chart

The Inode Usage Chart provides a visual representation of inode usage across directories. It enables you to identify areas with high inode consumption and take action as needed.

## Browsing Inodes

The "Browse Directories" section presents a table listing inodes, their associated files and directories, and their inode counts. This table allows you to navigate through inodes and assess their usage.

To explore a inodes for a specific directory, click on the directory name in the table.

To navigate to the parent directory, click on "Up One Level."

## Usage Example

Suppose you need to check the inode usage of a specific directory. Here's a simple guide:

1. Navigate to the "Browse Directories" section.
2. Click on the file or directory you want to inspect.
3. Review the inode count.

## Lowering Inode Usage

Optimizing inode usage is crucial for maintaining your hosting environment's efficiency. Here are strategies to reduce inode usage within OpenPanel:

### Regularly Clean Up Unnecessary Files
- Delete Unused Files: Periodically remove files that are no longer needed, such as outdated backups, temporary files, and old logs.
- Remove Unnecessary Duplicates: Check for and remove duplicate files or unnecessary copies.
- Delete Cache Files: Periodically delete cached files of your websites to free up inode usage and ensure efficient resource management.
- Empty Trash: Ensure the trash is emptied regularly to permanently delete files.

### Efficiently Manage Directories
- Organize Files: Keep your directories organized, avoid unnecessary subdirectories, and reduce nesting when possible.
- Archive Old Data: Archive older data and directories to secondary storage or external services.
- Implement Content Delivery: For large number of media files, consider using external hosting services or CDNs.

## Troubleshooting

If you encounter issues related to inode usage, consider these steps:

1. Verify your permissions to access inodes and directories.
2. Ensure that your inode usage data source is correctly configured.
3. Clear your browser cache if you encounter display problems with the Inode Usage Chart or table.

---

By following these best practices and maintaining efficient inode usage, you can prevent inode exhaustion issues and ensure the smooth operation of your hosting environment.

---

// File: panel/files/malware-scanner

# Malware Scanner

The **Malware Scanner** feature is available in your OpenPanel dashboard only if **ClamAV** is enabled on the server and your account has permission to use it.

## Manual Scan

To perform a manual scan, select the path you want to scan and click the **Start Scan** button.

ClamAV will check the files one by one and display the results for each.

## Automatic Scan

Automatic scans are configured by the server administrator. If enabled, scan results will appear on this page, along with a **Quarantine** section where you can view and manage infected files.

---

// File: panel/files/backups

# Backups

In OpenPanel, backups are configurable directly **by the panel users**, unlike other panels where backups are managed by the admin.

This empowers users to define their own backup schedules, choose exactly what to back up, and select from a wide range of supported destinations.
As a result, administrators have fewer tasks to manage, and users gain greater control and flexibility.

![backups.png](/img/panel/v2/backups.png)

## Destinations

OpenPanel supports the following destinations:

- [**S3 storage**](#s3) - AWS S3, Filebase, MinIO, etc.
- [**WebDAV**](#webdav) - Remote backups using WebDAV.
- [**SSH**](#azure) - Remote backups via SSH to another server.
- [**Azure**](#azure) - Remote backups to Azure Blob Storage.
- [**Dropbox**](/#dropbox) - Remote backups to Dropbox cloud storage.

User can select destination from **Backups > Destinations** page.

![destinations.png](/img/panel/v2/destinations.png)

Once backup is selected, it's options are available on **Backups > Settings page**.

### SSH/SFTP

| Setting | Description |
|----------|----------|
| **SSH_HOST_NAME**    | The FQDN of the remote SSH server, example: `server.local`  |
| **SSH_PORT**    | The port of the remote SSH server  |
| **SSH_REMOTE_PATH**    | The Directory to place the backups to on the SSH server. Example: `/home/user/backups`  |
| **SSH_USER**    | The username for the SSH server. Example: `user`  |
| **SSH_PASSWORD**    | The password for the SSH server. Example: `password`  |
| **SSH_IDENTITY_FILE**    | The private key path inside `/var/www/html/` for SSH server. Non-RSA keys (e.g. ed25519) will also work.  |
| **SSH_IDENTITY_PASSPHRASE**    | The passphrase for the identity file if applicable. Example: `pass`  |


### S3

| Setting | Description |
|----------|----------|
| **AWS_S3_BUCKET_NAME**    | The name of the remote bucket that should be used for storing backups. If this is not set, no remote backups will be stored. Example: `backup-bucket` |
| **AWS_S3_PATH**    | If you want to store the backup in a non-root location on your bucket  you can provide a path. The path must not contain a leading slash. Example: `my/backup/location`  |
| **AWS_ACCESS_KEY_ID** **AWS_SECRET_ACCESS_KEY**   | Define credentials for authenticating against the backup storage and a bucket name. Although all of these keys are `AWS`-prefixed, the setup can be used with any S3 compatible storage. |
| **AWS_IAM_ROLE_ENDPOINT**    | Instead of providing static credentials, you can also use IAM instance profiles or similar to provide authentication. Some possible configuration options on AWS: `- EC2: http://169.254.169.254` `- ECS: http://169.254.170.2` |
| **AWS_ENDPOINT**    | This is the FQDN of your storage server, e.g. `storage.example.com`. If you need to set a specific (non-https) protocol, you will need to use the `AWS_ENDPOINT_PROTO` option. The default value points to the standard AWS S3 endpoint. Example: `s3.amazonaws.com`  |
| **AWS_ENDPOINT_PROTO**    | The protocol to be used when communicating with your S3 storage server. Defaults to "https". You can set this to "http" when communicating with a different seld-hosted s3 storage. |
| **AWS_ENDPOINT_INSECURE**    | Setting this variable to `true` will disable verification of SSL certificates for `AWS_ENDPOINT`. You shouldn't use this unless you use self-signed certificates for your remote storage backend. This can only be used when `AWS_ENDPOINT_PROTO` is set to `https`.  |
| **AWS_ENDPOINT_CA_CERT**    | If you wish to use self signed certificates your S3 server, you can pass the location of a PEM encoded CA certificate and it will be used for validating your certificates. Alternatively, pass a PEM encoded string containing the certificate. Example: `/var/www/html/cert.pem` |
| **AWS_STORAGE_CLASS**    | Setting a value for this key will change the S3 storage class header. Default behavior is to use the standard class when no value is given. Example: `GLACIER` |
| **AWS_PART_SIZE**    | Setting this variable will change the S3 default part size for the copy step. This value is useful when you want to upload large files. Note: While using Scaleway as S3 provider, be aware that the parts counter is set to 1.000. While Minio uses a hard coded value to 10.000. As a workaround, try to set a higher value. Defaults to `16` (MB) if unset (from minio), you can set this value according to your needs. The unit is in MB and an integer. |


### WebDAV

| Setting | Description |
|----------|----------|
| **WEBDAV_URL**    | The URL of the remote WebDAV server. Example: `https://webdav.example.com` |
| **WEBDAV_PATH**    | The Directory to place the backups to on the WebDAV server. If the path is not present on the server it will be created. Example: `/my/directory/` |
| **WEBDAV_USERNAME**    | The username for the WebDAV server Example: `user` |
| **WEBDAV_PASSWORD**    | The password for the WebDAV server. Example: `password` |
| **WEBDAV_URL_INSECURE**    |  Setting this variable to "true" will disable verification of SSL certificates for WEBDAV_URL. You shouldn't use this unless you use self-signed certificates for your remote storage backend. |

### Azure

| Setting | Description |
|----------|----------|
| **AZURE_STORAGE_ACCOUNT_NAME**    | The credential's account name when using Azure Blob Storage. This has to be set when using Azure Blob Storage.  Example: `account-name` |
| **AZURE_STORAGE_PRIMARY_ACCOUNT_KEY**    | The credential's primary account key when using Azure Blob Storage. If this is not given, the command tries to fall back to using a connection string (if given) or a managed identity (if neither is set). |
| **AZURE_STORAGE_CONNECTION_STRING**    | A connection string for accessing Azure Blob Storage. If this is not given, the command tries to fall back to using a primary account key (if given) or a managed identity (if neither is set). |
| **AZURE_STORAGE_CONTAINER_NAME**    | The container name when using Azure Blob Storage.  Example: `container-name` |
| **AZURE_STORAGE_ENDPOINT**    | The service endpoint when using Azure Blob Storage. This is a template that can be passed the account name.  Example: `https://{{ .AccountName }}.blob.core.windows.net/` |
| **AZURE_STORAGE_ACCESS_TIER**    | The access tier when using Azure Blob Storage. Possible values are [listed here](https://github.com/Azure/azure-sdk-for-go/blob/sdk/storage/azblob/v1.3.2/sdk/storage/azblob/internal/generated/zz_constants.go#L14-L30) Example: `Cold` |


### Dropbox

| Setting | Description |
|----------|----------|
| **DROPBOX_REMOTE_PATH**    | Absolute remote path in your Dropbox where the backups shall be stored. Note: Use your app's subpath in Dropbox, if it doesn't have global access.  Example: `/my/directory` |
| **DROPBOX_APP_KEY**  **DROPBOX_APP_SECRET**   | App key and app secret from your app created at [https://www.dropbox.com/developers/apps](https://www.dropbox.com/developers/apps) |
| **DROPBOX_CONCURRENCY_LEVEL**    | Number of concurrent chunked uploads for Dropbox. Values above 6 usually result in no enhancements. |
| **DROPBOX_REFRESH_TOKEN**    |  Refresh token to request new short-lived tokens (OAuth2) |


Set up Dropbox storage backend:

1. Create a new Dropbox App in the [App Console](https://www.dropbox.com/developers/apps)
2. Open your new Dropbox App and copy the `DROPBOX_APP_KEY` and `DROPBOX_APP_SECRET`
3. Click on `Permissions` in your app and make sure, that the following permissions are cranted (or more):
   - `files.metadata.write`
   - `files.metadata.read`
   - `files.content.write`
   - `files.content.read`
4. Replace APPKEY in `https://www.dropbox.com/oauth2/authorize?client_id=APPKEY&token_access_type=offline&response_type=code `with the app key from step 2
5. Visit the URL and confirm the access of your app. This gives you an `auth code` -> save it somewhere!
6. Replace AUTHCODE, APPKEY, APPSECRET accordingly and perform the request from your terminal:
   ```
   curl https://api.dropbox.com/oauth2/token \
   -d code=AUTHCODE \
   -d grant_type=authorization_code \
   -d client_id=APPKEY \
   -d client_secret=APPSECRET
   ```
7. Execute the request. You will get a JSON formatted reply. Use the value of the `refresh_token` for the last setting `DROPBOX_REFRESH_TOKEN`
8. You should now have `DROPBOX_APP_KEY`, `DROPBOX_APP_SECRET` and `DROPBOX_REFRESH_TOKEN` set. These don’t expire.

:::info
*Note*: Using the “Generated access token” in the app console is not supported, as it is only very short lived and therefore not suitable for an automatic backup solution. The refresh token handles this automatically - the setup procedure above is only needed once.
:::

:::danger
Important: If you chose `App folder` access during the creation of your Dropbox app in step 1 above, `DROPBOX_REMOTE_PATH` will be a relative path under the App folder! (For example, DROPBOX_REMOTE_PATH=/somedir means the backup file will be uploaded to /Apps/myapp/somedir) On the other hand if you chose Full Dropbox access, the value for `DROPBOX_REMOTE_PATH` will represent an absolute path inside your Dropbox storage area. (Still considering the same example above, the backup file will be uploaded to /somedir in your Dropbox root)
:::


## Encryption

Backup encryption is by default disabled and needs to be enabled by the Administrator first.

All of the encryption options are mutually exclusive. Provide a single option for the encryption scheme of your choice.


| Setting | Description |
|----------|----------|
| **GPG_PASSPHRASE**    | Backups can be encrypted symmetrically using gpg in case a passphrase is given. |
| **GPG_PUBLIC_KEY_RING**    |  Backups can be encrypted asymmetrically using gpg in case publickeys are given. You can use pipe syntax to pass a multiline value. |
| **AGE_PASSPHRASE**    | Backups can be encrypted symmetrically using age in case a passphrase is given. |
| **AGE_PUBLIC_KEYS**    | Backups can be encrypted asymmetrically using age in case publickeys are given. Multiple keys need to be provided as a comma separated list. Right now, this supports `age` and `ssh` keys. |

## Rotation

:::danger
**IMPORTANT, PLEASE READ THIS BEFORE USING THIS FEATURE**:
The mechanism used for pruning old backups is not very sophisticated and applies its rules to **all files in the target directory** by default, which means that if you are storing your backups next to other files, these might become subject to deletion too. When using this option make sure the backup files are stored in a directory used exclusively for such files, or to configure `BACKUP_PRUNING_PREFIX` to limit removal to certain files.
:::

| Setting | Description |
|----------|----------|
| **BACKUP_RETENTION_DAYS**    | Pass zero or a positive integer value to enable automatic rotation of old backups. The value declares the number of days for which a backup is kept. Default: `-1` |
| **BACKUP_PRUNING_LEEWAY**    | In case the duration a backup takes fluctuates noticeably in your setup you can adjust this setting to make sure there are no race conditions between the backup sit on the edge of the time window. Set this value to a duration finishing and the rotation not deleting backups that that is expected to be bigger than the maximum difference of backups. Valid values have a suffix of (s)econds, (m)inutes or (h)ours. By default, one minute is used. |
| **BACKUP_PRUNING_PREFIX**    | In case your target bucket or directory contains other files than the ones managed by this container, you can limit the scope of rotation by setting a prefix value. This would usually be the non-parametrized part of your BACKUP_FILENAME. E.g. if BACKUP_FILENAME is `db-backup-%Y-%m-%dT%H-%M-%S.tar.gz`, you can set BACKUP_PRUNING_PREFIX to `db-backup-` and make sure unrelated files are not affected by the rotation mechanism. |

## Source

By default, everything will be backed up. In case you need to backup only a specific data, set `BACKUP_SOURCES`.

Available options are:

| Setting | Description |
|----------|----------|
| **All**    |  Backups content of all docker volumes: website files, mysql/mariadb databases, minecraft, postgre databases, vhosts files. |
| **Files**    |  Backups only website files inside `/var/www/html/` directory. |
| **Emails**    |  Backups only email files inside `/var/mail/` directory. |
| **MySQL Databases**    |  Backups only MySQL/MariaDB databases. |
| **Postgres Databases**    |  Backups only PostgreSQL databases. |
| **MsSQL Databases**    |  Backups only MsSQL databases. |
| **VirtualHosts**    |  Backups only Apache/Nginx VirtualHosts for domains. |
| **Minecraft Data**    |  Backups only `/data` folder from Minecraft container. |


## Schedule

Backups can be run on fixed scheduled that are defined as a cron expression.
`BACKUP_CRON_EXPRESSION` is used to schedule the backup job, a cron expression represents a set of times, using 5 or 6 space-separated fields.

| Field name   | Mandatory? | Allowed values  | Allowed special characters |
| ----------   | ---------- | --------------  | -------------------------- |
| Seconds      | No         | 0-59            | `* / , -` |
| Minutes      | Yes        | 0-59            | `* / , -` |
| Hours        | Yes        | 0-23            | `* / , -` |
| Day of month | Yes        | 1-31            | `* / , - ?` |
| Month        | Yes        | 1-12 or JAN-DEC | `* / , -` |
| Day of week  | Yes        | 0-6 or SUN-SAT  | `* / , - ?` |


Month and Day-of-week field values are case insensitive. "SUN", "Sun", and "sun" are equally accepted. Refer to sites like [crontab.guru](https://crontab.guru) for help.

If no value is set, `@daily` will be used, which runs every day at midnight.

## Compression


| Setting | Description |
|----------|----------|
| `BACKUP_COMPRESSION`    |  The compression algorithm used in conjunction with tar. Valid options are: "gz" (Gzip), "zst" (Zstd) or "none" (tar only).  Default is "gz". Note that the selection affects the file extension. |
| `GZIP_PARALLELISM`    | Parallelism level for "gz" (Gzip) compression. Defines how many blocks of data are concurrently processed. Higher values result in faster compression. No effect on decompression. Default = `1`. Setting this to 0 will use all available threads. |

## Names

Options here are available byt disabled by default and need to be manually enabled by the Administrator first.

| Setting | Description |
|----------|----------|
| `BACKUP_FILENAME`    |  The desired name of the backup file including the extension. Format verbs will be replaced as in `strftime`. Omitting all verbs will result in the same filename for every backup run, which means previous versions will be overwritten on subsequent runs. Extension can be defined literally or via `{{ .Extension }}` template,  in which case it will become either "tar.gz", "tar.zst" or ".tar" (depending on your `BACKUP_COMPRESSION` setting). The default `backup-%Y-%m-%dT%H-%M-%S.{{ .Extension }}` results in filenames like: `backup-2021-08-29T04-00-00.tar.gz`. |


## Exclude

`BACKUP_EXCLUDE_REGEXP` - When a value is given, all files in `BACKUP_SOURCES` whose full path matches the regular expression will be excluded from the archive. Regular Expressions can be used as from [the Go standard library](https://pkg.go.dev/regexp). Example: `\.log$`.

## Notifications

Notifications (email, Slack, etc.) can be sent out when a backup run finishes.

### NOTIFICATION_URLS

Configuration is provided as a comma-separated list of URLs as consumed by [shoutrrr](https://containrrr.dev/shoutrrr/v0.8/services/overview/)

| Service      | URL format                                                                                           |
|--------------|------------------------------------------------------------------------------------------------------|
| [Bark](#bark)         | `bark://devicekey@host`                                                                              |
| [Discord](#discord)      | `discord://token@id`                                                                                 |
| [Email](#email)        | `smtp://username:password@host:port/?from=fromAddress&to=recipient1[,recipient2,...]`               |
| Gotify       | `gotify://gotify-host/token`                                                                         |
| Google Chat  | `googlechat://chat.googleapis.com/v1/spaces/FOO/messages?key=bar&token=baz`                         |
| IFTTT        | `ifttt://key/?events=event1[,event2,...]&value1=value1&value2=value2&value3=value3`                  |
| Join         | `join://shoutrrr:api-key@join/?devices=device1[,device2,...][&icon=icon][&title=title]`              |
| Mattermost   | `mattermost://[username@]mattermost-host/token[/channel]`                                            |
| Matrix       | `matrix://username:password@host:port/[?rooms=!roomID1[,roomAlias2]]`                                |
| Ntfy         | `ntfy://username:password@ntfy.sh/topic`                                                             |
| OpsGenie     | `opsgenie://host/token?responders=responder1[,responder2]`                                           |
| Pushbullet   | `pushbullet://api-token[/device/#channel/email]`                                                    |
| Pushover     | `pushover://shoutrrr:apiToken@userKey/?devices=device1[,device2,...]`                                |
| Rocketchat   | `rocketchat://[username@]rocketchat-host/token[/channel|@recipient]`                                 |
| Slack        | `slack://[botname@]token-a/token-b/token-c`                                                          |
| Teams        | `teams://group@tenant/altId/groupOwner?host=organization.webhook.office.com`                         |
| Telegram     | `telegram://token@telegram?chats=@channel-1[,chat-id-1,...]`                                         |
| Zulip Chat   | `zulip://bot-mail:bot-key@zulip-domain/?stream=name-or-id&topic=name`                                |

#### Email

URL Format:

```
smtp://username:password@host:port/?from=fromAddress&to=recipient1[,recipient2,...]
```

URL Fields:

- **Username** – SMTP server username  
  **Default:** _empty_  
  **URL part:** `smtp://username:password@host:port/`

- **Password** – SMTP server password or hash (for OAuth2)  
  **Default:** _empty_  
  **URL part:** `smtp://username:password@host:port/`

- **Host** – SMTP server hostname or IP address (**Required**)  
  **URL part:** `smtp://username:password@host:port/`

- **Port** – SMTP server port  
  **Common values:** 25, 465, 587, 2525  
  **Default:** `25`  
  **URL part:** `smtp://username:password@host:port/`

Query/Param Props:

Props can be supplied via the `params` argument or directly in the URL using `?key=value&key=value`.

- **FromAddress** – Email address the mail is sent from (**Required**)  
  **Aliases:** `from`

- **ToAddresses** – Comma-separated list of recipient emails (**Required**)  
  **Aliases:** `to`

- **Auth** – SMTP authentication method  
  **Default:** `Unknown`  
  **Possible values:** `None`, `Plain`, `CRAMMD5`, `Unknown`, `OAuth2`

- **ClientHost** – Hostname sent to the SMTP server during the HELO phase  
  **Default:** `localhost`  
  Set to `"auto"` to use OS hostname

- **Encryption** – Encryption method  
  **Default:** `Auto`  
  **Possible values:** `None`, `ExplicitTLS`, `ImplicitTLS`, `Auto`

- **FromName** – Name of the sender  
  **Default:** _empty_

- **Subject** – Subject line of the email  
  **Default:** `Shoutrrr Notification`  
  **Aliases:** `title`

- **UseHTML** – Whether the message is in HTML format  
  **Default:** ❌ No

- **UseStartTLS** – Whether to use StartTLS encryption  
  **Default:** ✔ Yes  
  **Aliases:** `starttls`
  

#### Bark

URL Fields:

- **DeviceKey** – The key for each device (**Required**)  
  **URL part:** `bark://:devicekey@host/path`

- **Host** – Server hostname and port (**Required**)  
  **URL part:** `bark://:devicekey@host/path`

- **Path** – Server path  
  **Default:** `/`  
  **URL part:** `bark://:devicekey@host/path`

Query/Param Props:

Props can be either supplied using the `params` argument, or through the URL using  `?key=value&key=value` etc.

- **Badge** – The number displayed next to App icon  
  **Default:** `0`

- **Category** – Reserved field, no use yet  
  **Default:** _empty_

- **Copy** – The value to be copied  
  **Default:** _empty_

- **Group** – The group of the notification  
  **Default:** _empty_

- **Icon** – A URL to the icon, available only on iOS 15 or later  
  **Default:** _empty_

- **Scheme** – Server protocol, `http` or `https`  
  **Default:** `https`

- **Sound** – Value from [Bark Sounds](https://github.com/Finb/Bark/tree/master/Sounds)  
  **Default:** _empty_

- **Title** – Notification title, optionally set by the sender  
  **Default:** _empty_

- **URL** – URL that will open when notification is clicked  
  **Default:** _empty_

#### Discord

URL Format:

```
discord://token@webhookid
```

URL Fields:

- **Token** – (**Required**)  
  **URL part:** `discord://token@webhookid/`

- **WebhookID** – (**Required**)  
  **URL part:** `discord://token@webhookid/`

Query/Param Props:

Props can be either supplied using the `params` argument, or through the URL using  `?key=value&key=value` etc.

- **Avatar** – Override the webhook default avatar with specified URL  
  **Default:** _empty_  
  **Aliases:** `avatarurl`

- **Color** – The color of the left border for plain messages  
  **Default:** `0x50D9ff`

- **ColorDebug** – The color of the left border for debug messages  
  **Default:** `0x7b00ab`

- **ColorError** – The color of the left border for error messages  
  **Default:** `0xd60510`

- **ColorInfo** – The color of the left border for info messages  
  **Default:** `0x2488ff`

- **ColorWarn** – The color of the left border for warning messages  
  **Default:** `0xffc441`

- **JSON** – Whether to send the whole message as the JSON payload instead of using it as the `content` field  
  **Default:** ❌ No

- **SplitLines** – Whether to send each line as a separate embedded item  
  **Default:** ✔ Yes

- **Title**  
  **Default:** _empty_

- **Username** – Override the webhook default username  
  **Default:** _empty_

Creating a Webhook in Discord:

1. Open your channel settings by clicking the gear icon next to the channel name.
   ![screenshot 1](/img/docs-content/FmYrJfhZ-sc-1.png)
2. In the left menu, click **Integrations**.  
   ![screenshot 2](/img/docs-content/NtJGM8vF-sc-2.png)
3. On the right, click **Create Webhook**.  
   ![screenshot 3](/img/docs-content/7Djx1x6y-sc-3.png)
4. Set the name, channel, and icon to your preference, then click **Copy Webhook URL**.  
   ![screenshot 4](/img/docs-content/2rvC2PbL-sc-4.png)
5. Press **Save Changes**.
   ![screenshot 5](/img/docs-content/wqG9GzQL-sc-5.png)
6 Format the service URL:
   ```
   https://discord.com/api/webhooks/693853386302554172/W3dE2OZz4C13_4z_uHfDOoC7BqTW288s-z1ykqI0iJnY_HjRqMGO8Sc7YDqvf_KVKjhJ
                                    └────────────────┘ └──────────────────────────────────────────────────────────────────┘
                                        webhook id                                    token
   
   discord://W3dE2OZz4C13_4z_uHfDOoC7BqTW288s-z1ykqI0iJnY_HjRqMGO8Sc7YDqvf_KVKjhJ@693853386302554172
             └──────────────────────────────────────────────────────────────────┘ └────────────────┘
                                             token                                    webhook id
   ```



### NOTIFICATION_LEVEL

By default, notifications would only be sent out when a backup run fails. To receive notifications for every run, set `NOTIFICATION_LEVEL` to `info` instead of the default `error`.


## Triggering a Backup

You can manually trigger a backup at any time, regardless of the scheduled settings.
To do this, ensure the Docker feature is enabled. Then:

1. Navigate to **Containers > Terminal**.
2. Select the **Backup** container.
3. In the terminal, type the following command and press Enter:

```bash
backup
```

## Troubleshooting

Error *error copying archive: ssh.(*sshStorage).Copy: error creating file: file does not exist* indicates that the configured directory does not exist on destination:

```
time=2025-07-22T11:21:05.117Z level=ERROR msg="Fatal error running command: file does not exist" error="main.(*command).runAsCommand: error running script: main.runScript.func4: error running script: main.(*script).copyArchive: error copying archive: ssh.(*sshStorage).Copy: error creating file: file does not exist"
```

---

// File: panel/files/fix_permissions

# Fix Permissions
The **Fix Permissions** tool is designed to automatically correct file and folder permissions for your websites, ensuring that they are secure and function properly.

Open **Fix Permissions**  page and set the path or leave empty (`/var/www/html/`) to go over all files.

## How It Works
Clicking the **Fix Permissions** button will:

- Recursively set the correct **ownership** for files and folders.
- Apply standard **permissions**:
  - Files: `644`
  - Folders: `755`
- Fix common permission problems for known CMS directories like `wp-content`, `storage`, `cache`, etc.

## Caution

- Custom permissions or advanced configurations may be overridden.
- If you're running custom scripts that require different permissions (e.g., executable `.sh` files), you'll need to reapply those settings manually after using this tool.

## Recommended Usage

You should use the **Fix Permissions** option only when:

- Your website is showing permission-related errors.
- You've uploaded or modified files manually (e.g., via FTP or File Manager).
- Your CMS (WordPress, Joomla, etc.) cannot write to certain folders.
- You suspect ownership or permission issues after a migration or manual edit.

Use this tool only when you’re experiencing issues. Frequent, unnecessary use is not required and may revert intentional permission changes.

---

// File: panel/files/backup-wizard

# Backup Wizard

Create a full account backup that can later be used to restore to restore on another server.

![screenshot](/img/panel/v2/backup_wizard.png)

---

// File: panel/files/trash

# Trash

When deleting files you can select to permanently delete them, or to place them in the Trash (default option).
The **Trash** page allows you to manage deleted.

In the table, you can see the following information:

* **Name**
* **Size** – Displays the size for files. For folders, click **Calculate** to fetch their size.
* **Deletion Date** – Shows the timestamp when the file was deleted.
* **Original Path** – Displays where the file was located before delete.
* **Permissions** – Displays symbolic file permissions (e.g., `drwxr-xr-x`). Hover over them to view the octal (numeric) equivalent (e.g., `0755`).

Clicking the **Toggle** icon reveals additional details:

* **Owner** – The UID of the file or folder owner.
* **Group** – The GID of the group that owns the file or folder.
* **Links** – The number of hard links to the file or directory.
* **Link Target** – If it’s a symlink, this shows the target it points to.
* **Type** – Indicates whether it's a directory, file, or symbolic link.

## Restore File

To restore a file, select the item and click on the **Restore** button, then confirm.

## Restore All Files

To restore all file, click on the **Restore All** button, then confirm.

## Delete a File

To permanently delete a file, select the item and click on the **Delete** button, then confirm.

Files will be permanently deleted.

## Delete All Files

To permanently delete all files, click on the **Delete All** button, then confirm.

---

// File: panel/mysql/databases

# Databases

![databases.png](/img/panel/v2/databases_main.png)

MySQL databases are used to store and manage your website's data, such as content, user information, and product details, making it accessible and organized for your web applications.

On the Databases page, you can view and manage your MySQL databases.

The page provides a table containing the users Databases, along with options related to them:

- **Databases:** Here, you can view database sizes and all users assigned to each database.

Available options on the Databases page are:

- **View Databases and assigned Users**
- **Create a new database**
- **Delete a MySQL Database**

## Create a MySQL Database

To create a new MySQL database, click on the "New Database" button and fill in the name of the new database:

![databases_new.png](/img/panel/v2/databases_new.png)

## Delete a MySQL Database

To delete an existing MySQL database, click on the "Delete" button next to the database name in the table.

Then click on the same 'Confirm' button.

![databases_delete_db.png](/img/panel/v2/databases_del.png)

:::danger
⚠️ Deleting a MySQL database will permanently delete all tables and data for that database.
:::

---

// File: panel/mysql/users

# MySQL Users

This section lists all your MySQL users and offers options to reset a user's password or delete a user.

Available options on the Users page are:

- **Create a new user**
- **Assign a user to a database**
- **Remove a user from a database**
- **Reset a user's password**
- **Delete a user**

## Create a New Database User

MySQL users are essential for controlling who can access and interact with your databases, ensuring data security and controlled access to your website's information. 

To create a new database user, click on the "New User" button and fill in the name and password for the new user.

![databases_new_user.png](/img/panel/v2/databases_new_user.png)

## Assign a User to a Database

For a MySQL user to be allowed to connect to a database, they need to be added (assigned) to that database. Assigning a user will grant them all privileges over the database. To assign a user to a specific database, click on the "Assign to Database" button and select a username and database.

![databases_assign.png](/img/panel/v2/databases_assign.png)

## Remove a User from a Database

To remove a user from a database, simply click on the "Remove User from Database" button, and in the new modal, select a username to be removed from a database.

![databases_remove_user.png](/img/panel/v2/databases_remove.png)

Removing a user will immediately remove all permissions for that user to the database and is useful when you want to temporarily disable a user's access to a database without actually deleting the user.

## Change User Password

If you need to change a user's password, simply click on the "Change Password" button next to that user. A modal will appear, and you can insert the new password in the field, then click on the "Change Password" button to save the new password.

![databases_reset_password.png](/img/panel/v2/databases_usrpw.png)

## Delete User

To delete a MySQL user, click on the delete button next to the user in the Users table and then click confirm on the same button:

![databases_delete_user.png](/img/panel/v2/databases_delusr.png)

:::danger
⚠️ Deleting a MySQL user will immediately remove that user and revoke all privileges to databases.
:::

---

// File: panel/mysql/wizard

# Database Wizard

![databases_wizard.png](/img/panel/v2/databases_wizard.png)

The Database Wizard can be accessed on the [MySQL](/docs/panel/mysql/) page by clicking the "Database Wizard" button. This tool is designed to streamline the creation of a new database, a new user, and their assignment to the database. When you initiate the database wizard, it will provide a secure, randomly generated password for the user, as well as random username and database name. You have the flexibility to modify these options, and there is also an option to generate random values for each field.

Upon creating the user and database, a new modal will appear, presenting you with the newly generated data.

Please ensure to save this data as the password will not be displayed again. However, you have the option to reset it at any time.

---

// File: panel/mysql/phpmyadmin

# phpMyAdmin

phpMyAdmin is an advanced MySQL database management tool and is recommended only for experienced users.

## Manage

To access phpMyAdmin, go to **Databases > phpMyAdmin** in the sidebar, or from **Databases** page click on the 'Open phpMyAdmin' icon next to the database name.


:::danger
Editing or manipulating tables directly in phpMyAdmin can break your site if done incorrectly. If you are unsure, consult a developer before making changes.
:::

Once logged in, you can:
- View database tables  
- Run SQL queries  
- Drop tables  
- Import data  
- Export databases (e.g., your WordPress database)  
- And more

For more information about using phpMyAdmin, refer to [the official phpMyAdmin documentation](https://www.phpmyadmin.net/docs/).

---

## Import SQL Files

phpMyAdmin allows you to import `.sql` files from your device:
1. Open phpMyAdmin and select the database you want to import into.  
2. Click **Import** in the top menu.  
3. Under **File to Import**, click **Choose File** and select the `.sql` file from your computer.  
4. Click **Import** at the bottom and wait for the process to complete.

---

// File: panel/mysql/new_db

# Create Database

Easily create a new MySQL database in just a few clicks. Databases are essential for storing, organizing, and retrieving data for your applications and websites.

Navigate to **OpenPanel > MySQL > Create Database**:

1. **Enter a Database Name**  
   Type your desired name into the input field. Make sure the name is unique and follows MySQL naming rules (e.g., avoid spaces or special characters).

2. **Generate a Random Name** *(Optional)*  
   If you're unsure about a name, click the button next to the input field to automatically generate a secure and unique database name.

3. **Click 'Create Database'**  
   Once the name is entered or generated, click the **Create Database** button to initialize your new MySQL database.

---

## Best Practices

- Use short and descriptive names (e.g., `app_data`, `wordpress_db`).
- Avoid using uppercase letters, spaces, or special characters.
- Make sure the database name is meaningful for easy identification later.

---

// File: panel/mysql/processlist

# Show Processes

This interface displays all currently active MySQL queries (connections). 

Checking the currently running queries is useful for identifying slow queries that slow down the website loading speed.

![databases_show_processes.png](/img/panel/v2/databases_processes.png)

You can also restart the MySQL service from this page and refresh the process list table.

---

// File: panel/mysql/import

# Import

Import tables into a MySQL database using a `.sql` export file. This feature is useful for restoring backups, migrating data, or setting up initial database structures.


To import tables into a database, navigate to **OpenPanel > MySQL > Import**:

1. **Select a Database**  
   Choose the target database into which you want to import the tables.

2. **Select a File**  
   Click the **Select** button to choose a `.sql` export file from your device.

3. **Upload**  
   Click the **Upload** button and wait for the import process to complete.

If your SQL file is larger than **1 GB**, we recommend using the **Docker > Terminal** interface instead for more reliable import handling.

---

// File: panel/mysql/new_user

# Create User

Easily create a new MySQL user in just a few clicks. Users are used for interacting with databases or the MySQL server.

Navigate to **OpenPanel > MySQL > Create User**:

1. **Enter a Username**  
   Type your desired username into the input field. Make sure the name is unique and follows MySQL naming rules (e.g., avoid spaces or special characters).

2. **Enter a Password**  
   Type your desired password in the second input field. To generate a strong random password, click the button next to the input field.

3. **Click 'Create User'**  
   Once you enter or generate username and password, click the **Create User** button to create your new MySQL user.

---

## Best Practices

- Use short and descriptive names (e.g., `app_data`, `wordpress_db`).
- Avoid using uppercase letters, spaces, or special characters.
- Make sure the username name is meaningful for easy identification later.

---

// File: panel/mysql/remote

# Remote MySQL

![databases_remote_mysql.png](/img/panel/v2/databases_remotedis.png)

Remote MySQL access gives you the ability to connect to a MySQL database on this server from an another (remote) device or location over the internet.

Allowing remote MySQL access opens your database to connections from the entire internet, which may pose a security risk. Please consider the following:

- Security Vulnerabilities: Allowing access from the web can expose your database to potential security vulnerabilities, increasing the risk of unauthorized access, data breaches, and data loss.
- Data Privacy: Your sensitive data may be at risk if not properly secured. Make sure to use strong passwords and encryption to protect your information.
- Regular Backups: Ensure that you have regular database backups in place to recover data in case of any security incidents.
- Before enabling remote MySQL access, please review your security settings, and consider the potential risks carefully.

If you're unsure about the security implications or need assistance, consult with your hosting administrator.

---

## Enable remote MySQL access

Remote MySQL access is disabled by default.

To enable remote access to your databases, click on the "Enable Remote MySQL Access" button in the "Databases > Remote MySQL" page.

Once enabled, you will be provided with an IP address and a port that you can utilize to establish a secure connection to the MySQL service from a remote server.

![databases_remote_mysql_enabled.png](/img/panel/v2/databases_remoten.png)

:::info
The displayed port is randomly generated and unique to your MySQL instance. Avoid using the standard port `3306` for remote access, as it will not function.
:::

---

## Test remote MySQL access

To test remote MySQL access from another server, you can use the `mysql` command-line client or a database management tool.

### mysql command-line client

Ensure that you have the MySQL client installed on the server from which you want to access the MySQL database.

Use the following command to connect to the MySQL server from the remote server:
```bash
mysql -h <IP_ADDRESS> -P <PORT> -u <USERNAME> -p <DATABASE_NAME>
```

### PHP

To establish a PHP-based connection from a remote server to a MySQL instance hosted on OpenPanel, here's an example code snippet:

```php
<?php
// MySQL server details
$hostname = 'IP_ADDRESS_HERE';
$port = 'CUSTOM_PORT'; // Custom port from the OpenPanel interface
$username = 'YOUR_MYSQL_USERNAME';
$password = 'YOUR_MYSQL_PASSWORD';
$database = 'YOUR_MYSQL_DATABASE';

// Create a connection
$conn = new mysqli($hostname, $username, $password, $database, $port);

// Check the connection
if ($conn->connect_error) {
   die("Connection failed: " . $conn->connect_error);
}

echo "Connected to the MySQL server on $hostname:$port successfully.";

// Close the connection
$conn->close();
?>
```

### WordPress

To connect to a MySQL instance on OpenPanel from a remote WordPress installation, you need to edit the wp-config.php file and change the database connection information.

```php
// ** MySQL settings - You can get this info from your web host **
/** The name of the database for WordPress */
define('DB_NAME', 'YOUR_MYSQL_DATABASE');

/** MySQL database username */
define('DB_USER', 'YOUR_MYSQL_USERNAME');

/** MySQL database password */
define('DB_PASSWORD', 'YOUR_MYSQL_PASSWORD');

/** MySQL hostname with custom port */
define('DB_HOST', 'IP_ADDRESS:PORT');
```

---

## Disable remote MySQL access

If you wish to disable access, simply click on the "Disable Remote MySQL Access" button, and it will immediately deactivate remote access in your MySQL configuration. Please be aware that this action will also necessitate a MySQL service restart to apply the new setting.

![databases_remote_mysql_disabled.png](/img/panel/v2/databases_remotedis.png)

---

// File: panel/mysql/assign

# Assign User to DB

Assign a MySQL user to an existing database to grant permissions for executing queries, modifying tables, and managing data.

This is a critical step after creating a database and user - without it, the user won't be able to interact with the database.

To assign an existing user to a database, navigate to **OpenPanel > MySQL > Assign User to DB**:

1. **Select a User**  
   Choose the MySQL user you want to grant access to.

2. **Select a Database**  
   Choose the existing database the user should be assigned to.

3. **Click 'Assign User to Database'**  
   After selecting both user and database, click the **Assign User to Database** button.  
   The user will be granted **all privileges** on the selected database.

---

// File: panel/mysql/remove

# Remove User from DB

Remove a MySQL user from an existing database to revoke their permissions and prevent access to execute queries, modify tables, or manage data.

This step is essential for managing access control and ensuring that only authorized users can interact with sensitive or production data.

To remove user access from a database, navigate to **OpenPanel > MySQL > Remove User from DB**:

1. **Select a User**  
   Choose the MySQL user whose access you want to revoke.

2. **Select a Database**  
   Choose the database from which the user should be removed.

3. **Click 'Remove User from Database'**  
   After selecting both the user and the database, click the **Remove User from Database** button.  
   The user will immediately lose **all privileges** on the selected database.

---

// File: panel/php/domains

# Select PHP Version  

Assign a PHP version to each domain. Changing the version updates the domain's configuration file and reloads the web server, which may temporarily interrupt website processes for that domain.  

For each version, the current development status is displayed, highlighting domains using outdated or unsupported PHP versions that may require an update.

Ensure you check your site's requirements before selecting the appropriate PHP version.

![change version for domains](/img/panel/v2/openpanel_change_default_php.gif)

---

// File: panel/php/default

# Set Default PHP Version  

Configure the default PHP version for new domains.


![change default](/img/panel/v2/openpanel_cahnge_default_php_version.gif)

NOTE: If you are using OpenLitespeed webserver, then you can not change PHP version.

---

// File: panel/php/options

# Options  

The PHP Options page allows you to modify PHP settings stored in the `php.ini` file.

![php options page](/img/panel/v2/php_options.png)

For more advanced users, the [**PHP.INI Editor**](/docs/panel/php/php_ini_editor/) can be used - if available.

---

## How to Change PHP Options

1. Open **OpenPanel** and navigate to **PHP > PHP Options**.
2. Select the desired **PHP version** from the dropdown.
3. Modify the options you want to change.
4. Click **Save** to apply changes.

Settings will be saved to the `php.ini` file for the selected PHP version, and the PHP container will restart to apply changes immediately. These settings apply to **all domains** using that PHP version.

---

## Available Options

The list of configurable PHP options is determined by the system administrator. By default, the following options are available:

- `allow_url_fopen`
- `date.timezone`
- `disable_functions`
- `display_errors`
- `error_reporting`
- `file_uploads`
- `log_errors`
- `max_execution_time`
- `max_input_time`
- `max_input_vars`
- `memory_limit`
- `open_basedir`
- `output_buffering`
- `post_max_size`
- `short_open_tag`
- `upload_max_filesize`
- `zlib.output_compression`

**Customizing Available Options**

Administrators can customize the available options:

- **For all new users**: Edit `/etc/openpanel/php/options.txt`
- **For a specific user**: Edit `/home/USERNAME/php.ini/options.txt`

---

## Important Notes

Some PHP options cannot be configured from this page. Instead, they must be set on the [**PHP Limits** page](/docs/panel/php/options):

- `max_execution_time`
- `max_input_time`
- `max_input_vars`
- `memory_limit`
- `post_max_size`
- `upload_max_filesize`

These limits are enforced at the container level and require a different configuration method.

---

// File: panel/php/php_ini_editor

# PHP.INI Editor  

The PHP.INI Editor allows you to view and modify the configuration file for each installed PHP version.  

> Note: PHP.INI Editor is [only available if `php_ini` feature is enabled by Administrator](/docs/admin/settings/modules#phpini-editor).

You can increase limits, enable new defaults, or adjust settings as needed. Changes will restart the corresponding PHP service.

![openpanel_php_ini_editor](/img/panel/v2/openpanel_php_ini_editor.gif)

---

To modify the total CPU or Memory resource limits for PHP service (container) use the [**Containers** page](/docs/panel/containers/).