Инсталлятор

    From WiKi - UserSide

    ВНИМАНИЕ: Инсталлятор используется для версий ERP "UserSide" 3.11 и выше. Для версии ниже 3.11 - используйте отдельную инструкцию по установке.

    Инсталлятор доступен в личном кабинете клиента по адресу https://my.userside.eu/soft/installer

    Он представляет собой консольную утилиту, которая запускается на сервере в каталоге, где установлена/будет установлена ERP "UserSide", и даёт возможность установить актуальную версию ERP "UserSide" или обновить текущую версию до актуальной.

    В процессе работы инсталлятора потребуется ввести свой лицензионный ключ, который также виден в личном кабинете в основном разделе информации о клиенте в подразделе Информации о лицензии. Дополнительная авторизация осуществляется по IP-адресу сервера, где запускается инсталлятор.

    Команды и опции

    Инсталлятор поддерживает несколько команд, в каждой из которых могут быть использованы различные опции.

    Опции начинаются с символа - (короткое именование) или -- (полное именование). Одновременно могут быть указаны несколько опций.

    Команда указывается без начального - или -- и может быть только одна. Команда - это то, что должен выполнить инсталлятор.

    Глобальные опции

    Глобальные опции доступны во всех командах.

    Чтобы увидеть глобальные опции, можно воспользоваться командой help

    php userside_install.phar help
    

    Перечень глобальных опций:

    --format=FORMAT - Формат вывода (txt, xml, json, md) по умолчанию txt

    -q, --quiet - Тихий режим. Не выводить никаких сообщений

    -V, --version - Вывод версии инсталлятора

    --ansi - Принудительный вывод в режиме ANSI (с поддержкой цветной консоли и т.д.)

    --no-ansi - Отключить режим ANSI

    -n, --no-interaction - Не задавать никаких вопросов. Стоит отметить, что не всегда инсталлятор может выполнять действия в этом режиме. В тех случаях, когда в ходе работы необходим обязательный ввод, инсталлятор остановится с ошибкой.

    --dir[=DIR] - Целевой каталог. Мы рекомендуем запускать инсталлятор в том же каталоге, в котором находится и Userside (или планируется). Но если по какой-то причине это невозможно, вы можете указать целевой каталог в значении этой опции.

    -v|vv|vvv, --verbose - Увеличить количество выводимой информации: 1 - нормальный вывод, 2 - более информативный вывод, 3 - выводить всё, включая отладочную информацию

    Чтобы увидеть опции для какой-то конкретной команды, укажите ее после слова help

    php userside_install.phar help install
    

    Отобразит помощь по команде install.

    Доступные команды

    Чтобы увидеть список доступных команд, можно воспользоваться командой list

    php userside_install.phar list
    

    Текущая версия инсталлятора реализует следующие команды:

    config - команда конфигурирования инсталлятора (настройки инсталлятора сохраняются в файле installer.json)

    install - команда установки userside. Она же предназначена и для обновления, т.к. это одна и та же процедура.

    repair - команда восстановления файлов userside для текущей версии (номер версии берется из БД). Команду необходимо выполнять после восстановления резервной копии БД для актуализации версии самой системы userside относительно версии данных.

    check:integrity - команда проверки целостности файлов. Целостность файлов также проверяется в комнадах install и repair, так что специально запускать эту команду вам может никогда не понадобится. Но вы всегда можете ее использовать только для того, чтобы проверить целостность файлов.

    check:updates - команда проверки наличия новой версии Userside. Может быть эту команду будет полезно выполнять только для того, чтобы узнать, есть ли новая версия. Если новых версий нет, то код завершения работы инсталлятора будет 1 (в отличие от нормального завершения с кодом 0), что позволит запускать команду в сценариях, основанных на проверке кода состояния.

    maintenance:disable - принудительное отключение режима обслуживания. Выполняйте на свой страх и риск. Если система не было должным образом установлена или обновление прошло с ошибками, не позволяющими использовать систему (т.е. атомарная целостность системы нарушена, пример, была выполнена только часть миграций), то userside остается заблокированным до тех пор, пока инсталлятор не будет завершен корректно. Если такое произошло, следует либо самостоятельно исправить ошибку либо обратиться в техподдержку за помощью и затем снова запустить инсталлятор. После устранения ошибки и удачного завершения обновления флаг блокировки снимается автоматически. Но если у вас вдруг появилась острая необходимость воспользоваться userside с нарушенной целостностью, вы можете запустить эту команду и флаг будет снят.

    Команда по умолчанию

    В ветке инсталлятора 2.0.х командой по умолчанию является команда install. Это означает то, что если вы запустите инсталлятор без указания какой либо команды, то инсталлятор запустится в режиме install. Однако такое поведение будет исключено в следующих минорных версиях (начиная с 2.1), поэтому рекомендуется явно указывать команду install всякий раз, особенно если инсталлятор запускается у вас автоматически из cron.

    Пример запуска команды с опциями

    Команда:

    php userside_install.phar install -q -n
    

    В данном примере будет запущена команда install в тихом режиме (-q) без вывода каких либо запросов (-n) принимая автоматически значения по умолчанию в качестве ответов на них. Здесь следует еще раз подчеркнуть то, что бывают ситуации, когда от пользователя требуется ввод (например, обновиться можно только на новую минорную версию, а для этого необходимо подтверждение, так как этот процесс может внести довольно серьезные изменения в системе).

    Команды

    Конфигурирование

    Чтобы увидеть доступные для конфигурирования опции, можно выполнить одну из следующих команды (они равнозначны):

    php userside_install.phar help config
    

    или

    php userside_install.phar config --help
    

    Помимо стандартных опций вы увидите две опции команды config:

    --stability[=STABILITY] - Минимальный уровень стабильности Userside, который может быть установлен (stable, rc, beta, alpha) по умолчанию stable.

    --key[=KEY] - Смена лицензионного ключа. При вводе лицензионного ключа в ходе работы инсталлятора, он сохраняется в конфиге инсталлятора installer.json и в следующий раз больше не запрашивается. Если вам необходимо сменить лицензионный ключ, вы можете отредактировать файл installer.json или же запустить команду config с этой опцией, передав в качестве значения новый ключ.

    Смена режима стабильности более подробно

    При помощи режима конфигурирования можно настроить уровень стабильности получаемых обновлений. Для этого запустите инсталлятор с командой config и опцией --stability=уровень:

    php userside_install.phar config --stability=stable
    

    По умолчанию, если уровень стабильности не настроен, вы всегда будете получать только стабильные обновления.

    Вы можете выбрать один из следующих уровней стабильности:

    • stable - вы будете получать только стабильные версии
    • rc - вы будете получать стабильные версии и релиз-кандидаты
    • beta - вы будете получать стабильные версии, релиз-кандидаты и бета-версии
    • alpha - вы будете получать стабильные версии, релиз-кандидаты, бета и альфа-версии
    • dev - вы будете получать все версии, в том числе находящиеся в активной разработке