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

11 октября 2015, 13:01

Вступление

Teleport является расширяемым скриптовым инструментом для работы с одной или несколькими локальными (не облачными) установками MODx Revolution.

Teleport в настоящее время функционирует приемущественно в качестве упаковочного инструмента который расширяет Транспортный API MODX'а и даёт команды для извлечения и инъекций кастомных Слепков сайтов на MODX. Но он может быть легко расширен для выполнения бесконечного множества действий, связанных с MODX.

Установка

Есть несколько способов установить Teleport для того, чтобы вы могли его использовать. Выбирайте один из:

  • Phar - Самый простой способ начать использовать Teleport это загрузить последнюю версию teleport.phar и положить её в папку где утилита сможет выполнять свою работу. В этом дистрибутиве, Teleport будет пытаться создать поддиректории profile/ и workspace/, где он будет хранить сгенерированные Профили сайтов и Извлечённые транспортные пакеты, соответственно. Дистрибутив phar включает все зависимости требуемые для использования Teleport'а. Примечание: однако, что вы не можете использовать Teleport HTTP Server из дистрибутива phar; он не включен в Phar.

  • Releases - Вы можете загрузить любой релиз Teleport в zip или tar.gz формате, распаковать его в подходящей директории (~/teleport/), и выполнить composer install в этой директории для того чтобы загрузить требуемые зависимости. GitHub релизы проекта доступны здесь.

  • Git Clone - Разработчики могут клонировать репозиторий teleport в свой собственный форк из GitHub, и выполнить composer install --dev в директории проекта для загрузки требуемых зависимостей, в том числе те, которые указаны в require-dev секции файла composer.json.

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

Команды

На самом базовом уровне, Вы взаимодействуете с приложением Teleport вызывая опредлённые Команды Teleport'а с каким-то количеством аргументов.

В настоящее время, Teleport предусматривает следующие Команды:

  • Profile - Сгенерировать JSON профиль сайта MODX который может быть использован другими Командами для работы.

  • Extract - Извлечь файлы, данные, и/или другие арефакты описанные в Шаблоне Извлечения (extract tpl), из сайта MODX описанного в особом формате, и упаковать его в транспортный пакет, который позже может быть впрыснут (Injected) в любой другой сайт на MODX.

  • Inject - Инъекция (вприскивание) указанного транспортного пакета, сгенерированного с помощью Teleport Extract, в сайт MODX, согласно описанию в заданном Профиле.

  • Push - Отправка указанного файла (источника) в указанное назначение.

  • UserCreate - Создать пользователя в сайте MODX согласно описанию в заданном Профиле.

  • Packages/GC - Удалить устаревшие версии пакетов из сайта MODX, согласно описанию в заданном Профиле.

  • Workspace/GC - Очистить содержимое директории workspace/ в рабочей папке Teleport.

CLI Запросы в командной строке

Самый простой способ использовать Teleport - вызывать Команды Teleport в командной строке Bash. Смотрите документацию по Командам, чтобы изучить обязательные и необязательные параметры для вызова Команд Teleport.

Teleport HTTP Server

Teleport (кроме Phar версии) идёт в комплекте с custom HTTP server, построенном на ReactPHP который может работать на любом серверном порту. Это позволяет выполнять Команды Teleport'а через HTTP, минуя тайм-ауты и другие проблемы, которые могут возникать при попытке выполнения длительных процессов с использованием конфигурации обычных веб-серверов.

Расширенние функционала

Teleport может быть расширен с помощью пары способов. Для лучших результатов, рекомендуется создавать Ваш собственный проект используя Teleport как библиотеку, где вы сможете вести ваши кастомные расширения функционала в системе контроля версий на Ваш выбор. Простейший способ начать кастомный Teleport проект - с помощью команды Composer'а create-project из пакета modxcms/teleport-project boilerplate.

php composer.phar create-project --prefer-source --stability=dev modxcms/teleport-project teleport-opengeek/

Вы можете найти больше информации о использовании пакета boilerplate в GitHub project.

Кастомные Извлечения

Teleport Команда Extract использует JSON Шаблоны Извлечения (extract tpl) чтобы описать как транспортный пакет создаётся из различных ресурсов/объектов сайта MODX. Вы можете легко создать Ваши собственные шаблоны чтобы быстро создавать кастомные пакеты для бесконечного количества целей от бекапирования сайтов до создания своих дополнений и создания вашего специфичного процесса разработки (workflow). Читайте Создание кастомных Шаблонов Извлечения (Extract Tpls) для большей информации.

Кастомные команды Teleport'а

[ В разработке ]

Contribute

We welcome all contributions to the Teleport application and library. Learn more about the variety of ways you can contribute and how.