zpan/README.md

ZPan

The open-source, S3-native file hosting platform.

Image bed, file sharing, and backup — powered by S3, deployed anywhere.

What is ZPan?

ZPan is a lightweight file hosting platform built on top of S3-compatible storage. Files upload directly from the client to S3, bypassing server bandwidth entirely.

Three scenarios, one platform:

• Image Bed — Upload via PicGo / ShareX / API, get a URL instantly
• File Sharing — Upload files, generate share links, distribute to anyone
• File Backup — CLI agent syncs local directories to S3/R2

Deploy

Cloudflare Workers (Recommended)

Deploy via GitHub Actions with zero server management. Free tier covers personal use.

1. Fork this repository
2. In your fork, go to Settings → Secrets and variables → Actions and add:
   • CLOUDFLARE_ACCOUNT_ID — found on the Cloudflare dashboard sidebar
   • CLOUDFLARE_API_TOKEN — create one here with Workers Scripts:Edit and D1:Edit permissions
3. Go to the Actions tab, select Deploy to Cloudflare Workers, and click Run workflow

After initial setup, the workflow runs automatically every time you sync your fork with the latest release.

Docker

docker compose up -d

Documentation

• Roadmap
• Contributing

Why ZPan?

• Zero bandwidth bottleneck — files transfer directly between client and S3
• Zero ops option — deploy to Cloudflare Workers for free, no server needed
• Self-host friendly — Docker deployment with any S3-compatible storage
• Tool ecosystem — works with PicGo, ShareX, Flameshot out of the box
• Open source — free forever for self-hosted users

v1

Looking for ZPan v1 (Go version)? See the v1 branch.

Contributing

See CONTRIBUTING.md for details.

Thank you to all the people who contributed to ZPan!

License

ZPan is under the GPL 3.0 license. See the LICENSE file for details.