One-time tasks

Requirements

• PHP
• Mysql client
• Git
• Composer
• Docker
• Platform CLI
• Drush
• Docker Compose

Note that after installing Docker you have to start the application to complete the command line install

Installation

You may download a ready-to-use version as a Phar:

$ curl -LSs https://github.com/tes/cms-builder/raw/master/cms-builder.phar -o cms-builder

The command will download it to the current directory. From there, you may place it anywhere that will make it easier for you to access (such as /usr/local/bin) and chmod it to 755.

Update

You can run the self-update command.

cms-builder self-update

Usage

Clone a project from github and run the cms-builder build command, for example:

git clone git@github.com:tes/cms-the-platform.git
cd cms-the-platform
cms-builder build

Once the build is complete you can open the site in a browser by doing:

cms-builder link

Setting up a new project

Add this to the project's .gitignore

# ignore cms-builder artifacts
.cms-builder/
docker/
.platform-project
docker-compose.yml

Create a .cms-builder.yml file in the project root. Example contents:

database: http://jenkins-native.tescloud.com/view/CMS/job/cms-backup-tes-live/ws/database.sql.gz
post_build:
  bash:
    # Bash commands in the post_build are run from the root directory of the project
    - 'cd _www/sites/all/modules/shared && rm -rf cms_modules && git clone git@github.com:tes/cms-modules.git cms_modules'
  docker:
    solr:
      - 'rm -rf /opt/solr/example/solr/tes_core'
      - 'mkdir /opt/solr/example/solr/tes_core'
      - 'echo name=tes_core > /opt/solr/example/solr/tes_core/core.properties'
      - 'cp -r /opt/solr/example/solr/collection1/conf /opt/solr/example/solr/tes_core'
  drush:
    - 'en stage_file_proxy devel -y'

Troubleshooting

Permission denied when connecting to socket?

sudo usermod -a -G docker $USER

Files keep reappearing even though you've deleted them?

The cms-builder uses unison to sync files to the container. This is a performance tweak for OSX. Sometimes the volume can get out-of-sync and contain files you don't want anymore. Running the following command with cause the volume to be rebuilt:

cms-builder build --rebuild-volumes

Don't run the command with sudo

Just don't.