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 website is the source of truth for setup and operations:

• Getting started
• Customize your instance
• Local CLI
• Full documentation

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.

Clone the vanityURLs code, detach the clone from the upstream project, then install dependencies:

git clone https://github.com/vanityURLs/code.git redirector
cd redirector
npm run detach
npm install

Run the installer, install local helpers, then validate the plain instance:

npm run setup
npm run local-install
npm run check

Review wrangler.toml and set the Worker name plus the route or custom domain for your short domain. Keep instance-specific files in custom/; do not edit defaults/ unless you are contributing upstream changes to vanityURLs itself.

Initialize Git, push the repository to GitHub, and connect it to Cloudflare Workers & Pages. You can also deploy manually:

npx wrangler deploy --config wrangler.toml

After the first redirect works, use the documentation to customize branding, legal pages, analytics, protected dashboards, and local workstation helpers.

Run npm run setup first to configure the instance, then npm run local-install to install workstation helpers. Run npm run local-publish after local edits when you want checks, commit selection, and push handled in one step. Run ./scripts/lnk --help for the local link-management quick reference.

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 💻 📖 🛡️

Brian J. Adams 🤔 📓

Félix Léger 🤔 📓 📣

Jake Edwards 📖

Tiago Serafim 💻

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

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