Реестр преобразований OGI

Преобразования сообщества для OGI, инструмента с открытым исходным кодом для OSINT и анализа связей.

Как это работает

Каждая директория в transforms/ — это независимо устанавливаемое преобразование. CLI OGI и интерфейс Transform Hub читают index.json (автоматически генерируется при каждом слиянии), чтобы узнать, что доступно.

Установка преобразования

Используйте CLI из проекта бэкенда OGI:

cd backend
uv sync
uv run ogi transform search shodan
uv run ogi transform install shodan-host-lookup

Или используйте интерфейс Transform Hub внутри OGI.

Переопределения ограничений времени выполнения

Преобразования сообщества в этом реестре наследуют переопределения ограничений преобразований на стороне хоста OGI. Операторы могут централизованно ограничивать или удалять общие максимальные настройки, такие как max_results, max_urls, max_links, max_content_chars или timeout_seconds, с помощью переменной окружения бэкенда:

OGI_TRANSFORM_SETTING_MAX_OVERRIDES=max_results=50,max_urls=25,max_links=40

Чтобы снять ограничение в локальном развертывании:

OGI_TRANSFORM_SETTING_MAX_OVERRIDES=max_results=none,max_content_chars=none

Это настраивается в основном приложении OGI, а не в этом репозитории реестра.

Встроенные преобразования (поставляются с OGI)

Вклад: добавление преобразования

1. Сделайте форк этого репозитория
2. Добавьте ваше преобразование в transforms/<category>/<slug>/
3. Включите файлы plugin.yaml, README.md и transforms/*.py
4. Объявляйте необходимые секреты в api_keys_required, а не в transform_settings
5. Откройте PR — CI проверяет автоматически

При добавлении ограниченных настроек предпочитайте общие имена, такие как max_results, max_urls, max_links, max_content_chars или timeout_seconds, если только настройка не является действительно специфичной для преобразования. Это сохраняет предсказуемость переопределений на стороне оператора во всей экосистеме.

Полное руководство см. в CONTRIBUTING.md.

Лицензия

AGPLv3