Довідка

Якщо ви читаєте це, то генерація робочого каталогу на сервері відбулося без помилок і не потребує додаткових дій. В подальшому, цю сторінку можна видалити, вона створюється лише за відсутності інших php-файлів у папці /pages.

Скрипти написані для домашнього WEB-сервера однодискової станції Synology DS118, але можуть бути розгорнуті на будь-якому іншому ресурсі як є. Відповідальність за їх роботу і можливі наслідки лежить на користувачеві.

Пояснення роботи

Проєкт автоматично генерує файли, необхідні для розгортання у будь-якій папці сервера з PHP версій 7.* та вище. Роутінг підтримує використання коротких і красивих URL, що відповідає базовим умовам Readable Permanent URLs. Наприклад, замість /index.php?page=help користувач може перейти за коротким і зрозумілим шляхом /help.

Захист, дозволи і перенаправлення на ресурси прописані у .htaccess, який створюється для безпеки. Карта сайту sitemap.xml генерується по запросу на льоту із файла кешу.

Формат метаданих

Для захисту від прямого доступу до PHP-сторінок, потрібно додавати на початку кожного скрипта строку: if (!defined('APP_ACCESS')) exit('No direct script access allowed'); Приклад metadata поточної сторінки:

<?php
if (!defined('APP_ACCESS')) exit('No direct script access allowed');

/**
title: Довідка
description: Згенеровано автоматично при розгортанні проєкту
menugroup: Допомога
menutitle: Довідка
menuorder: 1
slug: help
layout: default
**/

Наявність slug обов’язкова для всіх сторінок, він має бути унікальним серед усіх файлів, бо в разі конфлікту імен, - буде викликана сторінка перша за алфавітом. Якщо layout відсутній, або пустий, то використовується шаблон формування сторінки default.php по замовчанню. Метатеги menugroup призначені для формування меню сайта і використовуються по необхідності. В разі відсутності menugroup, файл буде пропущений при формуванні карти (меню) сайта.

Перший запуск і перенесення

Розмістіть файли проекту на сервері в будь-яку папку і введіть її ім'я у браузері. В результаті, буде розгорнута структура файлів і директорій, яка показана вище. У подальшому папку можна перейменовувати, або переносити в інше місце WEB-сервера, видаливши попередньо файл .htaccess, після чого дані кешу і правила роутінгу будуть оновлені автоматично.