Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,15 @@ It is a standalone product with its own HTTP API, command-line client and TypeSc
- **The whole cluster in one place.** Pair the other installations, mirrors and second sites with a one-time code over a pinned certificate, and see on one page whether each answers, its version, HA copies, read gateways, mirror lag and download queue.
- **Mirrors and read gateways.** A second installation keeps a read-only copy of repositories and serves it when the first site is lost; extra download processes share one bandwidth budget.
- **Runs by itself.** Windows services, Linux packages or Docker Compose. Services restart after a crash or a hang; signed stable updates install by hand or in a maintenance hour, behind a fresh verified backup, with rollback.
- **A console in eleven languages.** English, Russian, Spanish, French, German, Portuguese, Chinese, Japanese, Korean, Hindi and Arabic, light and dark. The documentation is in the same languages.
- **A console in eleven languages.** English, Russian, Spanish, French, German, Portuguese, Chinese, Japanese, Korean, Hindi and Arabic, light and dark. The documentation offers the same language selection; some Japanese and Arabic pages fall back to English.

## Modules and Arkvory Pro

Arkvory supports signed ProAnimaStudio modules for additional storage, transfer protocols and HTTP routes. Modules are installed on the host and loaded at service startup; Docker Compose does not load them. Third-party plugins cannot yet be installed or run; the host can only maintain their trusted author keys.

**Arkvory Pro** is an optional paid module bundle for deduplication and delta transfers with compatible clients. Pro 0.1.0 works with Arkvory 0.6.3 on Windows/Linux x64. It reuses shared chunks in storage and transfers missing content or patches instead of always sending complete files. Savings depend on the data and client. Existing Pro data remains readable without an active licence; new uploads fall back to core storage and ordinary transfers when paid features are unavailable. The core remains free of charge under its existing licence.

Obtain Pro packages and a licence from ProAnimaStudio. See [modules, Pro features and operating limits](https://proanima.github.io/Arkvory/operate/modules#pro) and [licence activation](https://proanima.github.io/Arkvory/operate/licenses) before deployment.

## Install

Expand Down Expand Up @@ -73,7 +81,7 @@ The full walkthrough: [Quick start](https://proanima.github.io/Arkvory/guide/qui

## Documentation

**[proanima.github.io/Arkvory](https://proanima.github.io/Arkvory/)** — installation, everyday work, clients and protocols, operation (backups, mirrors, the high-availability cluster, storage, monitoring, security, troubleshooting) and the HTTP API reference generated from the contract the server enforces. With search, in the eleven languages of the console. The engineering documents (architecture, contracts, decisions) are in Russian in [`docs/`](docs/) and in the site's developers' section.
**[proanima.github.io/Arkvory](https://proanima.github.io/Arkvory/)** — installation, everyday work, clients and protocols, operation (backups, mirrors, the high-availability cluster, storage, monitoring, security, troubleshooting) and the HTTP API reference generated from the contract the server enforces. With search and the eleven-language selector of the console; Japanese and Arabic still contain English fallback pages. The [current implementation and limits](docs/CURRENT_STATE.md) distinguish shipped features from historical plans. The engineering documents (architecture, contracts, decisions) are in Russian in [`docs/`](docs/) and in the site's developers' section.

## Limits

Expand Down
12 changes: 10 additions & 2 deletions README.ru.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,15 @@ Arkvory — репозиторий для файлов, которые прои
- **Весь кластер в одном месте.** Подключите другие установки, зеркала и вторые площадки одноразовым кодом по закреплённому сертификату и смотрите на одной странице, отвечает ли каждая, её версию, копии HA, шлюзы чтения, отставание зеркал и очередь скачиваний.
- **Зеркала и шлюзы чтения.** Вторая установка держит копию репозиториев только для чтения и раздаёт её, если основная площадка потеряна; дополнительные процессы скачивания делят общий бюджет полосы.
- **Работает сам.** Службы Windows, пакеты Linux или Docker Compose. Службы перезапускаются после падения или зависания; подписанные стабильные обновления ставятся вручную или в час обслуживания, после свежей проверенной резервной копии, с откатом.
- **Консоль на одиннадцати языках.** Английский, русский, испанский, французский, немецкий, португальский, китайский, японский, корейский, хинди и арабский; светлая и тёмная тема. Документация — на тех же языках.
- **Консоль на одиннадцати языках.** Английский, русский, испанский, французский, немецкий, португальский, китайский, японский, корейский, хинди и арабский; светлая и тёмная тема. В документации доступны те же языки; часть японских и арабских страниц пока показывается на английском.

## Модули и Arkvory Pro

Arkvory поддерживает подписанные модули ProAnimaStudio для дополнительных хранилищ, протоколов передачи и HTTP-маршрутов. Модули устанавливаются на хосте и загружаются при старте служб; Docker Compose их не загружает. Установка и выполнение сторонних плагинов пока недоступны; на хосте можно только вести список доверенных ключей их авторов.

**Arkvory Pro** — дополнительный платный комплект модулей дедупликации и дельта-передачи для совместимых клиентов. Pro 0.1.0 работает с Arkvory 0.6.3 на Windows/Linux x64. Он переиспользует общие чанки в хранилище и передаёт недостающие данные или патчи вместо постоянной передачи целых файлов. Экономия зависит от данных и клиента. Существующие данные Pro читаются без активной лицензии; при недоступности платных функций новые загрузки переходят в хранилище ядра и на обычную передачу. Ядро остаётся бесплатным на прежних условиях лицензии.

Пакеты Pro и лицензию получают у ProAnimaStudio. Перед внедрением прочитайте о [модулях, возможностях Pro и эксплуатационных ограничениях](https://proanima.github.io/Arkvory/ru/operate/modules#pro) и [активации лицензии](https://proanima.github.io/Arkvory/ru/operate/licenses).

## Установка

Expand Down Expand Up @@ -73,7 +81,7 @@ curl -fL -H "Authorization: Bearer $ARKVORY_KEY" -o Setup.exe \

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

**[proanima.github.io/Arkvory](https://proanima.github.io/Arkvory/ru/)** — установка, повседневная работа, клиенты и протоколы, эксплуатация (резервные копии, зеркала, кластер высокой доступности, хранение, мониторинг, безопасность, устранение неполадок) и справочник HTTP API, который генерируется из контракта, проверяемого сервером. С поиском, на одиннадцати языках консоли. Инженерные документы (архитектура, контракты, решения) ведутся на русском в [`docs/`](docs/) и доступны в разделе сайта для разработчиков.
**[proanima.github.io/Arkvory](https://proanima.github.io/Arkvory/ru/)** — установка, повседневная работа, клиенты и протоколы, эксплуатация (резервные копии, зеркала, кластер высокой доступности, хранение, мониторинг, безопасность, устранение неполадок) и справочник HTTP API, который генерируется из контракта, проверяемого сервером. С поиском и выбором одиннадцати языков консоли; часть японских и арабских страниц пока показывается на английском. [Актуальные возможности и ограничения](docs/CURRENT_STATE.md) отделены от исторических планов. Инженерные документы (архитектура, контракты, решения) ведутся на русском в [`docs/`](docs/) и доступны в разделе сайта для разработчиков.

## Ограничения

Expand Down
2 changes: 1 addition & 1 deletion docs/API_CONTRACT_GUARD.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,4 +60,4 @@ GET bytes описывает 200/206, binary content, ETag, Content-Length, Cont

Добавить use case и server handler, wire-схемы и строку operation policy; определить стабильное имя, реальные права и retry. Обновить SDK и карту API, затем осмысленно обновить снимок operations. Запустить `npm run check`, `npm test`, PostgreSQL integrations и относящиеся ACL/отказные сценарии. Не расширять static exclusions ради прохождения проверки.

Сам inventory guard не требует таблиц; текущий runtime использует схему **11** с [индексом файловых страниц](ASSET_PAGINATION.md), сохраняя [делегированное управление](SERVICE_DELEGATION.md). Новые service-administration policies задают action, точную область resource и bootstrapAlternative; это metadata, не замена транзакционной авторизации. Следующие этапы: импорт identities/ownership, namespace selectors, события и UI управления ключами. Полный HA-стенд остаётся отдельной отложенной приёмкой.
Сам inventory guard не требует таблиц; версию runtime определяет `packages/infrastructure/src/schema-version.ts` (52 в ядре 0.6.3). Service-administration policies задают action, точную область resource и bootstrapAlternative; это metadata, не замена транзакционной авторизации. Наличие событий, управления ключами и HA проверяется по текущей реализации и гейтам, а не по списку будущих этапов первоначального guard: [CURRENT_STATE](CURRENT_STATE.md), [CI](CI.md).
6 changes: 3 additions & 3 deletions docs/API_MAP.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@

Управление установленным кодом: `GET/HEAD /api/v1/system/updates` и `POST /api/v1/system/updates/requests`. Surface administration, глобальный administrator, команды check/configure/apply с revision и UUID. SDK: `client.updates`. [Контракт, права и восстановление](UPDATES.md).

Резервные копии экземпляра (B2, [ADR 0056](adr/0056-unattended-backups.md)): `/api/v1/backup/*`, surface administration, системные права `backup.read`/`backup.manage` (администратор учётных записей или файловый ключ владельца/bootstrap; ключи репозиториев — 403). Подробности — [раздел 1a](#1a-резервные-копии--реализовано). Схема БД введена в 26; актуальная — 34 (`SCHEMA_VERSION`).
Резервные копии экземпляра (B2, [ADR 0056](adr/0056-unattended-backups.md)): `/api/v1/backup/*`, surface administration, системные права `backup.read`/`backup.manage` (администратор учётных записей или файловый ключ владельца/bootstrap; ключи репозиториев — 403). Подробности — [раздел 1a](#1a-резервные-копии--реализовано). Схема БД введена в 26; в ядре 0.6.3 актуальная — 52 (`SCHEMA_VERSION`).

Области ответственности, уровни видимости, каталог операций текущего credential и SDK для удалённых клиентов реализованы: [API_SURFACES](API_SURFACES.md). `GET/HEAD /api/v1/operations` — authenticated, контекст repository необязателен, pagination до 100, advisory conditions. `GET/HEAD /api/v1/openapi.json?surface=…` — документационное представление. Актуальная схема БД — 32.
Области ответственности, уровни видимости, каталог операций текущего credential и SDK для удалённых клиентов реализованы: [API_SURFACES](API_SURFACES.md). `GET/HEAD /api/v1/operations` — authenticated, контекст repository необязателен, pagination до 100, advisory conditions. `GET/HEAD /api/v1/openapi.json?surface=…` — документационное представление. Версия схемы определяется `packages/infrastructure/src/schema-version.ts`; для выпущенного ядра 0.6.3 это 52.

Дата сверки: 2026-10-05, runtime со схемой 32. Это точка входа для интеграторов: **реализованные маршруты** ниже отделены от **проектируемых расширений**. Детальные JSON-схемы текущего сервера: `GET /api/v1/openapi.json` с действующим Bearer. OpenAPI сейчас 3.0.3; новую модель доступа описывает [API_ACCESS](API_ACCESS.md), порядок внедрения — [API_EVOLUTION](API_EVOLUTION.md).
Текущие версии и границы реализации: [CURRENT_STATE](CURRENT_STATE.md). Это точка входа для интеграторов: **реализованные маршруты** ниже отделены от **проектируемых расширений**. Детальные JSON-схемы текущего сервера: `GET /api/v1/openapi.json` с действующим Bearer. OpenAPI сейчас 3.0.3; новую модель доступа описывает [API_ACCESS](API_ACCESS.md), порядок внедрения — [API_EVOLUTION](API_EVOLUTION.md).

Физическая очистка: GET/HEAD `R/storage/cleanup` (`storage.read`), PUT того же пути и POST `R/storage/cleanup/run` (`storage.manage`). Настройки с CAS, динамическая пауза, ограниченный проход и результат последнего выполнения: [ONLINE_CLEANUP](ONLINE_CLEANUP.md). Выполняется в фоне без остановки HTTP; 200 при запросе прохода не означает завершение удаления.

Expand Down
Loading