Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.blnkfinance.com/llms.txt

Use this file to discover all available pages before exploring further.

For production deployments, install or build the Watch binary and run it with the start command. This gives you the standard long-running Watch process: the HTTP service starts, and when DB_URL is set, Watch also runs continuous Core sync in the same process.

​
Standard deployment

Use direct download to fetch and install the Watch binary on your system. No Git or Go is required for the binary itself.
1

Install Watch

Install the Watch binary without cloning the repo or building from source:
curl -fsSL https://blnkfinance.xyz/install/watch | bash
This installs the blnk-watch binary on your machine.
2

Set environment variables

Set the environment variables Watch needs:
.env
# PostgreSQL database connection string
DB_URL=postgres://user:password@localhost:5432/blnk?sslmode=disable

# GitHub repo containing your .ws rule files (required when not using a local rules directory)
WATCH_SCRIPT_GIT_REPO=https://github.com/your-org/watch-rules.git
WATCH_SCRIPT_GIT_BRANCH=main
See Configuration for the full list, including Git authentication for private repos.
3

Start Watch

Run Watch with the start command:
start
blnk-watch start

​
For PaaS deployments (Railway, Render, Fly.io, etc)

The same deployment steps apply, but you need to attach a persistent volume to the container. Watch stores its data on disk. However, most PaaS platforms have a temporary disk that is wiped on redeploys. To prevent this, attach a persistent volume mounted at ./blnk_watch_db so that data survives restarts and redeploys.