WR.DO

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)
    • Support catch-all emails
    • Support push to telegram groups
    • 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.)
    • Support enabling application mode (user submission, admin approval)
    • Support email notification of administrator and user domain application status

  • 💳 Cloud Storage Service

    • Connects to multiple channels (S3 API) cloud storage platforms (Cloudflare R2, AWS S3)
    • Supports single-channel multi-bucket configuration
    • Dynamic configuration (user quota settings) for file upload size limits
    • Supports drag-and-drop, batch, and chunked file uploads
    • Supports batch file deletion
    • Quickly generates short links and QR codes for files
    • Supports online preview of certain file types
    • Supports file uploads via API calls

  • 📡 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)
    • Dynamically configure login methods (Google, GitHub, Magic Link, Credentials, LinuxDO)
    • 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

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

License

MIT

Star History

Star History Chart

Quick Start