Docs
Introduction
Introduction
Welcome to the WR.DO documentation.
Introduction
WR.DO is a all-in-one web utility platform featuring short links with analytics, temporary email service, subdomain management, open APIs for screenshots and metadata extraction, plus comprehensive admin dashboard.
Features
-
🔗 Short Link Service:
- Custom short links
- Generate custom QR codes
- Password-protected links
- Expiration time control
- Access analytics (real-time logs, maps, and multi-dimensional data analysis)
- API integration for link creation
-
📮 Email Service:
- Create custom prefix emails
- Filter unread email lists
- Unlimited mailbox creation
- Receive unlimited emails (powered by Cloudflare Email Worker)
- Send emails (powered by Resend)
- API endpoints for mailbox creation
- API endpoints for inbox retrieval
-
🌐 Subdomain Management Service:
- Manage DNS records across multiple Cloudflare accounts and domains
- Create various DNS record types (CNAME, A, TXT, etc.)
-
📡 Open API Module:
- Website metadata extraction API
- Website screenshot capture API
- Website QR code generation API
- Convert websites to Markdown/Text format
- Comprehensive API call logging and statistics
- User API key generation for third-party integrations
-
🔒 Administrator Module:
- Multi-dimensional dashboard with website analytics
- Dynamic service configuration (toggle short links, email, subdomain management)
- User management (permissions, quotas, account control)
- Centralized short link administration
- Centralized email management
- Centralized subdomain administration
Screenshots
![]() | ![]() |
![]() | ![]() |
![]() | ![]() |
Quick Start
See docs about guide for quick start.
Self-hosted Tutorial
See step by step installation tutorial at Quick Start for Developer.
Requirements
- Vercel to deploy app
- Cloudflare account
- A domain name hosted on Cloudflare
See docs about developer.
Local development
copy .env.example
to .env
and fill in the necessary environment variables.
git clone https://github.com/oiov/wr.do
cd wr.do
pnpm install
# run on localhost:3000
pnpm dev
Community Group
- Discord: https://discord.gg/d68kWCBDEs