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

Одна інсталяція — один сайт. Ці кроки встановлюють Energine Simple у порожню базу даних; далі читайте Ваш перший сайт. Інтерфейс доступний англійською, російською та українською мовами.

Вимоги

  • PHP 8.4 або новіший з розширеннями ctype, dom, fileinfo, gd, json, libxml, mbstring, openssl, PDO, pdo_mysql, session, SimpleXML та xsl. GD потребує підтримки JPEG, PNG і WebP для зміни розміру зображень. Необов'язково: tidy — очищує HTML текстів перед збереженням; posix — дозволяє інсталятору запитувати паролі; без нього паролі беруться лише зі змінних середовища.
  • MariaDB — порожня база даних і її користувач. Користувач повинен мати право створювати підпрограми (CREATE ROUTINE та ALTER ROUTINE): схема містить збережену функцію та процедури, і інсталятор перевіряє це перед будь-якими змінами.
  • Composer — лише для генерації автозавантажувача; Simple не має сторонніх PHP-пакетів.
  • Веб-сервер, який передає PHP-файли інтерпретатору PHP і надсилає невідомі адреси до index.php — див. Веб-сервер. У репозиторії немає конфігурації веб-сервера.
  • Доступ до оболонки від імені користувача, якому належить сайт, не root. Інсталятор, setup demo, setup page і setup linker відмовляються запускатися від root: файли, що належать root, не можуть обслуговуватися веб-сервером.

Структура каталогів

Кореневий каталог веб-сервера — web/, а репозиторій розташований поруч у private/energine. Код шукає себе за шляхом ../private/energine відносно кореневого каталогу, тому зберігайте ці назви:

my-site/
├── web/                         document root
│   ├── index.php  bootstrap.php  auth.php  resizer/    copied from htdocs/
│   ├── uploads/                 the site's files
│   ├── system.config.php        link to the site's configuration
│   └── images/  scripts/  stylesheets/  templates/     links made by setup linker
└── private/energine/            the repository
    ├── core/      the modules share, user and seo
    ├── site/      your site: theme, XSLT, page templates, translations
    ├── setup/     the console tool
    ├── sql/       schema, base data, demo content, database migrations (sql/cut/)
    ├── htdocs/    the files to copy into web/
    ├── configs/   the configuration template and the site's configuration
    └── docs/  tests/  tools/

site/ знаходиться в тому самому git-дереві, що й ядро: ваша тема та шаблони є частиною склонованого репозиторію.

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

cd my-site
git clone --branch simple https://github.com/kwebmn/energine-cmf-latest.git private/energine
git -C private/energine config core.hooksPath .githooks

Хук відхиляє коміт, що містить пароль бази даних або пароль тестового адміністратора.

2. Скопіюйте вхідні файли до кореневого каталогу

mkdir -p web
cp private/energine/htdocs/index.php private/energine/htdocs/bootstrap.php private/energine/htdocs/auth.php web/
cp -a private/energine/htdocs/resizer private/energine/htdocs/uploads web/

На більшості хостингів кореневий каталог вже існує; mkdir -p web створює його за потреби. auth.php обробляє форми входу та виходу; resizer/ обслуговує масштабовані зображення.

3. Згенеруйте автозавантажувач

cd private/energine
composer install --no-dev
cd ../..

Без нього сайт зупиниться з повідомленням Autoloader not found. Firstly you have to run "composer install".

4. Запустіть інсталятор

З кореневого каталогу, від імені користувача сайту:

cd web
php index.php setup install --domain=example.com --db-name=site --db-user=site --admin-email[email protected]

Паролі ніколи не передаються як параметри: інсталятор зчитує їх зі змінних ENERGINE_DB_PASSWORD і ENERGINE_ADMIN_PASSWORD або запитує без відображення на екрані. Параметр, що схожий на пароль, буде відхилено.

Параметр Значення
--admin-email Обов'язковий. E-mail адміністратора, що є також логіном; не більше 50 символів.
--admin-name Ім'я адміністратора; за замовчуванням Admin.
--domain Хост сайту, з :port, якщо порт нестандартний.
--url Замість --domain: повна адреса, http(s)://host[:port]/path/; шлях стає коренем сайту.
--db-host, --db-port, --db-socket Розташування MariaDB: за замовчуванням localhost і 3306; сокет замінює хост і порт.
--db-name, --db-user База даних і її користувач.
--config Читати або записувати конфігурацію у вказаний файл замість configs/system.config.<host>.php; посилання у web/ не створюється.
--no-static Пропустити останній крок, setup linker.

Інсталятор:

  1. перевіряє розширення PHP і відмовляється запускатися від root;
  2. перевіряє, що база даних порожня — без таблиць і без підпрограм — і що її користувач може створювати підпрограми;
  3. записує конфігурацію сайту, configs/system.config.<host>.php, з шаблону — доступну лише власнику і з вимкненим режимом налагодження — і створює на неї посилання з web/system.config.php;
  4. завантажує схему, базові дані та переклади сайту, і створює адміністратора в групі «Администратор»;
  5. запускає setup linker, який створює посилання на тему, скрипти та шаблони у web/;
  6. виводить Готово: і адресу сайту.

У разі помилки інсталятор виводить її причину і завершується з кодом 1. Конфігурація, записана під час цього запуску, видаляється, але база даних залишається частково заповненою: очистіть її — таблиці та підпрограми — перед повторною спробою. Якщо невдачею завершився лише останній крок, сайт встановлено: усуньте причину і запустіть php index.php setup linker.

Якщо конфігурація вже існує, запустіть інсталятор лише з --admin-email: він візьме базу даних і адресу з конфігурації і відхилить параметри бази даних або іншу адресу.

Веб-сервер

Невідомі адреси надсилаються до index.php, а адреси масштабованих зображень — до ресайзера. У репозиторії задокументовано ці два правила для nginx:

location / {
    try_files $uri $uri/ @rewrites;
}

location @rewrites {
    rewrite ^ /index.php last;
}

rewrite "^/resizer/w([0-9]+)\-h([0-9]+)/(.*)$" /resizer/timthumb.php?w=$1&h=$2&src=$3&zc=2;

Передавайте .php-файли до PHP-FPM як зазвичай і тримайте private/ поза кореневим каталогом. Файли в web/images, web/scripts, web/stylesheets і web/templates є посиланнями до репозиторію: при використанні nginx з disable_symlinks if_not_owner вони повинні належати користувачу сайту. Не кладіть статичний robots.txt у web/ — він замінить власний файл сайту. Заголовки безпеки та перенаправлення на HTTPS — завдання веб-сервера; див. Безпека.

Демонстраційний вміст

Відразу після setup install команда php index.php setup demo завантажує демонстраційний вміст: сторінки — зокрема головна сторінка «Лендинг», розділ «Возможности» з підсторінками, сторінки «Услуга» і «Контакты» — трьох демо-відвідувачів і зображення. Він призначений для ознайомлення з Simple, а не для сайту клієнта: приймається лише при чистій установці, команди для його видалення немає, а setup check повідомляє про демо-користувачів як про помилку.

Після встановлення

  • Увійдіть за адресою /login/ з e-mail і паролем адміністратора; адмін-панель розташована за адресою /admin/.
  • Перш ніж передавати сайт замовнику, запустіть php index.php setup check. Команда виводить список того, що не готово — режим налагодження, адреса, демо-користувачі, зламані посилання, неперекладені рядки, налаштування пошти — і завершується з кодом 1 у разі невідповідності. Див. Ваш перший сайт.
  • Щоб оновити сайт пізніше, читайте Оновлення.