Skip to Content search facebook instagram pinterest twitter youtube

Installation

The basics of installation are as follows:

  • For developing a site using SproutCMS, extract the tarball, and make the src directory web-accessible
    OR
    If you're planning on contributing to SproutCMS itself, clone the repository from GitHub, and make the src directory web-accessible
  • If you just cloned from the git repository, uncomment the three lines for the welcome module in src/config/config.php (lines 40-42 at last check - see code below)
  • Browse to /welcome/checklist
  • Follow the on-screen instructions

These instructions can be used both for local installation (e.g. using MAMP) or for a production install.

src/config/config.php

<?php
// ...
// The following code should be found at about lines 40-42;
// make sure these lines don't begin with //
 
/**
* Remove these three lines once SproutCMS has been set up
**/
Sprout\Helpers\Register::modules([
    'Welcome',
]);

Local web serving

Set your webserver to serve the src directory of the extracted tarball.

git-deploy

git-deploy utilises the Git SCM to determine which files need to be uploaded to the server and authentication is handled by SSH. We prefer this method as it's both the easiest and most secure of the two.

FTP

FTP is the old-school system of deploying changes, you either have to upload the entire code-base each time or manually upload each modified file. It's error prone and tedious.