paperclip/docs/deploy/overview.md at f60c1001ec809a6aa898efd1d119d326e52f2216

Files

Dotta f60c1001ec refactor: rename packages to @paperclipai and CLI binary to paperclipai

Rename all workspace packages from @paperclip/* to @paperclipai/* and
the CLI binary from `paperclip` to `paperclipai` in preparation for
npm publishing. Bump CLI version to 0.1.0 and add package metadata
(description, keywords, license, repository, files). Update all
imports, documentation, user-facing messages, and tests accordingly.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

2026-03-03 08:45:26 -06:00

1.4 KiB

Raw Blame History

title, summary

title	summary
Deployment Overview	Deployment modes at a glance

Paperclip supports three deployment configurations, from zero-friction local to internet-facing production.

Deployment Modes

Mode	Auth	Best For
`local_trusted`	No login required	Single-operator local machine
`authenticated` + `private`	Login required	Private network (Tailscale, VPN, LAN)
`authenticated` + `public`	Login required	Internet-facing cloud deployment

Quick Comparison

Local Trusted (Default)

Loopback-only host binding (localhost)
No human login flow
Fastest local startup
Best for: solo development and experimentation

Authenticated + Private

Login required via Better Auth
Binds to all interfaces for network access
Auto base URL mode (lower friction)
Best for: team access over Tailscale or local network

Authenticated + Public

Login required
Explicit public URL required
Stricter security checks
Best for: cloud hosting, internet-facing deployment

Choosing a Mode

Just trying Paperclip? Use local_trusted (the default)
Sharing with a team on private network? Use authenticated + private
Deploying to the cloud? Use authenticated + public

Set the mode during onboarding:

pnpm paperclipai onboard

Or update it later:

pnpm paperclipai configure --section server

1.4 KiB Raw Blame History