Document repository architecture and deployments

README.md

@@ -3,6 +3,43 @@
 **URL:** https://drhider.pythonk8s.dev.nubes.ru/
 **Репозиторий:** https://gitea.services.ngcloud.ru/Nail/drhider
 **Платформа:** Штурвал (Managed Flask на pythonk8s)
+
+## Как всё устроено
+
+В этом workspace есть три разных репозитория:
+
+| Репозиторий | Назначение | Где работает |
+|---|---|---|
+| `Nail/drhider` | исходный основной DrHider | `https://drhider.pythonk8s.dev.nubes.ru/` через Штурвал |
+| `forcloud/obfuscator` | чистая deploy-копия DrHider без документации и тестов | предназначена для отдельного Flask-деплоя через Штурвал |
+| `forcloud/upload-platform` | переиспользуемый upload-модуль и сервис `vmfiles` | VM213 `5.172.178.213`, systemd `vmfiles.service`, backend `127.0.0.1:8769` |
+
+### Поток загрузки DrHider
+
+Текущий DrHider использует WebDAV-буфер на VM213:
+
+```text
+браузер
+  -> PUT https://upload.sinefo.ru/drhider-upload/<token>
+  -> POST /api/upload_refs в DrHider
+  -> DrHider забирает файл с VM213 по GET
+  -> DELETE файла из буфера
+```
+
+`upload.sinefo.ru` указывает на `5.172.178.213`. Nginx VM213 обслуживает
+`/drhider-upload/`, сертификат выпускается Certbot. Старый домен
+`contracts.kube5s.ru` больше не используется новым DrHider.
+
+`upload-platform` и его `vmfiles.service` — отдельный слой с API `/api/v1/`.
+Основной DrHider сейчас использует WebDAV-маршрут, а не `/api/v1/`.
+
+### Деплой
+
+- Изменения основного приложения: push в `Nail/drhider` или в отдельный
+  `forcloud/obfuscator`, затем **Redeploy** соответствующего приложения в Штурвале.
+- Изменения `upload-platform`: это отдельная репа и отдельный сервис на VM213;
+  push основного DrHider его не обновляет.
+- Nginx, DNS и TLS upload-буфера находятся на VM213, а не в Flask-репозитории.
 **Дизайн фронтенда:** `/home/naeel/nubes/design/`
 
 ---