OpenPanel Documentation

https://openpanel.com/docs
Admin
OpenPanel provides a robust interface for end-users to simplify web and server management, while...
Tokens:174,378
Snippets:390
Trust Score:8.9
Update:1 year ago
Show doc for...
Tokens:
Raw
### Install OpenPanel via Bash Script

Source: https://openpanel.com/docs/admin/intro

This snippet shows the command to download and execute the OpenPanel installation script directly from the terminal. It supports optional flags for customization, such as specifying a username or enabling debug mode. Ensure you have root or sudo privileges.

```bash
bash <(curl -sSL https://openpanel.org)
```

--------------------------------

### Install OpenPanel using Ansible

Source: https://openpanel.com/docs/admin/intro

This Ansible playbook automates the OpenPanel installation process on target machines. It includes variables for customizing installation flags, such as enabling debug mode or setting default administrative credentials. The playbook requires Ansible to be installed and configured on your control machine.

```ansible
---
- name: Install OpenPanel on target machine
  hosts: all
  become: true
  vars:
    openpanel_install_flags: "--debug --username=admin --password=super123"  # Customize your flags here, full list: https://openpanel.com/install

  tasks:
    - name: Download and run OpenPanel installer
      shell: |
        curl -sSL https://openpanel.org | bash -s -- {{ openpanel_install_flags }}
      args:
        executable: /bin/bash

```

--------------------------------

### Install OpenPanel Enterprise with License Key

Source: https://openpanel.com/docs/articles/license/upgrade_to_openpanel_enterprise_and-activate_license

Installs OpenPanel Enterprise on a new server by executing a provided installation command that includes the license key. This command is typically copied from the user's service page after purchasing a license.

```bash
curl -sSL https://install.openpanel.com | sudo bash -s -- --enterprise-key YOUR_ENTERPRISE_KEY
```

--------------------------------

### Install OpenPanel on New Server

Source: https://openpanel.com/docs/articles/transfers/migrate-openadmin-to-new-server

This command installs OpenPanel on a new server. It downloads and executes the official OpenPanel installation script from openpanel.org.

```bash
bash <(curl -sSL https://openpanel.org)
```

--------------------------------

### Example: Post-command Hook for Domain Addition

Source: https://openpanel.com/docs/articles/dev-experience/openpanel-pre-post-hooks

Shows an example of a bash script designed to run after the 'domains-add' OpenCLI command is executed, typically when a new domain is added via the UI.

```bash
/etc/openpanel/openpanel/hooks/post_domains-add.sh
```

--------------------------------

### Download OpenPanel Server Manager (Bash)

Source: https://openpanel.com/docs/articles/extensions/openpanel-and-fossbilling

Downloads the OpenPanel Server Manager PHP file from a GitHub repository to the FOSSBilling installation directory. This file enables FOSSBilling to communicate with OpenPanel. It requires `wget` to be installed and the correct path for FOSSBilling.

```bash
wget -O library/Server/Manager/OpenPanel.php https://raw.githubusercontent.com/stefanpejcic/FOSSBilling-OpenPanel/main/OpenPanel.php

```

--------------------------------

### Install Email Server using OpenCLI

Source: https://openpanel.com/docs/articles/user-experience/how-to-setup-email-in-openpanel

This command installs the `docker-mailserver` stack, which is the backend for the Email feature in OpenPanel. It is executed via the OpenCLI tool after the Email module has been activated. The process requires pasting the command into a terminal and waiting for completion.

```bash
opencli email-server install
```

--------------------------------

### Install Traceroute Plugin via Git

Source: https://openpanel.com/docs/articles/dev-experience/custom-plugins

Clones the traceroute plugin repository into the OpenPanel modules directory. This is the recommended method for installing plugins to facilitate easy updates.

```shell
cd /etc/openpanel/modules/ && git clone https://github.com/stefanpejcic/traceroute
```

--------------------------------

### Application Management

Source: https://openpanel.com/docs/panel/php/options

Install and manage various web applications, including WordPress, Node.js/Python applications via PM2, and website builders.

```APIDOC
Application Management:
  WordPress Manager:
    Description: Install, manage, and update WordPress instances.
    Parameters:
      - domain_name: The domain to install WordPress on.
      - installation_path: The directory for WordPress files.
      - database_name: The MySQL database to use.
      - database_user: The MySQL user for the database.
      - wp_config_settings (optional): Custom wp-config.php settings.
    Returns: Confirmation of WordPress installation or management action.

  NodeJS and Python (PM2):
    Description: Deploy and manage Node.js and Python applications using PM2.
    Parameters:
      - app_name: The name of the application.
      - script_path: The path to the application's entry script.
      - runtime: The runtime environment ('node' or 'python').
      - interpreter_path (optional): Path to the specific Node.js or Python interpreter.
      - pm2_options (optional): Additional PM2 configuration options.
    Returns: Confirmation of application deployment or management.

  Website Builder:
    Description: Use a built-in website builder to create and manage websites.
    Parameters:
      - domain_name: The domain to associate with the website.
      - template_name: The template to use for the website.
      - content_data (optional): Website content and structure.
    Returns: Confirmation of website creation or update.
```

--------------------------------

### Example: Pre-command Hook for User Addition

Source: https://openpanel.com/docs/articles/dev-experience/openpanel-pre-post-hooks

Illustrates the creation of a bash script to be executed before the 'user-add' OpenCLI command. This script would be placed in the designated hooks directory with the 'pre_' prefix.

```bash
/etc/openpanel/openpanel/hooks/pre_user-add.sh
```

--------------------------------

### OpenPanel Applications Management Navigation

Source: https://openpanel.com/docs/panel/account/active_sessions

Details the documentation for managing various applications supported by OpenPanel. This includes guides for WordPress, Node.js/Python applications, and website builders.

```APIDOC
OpenPanel Applications Management:
  - WordPress Manager: /docs/panel/applications/wordpress/
  - NodeJS and Python: /docs/panel/applications/pm2/
  - Website Builder: /docs/panel/applications/builder/
```

--------------------------------

### Add License Key via OpenCLI

Source: https://openpanel.com/docs/articles/license/upgrade_to_openpanel_enterprise_and-activate_license

Activates an OpenPanel Enterprise license on an existing installation using the `opencli` command. Replace `enterprise-XXX` with your actual license key.

```bash
opencli license enterprise-XXX
```

--------------------------------

### Application Management

Source: https://openpanel.com/docs/panel/mysql/assign

Guides on managing various web applications and runtimes supported by OpenPanel, such as WordPress, Node.js, Python, and website builders.

```APIDOC
Application Management:

Supported Applications:
  - WordPress Manager: Tools for installing, managing, and updating WordPress sites.
  - NodeJS and Python: Support for deploying and managing Node.js and Python applications (likely via PM2).
  - Website Builder: Integration with website building tools.
```

--------------------------------

### Fail2ban Configuration Example

Source: https://openpanel.com/docs/articles/email/how-to-setup-fail2ban-mailserver-openpanel

This snippet shows a sample configuration for a custom Fail2ban jail in OpenPanel, specifying enabled status, ban time, and ports to monitor. It demonstrates how to define specific rules for IP blocking.

```ini
[custom]
enabled = true
bantime = 180d
port = smtp,pop3,pop3s,imap,imaps,submission,submissions,sieve
```

--------------------------------

### Configure OpenPanel Dashboard How-to Articles

Source: https://openpanel.com/docs/admin/settings/custom_code

This JSON object defines the 'how_to_topics' displayed on the OpenPanel dashboard, linking to specific guides. It also includes a 'knowledge_base_link' for general documentation access.

```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"
}
```

--------------------------------

### Navigate and Edit docker-compose.yml (Shell)

Source: https://openpanel.com/docs/articles/dev-experience/add-custom-services-to-openadmin

This command navigates to the root directory and opens the `docker-compose.yml` file using the `nano` editor. It's the initial step to add new service definitions to your Docker Compose setup.

```shell
cd /root
nano docker-compose.yml
```

--------------------------------

### Create Hosting Plan with OpenCLI

Source: https://openpanel.com/docs/admin/plans/hosting_plans

Creates a new hosting package (plan) with specified limits and configurations. Requires detailed parameters for plan definition.

```bash
opencli plan-create 'name' 'description' email_limit ftp_limit domains_limit websites_limit disk_limit inodes_limit db_limit cpu ram bandwidth feature_set
```

--------------------------------

### Application Management

Source: https://openpanel.com/docs/panel/emails/filters

Guides for managing various applications installed or supported by OpenPanel, such as WordPress, NodeJS, and Python applications.

```APIDOC
Application Management:

  WordPress Manager:
    - Install, manage, and update WordPress sites.

  NodeJS and Python:
    - Deploy and manage applications built with NodeJS and Python using PM2.

  Website Builder:
    - Utilize the integrated website builder tool.
```

--------------------------------

### Get OpenPanel Server IP Address (Bash)

Source: https://openpanel.com/docs/articles/extensions/openpanel-and-fossbilling

Retrieves the public IP address of the OpenPanel server. This command is useful for obtaining the IP needed to whitelist the FOSSBilling server in OpenPanel's firewall settings. It requires `curl` to be installed on the server.

```bash
curl ip.openpanel.com

```

--------------------------------

### OpenCLI Plan Create Command Details

Source: https://openpanel.com/docs/admin/plans/hosting_plans

Details the 'opencli plan-create' command, outlining all required parameters for defining a new hosting plan, including limits and feature sets.

```APIDOC
opencli plan-create 'name' 'description' email_limit ftp_limit domains_limit websites_limit disk_limit inodes_limit db_limit cpu ram bandwidth feature_set
  Creates a new hosting plan.
  
  Parameters:
    name (string): Display name for the plan.
    description (string): Internal note for admins.
    email_limit (integer): Max number of email accounts (0 for unlimited).
    ftp_limit (integer): Max number of FTP accounts (0 for unlimited).
    domains_limit (integer): Max number of domain names (0 for unlimited).
    websites_limit (integer): Max number of websites (0 for unlimited).
    disk_limit (string): Storage in GB (e.g., '50GB', '0' for unlimited).
    inodes_limit (integer): Number of inodes (0 for unlimited).
    db_limit (integer): Max number of databases (0 for unlimited).
    cpu (integer): Number of CPU cores (0 for unlimited).
    ram (string): Physical memory in GB (e.g., '4g', '0' for unlimited).
    bandwidth (integer): Maximum bandwidth in Mbit/s.
    feature_set (string): Name of the feature set for UI access.
  
  Example Usage:
    opencli plan-create 'Amother Plan' 'this plan is used for X' 0 0 10 10 50 1000000 25 2 4 100 'default'
```

--------------------------------

### OpenCLI Install Flag Renaming

Source: https://openpanel.com/docs/changelog/1.0

The `--hostname` installation flag has been renamed to `--dpmain` for improved clarity and consistency in the installation process.

```APIDOC
opencli install --hostname <value>  // Old
opencli install --dpmain <value>    // New
```

--------------------------------

### List Hosting Plans with OpenCLI

Source: https://openpanel.com/docs/admin/plans/hosting_plans

Lists all current hosting packages (plans) configured in OpenPanel. The command can output data in a tabular format or as JSON.

```bash
opencli plan-list
```

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

--------------------------------

### Install Locales via OpenCLI

Source: https://openpanel.com/docs/admin/settings/locales

Installs specified language locales using the OpenCLI tool. Users can install single or multiple locales by providing their respective prefixes. The available locale prefixes can be found on the project's GitHub repository.

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

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

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

--------------------------------

### OpenCLI Plan List Command Details

Source: https://openpanel.com/docs/admin/plans/hosting_plans

Provides a detailed breakdown of the 'opencli plan-list' command, including its purpose, parameters, and expected output structure for hosting plan management.

```APIDOC
opencli plan-list
  Lists all current hosting packages (plans).
  
  Options:
    --json: Formats the output as JSON.
  
  Example Output Fields:
    id: Unique identifier for the plan.
    name: Display name of the hosting plan.
    description: Internal note for admins.
    domains_limit: Maximum number of domain names allowed.
    websites_limit: Maximum number of websites (WordPress, NodeJS, Python).
    email_limit: Maximum number of email accounts.
    ftp_limit: Maximum number of FTP accounts.
    disk_limit: Disk space in GB (0 for unlimited).
    inodes_limit: Total number of files allowed (0 for unlimited).
    db_limit: Maximum number of databases (MySQL, MariaDB, PostgreSQL) (0 for unlimited).
    cpu: Number of CPU cores allocated (0 for unlimited).
    ram: Physical Memory (RAM) in GB (e.g., '2g', '4g').
    bandwidth: Maximum bandwidth in Mbit/s.
    feature_set: Name of the feature set defining UI access.
```

--------------------------------

### Install OpenPanel WHMCS Module

Source: https://openpanel.com/docs/articles/extensions/openpanel-and-whmcs

Installs the OpenPanel WHMCS module by cloning the repository into the appropriate directory on the WHMCS server via SSH. This makes the module available for configuration within WHMCS.

```shell
git clone https://github.com/stefanpejcic/openpanel-whmcs-module.git openpanel
```

--------------------------------

### PHP Version and Configuration Management

Source: https://openpanel.com/docs/panel/mysql/processlist

Details on how to manage PHP versions and configurations for domains and the server.

```APIDOC
PHP Management:

Select PHP Version:
  - Set the PHP version for individual domains.
    Parameters:
      - domain_name: The domain to configure.
      - php_version: The desired PHP version (e.g., '8.1', '7.4').

Set Default PHP Version:
  - Set the global default PHP version for new domains.
    Parameters:
      - php_version: The default PHP version.

Options:
  - Configure common PHP settings (e.g., memory_limit, upload_max_filesize).

PHP.INI Editor:
  - Direct editing of the php.ini file for advanced customization.

Limits:
  - Manage PHP resource limits (e.g., max_execution_time, memory_limit).
```

--------------------------------

### Start Netdata Service with Docker Compose (Shell)

Source: https://openpanel.com/docs/articles/dev-experience/add-custom-services-to-openadmin

This command starts the Netdata service defined in the `docker-compose.yml` file in detached mode. It assumes Docker Compose is configured and the `netdata` service is correctly defined.

```shell
docker --context=default compose up -d netdata
```

--------------------------------

### Check OpenPanel Version using CLI

Source: https://openpanel.com/docs/articles/install-update/how-to-check-openpanel-version

This snippet shows how to check the installed OpenPanel version from your server's terminal using the `opencli` command. It's a straightforward way to confirm your current installation version.

```shell
opencli --version
```

--------------------------------

### DNS TXT Record Formatting Example

Source: https://openpanel.com/docs/articles/email/how-to-setup-dkim-for-mailserver

Illustrates the correct formatting for a DKIM TXT record, especially when the public key (p=...) exceeds 255 characters. It shows how the value is split into multiple quoted strings within parentheses.

```dns
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"
) ;
```

--------------------------------

### Docker Compose Example Services Removal

Source: https://openpanel.com/docs/changelog/1.4

Example services such as busybox, filebrowser, uptimekuma, mssql, and minecraft have been removed from the `docker-compose.yml` file. This streamlines the default configuration by removing pre-included but potentially unused services.

```yaml
services:
  busybox: # removed
  filebrowser: # removed
  uptimekuma: # removed
  mssql: # removed
  minecraft: # removed
```

--------------------------------

### List Users on Plan using OpenCLI

Source: https://openpanel.com/docs/admin/plans/hosting_plans

Lists all users currently assigned to a specific hosting plan. This command can display results in a tabular format or as JSON. It requires the plan name as an argument.

```bash
opencli plan-usage

```

```bash
opencli plan-usage 'Standard plan'

```

```bash
opencli plan-usage --json

```

--------------------------------

### Get OpenCLI Notification Settings

Source: https://openpanel.com/docs/admin/settings/notifications

Retrieves the current notification setting for a specified option using the OpenCLI. The option can be any configurable notification parameter, such as 'reboot' or 'load'.

```cli
opencli admin notifications get <OPTION>
```

```cli
# Example: Get reboot notification status
opencli admin notifications get reboot
yes
```

--------------------------------

### Application Management API

Source: https://openpanel.com/docs/panel/advanced

Endpoints for managing applications installed on OpenPanel, including specialized managers for WordPress, NodeJS/Python applications (via PM2), and a website builder.

```APIDOC
Application Management:
  - WordPress Manager: Tools for managing WordPress installations.
  - NodeJS and Python: Deploy and manage Node.js and Python applications using PM2.
  - Website Builder: Utilize a built-in website creation tool.
```

--------------------------------

### Migrate Server via OpenCLI

Source: https://openpanel.com/docs/articles/transfers/migrate-openadmin-to-new-server

Initiates a server migration using the OpenCLI tool from the terminal. This command requires the IP address and root credentials of the new server.

```bash
opencli server-migrate -h NEW_SERVER_IP --user root --password NEW_SERVER_ROOT_PASSWORD
```
Tokens:
Raw