Redirector

Redirector is a Cloudflare Workers script that uses Workers KV to manage and perform domain redirections.

Features

• Redirect any domain pointed to the worker to a desired target URL.
• One place (Workers KV) to manage all your redirect rules.
• Easy to deploy and manage using Cloudflare's Wrangler.

Requirements

• Cloudflare Account
• Wrangler CLI

Installation

1. Clone this repository:

   git clone https://github.com/CasualCodersProjects/redirector.git
   cd redirector

2. Install the dependencies:

   npm install

3. Update wrangler.toml:

   Ensure the details like name, kv_namespaces, and compatibility_date are accurate.

4. Set up Workers KV namespace:

   Create a KV namespace named RULES from the Cloudflare dashboard, replace the id field in wrangler.toml with the actual ID from Cloudflare dashboard.

Usage

1. Adding Redirect Rules

1. Go to the Cloudflare dashboard.
2. Navigate to Workers KV and find your RULES namespace.
3. Add Key-Value Pairs where keys are the domains you want to redirect and values are the target URLs.

2. Deploying the Worker

Deploy the worker to Cloudflare:

npm run deploy

OR

wrangler deploy

Project Structure

• src/index.ts: Main worker code. It fetches the rules from KV and performs redirects.
• Configuration files: .editorconfig, .prettierrc for coding standards; tsconfig.json for TypeScript settings.
• Deployment files: wrangler.toml, package.json for project dependencies and scripts.

Contributing

Feel free to fork this repository, make changes, and open a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.

---

Happy Redirecting!

For more details on Cloudflare Workers and Workers KV, refer to the Cloudflare Documentation.