Skip to main content

edgevault

Encrypted backups for Python projects: Postgres, SQLite, files and secrets → S3, Google Drive, Yandex Disk, SFTP, with Telegram alerts. Docs are in Russian.

Зашифрованные бэкапы для проекта: Postgres, SQLite, папки, секреты. Подключается к бэкенду как обычная библиотека, настраивается его же settings, запускается вместе с проектом. О сбое приходит сообщение в Telegram: какой проект, какой сервер, что сломалось и что делать.

Базы edgevault не меняет: подключения к Postgres только на чтение (запись отклонит сам сервер), SQLite открывается только на чтение, удаляет edgevault только свои старые копии. Места на диске не хватит — прогон пропустит и скажет, а не переполнит диск под базой.

Python 3.11, 3.12, 3.13, 3.14 — тесты идут на каждой. Из зависимостей — только cryptography.

Внедрение в проект — чеклист

  1. Зависимость с ограничением сверху — новая минорная версия не приедет на прод сама: edgevault~=0.8.
  2. Образ проекта:
    • postgresql-client той же версии, что сервер Postgres, или новее;
    • tzdata, если расписание по местному времени (check предупредит, если нет).
  3. app/backup.py (пример ниже):
    • Postgres — напрямую к базе, не через pgbouncer;
    • Secrets — .env целиком (Secrets(root="/secrets", patterns=(".env",)));
    • Telegram(..., proxy=...), если Telegram с сервера доступен только через прокси.
  4. Сервис в compose: тот же образ, отдельный процесс; копии — в /srv/edgevault/<проект> на сервере; .env — только на чтение:
      backup:
        build: .
        command: python -m app.backup
        env_file: .env
        volumes:
          - /srv/edgevault/my-project:/backups
          - ./.env:/secrets/.env:ro
        restart: unless-stopped
    
  5. На сервере: docker compose run --rm backup python -m app.backup check, затем … run. Ручные запуски — под тем же пользователем, что и сервис (без -u root): иначе служебные файлы станут чужими, и следующий прогон упадёт на правах.
  6. На своём компьютере: edgevault link root@host:/srv/edgevault/my-project --name my-project — и копии сами скачиваются к вам.
  7. Через неделю: edgevault pull --status и сообщение «восстановление проверено».

В проект за три шага

1. Зависимость

uv add edgevault        # или pip install edgevault

2. Файл app/backup.py — всё, что нужно знать о бэкапе проекта:

from edgevault import Postgres, S3, Secrets, Telegram, Vault

from app.config import settings

vault = Vault(
    "my-project",
    recipients=settings.BACKUP_AGE_KEY,  # открытый ключ age1…
    sources=[
        Postgres(settings.DATABASE_URL),  # можно postgresql+asyncpg://…
        Secrets(env=["SECRET_KEY", "FERNET_KEY"]),  # ключи, без которых дамп не прочитать
    ],
    targets=[S3(settings.BACKUP_S3_URL)],  # https://KEY:SECRET@host/bucket/папка
    notify=Telegram(settings.BOT_TOKEN, settings.ADMIN_CHAT_ID),
    every="1h",  # или schedule=["04:00"]
    verify_days=7,  # раз в неделю — пробное восстановление
    store="/backups",
)

if __name__ == "__main__":
    vault.cli()  # python -m app.backup [daemon|run|check|test-notify]

3. Запуск — как удобно:

Как Что написать
Отдельный сервис рядом (рекомендую) в docker-compose.yml — сервис ниже
Внутри приложения, фоном vault.start() при старте, vault.stop() при остановке
Один раз python -m app.backup run, или vault.run() из своего кода
  backup:
    build: .                        # тот же образ, что у бэкенда
    command: python -m app.backup
    env_file: .env
    volumes: ["backups:/backups"]
    restart: unless-stopped

Внутри приложения — например, FastAPI:

@asynccontextmanager
async def lifespan(app):
    vault.start()  # расписание в своём потоке, приложению не мешает
    yield
    vault.stop()

Несколько воркеров uvicorn с одной папкой копий — не страшно: прогон делает один, остальные молча пропускают. Но если API масштабируется на несколько машин, берите отдельный сервис.

Sync или async — без разницы, и проект он не ломает

  • start() возвращается сразу. Проверки, сеть, pg_dump — в своём потоке с пониженным приоритетом: цикл событий asyncio и потоки приложения не ждут.
  • Async-код: async with vault: или vault.start() … await vault.astop(), разовый прогон — await vault.arun(). Sync-код (Django, Flask, скрипты): with vault: или start()/stop(), разовый — vault.run().
  • Ошибка в окружении (пустой BACKUP_AGE_KEY, опечатка в ключе) не роняет импорт и старт приложения: бэкап выключается и говорит почему — в журнал, в check и в чат. Выключить явно, например в dev: Vault(..., enabled=settings.IS_PROD).
  • run() и прогоны по расписанию не бросают исключений: всё — в отчёт и в чат.
  • Запускайте start() в процессе воркера (lifespan, on_startup), а не при импорте: с gunicorn --preload поток, запущенный до fork, в воркеры не попадёт.

Ключ — один раз, на своём компьютере

uv tool install edgevault
edgevault keygen --name my-project   # → ~/.config/edgevault/keys/my-project.txt (права 600)

Ключ ложится не в текущую папку, а в ~/.config/edgevault/keys/ — из папки проекта его легко закоммитить или потерять вместе с ней. Путь внутри рабочей копии git, не закрытый .gitignore, keygen не примет. Открытый age1… — в настройки проекта (recipients), закрытый — в менеджер паролей и link --key.

Две роли edgevault. Библиотека (Vault в коде) живёт в .venv проекта — своя версия на проект. Команды машины (link, unlink, pull, systemd, keygen, authorize) меняют общее состояние — службы, ~/.config/edgevault, ключи — и выполняются одной общей программой из uv tool (или pipx). Запустили такую команду из .venv проекта — edgevault сам выполнит её общей программой; если та старше — остановится и скажет обновить (uv tool upgrade edgevault); если её нет — команды, ставящие службу, откажутся (--allow-project-env, если сознательно). Служба никогда не переезжает с общей программы на программу из .venv.

На сервер кладут только открытый age1…: украденная копия без закрытого ключа бесполезна. Программа age не нужна — шифрование встроено, но копии расшифровывает и обычный age -d.

До старта скажет, чего не хватает

python -m app.backup check (и сам start()/daemon при запуске — в журнал и сообщением) проверяет всё, что можно проверить, ничего не делая:

  ✗ Программа pg_dump: не установлена, а нужна, чтобы снимать Postgres по адресу
    → Добавьте в Dockerfile образа: RUN apt-get update && apt-get install -y --no-install-recommends postgresql-client
  ✗ Программа pg_dump: версии 17, а сервер Postgres 18: старый pg_dump новую базу не снимет
  ✗ Отправка → s3://storage.yandexcloud.net/backups: HTTP 403 SignatureDoesNotMatch …
    → Ключи S3 неверны или у них нет прав на бакет

Команда установки — под систему образа (Debian, Alpine) или машины. Внешние программы нужны не всегда:

Что в конфиге Что нужно поставить
Postgres(url) postgresql-client той же версии, что сервер, или новее
S3, Folder, Sqlite, Files, Secrets, шифрование ничего
Rclone("gdrive:…") — Google/Яндекс Диск, SFTP rclone
Postgres в соседних контейнерах (container, discover) docker и смонтированный docker.sock

Что сохранять

Postgres(settings.DATABASE_URL)  # по адресу; база из адреса
Postgres(host="db", user="app", password=..., databases=["app", "auth"])
Postgres(container="app-db")  # pg_dump внутри контейнера базы
Postgres(discover=True, compose_project="app")  # все базы своего compose-проекта
Sqlite("data/*.sqlite3")  # согласованная копия, даже если пишут
Files("uploads", exclude=["cache/*"])  # папка архивом
Secrets(env=["SECRET_KEY"])  # переменные окружения
Secrets(root=".", patterns=[".env", "config.py"])  # или файлы

Сжатие

Всё сжимается до шифрования (зашифрованное уже не сжать):

Что Как Копия
Postgres pg_dump -Fc (gzip внутри дампа) …__база.dump.age
Postgres, compression="zstd" zstd: меньше и быстрее, нужен Postgres 16+ то же имя
SQLite gzip, обычно в 3–5 раз sqlite__имя.sqlite3.gz.age
Папки, секреты tar.gz files__….tar.gz.age, secrets.tar.gz.age

В отчёте видно, сколько дало сжатие: SQLite app: 120,0 МБ → 31,2 МБ (в 3,8 раза). restore и пробное восстановление разжимают сами; decrypt одного файла подскажет gunzip. Испорченный архив не распакуется молча: в gzip есть контрольная сумма. compression — "zstd", "zstd:5", "lz4", "gzip:9"; check скажет заранее, если pg_dump старше 16 для zstd/lz4.

Куда отправлять

S3("https://KEY:SECRET@s3.ru-1.storage.selcloud.ru/bucket/my-project")
S3(
    endpoint="https://storage.yandexcloud.net",
    bucket="b",
    prefix="app",
    access_key=...,
    secret_key=...,
    region="ru-central1",
)
Folder("/mnt/backup-disk/my-project")  # другой диск, NFS, volume
Rclone("gdrive:Backups/my-project", {"type": "drive", "token": settings.GDRIVE_TOKEN})
Rclone("yadisk:Backups/my-project", {"type": "yandex", "token": settings.YADISK_TOKEN})
Rclone(
    "box:/backups",
    {
        "type": "sftp",
        "host": "backup.example.ru",
        "user": "b",
        "key_file": "/run/secrets/backup_key",
    },
)

Мест можно несколько: не дошло в одно — остальные всё равно получают копию. Хотя бы одно — у другого провайдера, не там, где сервер. Без мест копии лежат только в store; их можно забирать к себе: edgevault pull.

Токен Google/Яндекс Диска: edgevault authorize gdrive (или yandex) на своём компьютере — откроется вход в браузере. Полученная строка — пароль от Диска: сразу в .env сервера и никуда больше. У Google Диска доступ только к файлам, которые положил сам edgevault. У Яндекс Диска токен даёт доступ ко всему Диску аккаунта: ограничить папкой через rclone не получится (доступ только к папке приложения rclone не поддерживает — по крайней мере, это не подтверждено), поэтому для бэкапов лучше отдельный аккаунт Яндекса.

Старые копии на Яндекс Диске edgevault удаляет насовсем, а не в Корзину (Корзина занимает ту же квоту): hard_delete = "true" подставляется сам, явное "false" уважается. check показывает свободное место на Диске и предупреждает, если после следующей отправки останется меньше 10%.

Как часто и сколько хранить

schedule=["03:30", "15:30"] — в эти часы, every="1h" — каждый час (30m, 2h, 6h…). Между бэкапами данные могут потеряться — это окно и задаёт расписание: при every="1h" теряется не больше часа. Время — по TZ контейнера; check пишет, по какому поясу идёт расписание, и предупреждает, если TZ задан, а tzdata в образе нет (тогда время молча считалось бы по UTC).

Хранение — keep=Keep(...):

По умолчанию Что это
local_days 3 сколько дней копии лежат в store
daily_days 14 сколько дней — в местах хранения
monthly_days 365 копия первого числа — год
all_runs_days 2 все прогоны дня — за последние 2 дня, раньше — последний прогон дня

Так every="1h" не превращается в сотни копий: сутки-двое — каждый час, дальше — по одной на день, месячные — год.

min_free_gb=1 — сколько места должно остаться на диске после бэкапа (и не меньше 5% диска). Не хватает — прогон пропускается с сообщением.

Пробное восстановление

То, что дамп читается, ещё не значит, что он восстановится. С verify_days=7 раз в неделю edgevault разворачивает свежий дамп во временный Postgres, смотрит, что все таблицы на месте, и удаляет его:

· восстановление app-db / app проверено: 42 таблиц, ~1830000 строк, 38 с
  • Рабочую базу не трогает: временный Postgres — отдельный контейнер без сети, на одном ядре, сравнение — с оглавлением самого дампа.
  • Образ — тот же, что у базы (с её расширениями: PostGIS, pgvector), для базы по адресу — postgres той же версии, что в дампе. Свой — verify_image="…".
  • Нужен Docker: в сервисе бэкапа — смонтированный /var/run/docker.sock. Без него check скажет об этом, а бэкапы идут как обычно.
  • Не прошла — сообщение с причиной и повтор через сутки.
  • SQLite проверяется каждый раз сам: копия — это готовая база, и integrity_check проходит по ней целиком.

Копии — к себе на компьютер

edgevault link root@203.0.113.10:/srv/edgevault/my-project --name my-project

Одна команда на своём компьютере. Ваш обычный доступ по SSH (агент, пароль) нужен один раз — для настройки:

  • ключи сервера сверяются с ssh-keyscan и записываются все (ed25519, ecdsa, rsa);
  • создаётся отдельный ключ ~/.ssh/edgevault_<сервер>;
  • на сервере — свой пользователь у каждого проекта (edgevault-<проект>): только чтение и только своя папка /srv/edgevault/<проект> (chroot + internal-sftp -R, без оболочки). На сервере могут быть проекты разных владельцев: чужие копии не читаются, даже список проектов не виден — /srv/edgevault получает права 711, а папки проектов — без доступа «для всех» (контейнерам-владельцам, root и выданным правам это не мешает). Основной sshd_config не меняется — свой файл в sshd_config.d (Match Group edgevault-pull), перед применением sshd -t, применяется через reload. Копии читаются по ACL;
  • сразу проверяется новым ключом: свои копии читаются, а чужое — нет (ни вне /srv/edgevault, ни другие проекты), запись не проходит, оболочка не открывается. Хоть что-то не так — ошибка. Не удалось подключиться для проверки — тоже ошибка, а не «проверено»;
  • проект дописывается в общий ~/.config/edgevault/pull.toml (права 600), пробное скачивание, служба автозапуска.

Повтор безопасен — ничего не дублирует. --dry-run показывает, что будет сделано, и ничего не меняет. Нет root на сервере — --print-server-steps напечатает шаги для админа. Сообщения: --telegram-token-from root@host:/path/.env:BOT_TOKEN и --telegram-chat-from … (токен на экран не выводится). Отключить — edgevault unlink my-project (с --server — и ключ на сервере); скачанное остаётся.

edgevault pull --status      # когда скачивали, свежая копия, место, проверка, служба
edgevault pull --install     # служба systemd пользователя (link делает это сам)
edgevault pull --uninstall   # убрать службу; копии остаются

Служба запускает ту же программу, которой вы выполнили --install, а не первую найденную в PATH. Ставьте её общей программой (uv tool install edgevault, затем ~/.local/bin/edgevault pull --install): из .venv проекта команда предупредит — при пересоздании окружения служба сломалась бы. Повторный --install сверяет юнит целиком и, если что-то поменялось, переписывает и перезапускает службу.

pull --once и link показывают, сколько предстоит скачать, ход скачивания и итог; служба пишет в журнал коротко.

Проверка восстановления у себя

На компьютере есть и Docker, и закрытый ключ — проверяется ровно та копия, что скачана. В [pull] pull.toml:

key_file = "~/age-key.txt"   # общий: для проектов без своего ключа
verify_days = 7              # 0 — выключить

[pull.keys]                  # у каждого проекта — свой ключ age
shop = "~/.config/edgevault/keys/shop.txt"
blog = "~/.config/edgevault/keys/blog.txt"

link --key <ключ> записывает ключ проекта сам и сразу проверяет, что он открывает скачанные копии: чужой ключ — ошибка в link (а не тревога через неделю), и pull.toml при этом не меняется. Есть age-key.txt в текущей папке — link предложит его. pull --status по каждому проекту пишет, какой ключ используется и открывает ли он свежую копию.

Раз в неделю свежий дамп расшифровывается во временную папку (700), разворачивается во временный Postgres той же версии (контейнер без сети, одно ядро, 2 ГБ памяти) и сверяется с оглавлением; архив секретов — расшифровывается, перечисляются файлы (содержимое — нет). Всё временное удаляется всегда — и после ошибки, и по Ctrl+C. В чат: «восстановление my-project проверено: 58 таблиц, ~55 000 строк, 41 с»; не прошла — сообщение со звуком. Сейчас: pull --verify-now.

Сообщения

🟠 my-project · бэкап с проблемами
prod-1 · 07.11.2026 04:00

Что не так (1):
• Отправка → s3://storage.yandexcloud.net/backups
  HTTP 403 SignatureDoesNotMatch
  💡 Ключи S3 неверны или у них нет прав на бакет

Копии: 2 · 8,9 МБ
Места хранения: s3://storage.yandexcloud.net/backups ✗

🔴 — копий нет, 🟠 — часть не сделана, ✅ — снова в порядке. Параметры Vault: on_success (сообщать и об успехах, без звука), on_recovery (по умолчанию да), remind_hours (тот же сбой — не чаще раза в N часов), server (имя сервера в сообщении). Telegram(token, "-100…, @ops", thread=42) — несколько чатов и тема форума; Webhook(url) — JSON со всеми полями. Проверить: python -m app.backup test-notify.

on_success="daily" — об успехах одна тихая сводка в день (сколько прогонов, копий, какого размера, когда последний; время — daily_digest="09:00"), о сбоях — сразу. on_success=True — как раньше, после каждого прогона.

Секреты в выводе не появляются: токен бота (bot***), логины и пароли в адресах (://***@), пароли, токены и ключи из конфига заменяются на *** — в журнале, чате, webhook, check, ошибках rclone и pg_dump, трейсбеках.

Через прокси

Если с сервера Telegram доступен только через VPN или прокси, задайте его только для сообщений, бэкапы через него не пойдут:

notify = Telegram(settings.BOT_TOKEN, settings.ADMIN_CHAT_ID, proxy="http://vpn:1080")
Webhook("https://hooks.example/backup", proxy="http://user:pass@proxy:3128")

В edgevault.toml: telegram_proxy и webhook_proxy в [notify]. Поддерживаются только http(s)-прокси, socks — нет: такой адрес будет ошибкой сразу, а не в день аварии. Пароль прокси и токен бота в журналах и выводе заменяются на ***. test-notify пишет, через какой прокси ушло сообщение.

Без proxy сообщения идут, как настроена система (HTTPS_PROXY, NO_PROXY). Встроенный S3 и Folder прокси из окружения не читают, а rclone читает: HTTPS_PROXY на весь процесс погонит через прокси и копии в Google/Яндекс Диск.

Вывод и журнал

Каждое действие — одной строкой со временем, значок говорит, чем кончилось:

2026-11-08 04:00:01 → Postgres app-db / shop: снимаю…
2026-11-08 04:00:04 ✓ Postgres app-db / shop: зашифровано, 12,4 МБ за 3 с
2026-11-08 04:00:04 → s3://storage.yandexcloud.net/backups: отправляю…
2026-11-08 04:00:09 ✓ s3://storage.yandexcloud.net/backups: отправлено за 5 с
2026-11-08 04:00:09 ✗ SQLite ~/app/data.db: нет файлов по этому пути
2026-11-08 04:00:09 ✉ сообщение отправлено: бэкап с проблемами

✓ — готово, ✗ — ошибка (следом «→ что делать»), ! — внимание, → — что идёт, · — подробность. В терминале значки цветные; в журнал службы, в файл и при NO_COLOR — чистый текст. Подробнее или тише — EDGEVAULT_LOG=debug|info|warning. Внутри вашего приложения (vault.start()) библиотека пишет в логгер edgevault и молчит, пока вы не настроите logging; ошибки — уровнем WARNING.

Восстановление

edgevault restore ~/Backups/my-project/daily/2026-11-07/1736 -k age-key.txt -o ./restore

Расшифровывает весь прогон (папка — права 700), секреты распаковывает в restore/secrets, печатает готовые команды (createdb …, pg_restore …). --into postgresql://… — сразу в базу, но только в пустую: в непустую откажется, флага в обход нет. Открытый ключ вместо закрытого — понятная ошибка. Один файл — edgevault decrypt <копия>.age -k age-key.txt -o <выход>.

Раскладка копий везде одна: daily/ГГГГ-ММ-ДД/ЧЧММ/<копия>.age, monthly/ГГГГ-ММ/<копия>.age.

Без кода: edgevault.toml

Для проектов, в код которых лезть не хочется, — отдельная программа и один конфиг: edgevault init в папке проекта напишет его сам (найдёт Postgres в compose-файлах, SQLite, .env), справочник — examples/edgevault.toml. Запуск — edgevault daemon, таймером sudo edgevault systemd --install или образом ghcr.io/vasiliynemix/edgevault:0.7 рядом с проектом.

Обновление

semver, что изменилось — в CHANGELOG.md.

  • в проекте: uv add edgevault@latest (или поднять версию в зависимостях) и uv lock;
  • программа: uv tool upgrade edgevault;
  • образ: тег 0.7 сам указывает на последнее исправление — docker compose pull.

После обновления — check.

Разработка

uv sync
uv run pytest && uv run ruff check . && uv run ruff format --check . && uv run mypy edgevault
scripts/release.sh 0.5.1     # выпуск: проверки → версия → коммит, тег, push → CI → PyPI

Metadata

Release files for edgevault 0.11.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for edgevault 0.11.2
File Size Uploaded Provenance Actions
edgevault-0.11.2.tar.gz 238.1 kB With provenance Details for edgevault-0.11.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for edgevault 0.11.2
File Interpreter ABI Platform Actions
edgevault-0.11.2-py3-none-any.whl Python 3 none any Details for edgevault-0.11.2-py3-none-any.whl

Total release size: 372.9 kB

Release files / edgevault-0.11.2.tar.gz

Download URL edgevault-0.11.2.tar.gz
Size 238.1 kB
Tags Source
SHA-256 checksum
How to use checksums
36b19c0092a9551ff5a0d9254d0b221193978ab438fdaea2304c2a8bb74937dc
BLAKE2b-256 checksum
How to use checksums
d07be927f557d804bfd0ca59c95d4587a8ebe26043aad003a655f62515cea766
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 8, 2026.

Transparency log

Release files / edgevault-0.11.2-py3-none-any.whl

Download URL edgevault-0.11.2-py3-none-any.whl
Size 134.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
745b15f253edf1285c7e9a060fa6fb4d4ac4f880271f0566a184af4dfce0dfc4
BLAKE2b-256 checksum
How to use checksums
9cd1613169a1b23bc123f0b5fccea54f2d592b5e2d0f9e3c318302e24015b137
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 8, 2026.

Transparency log

Security for edgevault 0.11.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for edgevault-0.11.2.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 8, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page