The documentation is part of the deliverable (spec 11.5/11.7/11.9), so it has to describe what the code does, not what was intended. Adds docs/documentation-plan.md: the package inventory against the spec, the per-claim sources of truth in the tree, the results of a first cross-check pass (11 findings, most notably the missing "operations" section required by spec 11.7, the absent env-var reference, .env.example's dangling link to a README "Rate limiting" section, and the unwritten "tar while stopped" backup path from spec 9), and tasks D1-D7 gating the next release tag. progress.md points at it so it survives a context reset. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
17 KiB
Прогресс реализации SelfPost
Живой трекер состояния. Переживает /clear — читается первым при возобновлении работы.
План (открытые вопросы + опциональные фазы): implementation-plan.md.
ТЗ: specification.md. Принятые риски безопасности: security.md.
История релизов: CHANGELOG.md.
История сделанного по фазам (0→13, все закрыты) — в git log и в CHANGELOG, здесь не дублируется.
Как возобновить после сброса контекста
- Прочитать этот файл (текущее состояние, что дальше).
- Открыть
implementation-plan.md— там нерешённые вопросы и опциональная линия 2.x.x (Фаза O1+); принятые риски безопасности — вsecurity.md. - При необходимости — детали в
specification.md. - Продолжить с пункта «Следующий шаг».
Модель по типу работы
Правило: безопасность / инфра / риск-критичное → Opus; UI / документация / бойлерплейт → Sonnet; тривиальная механика → Haiku.
Исключение — ревизия (не написание) кода: предрелизная проверка на уязвимости (пункт D.5 плана) делается моделью Fable, чтобы проверял не тот, кто писал.
Коммиты
Коммит на каждом осмысленном шаге (не каждое сохранение файла, но и не только конец фазы): рабочий под-функционал, зелёная сборка, конец фазы. Минимум — один коммит на закрытую фазу + промежуточные на связные под-шаги. Ветка main (если пользователь не попросит отдельную). Push/PR — только по явной команде. Сообщение коммита завершается трейлером Co-Authored-By: Claude <модель> <noreply@anthropic.com> — с той моделью, которая этот шаг делала (на момент Фазы 14 — Claude Opus 5).
На каждом таком шаге — запись в CHANGELOG.md под [Unreleased] (формат Keep a Changelog). При явном решении зарезать версию — секция [Unreleased] переименовывается в [X.Y.Z] - дата, заводится новая пустая [Unreleased]. Тег/пуш образа — только по явному запросу (см. workflow release.yml).
Протокол закрытия фазы/крупного шага
Перед /clear в конце каждого законченного шага Claude:
- Обновляет этот файл: «Текущее состояние» → что изменилось, что дальше.
- Проверяет применимые критерии «Готово, когда…».
- Дописывает
CHANGELOG.mdпод[Unreleased]. - Делает финальный коммит шага.
Текущее состояние
- Выполнено и принято: базовый линейный план 0→11 (v1.0; аудит безопасности ТЗ 7.6 — полное соответствие), Фаза 12 (UI/UX), Фаза 13 (страница
/status, DNS-проверки домена) и Фаза 14 (security-заголовки, проверка origin, cookie__Host-+ обнаружение дублей, документация про/data/setup-token). Что именно сделано — вgit logиCHANGELOG.md, здесь не дублируется. - B.1 реализован (не выкачен на прод): сессии переехали в SQLite (
internal/store/migrations/0002_sessions.sql,internal/store/sessions.go,internal/web/session.go) — хранится SHA-256 токена, не сам токен; скользящий срок бездействияPANEL_SESSION_IDLE_DAYS(по умолчанию 7 дней, без абсолютного потолка); запись в БД продлевается не чаще раза в час (renewThreshold); опросы мониторинга (GETсHX-Request) продление не триггерят (isSessionActivityвinternal/web/middleware.go);Max-Agecookie выставляется тем же значением при логине и при продлении (setSessionCookie); смена пароля разлогинивает все сессии кроме текущей (уже было, теперь через БД). Проверено на стенде: логин → рестарт процесса панели → сессия жива по старой cookie; HX-Request-опрос и повторный GET внутри часового окна не шлютSet-Cookie.go vet/go test ./.../gofmt -l .чистые. - B.2 реализован (не выкачен на прод): ротация
mail.logушла сcopytruncateна «переименовать +postfix reload» —build/logrotate-mail.conf(nocreateзаменён наcreate 0644 root rootне по плану, а по стендовой проверке: после reload Postfix пересоздаёт лог сам только в момент следующей фактической записи и с режимом0600, недоступным непривилегированной панели, —createв logrotate закрывает это, отдавая файл ей же на 644 сразу после переименования);follow()вinternal/logtail/logtail.goпри обнаружении смены inode дочитывает старый дескриптор ещё раз перед переключением;readLogTail()вinternal/web/handlers_monitor.goсчитает отсутствующий файл пустым экраном, а не ошибкой. Проверено на стенде (selfpost.example.com, отдельный контейнерselfpost:b2test2): цикл трафик → принудительная ротация → файл пуст и сразу читаем непривилегированным uid панели (0 читаетmail.logсразу после rename, без окна недоступности) → новый трафик после ротации уходит в новый файл на 644, ничего не потеряно по обе стороны rename.go vet/go test ./.../gofmt -l .чистые (на dev-сервере; локально на WindowsTestFollowTailsAndRotatesпадает — rename открытого файла запрещён ОС, к делу не относится). - B.3 реализован (не выкачен на прод):
build/entrypoint.shпроверяетSELFPOST_HOSTNAMEдоpostfix-config.shи доsupervisord— при пустом значенииexit 1с развёрнутым текстом ошибки (что это за имя, почему обязательно, пример, где задаётся); плюс синтаксическая проверка черезcase: минимум одна точка, без схемы/порта/пробелов (*://*,*:*, пробел/таб — тот же класс тихого спам-отказа, что и пустое значение).saslRealm()и fallback вpostfix-config.shне тронуты — после гейта эти ветки мертвы. Заодно отмечена обязательность переменной вREADME.mdиdeploy/.env.example. Проверено на стенде (selfpost.example.com, отдельный образselfpost:b3test, cap-list как в поставляемом compose): без переменной —exit 1с ожидаемым текстом, без бесконечного тихого retry;https://mail.example.com:465иlocalhostотклонены с понятными сообщениями; валидныйmail.example.com— обычный старт, все процессы supervisord поднимаются.go vet/go test ./...чистые. - C.4 реализован (не выкачен на прод — это CI/тестовая инфраструктура, а не образ): герметичный контейнерный e2e отдельным Go-модулем
test/e2e/(свойgo.mod, не подхватываетсяgo test ./...основного модуля) поверх поставляемогоdeploy/docker-compose.ymlплюсtest/e2e/compose.override.yml(самоподписанный сертификат,PANEL_COOKIE_SECURE=false,SELFPOST_HOSTNAME=mail.e2e.test, высокие порты20465/20587/20080, изолированный compose-проектselfpost-e2e, свой--project-directory— прод на том же хосте не задет). Герметичная почта: CoreDNS (test/e2e/dns/Corefile— авторитетна только дляe2e.test,file-плагин с саб-директивойreloadперечитываетdb.zoneпо mtime, без сигналов) плюсsmtp-sinkиз пакета postfix (test/e2e/sink/) как sink-MX. Сценарий (test/e2e/*_test.go): старт контейнера → все supervisord-программыRUNNING(postfix-reload—STOPPED) → токен из/data/setup-token→ setup → login → добавление домена → DKIM-запись скраплена со страницы панели и опубликована в фейковую зону → добавление приложения → SMTP AUTH на 465 → письмо на sink → DKIM-подпись проверена (go-msgauth/dkimс кастомнымLookupTXTчерез CoreDNS) против ключа из DNS, не из панели напрямую → send-logqueued → sent. Негативы: без AUTH, relay на чужой домен без AUTH, sender/login mismatch (reject_sender_login_mismatchрепортится Postfix'ом на RCPT, не MAIL —smtpd_delay_reject=yesпо умолчанию), L1-лимит (anvil, overrideRATE_LIMIT_MESSAGES_PER_IP=50— специально высокий, чтобы остальные под-тесты не расходовали общий бюджет по IP раньше времени; сам тест шлёт до 60 раз, ждёт отказа), L2-лимит через панель (домен/приложение →rejected-строка в send-log), fail-open journal-milter'а (supervisorctl stop panel, письмо всё равно принято, контейнер жив), пустой/синтаксически неверныйSELFPOST_HOSTNAME(отдельный один-разовый контейнер, не общий стенд), сессия переживаетdocker restart(плюс явное ожидание готовности smtps-порта после рестарта — панель и Postfix поднимаются независимо).make e2e— локальный/dev-server прогон. Найдено и исправлено по ходу стендовой проверки:reload— саб-директиваfile-плагина CoreDNS, а не отдельный топ-левел плагин (топ-левелreloadследит за самим Corefile, не за зоной);docker compose build.contextрезолвится относительно--project-directory, а не относительно файла, где объявлен;smtp-sinkотказывается стартовать от root без-u;html/templateэскейпит+в+даже в тексте — скрапер значений со страницы обязанhtml.UnescapeString; проверки состояния сразу послеup/restartдолжны поллиться, а не разово опрашиваться (supervisord/postfix поднимаются не мгновенно). Проверено на dev-сервере (selfpost.example.com):make e2e— зелёный (go vet/gofmt -lтоже чистые в обоих модулях).release.ymlпереработан: jobprepare(версия из тега) → матрица[ubuntu-latest, ubuntu-24.04-arm]— каждая нативно собирает образ (--load), прогоняет e2e, пушит тегX.Y.Z-amd64/X.Y.Z-arm64→ jobmerge—docker buildx imagetools createв единый тегX.Y.Z;setup-qemu-actionубран. Не проверено вживую (нельзя без реального тега): сам workflow на GitHub Actions — синтаксис вычитан, логика идентична локальномуmake e2eпути. - Дальше — документация: documentation-plan.md — состав пакета (ТЗ 11), метод сверки с кодом, результаты первого прохода (11 находок: нет раздела «эксплуатация» по ТЗ 11 п.7, нет справочника env-переменных, битая ссылка на «Rate limiting» из
.env.example, не отражена оговорка ТЗ 9 про прямойtar) и задачи D1–D7. Часть предрелизного гейта наравне с e2e и ревизией безопасности. - Дальше: пункт D.5 плана — предрелизная проверка на уязвимости моделью Fable по всему дифу от
v1.0.0плюс повторный проход по ТЗ 7.6; вместе с e2e (C.4, готов) это гейт перед тегом релиза. - Дальше — то, что перечислено в
implementation-plan.md: открытые вопросы закрыты, раздел E теперь только указатель на объём 2.x (входящий релей O1+ и роль администратора домена; 2FA снята с рассмотрения); остаются принятые риски безопасности (переехали в security.md:POSTбезSec-Fetch-Site/Originпропускается, CSRF-токенов нет) и опциональная Фаза O1+ (входящий релей, линия 2.x.x, требует согласования). - Прод:
selfpost.example.com, реальный Let's Encrypt сертификат, живой e2e (DKIM/SPF pass). Контейнер там всё ещё на образе v1.0 — Фаза 14 в него не выкатывалась. При апгрейде: админа один раз разлогинит (сменилось имя cookie), а от reverse-proxy требуется передача исходногоHost(Apache-фрагмент изdeploy/это делает).
Рабочая петля (dev loop) — ВАЖНО
Локально (Windows, <repo>) нет Go и Docker — только редактирование и git. Вся сборка/тесты идут на dev-сервере selfpost.example.com (Debian 12 bookworm, тот же, что базовый образ; провижён под разработку). Цикл: править локально → залить дерево на сервер → go build/go vet/docker build/тесты там. rsync в локальном git-bash нет, поэтому дерево едет tar'ом по ssh: tar -czf - --exclude=.git . | ssh root@selfpost.example.com 'rm -rf /root/selfpost-src && mkdir -p /root/selfpost-src && tar -xzf - -C /root/selfpost-src'; Go на сервере — в /usr/local/go/bin (не в PATH по умолчанию); образ — docker build -f build/Dockerfile -t selfpost:dev --build-arg VERSION=dev .. Источник истины и git-история — локальный репозиторий; сервер — только исполнитель сборки/тестов. Подключение: ssh root@selfpost.example.com (по ключу).