Установка

Эти шаги устанавливают 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. Запуск установки

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, помещаемый туда; всё остальное компонуется ссылками. Установка запускается только из консоли и завершается с ненулевым статусом при возникновении ошибок.

Каждый запуск установки очищает и пересоздаёт четыре папки htdocs/. Размещайте собственные изображения, скрипты и стили в site/modules/main/images/, site/modules/main/scripts/ и site/modules/main/stylesheets/ (установка создаёт на них ссылки в 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 должен работать от имени пользователя, которому принадлежит сайт: установка и сам сайт пишут в одни и те же папки, а другие пользователи не могут читать 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: скопируйте серверный блок из 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/.

Папки, доступные для записи

Установка и PHP работают от имени пользователя сайта (шаг 10) и выполняют запись в:

  • htdocs/ — установка пересоздаёт images/, scripts/, stylesheets/, templates/ и system.jsmap.php;
  • core/modules/ проекта — установка создаёт там ссылки на модули ядра;
  • 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

Установка пересоздаёт четыре папки htdocs/, поэтому файлы, помещённые непосредственно в них, будут удалены после обновления: храните их в site/modules/main/ (шаг 6). Папка проекта принадлежит вам: обновление ядра не затрагивает её. Сравнивайте starter/ нового релиза со своим проектом, чтобы перенести внесённые изменения.

Известные риски

Прочитайте Известные риски перед публикацией сайта в интернете.