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

Материал из WiKi - UserSide
([IronBot] Rename UK page title to Ukrainian)
 
([IronBot] Sync installer localization from RU)
 
Строка 1: Строка 1:
[[Installer|en]] | '''uk''' | [[Инсталлятор|ru]]
[[Installer|en]] | '''uk''' | [[Инсталлятор|ru]]


'''УВАГА: Інсталятор використовується для версій ERP "UserSide" 3.21 і вище. Для версії 3.11-3.20 використовуйте окрему [[Встановлення_для_версій_3.11_-_3.20|інструкцію з установлення]]. Для версій нижче 3.11 використовуйте [[Встановлення_для_версії_3.10_і_раніших|інструкцію для ранніх версій]].'''
'''УВАГА: Інсталятор використовується для версій ERP "UserSide" 3.19 і вище. Для версії 3.11-3.18 використовуйте окрему [[Встановлення_для_версій_3.11_-_3.18|інструкцію з установлення]]. Для версій нижче 3.11 використовуйте [[Встановлення_для_версії_3.10_і_раніших|інструкцію для ранніх версій]].'''


Інсталятор доступний в особистому кабінеті клієнта за адресою https://my.userside.eu/soft/installer
== Завантаження інсталятора ==


Це консольна утиліта, яка '''запускається на сервері в каталозі, де встановлено або буде встановлено 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.


Опції починаються із символу <code>-</code> (коротка назва) або <code>--</code> (повна назва). Одночасно можна вказати кілька опцій.
Для встановлення достатньо запустити інсталятор з параметром '''install''':


Команда вказується без початкового <code>-</code> або <code>--</code> і може бути лише одна. Команда визначає, що має виконати інсталятор.
<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.x командою за замовчуванням є 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''' - ви отримуватимете стабільні версії, реліз-кандидати, бета- та альфа-версії
* '''dev''' - ви отримуватимете всі версії, зокрема ті, що перебувають в активній розробці

Текущая версия от 16:53, 23 мая 2026

en | uk | ru

УВАГА: Інсталятор використовується для версій ERP "UserSide" 3.19 і вище. Для версії 3.11-3.18 використовуйте окрему інструкцію з установлення. Для версій нижче 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> — увімкнення або вимкнення режиму двофакторної автентифікації.