Skip to main content

hostme

Личный аналог surge.sh: CLI на Python/uv, который одной командой деплоит статические сайты и простые PHP-скрипты на собственные VPS (через Webinoly), с поддержкой нескольких серверов и доменов.

Документация по продукту — docs/usage/: что такое hostme и чего он не делает, серверы и домены, настройки и реестр, контракт для агента, безопасность. Решения и их причины — docs/adr/. Для AI-агентов, работающих в этом репозитории — AGENTS.md.

Установка

Из Gitea-реестра (пакет релизится туда):

Или из git-тега, на любой машине:

uv tool install "rb-hostme @ git+https://homeserver.tailee01ab.ts.net:3000/bolandeu/rb_hostme.git@vX.Y.Z"

vX.Y.Z — последний тег релиза (только из тега, не из ветки). Дистрибутив называется rb-hostme, команда — hostme; обновление — uv tool upgrade rb-hostme.

При разработке самого hostme (в этом репозитории) — editable-режим, чтобы изменения в коде подхватывались без переустановки:

uv tool install --editable .

После изменения [project.scripts] в pyproject.toml editable-режим не перегенерирует уже установленный launcher-скрипт сам — обязательно uv tool install --editable . --force, иначе hostme из PATH продолжит звать старый entry point (см. AGENTS.md).

После любого из вариантов hostme доступен как обычная команда в PATH из любой директории.

Требования к серверу перед server add/server init

  • Чистый Ubuntu Server 24.04/26.04 LTS (arm64 или x86_64), минимум 512MB RAM — hostme server init сам ставит Webinoly (nginx+php-fpm), но ОС должна быть готова заранее
  • Открытые порты (входящие как минимум): 22/TCP (SSH), 80/TCP и 443/TCP+UDP (HTTP/HTTPS/HTTP3). Подробный список (включая исходящие для почты/GPG) — docs/usage/webinoly.md, раздел «Установка стека»
  • SSH-пользователь (обычно root) должен пускать по ключу (ssh_key в hostme server add) и иметь passwordless sudo — hostme/Webinoly не умеют отвечать на запрос пароля sudo
  • Перед первым server init: sudo apt update && sudo apt -y upgrade (и по-хорошему reboot) — руками, hostme этого не делает

Деплой

hostme <path> [domain] [--server NAME]

Заливка файлов идёт через rsync --delete: webroot на сервере становится точным зеркалом локальной папки на момент деплоя. Если файл убрать из path и задеплоить снова — на сервере он тоже исчезнет. Это сделано намеренно, чтобы повторный деплой был идемпотентным и не копил старые файлы — но по той же причине деплой не той (пустой/неверной) папки снесёт существующий контент сайта на сервере.

Где лежат настройки и данные

  • Настройки — ~/.config/hostme/: servers.yaml (серверы и target'ы), settings.yaml.

  • Данные (пишет сам hostme) — platformdirs.user_data_dir("hostme") (macOS ~/Library/Application Support/hostme, Linux ~/.local/share/hostme): sites.yaml + sites.d/, target-backups/<target>/<ts>/ — снепшоты target-сайта перед деплоем. До v0.4.0 всё лежало в ~/.config/hostme — переносится само при первом запуске.

  • Хранение бэкапов (settings.yaml, по умолчанию keep: 5 без срока; самый свежий не удаляется):

    target_backups:
      keep: 5            # последние N на target
      max_age_days: 30   # и/или удалять старше X дней
    
  • hostme doctor показывает путь, размер и политику бэкапов.

Для агентов

hostme --ai печатает встроенный SKILL.md (конвенции: --json, exit-коды, --dry-run/--confirm, правила для --target); hostme skill install кладёт его в ~/.claude/skills/hostme/. Список команд — голый hostme, полный справочник с примерами — hostme help (--json для агентов).

Разработка

Архитектура — по cli-builder: commands/ (только разбор аргументов) → core/ (сервисы, ошибки) → providers/ (ssh/rsync/lftp/Webinoly — всё, что выходит за пределы процесса), output/ (human/json, guard), credentials/ (пароли target'ов: env HOSTME_DEPLOY_<TARGET>_PASSWORD, иначе OS keychain hostme:<target>; auth status).

Проверка — один гейт: gate check на этой машине, команда — [publish] gate_command в .agents/antagor/antagor.toml. Из корня пакета:

gate check

(lock, ruff, ty, pytest с порогом покрытия и снапшотами --help, сверка [[tool.rb.external]] с кодом, сборка+установка колеса, правила Standard, gitleaks и osv-scanner, если установлены). Работа и релизы — через Antagor (antagor publish пишет CHANGELOG.md и ставит тег). Версия только из git-тега, version = в pyproject нет. План и прогресс — в Antagor: antagor board показывает задачи и их статусы, идеи — antagor idea list; файла-бэклога в репозитории нет.

Metadata

Release files for rb-hostme 0.6.18

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

Source distribution (sdist)

Source distribution for rb-hostme 0.6.18
File Size Uploaded Provenance Actions
rb_hostme-0.6.18.tar.gz 155.0 kB Without provenance Details for rb_hostme-0.6.18.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for rb-hostme 0.6.18
File Interpreter ABI Platform Actions
rb_hostme-0.6.18-py3-none-any.whl Python 3 none any Details for rb_hostme-0.6.18-py3-none-any.whl

Total release size: 263.0 kB

Release files / rb_hostme-0.6.18.tar.gz

Download URL rb_hostme-0.6.18.tar.gz
Size 155.0 kB
Tags Source
SHA-256 checksum
How to use checksums
5a5a8435c971e3ac7d7e6f69acf04e4ce58b957d39659af84e3a9c4c000777ec
BLAKE2b-256 checksum
How to use checksums
722e2b6776dd6c354f1dd70639e6dbacbd87b96e459c885e62ad43b5e44e2eb2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.4 {"installer":{"name":"uv","version":"0.13.4","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release files / rb_hostme-0.6.18-py3-none-any.whl

Download URL rb_hostme-0.6.18-py3-none-any.whl
Size 108.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
22079747600fb74b6c858d098e6d56d6e7f8c4ddd0d78fd4086743066cafd779
BLAKE2b-256 checksum
How to use checksums
91310f81a38285f648826f0c10ab004c13355a6642835abb01584399eacb859c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.4 {"installer":{"name":"uv","version":"0.13.4","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Security for rb-hostme 0.6.18

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.

No provenance found

None of the files in this release were uploaded with provenance metadata.

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.

Release history Release notifications | RSS feed

This release

0.6.18 This release

2 release files No provenance

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