Overview of Deploying OpenPanel on Server¶
Prerequisites and Basic Requirements¶
- A server running Ubuntu (any recent LTS release is supported).
- SSH access to the machine with a user that has sudo privileges.
- The following command line utilities must be available:
wgetorcurl(used implicitly by theget_urlmodule in the installation step).bash(to execute the installation script).- Sufficient disk space for the application and any dependencies that the installation script may download.
- A valid DNS record pointing the domain
{{ prefix }}{{ server_id }}.{{ zone }}to the server’s public IP address.
File and Directory Structure¶
After running the deployment process the following key locations will exist:
| Path | Description |
|---|---|
/root/installation_script.sh | The main installer script downloaded from https://openpanel.org. This script contains all commands necessary to set up the application. |
/root/installation_script.log (if generated) | Log file created by the installer to record progress and any errors. |
/etc/openpanel/ (if created by the installer) | Configuration directory for OpenPanel. |
/var/www/openpanel/ (if created by the installer) | Webroot or application files. |
/var/log/openpanel/ (if created by the installer) | Runtime logs for the application. |
Only the /root/installation_script.sh file is guaranteed to be present, as that is the file explicitly referenced in the deployment tasks.
Access Rights and Security¶
- The installation script is made executable (
mode: "o+x") and owned by root. - No additional users are created by the deployment tasks; the installer may create an
adminuser within the application context. - The script receives the application’s administrator password via the
--passwordargument. This value is derived from the SSH password (ansible_ssh_pass) with all non‑alphanumeric characters removed. - It is strongly recommended to review the content of
/root/installation_script.shbefore execution, as it contains the full installation logic.
Starting, Stopping, and Updating¶
The installer itself is responsible for setting up the application’s runtime environment. Typically this includes:
- Creating a system service or background process that keeps the application running.
- Configuring the service to start automatically on boot.
- Setting up any required scheduled tasks or cron jobs.
After installation:
- Start the application by running the service start command provided by the installer, for example:
- Stop the application:
- Restart the application:
- Check status:
To update the application, re‑run the installation_script.sh with the same parameters. The script is designed to detect existing installations and perform an upgrade when necessary.