Home

Welcome to the SynergyCP Package Development wiki!

Installation

First, you will need to install the developer version of SynergyCP:

1. Install the SynergyCP Docker swarm (you must run this as a user with sudo access). This must be done on an Ubuntu or Debian OS - we recommend doing this in a Virtual Machine as the server will boot when your OS boots and there's no easy way to uninstall it all later. Warning: this is a very large application and can end up taking 20+GB of space due to all of the operating system files. You may delete those OS files from the system after the installation if you do not plan on testing OS reloads from your development server. They are located in /scp/pxe/file/srv/.

   cd /tmp && wget https://install.synergycp.com/bm/app-dev.sh && bash app-dev.sh

2. For convenience, it is recommended that you setup non-root access to docker using the instructions here.

3. Add

   127.0.0.1 dev.synergycp.com admin.dev.synergycp.com api.dev.synergycp.com 
   

   to /etc/hosts. If you are running docker in a virtual machine or remote server, you should do this on your development machine and replace 127.0.0.1 with the IP of your VM/server.

4. If you're going to be working on the backend of Synergy please follow the Editing Guidelines to get your app ready to develop with.

If any issues appear during the installation, refer to the troubleshooting guide for solutions.

Package Architecture

SynergyCP Packages are like small Laravel applications. The default folder structure will be very familiar for anyone who has used Laravel, but you are free to modify it. Packages can register their own Routes, Service Providers, and can use Database Migrations.

Please read through the links on the sidebar (to the right) for further information.