Дмитрий Яковлев

PHP CLI GetSimple CMS Installation Tool

Описание

Утилита PHP CLI GetSimple CMS Installation Tool предназначена для выполнения автоматической установки системы управления контентом GetSimple CMS, используя CLI интерфейс PHP.

Возможности

  • удобство работы: утилита PHP CLI GetSimple CMS Installation Tool позволяет упростить и автоматизироать процесс установки чистой копии системы управления контентом GetSimple CMS на веб-сервере или в локальной среде разработки, в соответствие с требованиями пользователя;
  • защита от ошибок: утилита PHP CLI GetSimple CMS Installation Tool предотвращает случайную перезапись файлов и поддиректорий в целевой директории установки GetSimple CMS;
  • поддержка различных версий GetSimple CMS: утилита PHP CLI GetSimple CMS Installation Tool позволяет установить любую версию системы управления контентом GetSimple CMS, для которой существует ветка в официальном репозитории проекта на GitHub;
  • кроссплатформенность: утилита PHP CLI GetSimple CMS Installation Tool написана на языке программирования PHP и не зависит от платформы, на которой запускается. Корректная работа утилиты была проверена на рабочих станциях и серверах, работающих под управлением различных версий операционных систем Microsoft Windows, GNU/Linux и FreeBSD.

Использование

Утилита PHP CLI GetSimple CMS Installation Tool использует интерфейс командной строки, поэтому для её запуска у пользователя должен быть доступ к командной строке, а также права, позволяющие запускать интерпретатор PHP и вносить изменения в файловую систему. Кроме того, в настройках PHP должна быть включена опция allow_url_fopen.

Для задания и изменения параметров работы утилиты используются следующие ключи:

  • -b, --branch - имя используемой ветки из официального репозитория GetSimple CMS. По умолчанию используется ветка stable.
  • -d, --directory - относительное или полное имя директории, в которую будет выполнена установка GetSimple CMS. По умолчанию используется текущая директория в которой выполняется запуск утилиты;
  • -f, --force - разрешение установки GetSimple CMS в не пустую директорию. По умолчанию принимает значение false.

Для того, чтобы создать новый проект с использованием текущей стабильной версии GetSimple CMS, утилита PHP CLI GetSimple CMS Installation Tool может быть запущена со следующими параметрами:

php gs-install --branch=stable --directory=/var/www/site.local

В результате работы утилиты будет создана директория /var/www/site.local, в которую будет установлена стабильная версия GetSimple CMS. В случае, если у пользователя, от имени которого выполняется запуск утилиты, нет прав на создание поддиректорий в /var/www/, утилита завершит выполнение, при этом в командной строке будет выведено информационное сообщение об ошибке работы с целевой директорией.

Следующий пример показывает использование утилиты PHP CLI GetSimple CMS Installation Tool для установки GetSimple CMS 3.4 без задания параметра --directory, предварительное создание целевой директории и изменение её владельца, с целью предоставления полных прав доступа к ней для текущего пользователя.

sudo mkdir /var/www/site.local
sudo chown $USER:$USER /var/www/site.local
cd /var/www/site.local
php gs-install -b=master

Не смотря на то, что утилита позволяет производить установку GetSimple CMS из любой доступной ветки, я рекомендую использовать ветки:

  • stable - стабильная ветка, то есть последняя стабильная версия системы управления контентом. Используется по умолчанию;
  • hotfixes - исправления, предназначенные для включения в следующий релиз стабильной версии системы управления контентом;
  • master - ветка разработки следующей мажорной версии системы управления контентом. Следует использовать тем, кто хочет познакомиться с будущими возможностями GetSimple CMS.

Следует иметь в виду, что имена веток, задаваемые в параметре --branch, регистрозависимые. При задании несуществующей ветки, утилита завершит работу, будет выведено сообщение о невозможности получения архива с установочными файлами системы управления контентом GetSimple CMS.

При выполнении установки GetSimple CMS, все существующие в целевой директории файлы и поддиректории, совпадающие по именам с файлами и директориями системы управления контентом, будут перезаписаны, что может привести к порче и потере данных. Для предотвращения этого, утилита PHP CLI GetSimple CMS Installation Tool перед началом работы проверяет наличие любых файлов и поддиректорий в целевой директорий. В случае, если целевая директория не является пустой, утилита завершит работу, при этом в командной строке будет выведено соответствующее информационное сообщение.

Для отключения проверки целевой директории на наличие файлов и поддиректорий, утилита PHP CLI GetSimple CMS Installation Tool должна быть запущена с параметром -f=true или --force=true. Этот параметр должен использоваться с осторожностью, только в тех случаях, когда пользователь уверен в своих действиях и понимает их последствия.

php gs-install -d=/var/www/site.local -b=master -f=true

В результате запуска утилиты PHP CLI GetSimple CMS Installation Tool с параметром -f=true или --f=true, все файлы и поддиректории целевой директории, совпадающие по имени с файлами и директориями системы управления контентом, будут перезаписаны. Однако остальные файлы и директории останутся без изменений. Поэтому, если требуется выполнить чистую установку GetSimple CMS в целевую директорию, содержащую файлы и поддиректории, не относящиеся к системе управления контентом, её следует предварительно очистить.

rm -rf /var/www/site.local/*
php gs-install -d=/var/www/site.local --branch=master

После завершения установки GetSimple CMS с использованием утилиты PHP CLI GetSimple CMS Installation Tool, как и в случае выполнения установки вручную, перед началом использования необходимо произвести стандартную настройку системы управления контентом при помощи графического пользовательского веб-интерфейса панели управления.