Встановлення для версій 3.11 - 3.20
УВАГА: Ця інструкція актуальна для версій ERP "UserSide" 3.11-3.20. Для версії 3.21 і вище використовуйте інструкцію з установлення системи за допомогою інсталятора. Для версій 3.10 і раніше використовуйте інструкцію для раніших версій.
Інсталятор доступний в особистому кабінеті клієнта за адресою 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.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:
--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 - ви отримуватимете всі версії, зокрема ті, що перебувають в активній розробці