Deployment Introduction
General Requirements
These are lists of general requirements to run our software to their fullest. You can use this knowledge to configure your server appropriately.
Deployment Requirements
Domain Names
- An active domain name or subdomain name
- An active email account with SMTP credentials available (or a subdomain to use for this purpose)
Server
- Apache server (Nginx is supported but not covered by this document)
- PHP (version must match that of the project)
- Composer CLI configured with access to our private repman packages.
- SupervisorD (required to run scheduled/async tasks such as emails).
- MariaDB or MySQL (PostgreSQL is supported but not covered by this document)
Automatic Deployment (Optional)
- Server To Github SSH Connection
- Github Workflow Configuration
Although many servers can meet these requirements, we will be focusing on the cPanel server environment for this document. This assumes you have cPanel Root WHM access. We will walk through three areas of deployment:
- Preparing The cPanel Server Environment
- Preparing The cPanel User Environment
- Setting Up Automatic Github Deployment in cPanel