CMS YouWebsite · 2.0.0

Карта исходников и настройка

← Все руководства

Чтобы вести сайт, этот файл не нужен: шапка, меню, страницы и публикации меняются в консоли, а установка описана в INSTALL.md. Здесь — для тех, кто меняет исходники: стили, шаблоны страниц, скрипты.

1. Название и адрес

В готовом архиве адрес — заготовка https://example.ru: при установке (sudo bash install.sh) настоящие адрес, название и разрешение индексации записываются на сервере в /etc/cms-youwebsite/site.json, и команда выкладки подставляет их в сборку. Менять их в исходниках не обязательно.

Если вы собираете сайт сразу под свой домен, они задаются в одном месте — src/content/site.ts (такую сборку установка выкладывает как есть):

  • url — адрес сайта (https://домен, без «/» в конце);
  • indexable — false, пока сайт не готов: на страницах noindex, в robots.txt — «Disallow: /». Перед запуском — true;
  • name — название: заголовки публикаций, письма с кодом входа. Если админ сменит название в консоли («Шапка и меню»), на сайте будет новое название: в шапке, подвале, заголовках страниц и публикаций.

Сборка (npm run build) подставляет адрес в canonical всех страниц, правило индексации — в метатеги robots, создаёт robots.txt (с адресом sitemap.xml, когда сайт открыт) и site.json. Сервер берёт адрес и название из site.json собранного сайта: для страниц публикаций, карты сайта, писем и проверки, откуда пришёл запрос. Отдельно прописывать их в настройках сервера не нужно.

Защита от ошибок: если indexable: true, а адрес остался example.ru, сборка остановится с понятной ошибкой; пока сайт закрыт, сборка и служба сайта пишут об этом предупреждение.

Кроме site.ts, домен меняется только в настройках сервера, которые сборка не видит: server_name и пути к сертификату в deploy/nginx/site.conf и first-certificate.conf. Почту сайта задают при установке в окнах (sudo cms-youwebsite-setup, INSTALL.md, шаг 3), без окон — в /etc/cms-youwebsite/service.env.

Остальное:

  • HTML-файлы в корне и каталогах страниц — заголовки, метаописания и видимые тексты. Новую постоянную страницу достаточно положить в свою папку (<папка>/index.html): сборка, шапка и sitemap.xml найдут её сами.

Шапка, меню и подвал по умолчанию

Шапку, меню и подвал нового сайта задаёт src/content/header.json: название, подпись, строка над шапкой, текст справа, телефон, кнопка, расположение, размер логотипа и шрифт названия (brand.logo_size, brand.font), шапка на главной поверх фото или нет (home) и два меню — menus.desktop и menus.mobile. Обычно они одинаковые. Свой цвет шапки — tone: "custom" и color (цвет палитры, номер оттенка и насыщенности).

Подвал — раздел footer того же файла: text (текст под названием), menu и menu_title (колонка разделов), contacts и contacts_title (колонка контактов; пустой текст — колонки нет), console_link (ссылка «Консоль»), copyright (текст после «© год»; пусто — название сайта) и credit — подпись «Сайт на CMS YouWebsite» со знаком. "credit": false убирает подпись и знак YouWebsite уже в шаблоне; владелец сайта делает то же в консоли.

Палитру своего цвета задают PALETTE, SHADES и SATURATION в server/site_header.py. Если меняете их, выполните npm run header: команда пересчитает src/styles/header-colors.css и откажется, если у какого-то варианта текст будет читаться хуже 4,5:1. Если меняете --ink в main.css, поменяйте и INK там же — это проверяет тест. После правки выполните npm run header: команда впишет шапку, подвал и название во все исходные страницы с шапкой — index.html, 404.html и каждую <папка>/index.html. Тест проверяет, что страницы и header.json не разошлись, а пункты меню ведут на существующие страницы.

Свои страницы

Страницы сайта — это папки: about/index.html открывается по адресу /about/. Их можно переименовывать, удалять и добавлять (history/, rector/, uslugi/…): сборка, npm run header, карта сайта для поисковиков и консоль находят страницы по папкам сами, нигде вписывать их не нужно. Новую страницу проще всего сделать копией существующей (например, about/index.html) — в ней уже есть нужные метки:

  • <!-- yw:header --> … <!-- /yw:header --> — шапка (её пишет npm run header или консоль, вручную не правьте);
  • <!-- yw:footer --> … <!-- /yw:footer --> — подвал целиком (его тоже пишет npm run header из раздела footer в src/content/header.json; в консоли — «Подвал»), атрибут data-yw-name — название сайта;
  • <!-- yw:page --> … <!-- /yw:page --> — основная часть: её админ может править в консоли («Страницы» → код страницы).

Не называйте папки страниц служебными именами: news, console, api, admin, build, assets, src, server, public, deploy, docs, dist. Пункт меню на новую страницу добавьте в src/content/header.json, затем npm run header.

Тесты (npm run test:api) не привязаны к демо-страницам и названию: после настройки сайта они должны проходить без правок. Если какой-то тест падает — скорее всего, в страницах потерялась одна из меток.

Дальше шапку и меню меняет админ в консоли («Шапка и меню», памятка), подвал — там же, «Подвал» (памятка). Сборка кладёт site-header.json — с ним консоль показывает шапку по умолчанию, пока админ ничего не менял.

2. Визуальные материалы

  • public/assets/images/cms-youwebsite.svg — знак CMS YouWebsite: логотип демо-сайта по умолчанию и значок консоли (свой логотип админ может загрузить в «Шапке и меню»);
  • public/assets/images/demo-photo.png — демонстрационное фото;
  • public/assets/images/youwebsite-logo.svg — знак YouWebsite в подписи «Сайт на CMS YouWebsite» в подвале (подпись со знаком убирается в консоли, «Подвал», или footer.credit в header.json).

Замените заглушки реальными файлами и обновите пути в HTML/CSS. Файлы из public/ браузер хранит у себя сутки: если заменить картинку, оставив то же имя, посетители увидят новую не позже чем через день (по кнопке «обновить» — сразу). Чтобы замена была видна мгновенно у всех, дайте файлу новое имя. Демонстрационное фото не содержит текста, людей, логотипов и отраслевых символов.

3. Постоянные страницы и права

Главная, «О проекте», «Руководитель», «Контакты» и любые новые страницы, у которых основная часть внутри <main> обёрнута в <!-- yw:page --> … <!-- /yw:page -->, админ может править прямо в консоли («Страницы»):

  • в редакторе — только HTML основной части; шапка, меню и подвал общие: их меняют в «Шапке и меню» и «Подвале»;
  • «Загрузить файл» кладёт фото или PDF на сервер и выдаёт ссылку для кода;
  • сервер не сохранит незакрытые теги (сообщит номер строки) и вырежет скрипты, обработчики on…, style и опасные ссылки;
  • если из кода пропал элемент, от которого зависит работа сайта (например, кнопка «Написать письмо»), консоль предупредит;
  • у каждой страницы 20 последних версий: «Вернуть предыдущую версию» и «Вернуть исходную»; все правки — в журнале;
  • правки хранятся в content.json (попадают в копии), служба собирает из них статические страницы, nginx отдаёт их раньше собранных. При выкладке новой версии сайта правки сохраняются; если исходная страница в новой версии изменилась, консоль об этом напишет.

Роли. Каждый видит в консоли только то, что ему доступно; сервер проверяет права при каждом действии.

Что доступно Суперадмин Админ Редактор Автор
Писать публикации ✓ ✓ ✓ ✓
Править и удалять все все все свои
Проверять публикации авторов ✓ ✓ ✓ —
Код страниц, настройки, журнал, копии ✓ ✓ — —
Приглашать и удалять редакторов и авторов ✓ ✓ — —
Назначать админов, включать проверку авторов, передать права ✓ — — —

Суперадмин — владелец сайта со стороны клиента, он один. Его создают при запуске в окнах установки (ссылку выдаёт sudo cms-youwebsite-setup; вариант в терминале — sudo cms-youwebsite-users), остальных он и админы приглашают в консоли («Пользователи»): человек получает письмо и сам задаёт пароль. Каждое изменение пользователей подтверждается кодом на почту того, кто его делает. Права суперадмина передаются другому админу с подтверждением обеих сторон; если суперадмин недоступен, нового назначают на сервере (пункт 9 команды).

Проверка публикаций авторов по умолчанию выключена. Если её включить («Настройки», только суперадмин), новые публикации авторов и их правки уже опубликованных материалов сначала ждут проверки редактора или админа, а на сайте до этого остаётся проверенная версия. Подробно для клиента — в docs/users-and-roles.md.

После запуска суперадмином должен стать клиент, а не разработчик, — см. «Передача сайта клиенту» в deploy/README.md.

4. Публикации

Оформление страниц публикаций задаёт news/index.html: шапка списка и всё, что между отметками <!-- yw:list-only -->, видно только на /news/; блок <!-- yw:head --> на страницах публикаций сервер заменяет своим. Отметки yw: удалять нельзя — без них служба не соберёт страницы и напишет об этом в журнал.

Типограф («ёлочки», тире, неразрывные пробелы после предлогов) по умолчанию выключен. Обсудите с клиентом и включите его в консоли («Настройки», видно только админу), если клиент согласен. Текст редакторов он не меняет — только вид на сайте, — поэтому включать и выключать его можно в любой момент.

Редакторам клиента передайте памятку docs/text-editor.md (как писать текст, быстрые метки, ссылки, вставка из Word) вместе с docs/backup-for-editors.md.

Стартовый контент находится в server/seed/content.json, вложения — в server/seed/uploads/. Для нового проекта можно оставить демонстрационные записи, заменить их в /console/ или начать с пустого массива posts и значения next_post_sequence: 1.

5. Контакты и защита

  • deploy/service.env.example — контактная почта и SMTP. Кнопка «Написать письмо» выдаёт адрес после своей проверки «не робот»: браузер посетителя за доли секунды решает задание сервера, поле-ловушка отсекает простых роботов, а частые запросы с одного адреса ограничены. Ни сторонних сервисов, ни ключей, ни cookie — регистрировать ничего не нужно. Сложность — CONTACT_CHECK_MAX_NUMBER;
  • deploy/editors.example.json — пример редактора;
  • deploy/nginx/site.conf — домен, сертификат и пути размещения.

Никогда не сохраняйте рабочие пароли, ключи и реальные файлы пользователей в исходниках.

Часовой пояс сайта по умолчанию не задан. При первом входе в консоль её нельзя закрыть, пока не выбран пояс (предлагается пояс компьютера). Выбирают пояс объекта, целевой аудитории или тех, кто отвечает на обращения. По нему консоль подставляет дату и время новой публикации, а поисковики и соцсети видят время публикаций. Сменить пояс можно в «Настройках» консоли — страницы публикаций сразу пересобираются, смена пишется в журнал. Пока пояс не выбран, поисковикам передаётся только дата публикации. Настройка хранится в content.json и попадает в резервные копии.

Файлы удалённых материалов 30 дней лежат в корзине uploads/.trash/, срок меняется переменной CONTENT_TRASH_DAYS.

Действия редакторов (входы, создание, изменение и удаление публикаций и страниц) записываются в журнал editor-journal.log рядом с content.json. Его видно в консоли по кнопке «Журнал». Путь меняется переменной CONTENT_JOURNAL_PATH.

6. Проверка перед публикацией

  1. Выполнить npm run check, npm run build, npm run test:api.
  2. Проверить все страницы на компьютере, планшете и телефоне.
  3. Проверить вход с одноразовым кодом, выбрать часовой пояс сайта (и решить с клиентом про типограф), создать, отредактировать и удалить запись.
  4. Проверить поддомены домена клиента командой python3 server/check_subdomains.py (добавьте --extra с поддоменами из DNS у регистратора). Сайт отдаёт HSTS с includeSubDomains: после первого визита браузер год открывает все поддомены только по HTTPS и не даёт обойти ошибку сертификата. Чаще всего забывают почту хостинга (mail.), 1С, CRM, видеонаблюдение и старые сайты. Что делать, если поддомен без HTTPS, — deploy/README.md, раздел «Поддомены и HSTS». Сборка с indexable: true напоминает об этом шаге.
  5. Сделать копию в консоли, скачать её, проверить командой site_backup.py verify и один раз восстановить на тестовом сервере (см. deploy/BACKUP.md). Отдельно сохранить файл настроек и файл редакторов.
  6. Только после этого открыть сайт поисковикам: на сервере sudo bash install.sh --search on (для сборки со своим адресом — indexable: true в src/content/site.ts, пересобрать и выложить). Затем подключить аналитику.