Инсталлятор: различия между версиями

Материал из WiKi - UserSide
Нет описания правки
 
(не показано 10 промежуточных версий 4 участников)
Строка 1: Строка 1:
'''ВНИМАНИЕ: Инсталлятор используется для версий ERP "UserSide" 3.11 и выше. Для версии ниже 3.11 - используйте отдельную инструкцию по [[Установка системы|установке]].
[[Installer|en]] | [[Інсталятор|uk]] | '''ru'''


[[Файл:20170702_4.PNG|thumb|800px|center]]
'''ВНИМАНИЕ: Инсталлятор используется для версий ERP "UserSide" 3.21 и выше. Для версии 3.11-3.20 - используйте отдельную инструкцию по [[Установка для версий 3.11 - 3.20|установке]]. Для версии ниже 3.11 - используйте инструкцию по [[Установка для версии 3.10 и более ранних|установке более ранних версий]].'''


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


Он представляет собой консольную утилиту, которая '''запускается на сервере в каталоге, где установлена/будет установлена ERP "UserSide"''', и даёт возможность [[Установка (инсталлятор)|установить актуальную версию]] ERP "UserSide" или [[Обновление (инсталлятор)|обновить текущую версию]] до актуальной.
Создайте каталог, в котором планируете установить ERP USERSIDE, перейдите в него и загрузите инсталлятор:


В процессе работы инсталлятора потребуется ввести свой лицензионный ключ, который также виден в личном кабинете. Дополнительная авторизация осуществляется по IP-адресу сервера, где запускается инсталлятор.
<pre>
curl -fsSL https://my.userside.eu/install.sh | sudo -u www-data bash
</pre>


== Команды и опции ==
== Установка ERP USERSIDE ==


Инсталлятор поддерживает несколько команд, в каждой из которых могут быть использованы различные опции.
Всегда запускайте инсталлятор от имени web-пользователя (например, www-data) чтобы гаранировать доступ к файлам как инсталлятору так и nginx и php-fpm.


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


Команда указывается без начального - или -- и может быть только одна. Команда - это то, что должен выполнить инсталлятор.
<pre>
sudo -u www-data ./installer install
</pre>


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


Глобальные опции доступны во всех командах.
== Расширенное использование инсталлятора ==


Чтобы увидеть глобальные опции, можно воспользоваться командой help
<pre>
sudo -u www-data ./installer [global flags] <command> [command flags]
</pre>


php userside_install.phar help
=== Глобальные флаги ===


Перечень глобальных опций:
* <code>--quiet</code> <code>-q</code> — "тихий" режим: подавить все сообщения на стандартный вывод, кроме ошибок. В этом режиме не доступна интерактивность инсталлятора. При необходимости пользовательского ввода инсталлятор завершится с ошибкой.
* <code>--verbose</code> <code>-v</code> — "детальный" режим: инсталлятор выводит больше информации во время работы.
* <code>--level <stable|rc|beta|alpha></code> — уровень стабильности сборки ERP USERSIDE. Не сохраняется в конфигурации и требуется вседа указывать явно, еслис нужна отличная от "stable" стабильность сборки.


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


<code>-q, --quiet</code> - Тихий режим. Не выводить никаких сообщений
* <code>install</code> — режим установки или обновления ERP USERSIDE.
* <code>repair</code> — режим восстановления текущей версии или неудачно установленной версии ERP USERSIDE.
* <code>update-check</code> — проверка наличия обновлений ERP USERSIDE (используйте флаг <code>--level</code> для указания уровня стабильности сборки).
* <code>self-update</code> — самообновление инсталлятора. Также проверка новой версии и самообновление выполняется каждый раз при запуске команд "install" и "repair".
* <code>crc-check</code> — проверка контрольных сумм файлов ERP USERSIDE.
* <code>config</code> — изменение некоторой конфигурации системы. Конкретные изменяемые параметры задаются дополнительными флагами:


<code>-V, --version</code> - Вывод версии инсталлятора
==== Флаги для команды config ====
 
* <code>--url <URL></code> — изменить URL системы. Будет проверена настройка web-сервера на указанный URL и внесены все необходимые изменения в конфигурацию системы.
<code>    --ansi</code> - Принудительный вывод в режиме ANSI (с поддержкой цветной консоли и т.д.)
* <code>--maintenance-disable</code> — принудительное отключение режима обслуживания (использовать с осторожностью). Если после обновления система не вышла из режима обслуживания самостоятельно, лучше обратиться в техническую поддержку за помощью.
 
* <code>--flush-cache</code> — полный сброс кеша. Не выполняйте это без рекомендации службы поддержки. Разогрев кеша может занять много времени, что скажется на деградации производительности системы.
<code>    --no-ansi</code> - Отключить режим ANSI
* <code>--2fa <enable|disable></code> — включение и выключение режима двухфакторной аутентификации.
 
<code>-n, --no-interaction</code> - Не задавать никаких вопросов. Стоит отметить, что не всегда инсталлятор может выполнять действия в этом режиме. В тех случаях, когда в ходе работы необходим обязательный ввод, инсталлятор остановится с ошибкой.
 
<code>    --dir[=DIR]</code> - Целевой каталог. Мы рекомендуем запускать инсталлятор в том же каталоге, в котором находится и Userside (или планируется). Но если по какой-то причине это невозможно, вы можете указать целевой каталог в значении этой опции.
 
<code>-v|vv|vvv, --verbose</code> - Увеличить количество выводимой информации: 1 - нормальный вывод, 2 - более информативный вывод, 3 - выводить всё, включая отладочную информацию
 
Чтобы увидеть опции для какой-то конкретной команды, укажите ее после слова help
 
php userside_install.phar help install
 
Отобразит помощь по команде install.
 
=== Доступные команды ===
 
Чтобы увидеть список доступных команд, можно воспользоваться командой list
 
php userside_install.phar list
 
Текущая версия инсталлятора реализует следующие команды:
 
<code>config</code> - команда конфигурирования инсталлятора (настройки инсталлятора сохраняются в файле installer.json)
 
<code>install</code> - команда установки userside. Она же предназначена и для обновления, т.к. это одна и та же процедура.
 
<code>repair</code> - команда восстановления файлов userside для текущей версии (номер версии берется из БД). Команду необходимо выполнять после восстановления резервной копии БД для актуализации версии самой системы userside относительно версии данных.
 
<code>check:integrity</code> - команда проверки целостности файлов. Целостность файлов также проверяется в комнадах install и repair, так что специально запускать эту команду вам может никогда не понадобится. Но вы всегда можете ее использовать только для того, чтобы проверить целостность файлов.
 
<code>check:updates</code> - команда проверки наличия новой версии Userside. Может быть эту команду будет полезно выполнять только для того, чтобы узнать, есть ли новая версия. Если новых версий нет, то код завершения работы инсталлятора будет 1 (в отличие от нормального завершения с кодом 0), что позволит запускать команду в сценариях, основанных на проверке кода состояния.
 
<code>maintenance:disable</code> - принудительное отключение режима обслуживания. Выполняйте на свой страх и риск. Если система не было должным образом установлена или обновление прошло с ошибками, не позволяющими использовать систему (т.е. атомарная целостность системы нарушена, пример, была выполнена только часть миграций), то 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:
 
<code>--stability[=STABILITY]</code> - Минимальный уровень стабильности Userside, который может быть установлен (stable, rc, beta, alpha) по умолчанию stable.
 
<code>--key[=KEY]</code> - Смена лицензионного ключа. При вводе лицензионного ключа в ходе работы инсталлятора, он сохраняется в конфиге инсталлятора installer.json и в следующий раз больше не запрашивается. Если вам необходимо сменить лицензионный ключ, вы можете отредактировать файл installer.json или же запустить команду config с этой опцией, передав в качестве значения новый ключ.
 
==== Смена режима стабильности более подробно ====
 
При помощи режима конфигурирования можно настроить уровень стабильности получаемых обновлений. Для этого запустите инсталлятор с командой '''config''' и опцией --stability=''уровень'':
 
php userside_install.phar config --stability=stable
 
По умолчанию, если уровень стабильности не настроен, вы всегда будете получать только стабильные обновления.
 
Вы можете выбрать один из следующих уровней стабильности:
 
* '''stable''' - вы будете получать только стабильные версии
* '''rc''' -  вы будете получать стабильные версии и релиз-кандидаты
* '''beta''' - вы будете получать стабильные версии, релиз-кандидаты и бета-версии
* '''alpha''' - вы будете получать версии с любым уровнем стабильности

Текущая версия от 07:47, 19 мая 2026

en | uk | ru

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

Загрузка инсталлятора

Создайте каталог, в котором планируете установить ERP USERSIDE, перейдите в него и загрузите инсталлятор: 

curl -fsSL https://my.userside.eu/install.sh | sudo -u www-data bash

Установка ERP USERSIDE

Всегда запускайте инсталлятор от имени web-пользователя (например, www-data) чтобы гаранировать доступ к файлам как инсталлятору так и nginx и php-fpm.

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

sudo -u www-data ./installer install

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

Расширенное использование инсталлятора

sudo -u www-data ./installer [global flags] <command> [command flags]

Глобальные флаги

  • --quiet -q — "тихий" режим: подавить все сообщения на стандартный вывод, кроме ошибок. В этом режиме не доступна интерактивность инсталлятора. При необходимости пользовательского ввода инсталлятор завершится с ошибкой.
  • --verbose -v — "детальный" режим: инсталлятор выводит больше информации во время работы.
  • --level <stable|rc|beta|alpha> — уровень стабильности сборки ERP USERSIDE. Не сохраняется в конфигурации и требуется вседа указывать явно, еслис нужна отличная от "stable" стабильность сборки.

Команды

  • install — режим установки или обновления ERP USERSIDE.
  • repair — режим восстановления текущей версии или неудачно установленной версии ERP USERSIDE.
  • update-check — проверка наличия обновлений ERP USERSIDE (используйте флаг --level для указания уровня стабильности сборки).
  • self-update — самообновление инсталлятора. Также проверка новой версии и самообновление выполняется каждый раз при запуске команд "install" и "repair".
  • crc-check — проверка контрольных сумм файлов ERP USERSIDE.
  • config — изменение некоторой конфигурации системы. Конкретные изменяемые параметры задаются дополнительными флагами:

Флаги для команды config

  • --url <URL> — изменить URL системы. Будет проверена настройка web-сервера на указанный URL и внесены все необходимые изменения в конфигурацию системы.
  • --maintenance-disable — принудительное отключение режима обслуживания (использовать с осторожностью). Если после обновления система не вышла из режима обслуживания самостоятельно, лучше обратиться в техническую поддержку за помощью.
  • --flush-cache — полный сброс кеша. Не выполняйте это без рекомендации службы поддержки. Разогрев кеша может занять много времени, что скажется на деградации производительности системы.
  • --2fa <enable|disable> — включение и выключение режима двухфакторной аутентификации.
Источник — https://wiki.userside.eu/index.php?title=Инсталлятор&oldid=21725