Link Redirect Service - Open Source Self-Hosted Version

A secure, open-source link redirection service built on Cloudflare Pages Functions. Deploy it yourself and take full control of your link management with multiple encryption methods and comprehensive security features.

Key Features

• ✅ Multiple Redirection Methods
  • Traditional URL parameter redirection
  • AES-256 encrypted redirection
• 🔐 Security Features
  • JWT session management
  • Domain whitelist validation
  • Referer security checks
  • Delayed redirection with target URL display
  • Click statistics and logging
• 🎨 User-Friendly
  • Clean management interface
  • One-click encrypted link generation
  • Support for custom source identification
  • Configurable delay time
• 🚀 Self-Hosted
  • Deploy to Cloudflare Pages for free
  • Full control over your data
  • Customizable configuration
  • Open-source with community contributions

Self-Deployment Guide

1. Prerequisites

• A Cloudflare account
• Node.js installed on your local machine
• Git installed on your local machine

2. Get the Source Code

# Clone the repository
git clone https://github.com/your-username/link-redirect-service.git

# Navigate to the project directory
cd link-redirect-service

3. Install Wrangler CLI

# Install Wrangler CLI globally
npm install -g wrangler

4. Login to Cloudflare

# Authenticate with Cloudflare
wrangler login

5. Configure Environment Variables

Create a .dev.vars file for local development and configure environment variables in the Cloudflare Pages dashboard for production:

Required Variables

• GENERATE_PAGE_PASSWORD: Password for accessing the admin interface
• ENCRYPTION_KEY: AES encryption key (recommended: 32+ characters, generate with openssl rand -base64 32)
• JWT_SECRET: JWT signing secret (recommended: 32+ characters, generate with openssl rand -base64 32)

Optional Variables for Self-Deployment

• SESSION_TIMEOUT: Session timeout in seconds (default: 3600)
• DEFAULT_DELAY: Default delay time in milliseconds (default: 3000)
• ENABLE_REFERER_CHECK: Enable Referer checking (default: true)
• ENABLE_DELAY: Enable delayed redirection (default: true)
• ALLOWED_DOMAINS: Restrict target domains, comma-separated (e.g., example.com,test.org)
• ALLOWED_REFERERS: Restrict source domains, comma-separated
• C_ENCRYPTION_KEY: AES encryption key for /c/ redirects
• R_ENCRYPTION_KEY: AES encryption key for /r/ redirects

6. Test Locally (Optional)

# Run the development server
wrangler pages dev public

# Access the local development server at http://localhost:8788

7. Deploy to Cloudflare Pages

# Deploy to production
wrangler pages deploy public --project-name=link-redirect-service

# Or deploy to a preview environment
wrangler pages deploy public --project-name=link-redirect-service --branch=preview

8. Configure Custom Domain (Optional)

After deployment, you can configure a custom domain through the Cloudflare Pages dashboard:

1. Go to your Cloudflare Pages project
2. Click on "Custom domains" in the left sidebar
3. Click "Set up a custom domain"
4. Follow the instructions to add your domain and configure DNS records

9. Configure KV Namespace for Persistent Statistics (Optional)

For persistent click statistics, set up a Cloudflare KV namespace:

# Create KV namespace
wrangler kv:namespace create "REDIRECT_STATS"

# Update wrangler.toml to include the KV binding
# Add the following to wrangler.toml:
# [[kv_namespaces]]
# binding = "REDIRECT_STATS"
# id = "YOUR_KV_NAMESPACE_ID"
# preview_id = "YOUR_PREVIEW_KV_NAMESPACE_ID"

# Redeploy the project
wrangler pages deploy public

Usage

1. Access Your Deployed Service

After successful deployment, access your service at the URL provided by Cloudflare Pages or your custom domain.

2. Traditional Redirection (Unencrypted)

Pass parameters directly in the URL:

https://your-custom-domain.com/redirect?to=https://example.com&source=newsletter&delay=5000

Parameter description:

• to: Target URL (required)
• source: Source identifier (optional)
• delay: Delay time in milliseconds (optional)

3. Encrypted Redirection

Use the admin interface to create secure encrypted links:

1. Visit https://your-custom-domain.com/login
2. Enter the password you configured in GENERATE_PAGE_PASSWORD
3. Fill in the target URL and optional parameters on the generation page
4. Click to generate the encrypted link

Generated link format:

• AES-256 Encrypted: https://your-custom-domain.com/e/encrypted-data

4. Admin Interface

The admin interface allows you to:

• Generate encrypted links
• Configure link parameters
• View basic usage statistics

Access the admin interface at https://your-custom-domain.com/generate (requires login).

Project Structure

.
├── functions/              # Cloudflare Pages Functions
│   ├── api/               # API routes
│   │   ├── login.js       # Login API
│   │   ├── logout.js      # Logout API
│   │   └── generate.js    # Link generation API
│   ├── e/                 # AES encrypted redirection
│   │   └── [[path]].js    # Dynamic route
│   ├── lib/               # Utility library
│   │   └── utils.js       # Common functions
│   ├── index.js           # Home page
│   ├── login.js           # Login page
│   ├── generate.js        # Generation page
│   ├── redirect.js        # Traditional redirection
│   └── health.js          # Health check
├── public/                # Static files directory
├── wrangler.toml          # Cloudflare configuration
└── README.md              # Project documentation

API Endpoints

• GET / - Home page and usage instructions
• GET /login - Login page
• POST /api/login - Login API
• POST /api/logout - Logout API
• GET /generate - Link generation page (requires login)
• GET /api/generate - Link generation API (requires login)
• GET /redirect?to=URL - Traditional redirection
• GET /e/{encrypted} - AES encrypted redirection
• GET /health - Health check

Security Recommendations

1. Strong Password: Use a strong password for GENERATE_PAGE_PASSWORD
2. Key Management: Regularly rotate ENCRYPTION_KEY and JWT_SECRET
3. Domain Restrictions: Configure ALLOWED_DOMAINS to limit target domains
4. Referer Checks: Configure ALLOWED_REFERERS to limit sources
5. HTTPS: Ensure the service is accessed over HTTPS
6. Log Monitoring: Regularly check logs for abnormal access

Differences from Workers Version

Advantages of Cloudflare Pages Functions

1. File System Routing: More intuitive route structure
2. Static Assets: Can directly host static files
3. Automatic Deployment: Git integration with automatic deployment
4. Free Tier: Higher free request quota

Major Changes

1. Routing Method: Changed from single entry to file system routing
2. Context Object: Uses context object instead of env and ctx
3. Export Method: Uses onRequest* functions for exports
4. Modularization: Better code organization and modularity

Development

Local Development

# Install dependencies
npm install wrangler -g

# Run locally
wrangler pages dev public

# Access http://localhost:8788

Deployment

# Deploy to production
wrangler pages deploy public --project-name=link-redirect-service

# Deploy to preview environment
wrangler pages deploy public --project-name=link-redirect-service --branch=preview

Troubleshooting

1. Login Failure

• Check if the GENERATE_PAGE_PASSWORD environment variable is correctly configured
• Check the browser console for error messages

2. Encrypted Link Inaccessible

• Check if the ENCRYPTION_KEY environment variable is configured
• Ensure the key is consistent between generation and access

3. JWT Session Expired

• Check if the JWT_SECRET environment variable is configured
• Adjust SESSION_TIMEOUT to increase session duration

License

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

Copyright (c) 2026 Link Redirect Service

Maintenance & Updates

Updating Your Deployment

To keep your self-hosted instance up to date:

# Pull the latest changes
git pull origin main

# Redeploy the project
wrangler pages deploy public --project-name=link-redirect-service

Monitoring Your Deployment

Monitor your Cloudflare Pages deployment using:

• Cloudflare Pages dashboard for request metrics
• Cloudflare Workers Logs for detailed logging
• Custom webhook notifications (configure via WEBHOOK_URL)

Security Best Practices for Self-Deployment

1. Regular Updates: Keep your deployment updated with the latest security patches
2. Strong Passwords: Use a strong password for the admin interface
3. Secure Keys: Use unique, randomly generated encryption keys and JWT secrets
4. Domain Restrictions: Configure ALLOWED_DOMAINS to prevent abuse
5. HTTPS Only: Ensure your custom domain uses HTTPS with a valid SSL certificate
6. Monitor Usage: Regularly check logs for unusual activity

Contributing to the Project

As an open-source project, we welcome contributions from the community:

1. Report Issues: Submit bug reports and feature requests on GitHub Issues
2. Submit Pull Requests: Contribute code improvements and new features
3. Improve Documentation: Help us improve this documentation
4. Share Feedback: Let us know how we can improve the service

Please read our contributing guidelines before submitting contributions.

Community Support

Join our community for support and discussions:

• GitHub Issues: For bug reports and feature requests
• GitHub Discussions: For questions and general discussions
• Documentation: This comprehensive guide