Deployment Overview of OpenPanel on Server¶

Prerequisites and Basic Requirements¶

To ensure a successful deployment of OpenPanel, the following requirements must be met:

• Operating System: Ubuntu

• Privileges: Root or sudo access is required for the installation process.

• Domain Configuration: A valid domain/subdomain pointing to the server's IP address is necessary for SSL and panel access.

• Network Ports:

• 2087: Default port for administrative access via HTTPS.

FQDN of the Final Panel¶

The management interface is accessible via a specific subdomain generated based on the server ID. The template for this domain is as follows:

Application Installation Process¶

The installation of OpenPanel is performed using a dedicated installation script. The process follows these steps:

1. Script Acquisition: The installer downloads the official installation script from the OpenPanel repository to /root/installation_script.sh.

2. Validation: The script's integrity is verified before execution.

3. Execution: The installation script is executed with the following parameters:

4. --domain: Sets the administrative URL using the template defined above.

5. --username: Configured as admin.

6. --password: A secure password generated during the deployment process.

7. Repair Mode: If a partial installation is detected on the system, the script is automatically executed with the --repair flag to restore service integrity.

Access Rights and Security¶

• Administrative Access: The panel is secured via HTTPS on port 2087.

• Webmail TLS: Webmail TLS can be disabled during the configuration phase if required by the environment settings.

• Firewall: Ensure that port 2087 (TCP) is open to allow access to the management interface.

Docker Containers and Their Deployment¶

OpenPanel utilizes Docker for its core services, specifically for managing the web server/proxy layer.

Custom Scripts and Additional Setup¶

The deployment includes several automated configuration steps performed after the main installation:

• Configuration Cleanup: The installer modifies the Caddyfile to remove deprecated interval settings for on-demand TLS.

• Webmail Configuration: If webmail TLS is disabled, the corresponding server block is removed from the Caddy configuration to prevent service conflicts.

• Diagnostics: In the event of an installation failure, diagnostic logs are collected from /root/openpanel_install.log, /tmp/clone_config.log, and system resource snapshots (free -m, df -h) to assist in troubleshooting.

Application Update Instructions¶

To update the OpenPanel application, the following procedure should be followed:

• Manual Re-run: The installation script can be re-executed to apply updates or repairs to the environment.

• Service Restart: If configuration changes are made manually to the Caddy service, the container must be restarted using:

  docker restart caddy
  

Location of Configuration Files and Data¶

The following paths contain critical application data and configurations:

• Caddy Configuration: /etc/openpanel/caddy/Caddyfile

• Installation Logs: /root/openpanel_install.log

• Backup Caddyfile: /etc/openpanel/caddy/Caddyfile.bak (created during the installation process).

Available Ports for Connection¶