Встановлення

Ці кроки встановлюють Energine 2.13: порожній сайт або сайт із демо-вмістом, що демонструє роботу кожного модуля (крок 4 має свій список SQL-файлів, а крок 9 додає демо-зображення). Це кроки з INSTALL.md у релізі: tools/install-check.sh запускає їх на тимчасовому сервері перед кожним випуском, використовуючи вбудований вебсервер PHP замість кроку 10.

Панель адміністрування доступна російською та українською мовами. Прочитайте Відомі ризики перед запуском сайту в публічний доступ.

Вимоги

  • PHP 8.4 або новіший (протестовано на 8.5) із розширеннями ctype, dom, fileinfo, gd, json, libxml, mbstring, PDO, pdo_mysql, SimpleXML, session та xsl. Необов'язково: tidy (очищує HTML текстових блоків), zip (архіви у файловому сховищі), curl (віддалені зображення в ресайзері), ftp (файлові сховища FTP), iconv (експорт CSV у кодуваннях, відмінних від UTF-8).
  • MariaDB 10.11 або новіша. MySQL не підтримується: файли SQL використовують синтаксис MariaDB.
  • nginx із PHP-FPM (starter/jambalaya/.nginx.conf.example) або Apache 2.4 із mod_rewrite (starter/jambalaya/.htaccess, не тестувався).
  • composer, git, bash і клієнт командного рядка mariadb.

Виконуйте кожну команду від імені користувача, якому належить сайт, а не від імені root: встановлення створює посилання, каталоги та файли, які PHP згодом має читати та змінювати.

1. Отримайте код

git clone https://github.com/kwebmn/energine-cmf-latest.git /var/www/energine
cp -a /var/www/energine/starter /var/www/my-site

/var/www/energine — це ядро, /var/www/my-site — ваш проєкт. Кореневою директорією вебсервера є /var/www/my-site/htdocs; SQL, скрипти налаштування, vendor та шаблон конфігурації залишаються поза її межами.

2. Встановіть залежності PHP

cd /var/www/my-site
composer install --no-dev

3. Створіть базу даних та її користувача

У mariadb від імені адміністратора бази даних:

CREATE DATABASE energine CHARACTER SET utf8 COLLATE utf8_general_ci;
CREATE USER 'energine'@'localhost' IDENTIFIED BY 'choose-a-password';
GRANT ALL PRIVILEGES ON energine.* TO 'energine'@'localhost';

Користувачеві потрібні всі привілеї на його базу даних: SQL створює збережені функції та процедури, представлення й тимчасові таблиці, а конструктор форм створює та змінює таблиці під час виконання. Якщо увімкнено бінарне логування, встановіть log_bin_trust_function_creators = 1, інакше збережені функції не вдасться імпортувати.

4. Імпортуйте SQL-файли

Імпортуйте файли з /var/www/my-site/sql по черзі й у такому порядку:

mariadb --default-character-set=utf8 -u energine -p energine < FILE

Порожній сайт:

  1. starter.structure.sql
  2. starter.routines.sql
  3. starter.data.empty.sql
  4. starter.structure.fixes.sql
  5. modules.structure.sql
  6. starter.data.admin.sql
  7. starter.data.sitemap.sql
  8. modules.data.sql

Сайт із демо-вмістом (замість наведеного вище списку):

  1. starter.structure.sql
  2. starter.routines.sql
  3. starter.data.demo.sql
  4. starter.structure.fixes.sql
  5. starter.data.demo.fixes.sql
  6. modules.structure.sql
  7. modules.data.sql
  8. demo/demo.content.sql

5. Створіть конфігураційний файл

cd /var/www/my-site
cp configs/system.config.default.php htdocs/system.config.php
chmod 640 htdocs/system.config.php

У файлі htdocs/system.config.php замініть:

  • 'PATH TO CORE' на каталог, клонований на кроці 1: '/var/www/energine';
  • 'DB HOST NAME', 'DB NAME', 'DB LOGIN' та 'DB PASSWORD' на параметри вашої бази даних: 'localhost', 'energine', 'energine' та пароль (і 'port' => '3306', якщо сервер слухає інший порт);
  • 'PROJECT DOMAIN NAME' на ваш домен, наприклад 'example.com';
  • 'debug' => 1 на 'debug' => 0 на робочому сайті (див. Відомі ризики);
  • адреси в секції mail на власні.

6. Запустіть налаштування (setup)

cd /var/www/my-site/htdocs
php index.php setup install

setup install перевіряє з'єднання з базою даних, записує ваш домен в адресу сайту, створює посилання на модулі ядра в проєктному core/modules/, заповнює каталоги htdocs/images/, scripts/, stylesheets/ і templates/ з модулів, а також формує карту скриптів htdocs/system.jsmap.php. Якщо режим debug вимкнено, розміщений там JavaScript мініфікується; решта файлів лінкується. Налаштування запускається лише з консолі й у разі помилки завершує роботу з ненульовим кодом повернення.

Кожен запуск setup очищує та перезбирає ці чотири каталоги в htdocs/. Розміщуйте власні зображення, скрипти та стилі в site/modules/main/images/, site/modules/main/scripts/ і site/modules/main/stylesheets/ (setup створить для них посилання в htdocs/images/main/ тощо) або в htdocs/uploads/, ніколи не записуючи їх напряму у відтворювані каталоги. Запускайте команду php index.php setup linker повторно після оновлення ядра, після переміщення ядра чи проєкту, після зміни debug та після додавання файлів до site/modules/main/.

7. Створіть обліковий запис адміністратора

Стартовий проєкт містить один обліковий запис адміністратора, [email protected], але він не має дійсного пароля: ніхто не зможе увійти, доки ви не виконаєте цей крок. Задайте для цього облікового запису вашу електронну адресу та пароль (у bash):

read -rs -p 'Administrator password: ' PW; echo
HASH=$(printf '%s' "$PW" | php -r 'echo password_hash(stream_get_contents(STDIN), PASSWORD_DEFAULT);'); unset PW
mariadb --default-character-set=utf8 -u energine -p energine \
  -e "UPDATE user_users SET u_name = '[email protected]', u_fullname = 'Administrator', u_password = '$HASH' WHERE u_name = '[email protected]'"

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

8. Адреса, за якою відповідає сайт

setup install зберігає ваш домен як адресу сайту http://YOUR-DOMAIN/ (порт 80), і сайт формує посилання на її основі. Якщо сайт працює за протоколом HTTPS або на іншому порту, додайте цю адресу до таблиці share_domains і зв'яжіть її із сайтом:

INSERT INTO share_domains (domain_protocol, domain_port, domain_host, domain_root) VALUES ('https', 443, 'example.com', '/');
INSERT INTO share_domain2site (domain_id, site_id) VALUES (LAST_INSERT_ID(), 1);

Адреса без окремого запису все одно відкриватиме сайт, проте посилання на сторінках вестимуть на першу адресу — http://YOUR-DOMAIN/.

9. Демо-зображення (тільки для демо-вмісту)

cd /var/www/my-site
mkdir -p htdocs/uploads/public/demo
cp -a sql/demo/uploads/. htdocs/uploads/public/demo/

Демо-користувачі (@example.com) також не мають робочих паролів; щоб увійти під одним із них, установіть пароль у панелі адміністрування («Пользователи» / «Користувачі»).

10. Вебсервер

PHP має виконуватися від імені користувача, якому належить сайт: setup і сайт пишуть в одні й ті самі каталоги, а інші користувачі не мають доступу на читання до htdocs/system.config.php (крок 5). Створіть для сайту окремий пул PHP-FPM, наприклад /etc/php/8.5/fpm/pool.d/my-site.conf:

[my-site]
user = mysite
group = mysite
listen = /run/php/my-site.sock
listen.owner = www-data
listen.group = www-data
pm = ondemand
pm.max_children = 10
php_admin_flag[display_errors] = off
php_admin_flag[log_errors] = on

Ядро вмикає display_errors під час виконання; лише директива php_admin_flag[display_errors] = off у пулі гарантує, що деталі помилок не відображатимуться на сторінках робочого сайту. Перезапустіть PHP-FPM після додавання пулу.

  • nginx: скопіюйте блок server із starter/jambalaya/.nginx.conf.example до конфігурації сервера, вкажіть server_name, root (/var/www/my-site/htdocs) та сокет пулу в директиві fastcgi_pass, після чого перезавантажте nginx.
  • Apache 2.4 (не тестувався): скопіюйте starter/jambalaya/.htaccess у htdocs/, увімкніть mod_rewrite і дозвольте використання файлу директивою AllowOverride All у блоці <Directory> сайту.

Відкрийте сайт і увійдіть на сторінці /login/ як адміністратор із кроку 7; панель адміністрування знаходиться за адресою /admin/.

Каталоги з правами на запис

Setup та PHP виконуються від імені користувача сайту (крок 10) і здійснюють запис до:

  • htdocs/ — setup перезбирає images/, scripts/, stylesheets/, templates/ та system.jsmap.php;
  • проєктного core/modules/ — setup створює там посилання на модулі ядра;
  • htdocs/uploads/ та всіх його підкаталогів — завантажені файли;
  • site/modules/*/templates/content/ — редактор віджетів зберігає тут макети сторінок.

Оновлення

git -C /var/www/energine pull
cd /var/www/my-site/htdocs
php index.php setup linker
php index.php setup scriptMap

Setup перезбирає чотири каталоги в htdocs/, тому файли, додані безпосередньо туди, зникнуть після оновлення: зберігайте їх у site/modules/main/ (крок 6). Каталог проєкту належить вам: оновлення ядра його не змінює. Порівнюйте starter/ нового релізу зі своїм проєктом, щоб перенести зміни.

Відомі ризики

Прочитайте Відомі ризики перед запуском сайту в публічний доступ.