Швидкий старт

Почніть роботу з Godwit Sync

Швидка, надійна та передбачувана синхронізація даних — для команд, які покладаються на S3 кожного дня. Почніть за лічені хвилини.

Що таке Godwit Sync?

Godwit Sync — це високопродуктивна утиліта передачі S3, що підтримує кілька режимів передачі:

S3 → Локальна файлова система
Локальна файлова система → S3
S3 → S3 (повністю на льоту, без локального сховища)

Вона спочатку створює детермінований план синхронізації (або тільки створює план з --plan-only), підтримує безпечне переривання та продовження через --resume, та дає вам точний контроль над пропускною здатністю через --rps та --read-bps.

Крок 1: Встановлення

Завантажте останній реліз для вашої платформи та розпакуйте бінарний файл:

# Install with Homebrew
brew tap godwitio/packages https://github.com/godwitio/packages
brew install godwit-sync

# Verify installation
godwit version

Or install manually:

# Download for Linux (x86_64)
curl -LO https://downloads.godwit.io/godwit-sync/latest/godwit-sync_linux_amd64.tar.gz

# Or for ARM64
curl -LO https://downloads.godwit.io/godwit-sync/latest/godwit-sync_linux_arm64.tar.gz

# Extract and move to PATH
tar -xzf godwit-sync_linux_*.tar.gz
sudo mv godwit /usr/local/bin/godwit

# Install with Scoop
scoop bucket add godwit https://github.com/godwitio/packages
scoop install godwit-sync

# Verify installation
godwit version

Or install manually with PowerShell:

Invoke-WebRequest -Uri "https://downloads.godwit.io/godwit-sync/latest/godwit-sync_windows_amd64.zip" -OutFile "godwit-sync.zip"
Expand-Archive -Path godwit-sync.zip -DestinationPath .

New-Item -ItemType Directory -Force -Path "C:\Program Files\godwit"
Move-Item godwit.exe "C:\Program Files\godwit\godwit.exe"

# Add to PATH (run as Administrator)
[Environment]::SetEnvironmentVariable("Path", $env:Path + ";C:\Program Files\godwit", "Machine")

# Install with Homebrew
brew tap godwitio/packages https://github.com/godwitio/packages
brew install godwit-sync

# Verify installation
godwit version

Or install manually:

# Download for Apple Silicon (M1/M2/M3/M4)
curl -LO https://downloads.godwit.io/godwit-sync/latest/godwit-sync_darwin_arm64.tar.gz

# Or for Intel
curl -LO https://downloads.godwit.io/godwit-sync/latest/godwit-sync_darwin_amd64.tar.gz

# Extract and move to PATH
tar -xzf godwit-sync_darwin_*.tar.gz
sudo mv godwit /usr/local/bin/godwit

# Download for FreeBSD (x86_64)
fetch https://downloads.godwit.io/godwit-sync/latest/godwit-sync_freebsd_amd64.tar.gz

# Extract the archive
tar -xzf godwit-sync_freebsd_*.tar.gz

# Move to PATH
sudo mv godwit /usr/local/bin/godwit

# Verify installation
godwit version

# Multi-arch tags include both linux/amd64 and linux/arm64.
# Docker will automatically pull the correct image for your machine.
IMAGE="godwitio/godwit-sync:latest"
# IMAGE="godwitio/godwit-sync:v1.0.1"  # specific version (also multi-arch)

# Pull the image
docker pull "$IMAGE"

# Run godwit sync via Docker
docker run --rm -v $(pwd)/data:/data -v $(pwd)/state:/state "$IMAGE" sync \
  --source /data \
  --destination s3://my-bucket/backup \
  --destination-endpoint localhost:9000 \
  --destination-access-key s3key \
  --destination-secret-key s3secret \
  --state-path /state/state.db

# Verify installation
docker run --rm "$IMAGE" version

Переглянути всі доступні теги на Docker Hub

Крок 2: Ліцензування

Godwit Sync пропонує безкоштовний режим для оцінки та платні ліцензії для продакшен використання:

Безкоштовний режим

Планування міграцій до 10GB. Ідеально для тестування та невеликих передач.

Ліцензований режим

До 10TB даних. Повний доступ до функцій. Комерційне використання. Зв'яжіться з нами, якщо потрібно більше.

# Register a license (saves beside the executable)
godwit sync --register <base64-license-key>

# Or provide license file per-run
godwit sync --license-file ./license.json ...

# Or provide inline base64 license
godwit sync --license <base64-string> ...

Крок 3: Ваша перша синхронізація

Почніть з простої синхронізації локальної папки до S3:

godwit sync \
  --source ./data \
  --destination s3://my-bucket/backup \
  --destination-endpoint localhost:9000 \
  --destination-access-key access_key \
  --destination-secret-key secret_key \
  --destination-secure=false \
  --state-path ./tmp/state.db \
  --logs-dir ./tmp/logs \
  --ui

Спочатку план

Використовуйте --plan-only, щоб побачити, що буде передано, перш ніж переміщувати дані:

# Create a plan without executing
godwit sync \
  --source ./data \
  --destination s3://my-bucket/backup \
  --destination-endpoint localhost:9000 \
  --destination-access-key access_key \
  --destination-secret-key secret_key \
  --destination-secure=false \
  --state-path ./tmp/state.db \
  --plan-only

# Review, then execute with resume
godwit sync \
  --source ./data \
  --destination s3://my-bucket/backup \
  --destination-endpoint localhost:9000 \
  --destination-access-key access_key \
  --destination-secret-key secret_key \
  --destination-secure=false \
  --state-path ./tmp/state.db \
  --resume

Крок 4: Увімкніть спостережуваність

Додайте --status-addr для надання endpoints метрик та статусу:

godwit sync \
  --source ./data \
  --destination s3://my-bucket/backup \
  --destination-endpoint localhost:9000 \
  --destination-access-key access_key \
  --destination-secret-key secret_key \
  --destination-secure=false \
  --status-addr :8080

Це надає:

/metrics— Prometheus-формат метрик (лічильники, гістограми, ETA)
/status— JSON підсумок поточного запуску

Наступні кроки

Довідник CLI

Дослідіть усі прапорці та параметри конфігурації.

Переглянути довідник CLI

Посібники

Покрокові посібники для типових сценаріїв.

Переглянути посібники

Швидкий старт

Почніть роботу з Godwit Sync

Що таке Godwit Sync?

Godwit Sync — це високопродуктивна утиліта передачі S3, що підтримує кілька режимів передачі:

S3 → Локальна файлова система
Локальна файлова система → S3
S3 → S3 (повністю на льоту, без локального сховища)

Крок 1: Встановлення

Завантажте останній реліз для вашої платформи та розпакуйте бінарний файл:

# Install with Homebrew
brew tap godwitio/packages https://github.com/godwitio/packages
brew install godwit-sync

# Verify installation
godwit version

Or install manually:

# Download for Linux (x86_64)
curl -LO https://downloads.godwit.io/godwit-sync/latest/godwit-sync_linux_amd64.tar.gz

# Or for ARM64
curl -LO https://downloads.godwit.io/godwit-sync/latest/godwit-sync_linux_arm64.tar.gz

# Extract and move to PATH
tar -xzf godwit-sync_linux_*.tar.gz
sudo mv godwit /usr/local/bin/godwit

# Install with Scoop
scoop bucket add godwit https://github.com/godwitio/packages
scoop install godwit-sync

# Verify installation
godwit version

Or install manually with PowerShell:

Invoke-WebRequest -Uri "https://downloads.godwit.io/godwit-sync/latest/godwit-sync_windows_amd64.zip" -OutFile "godwit-sync.zip"
Expand-Archive -Path godwit-sync.zip -DestinationPath .

New-Item -ItemType Directory -Force -Path "C:\Program Files\godwit"
Move-Item godwit.exe "C:\Program Files\godwit\godwit.exe"

# Add to PATH (run as Administrator)
[Environment]::SetEnvironmentVariable("Path", $env:Path + ";C:\Program Files\godwit", "Machine")

# Install with Homebrew
brew tap godwitio/packages https://github.com/godwitio/packages
brew install godwit-sync

# Verify installation
godwit version

Or install manually:

# Download for Apple Silicon (M1/M2/M3/M4)
curl -LO https://downloads.godwit.io/godwit-sync/latest/godwit-sync_darwin_arm64.tar.gz

# Or for Intel
curl -LO https://downloads.godwit.io/godwit-sync/latest/godwit-sync_darwin_amd64.tar.gz

# Extract and move to PATH
tar -xzf godwit-sync_darwin_*.tar.gz
sudo mv godwit /usr/local/bin/godwit

# Download for FreeBSD (x86_64)
fetch https://downloads.godwit.io/godwit-sync/latest/godwit-sync_freebsd_amd64.tar.gz

# Extract the archive
tar -xzf godwit-sync_freebsd_*.tar.gz

# Move to PATH
sudo mv godwit /usr/local/bin/godwit

# Verify installation
godwit version

# Multi-arch tags include both linux/amd64 and linux/arm64.
# Docker will automatically pull the correct image for your machine.
IMAGE="godwitio/godwit-sync:latest"
# IMAGE="godwitio/godwit-sync:v1.0.1"  # specific version (also multi-arch)

# Pull the image
docker pull "$IMAGE"

# Run godwit sync via Docker
docker run --rm -v $(pwd)/data:/data -v $(pwd)/state:/state "$IMAGE" sync \
  --source /data \
  --destination s3://my-bucket/backup \
  --destination-endpoint localhost:9000 \
  --destination-access-key s3key \
  --destination-secret-key s3secret \
  --state-path /state/state.db

# Verify installation
docker run --rm "$IMAGE" version

Переглянути всі доступні теги на Docker Hub

Крок 2: Ліцензування

Godwit Sync пропонує безкоштовний режим для оцінки та платні ліцензії для продакшен використання:

Безкоштовний режим

Планування міграцій до 10GB. Ідеально для тестування та невеликих передач.

Ліцензований режим

До 10TB даних. Повний доступ до функцій. Комерційне використання. Зв'яжіться з нами, якщо потрібно більше.

# Register a license (saves beside the executable)
godwit sync --register <base64-license-key>

# Or provide license file per-run
godwit sync --license-file ./license.json ...

# Or provide inline base64 license
godwit sync --license <base64-string> ...

Крок 3: Ваша перша синхронізація

Почніть з простої синхронізації локальної папки до S3:

godwit sync \
  --source ./data \
  --destination s3://my-bucket/backup \
  --destination-endpoint localhost:9000 \
  --destination-access-key access_key \
  --destination-secret-key secret_key \
  --destination-secure=false \
  --state-path ./tmp/state.db \
  --logs-dir ./tmp/logs \
  --ui

Спочатку план

Використовуйте --plan-only, щоб побачити, що буде передано, перш ніж переміщувати дані:

# Create a plan without executing
godwit sync \
  --source ./data \
  --destination s3://my-bucket/backup \
  --destination-endpoint localhost:9000 \
  --destination-access-key access_key \
  --destination-secret-key secret_key \
  --destination-secure=false \
  --state-path ./tmp/state.db \
  --plan-only

# Review, then execute with resume
godwit sync \
  --source ./data \
  --destination s3://my-bucket/backup \
  --destination-endpoint localhost:9000 \
  --destination-access-key access_key \
  --destination-secret-key secret_key \
  --destination-secure=false \
  --state-path ./tmp/state.db \
  --resume

Крок 4: Увімкніть спостережуваність

Додайте --status-addr для надання endpoints метрик та статусу:

godwit sync \
  --source ./data \
  --destination s3://my-bucket/backup \
  --destination-endpoint localhost:9000 \
  --destination-access-key access_key \
  --destination-secret-key secret_key \
  --destination-secure=false \
  --status-addr :8080

Це надає:

/metrics— Prometheus-формат метрик (лічильники, гістограми, ETA)
/status— JSON підсумок поточного запуску

Наступні кроки

Довідник CLI

Дослідіть усі прапорці та параметри конфігурації.

Переглянути довідник CLI

Посібники

Покрокові посібники для типових сценаріїв.

Переглянути посібники