Skip to content

vanityURLs/code

logo

License Release Contributor Covenant All Contributors

vanityURLs is a Cloudflare Workers redirector for running a branded short-link domain as code. Links, schedules, destination policies, localized instance pages, and operator configuration live in Git; the build produces the Worker assets that Cloudflare deploys.

The documentation on the website is the source of truth for setup and operations.

Quickstart

Before starting, you need a registered short domain, GitHub and Cloudflare accounts, Git, Node.js 20 or newer, npm, and a text editor. The short domain must use Cloudflare as its authoritative DNS provider before the Worker can serve it.

Follow the documentation to spin your vanityURLs' instance.

Contributions

Contributions are welcome! We recognize all types based on the all-contributors specification. Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Benoît H. Dicaire
Benoît H. Dicaire

💻 📖 🛡️
Brian J. Adams
Brian J. Adams

🤔 📓
Félix Léger
Félix Léger

🤔 📓 📣
Jake Edwards
Jake Edwards

📖
Tiago Serafim
Tiago Serafim

💻

Related

  • dnsConfiguration – Automated DNS configuration with StackOverflow's DNSControl and Git

Licence

vanityURLs is Copyright 2023 Benoît H. Dicaire and licensed under the MIT licence.