Ergon CMS runs on shared hosting with cPanel or Plesk, on a VPS and in Docker. The installer needs no shell; with a terminal every step is also an artisan command.
What you need
- The release zip
ergon-cms-v<version>.zip(signed; plugins come as separate packages). - A licence key
ERGON-XXXX-XXXX-XXXX-XXXX. Keys are issued by Ergon Code for one domain and list the plugins they unlock — they cannot be bought in a shop. Ask for one. - The final domain with HTTPS. Activation binds the key to the domain, so set up the domain first.
Server requirements
- PHP 8.3 or newer (8.4 recommended), the same version for the command line and the web server
- Extensions: bcmath, ctype, curl, dom, fileinfo, gd or imagick, intl, mbstring, openssl, sodium, pdo with mysql, pgsql or sqlite, tokenizer, xml, zip
- MySQL / MariaDB, PostgreSQL or SQLite
memory_limit256M andmax_execution_time120 s or more- Outgoing HTTPS to
ergon-code.dev(licence checks, updates, plugin downloads) - One cron line (below)
The installer checks all of this first and says exactly what is missing.
Shared hosting (cPanel)
- PHP: Select PHP Version → 8.4; enable sodium, intl, zip, gd, bcmath, fileinfo; set
memory_limit256M,max_execution_time300, upload sizes 128M. - Database: MySQL Databases → create a database and a user with all privileges.
- Upload: unpack the zip into a folder outside
public_html(for example~/ergon) and point the domain's document root to~/ergon/public. Unpacking straight intopublic_htmlalso works — the installer writes a.htaccessthat sends every request topublic/. - Permissions:
storage/andbootstrap/cache/writable (0775, or 0755 when PHP runs as your account). - Installer: open
https://<domain>/install.php— requirements → database → site and admin account → licence key → install. The last page shows the cron line with the right PHP path. The installer deletes itself afterwards. - Cron: add the line from the last page (see Cron).
There is no queue:work daemon on shared hosting: the scheduler works the queue every minute, which is plenty for a normal website.
VPS
cd /var/www && unzip ergon-cms-v<version>.zip && mv ergon-cms-v<version> site
chown -R www-data:www-data site/storage site/bootstrap/cache
# web root: /var/www/site/public
cd site && php artisan ergon:install --site-name="Example Ltd" [email protected] --admin-password='…'
php artisan ergon:license:activate ERGON-XXXX-XXXX-XXXX-XXXX
With Supervisor you can run php artisan queue:work --sleep=3 --tries=3 as a service; then set ERGON_QUEUE_DRAIN=false so the service and the cron do not compete for jobs.
Docker
Any PHP 8.4 image with the extensions above works (for example serversideup/php). Run the scheduler as a second container with php artisan schedule:work instead of a cron line, keep storage/ on a volume owned by the container's user, and set TRUSTED_PROXIES when a reverse proxy sits in front.
Cron
One line, every minute, as the user PHP runs as:
* * * * * cd /path/to/site && /path/to/php artisan schedule:run >> /dev/null 2>&1
It drives the queue (mail, webhooks), scheduled publishing, reminder and cart emails, backups, and the daily update and licence check. Check it with php artisan schedule:list, or the next day under System → Update ("last checked").
Licence
- Activate in the installer, under Admin → Licence, or with
php artisan ergon:license:activate ERGON-…. php artisan ergon:license:showandergon:license:checkshow and re-check it.- The site re-checks every 7 days and keeps working up to 14 days without reaching the licence server.
- New domain: ask Ergon Code to move the key, then activate again on the site.
Plugins
Plugins are separate signed packages. Admin → Plugins → Upload → Activate. A plugin that needs a licence only starts when the site's key includes it; until then the Plugins screen says so. Installed plugins update from the Update screen.
Updates and going back
Admin → System → Update → Check for updates → Install. The updater downloads the release, verifies its signature, makes a backup of code and database, swaps the files in stages (and puts the old ones back if a step fails), migrates and clears the caches. The last three backups are kept.
Back to the previous version appears once a backup of an older version exists (php artisan ergon:update:rollback in a terminal). It undoes the newer version's database changes without touching content, orders or users.
When something is wrong
| Symptom | Cause |
|---|---|
| White page / 500 after upload | storage/ not writable — see storage/logs/laravel.log |
| Installer: "vendor/ present" red | Unpacked one level too deep — artisan and vendor/ belong side by side |
| Licence: domain does not match | The key is for another domain — ask for it to be moved |
| Mail never arrives | Cron missing or wrong PHP path |
| Update stops after 30/60 s | Raise max_execution_time; the old files were put back |
php artisan ergon:doctor checks everything at once.