Pipe Farm

Pipe Farm is an invite-only CLI tunnel service. Users authenticate with the web app, create pipes from the CLI, and monitor active/history/traffic from the dashboard.

Beta User Flow

npm install -g pipefarm
pipefarm login
pipefarm 3000

Hosted pipes are created only from the CLI. The CLI accepts local ports, not arbitrary remote URLs. The web dashboard shows active pipes, past pipes, and usage.

Runtime Environment

Production requires:

• DATABASE_URL: Postgres connection string.
• BETTER_AUTH_SECRET: at least 32 characters.
• BETTER_AUTH_URL: public app URL, such as https://pipe.farm.
• PIPEFARM_ADMIN_EMAILS: comma-separated global admin emails.
• RESEND_API_KEY: Resend API key for verification, invite, access, and password reset emails.
• EMAIL_FROM: transactional sender, such as Pipe Farm <[email protected]>.
• EMAIL_REPLY_TO: optional reply-to address.

Optional production tuning:

• PIPEFARM_ADMIN_HOST: default admin.${BASE_DOMAIN}.
• GRACEFUL_SHUTDOWN_MS: default 25000.
• AUTH_RATE_LIMIT_PER_MINUTE: default 30.
• CREATE_TUNNEL_LIMIT_PER_MINUTE: default 20.
• AGENT_CONNECT_LIMIT_PER_MINUTE: default 20.
• TUNNEL_REQUEST_LIMIT_PER_MINUTE: default 600.
• USER_TUNNEL_REQUEST_LIMIT_PER_MINUTE: default 1200.
• USER_DAILY_REQUEST_LIMIT: default 100000.
• USER_DAILY_BYTES_LIMIT: default 1073741824.
• MAX_ACTIVE_TUNNELS_PER_USER: default 25.
• MAX_CONCURRENT_TUNNEL_REQUESTS: default 100.
• MAX_CONCURRENT_TUNNEL_REQUESTS_PER_TUNNEL: default 20.
• MAX_TUNNEL_RESPONSE_BYTES: default 10485760.
• MAX_TUNNEL_HEADER_BYTES: default 32768.
• MAX_TUNNEL_HEADER_COUNT: default 80.
• TUNNEL_AUTH_FAIL_LIMIT_PER_MINUTE: default 10.
• CLI_EXCHANGE_LIMIT_PER_MINUTE: default 20.
• PIPEFARM_ALLOW_REMOTE_TARGETS: set to 1 only if remote proxy targets are intentionally allowed.

Local Development

npm install
npm run build
npm test
npm run dev

Use local mode when you do not want the CLI to talk to production:

PIPEFARM_MODE=local npm run dev

Run the bundled test app:

npm run test-app

Invite-Only Beta Access

1. A visitor requests access on https://pipe.farm.
2. Pipe Farm sends a Resend verification email.
3. The user verifies their email.
4. The global admin reviews verified requests at https://admin.pipe.farm.
5. Approval sends an invite email.
6. The user can sign in and run pipefarm login.

Health Checks

• GET /healthz: process liveness.
• GET /readyz: readiness; fails while draining or when Postgres is unavailable.

Production Beta Checklist

• Supabase/Postgres configured and reachable from Coolify.
• BETTER_AUTH_SECRET, BETTER_AUTH_URL, PIPEFARM_ADMIN_EMAILS, and Resend variables set in Coolify.
• Resend domain has SPF, DKIM, bounce/MX, and one _dmarc TXT record.
• pipe.farm, admin.pipe.farm, and wildcard pipe hosts route through the proxy.
• Coolify health check uses /readyz.
• npm run build, npm test, and npm audit --omit=dev pass before release.
• The real CLI package is published to npm after smoke testing the production login and tunnel flow.

Publishing The CLI

The npm package name is pipefarm.

npm run build
npm test
npm audit --omit=dev
npm publish --access public

Local Edge Utilities

The local edge scripts are for internal local development only:

npm run local-edge:install
npm run local-edge:status
npm run local-edge:uninstall