Skip to content

v1.2.2

Latest
Latest

Choose a tag to compare

View all tags
@github-actions github-actions released this 25 Jun 02:16
v1.2.2
c8731a3

API Monitor 1.2.2

This release publishes ready-to-run API Monitor binaries and a multi-arch Docker image.

Docker image

ghcr.io/baogutang/api-monitor:v1.2.2
ghcr.io/baogutang/api-monitor:latest

Supported Docker platforms:

  • linux/amd64
  • linux/arm64

Docker Compose deployment

mkdir -p api-monitor
cd api-monitor
curl -fsSLO https://raw.githubusercontent.com/baogutang/api-monitor/main/docker-compose.release.yml

cat > .env <<'ENVEOF'
HTTP_PORT=5090
API_MONITOR_IMAGE=ghcr.io/baogutang/api-monitor:v1.2.2
POSTGRES_PASSWORD=replace-with-a-strong-password
APP_SECRET=replace-with-at-least-32-random-characters
DEFAULT_SCAN_INTERVAL_SECONDS=60
GITHUB_REPO=baogutang/api-monitor
ENABLE_SELF_UPDATE=false
ENVEOF

docker compose -f docker-compose.release.yml up -d

Open:

http://<server-ip>:5090

Upgrade an existing Docker deployment

cd api-monitor
sed -i.bak 's#^API_MONITOR_IMAGE=.*#API_MONITOR_IMAGE=ghcr.io/baogutang/api-monitor:v1.2.2#' .env
docker compose -f docker-compose.release.yml pull api worker
docker compose -f docker-compose.release.yml up -d
docker compose -f docker-compose.release.yml ps

The API service runs database migrations automatically on startup. Keep the same APP_SECRET value across upgrades; changing it invalidates encrypted upstream credentials.

Binary artifacts

Download the matching tarball below:

  • api-monitor_1.2.2_linux_amd64.tar.gz
  • api-monitor_1.2.2_linux_arm64.tar.gz
  • api-monitor_1.2.2_darwin_amd64.tar.gz
  • api-monitor_1.2.2_darwin_arm64.tar.gz

Each archive includes:

  • api-monitor binary
  • built web assets
  • database migrations
  • docker-compose examples
  • README, docs, and .env.example

Required runtime services

  • PostgreSQL 14+
  • Redis 6+
  • One API service process: api-monitor api
  • One worker process: api-monitor worker

Version check and self-update

API Monitor can check this GitHub Release from the Settings page when GITHUB_REPO=baogutang/api-monitor is configured.

Self-update is intentionally disabled by default. Enable it only in a trusted deployment environment:

ENABLE_SELF_UPDATE=true
UPDATE_COMMAND='docker compose -f docker-compose.release.yml pull api worker && docker compose -f docker-compose.release.yml up -d'

Rollback

Set API_MONITOR_IMAGE back to the previous tag and restart:

docker compose -f docker-compose.release.yml pull api worker
docker compose -f docker-compose.release.yml up -d

Always keep database volumes and Redis volumes mounted. Do not delete them during upgrades or rollbacks.

Assets 6
Loading