- Главная
- Документация
- Установка
Установка
Одна установка — один сайт. Эти шаги устанавливают 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, не должны отдаваться сервером.
Структура каталогов
Корневым каталогом веб-сервера (document 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 |
Обязательный. Email администратора, который также является логином; не более 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. |
Установщик:
- проверяет расширения PHP и отказывается запускаться от root;
- проверяет, что база данных пуста — без таблиц и процедур/функций, — и что у пользователя есть права на создание процедур;
- записывает конфигурацию сайта
configs/system.config.<host>.phpна основе шаблона (доступную для чтения только владельцу и с выключенным режимом отладки) и создаёт на неё ссылку изweb/system.config.php; - загружает схему, базовые данные и переводы сайта, а также создаёт администратора в группе «Администратор»;
- запускает
setup linker, создающий ссылки на тему, скрипты и шаблоны вweb/; - выводит
Готово:и адрес сайта.
В случае ошибки установщик выводит её причину и завершает работу с кодом 1. Конфигурация, записанная во время этого запуска, удаляется, но база данных остаётся частично заполненной: очистите её — таблицы и хранимые процедуры/функции — перед повторной попыткой. Если произошёл сбой только на последнем шаге, сайт считается установленным: устраните причину и выполните php index.php setup linker.
Если конфигурация уже существует, запустите установщик, указав только --admin-email: параметры базы данных и адрес будут взяты из конфигурации, а попытка указать параметры БД или другой адрес будет отклонена.
Веб-сервер
Неизвестные адреса передаются в index.php, а адреса масштабированных изображений — в resizer. В репозитории приведены эти два правила для 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/ — он перекроет собственный robots.txt сайта. Установка заголовков безопасности и перенаправление на HTTPS — задача веб-сервера; см. Безопасность.
Демо-контент
Сразу после setup install команда php index.php setup demo загружает демонстрационный контент: страницы — в том числе главную страницу «Лендинг», раздел «Возможности» с подстраницами, страницу «Услуга» и «Контакты», — трёх демо-посетителей и изображение. Он предназначен исключительно для ознакомления с Simple, а не для клиентских сайтов: команда сработает только на чистой установке, команды для его удаления нет, а setup check считает наличие демо-пользователей ошибкой.
После установки
- Войдите по адресу
/login/, используя email и пароль администратора; панель управления доступна по адресу/admin/. - Перед сдачей сайта запустите
php index.php setup check. Команда выведет список того, что ещё не готово: режим отладки, адрес, демо-пользователи, битые ссылки, непереведённые строки, настройки почты — и завершит работу с кодом 1 при обнаружении проблем. См. Ваш первый сайт. - О том, как обновлять сайт в дальнейшем, см. в разделе Обновление.