Skip to content

README.md

Latest commit

 

History

History
35 lines (25 loc) · 2.64 KB

README.md

File metadata and controls

35 lines (25 loc) · 2.64 KB
Raw

Документация KeyWai

Здесь собраны руководства по установке, настройке и эксплуатации KeyWai — self-hosted SEO-платформы (сбор семантики, кластеризация, анализ конкурентов, контент-планы, AI-статьи, генерация объявлений Яндекс.Директ, канбан и AI-чат).

Документация рассчитана на тех, кто разворачивает проект у себя: базовое знакомство с терминалом и Docker желательно, глубоких знаний программирования не требуется.

С чего начать

  1. Установка — запуск KeyWai на своём компьютере (Windows, macOS, Linux) одной командой Docker Compose.
  2. Первый запуск — создание администратора, ввод API-ключей, выбор AI-моделей, начисление кредитов.
  3. Регистрация API-ключей — где взять ключи внешних сервисов (OpenRouter, Yandex Cloud, ЮKassa, SMTP и др.) и куда их вставить.
  4. Эксплуатация — развёртывание на VPS, обновление версии, резервное копирование и восстановление.

Полезное рядом

  • README проекта — обзор, возможности, быстрый старт.
  • CHANGELOG — история версий.
  • LICENSE — лицензия MIT.
  • SECURITY — модель угроз и ответственное раскрытие уязвимостей.
  • CONTRIBUTING — как внести вклад.

⚠️ Важно: OpenRouter и доступ из России

Вся работа AI-функций идёт через OpenRouter. Сайт openrouter.ai недоступен из России без VPN или прокси — причём доступ нужен дважды:

  • вашему браузеру — чтобы зарегистрироваться и получить ключ;
  • серверу KeyWai — бэкенд обращается к openrouter.ai при каждом AI-запросе.

Подробности — в разделах Установка и Регистрация API-ключей.