December 14th, 2021

WHM / CPanel now has an automated Pimcore deployment utility provided by Softaculous. There is some basic prep-work to complete before beginning an installation, namely creating a subdomain and applying SSL to the subdomain.

Subdomain

The grafikdev.io remote host can rapidly deploy changes to its own DNS and auto-provision SSL certs. To create a subdomain, log into CPanel and search for “sub” and you should be able to quickly locate the “Subdomains” control panel.

Creating the Zone

Choose a meaningful subdomain (clients are often provided these URLs), and allow CPanel to choose the Document Root for you (unless you have good reason otherwise).

Activating TLS

Once the subdomain / zone is created, you’ll want to head back over to WHM to provision the SSL Certificate. Once logged in, search for “tls” and select “Manage Auto SSL” from the navigation menu. The following screen will have several tabs; click “Manage Users”. Click on the button in the right-hand column that reads “Check grafikdevio”. You should have a working certificate in a few moments.


Softaculous

When logged into the CPanel interface, search for “apps” and you should be able to quickly locate the “Softaculous Apps Installer”. In the Softaculous control panel, search for “pim” and you should be able to quickly locate “Pimcore” in the left-hand navigation menu. Click the big blue “Install Now” button to continue with the installation process.

  • Software Setup
    • Choose Installation URL
      Select “https://” and the desired subdomain from the dropdown. Leave the In Directory field blank.
    • CRON Job
      The default settings are adequate for most installations.
  • Admin Account
    • Admin Username & Password
      Select a meaningful Admin Username and Admin Password.
  • Advanced Options (Don’t Skip)
    • Database Name
      The database name should closely resemble the subdomain for organizational purposes (there is a pretty restrictive character limit, do your best).
    • Backup Location
      Select the “Default” location.
    • Automated Backups
      Select the “Once a day” option.
    • Backup Rotation
      Select the “4” option.

Note: Currently, Softaculous gets two major things wrong with the automated install. The first is correctly setting the webroot for the project. Currently, the automation script does not change the webroot correctly per Pimcore’s requirements, instead, it attempts to reroute traffic from the project root to the webroot via .htaccess rules. It also does not configure the binary mappings correctly (at all). See steps below for remedies.

Fixing the Webroot Problem

  1. Install Pimcore through Softaculous (should be completed).
  2. In CPanel, change the domain’s webroot path to include the /web directory.
  3. Navigate to the project root directory (not /web).
  4. Delete the .htaccess file here.

Without completing this step, the install will appear to work correctly… until you attempt to view an image stored in the Asset manager or attempt to access a physical file in the /web directory. No logical file will be able to be accessed using the Softaculous setup, only virtual paths will work (anything Pimcore manages).

Fixing the Parameters Problem

  1. Install Pimcore through Softaculous (should be completed).
  2. Navigate to /app/config/parameters.yml and begin editing the file.
  3. Go line-for-line and use the which command to determine the path of each binary.
  4. Uncomment anything that is found using which some will not be found, and that’s okay.
  5. Save your changes (this file should be .gitignored).

Without completing this step, Pimcore will work just fine but it will be operating purely on default values and you will not be able to make changes to the Website Settings admin panel in Pimcore.

Sidebar
Loading…
Loading the web debug toolbar…
Attempt #