oiov
61 lines
2.0 KiB
Plaintext
61 lines
2.0 KiB
Plaintext
---
|
|
title: Introduction
|
|
description: Welcome to the WR.DO documentation.
|
|
---
|
|
|
|
<Callout type="danger" twClass="mb-3">
|
|
We will rigorously review the legitimacy of DNS records and URLs, and strongly advise users against using WRDO's free services for any illegal activities, such as copyright infringement, dissemination of malicious software, or phishing attempts, among others. These measures are in place to ensure the sustainable and stable operation of WRDO, providing a secure and reliable service environment for all users.
|
|
</Callout>
|
|
|
|
{/* <img className="rounded-xl border md:rounded-lg shadow-md" src="/_static/images/light-preview.png"/> */}
|
|
|
|
## Features
|
|
|
|
- 🌐 **Multi-Tenant Support:** Manage multiple DNS records seamlessly
|
|
- ⚡ **Instant Record Creation:** Set up CNAME, A, and other records quickly
|
|
- 🔗 **URL Shortening:** Generate short links effortlessly
|
|
- 💻 **User-Friendly Interface:** Intuitive and easy to navigate
|
|
- 🔒 **Secure & Reliable:** Built on Cloudflare's robust DNS API
|
|
- 💰 **Free Registration:** No cost to create and manage records
|
|
- 🔄 **Real-Time Updates:** Instant propagation of DNS changes
|
|
- 🚀 **Open Source:** Fully transparent, customizable code base
|
|
|
|
## Quick Start
|
|
|
|
See docs about [guide](/docs/quick-start) for quick start.
|
|
|
|
## Self-hosted Tutorial
|
|
|
|
### Requirements
|
|
|
|
- [Vercel](https://vercel.com) to deploy app
|
|
- [Cloudflare](https://dash.cloudflare.com/) account
|
|
- A **domain** name hosted on Cloudflare
|
|
|
|
See docs about [developer](/docs/developer/installation).
|
|
|
|
## Local development
|
|
|
|
copy `.env.example` to `.env` and fill in the necessary environment variables.
|
|
|
|
```bash
|
|
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
|
|
|
|
## License
|
|
|
|
[MIT](https://github.com/oiov/wr.do/LICENSE.md)
|
|
|
|
## Star History
|
|
|
|
[](https://star-history.com/#oiov/wr.do&Date)
|