https://github.com/davidkk/vercel-proxy-rule

https://github.com/davidkk/vercel-proxy-rule

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/davidkk/vercel-proxy-rule
• Owner: DavidKk
• License: mit
• Created: 2025-01-21T09:58:24.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2025-02-17T16:53:52.000Z (3 months ago)
• Last Synced: 2025-02-17T17:40:53.627Z (3 months ago)
• Language: TypeScript
• Homepage: https://vercel-proxy-rule.vercel.app
• Size: 290 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://github.com/DavidKk/vercel-proxy-rule/actions/workflows/coverage.workflow.yml/badge.svg)](https://github.com/DavidKk/vercel-proxy-rule/actions/workflows/coverage.workflow.yml) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![中文](https://img.shields.io/badge/%E6%96%87%E6%A1%A3-%E4%B8%AD%E6%96%87-green?style=flat-square&logo=docs)](https://github.com/DavidKk/vercel-proxy-rule/blob/main/README.zh-CN.md) [![English](https://img.shields.io/badge/docs-English-green?style=flat-square&logo=docs)](https://github.com/DavidKk/vercel-proxy-rule/blob/main/README.md)

# Proxy Rule Management

Centralized management and generation of remote proxy rules, suitable for unified rule management across multiple clients.

- **Supported Clients**: Currently supports Clash only. Ensure your client supports `RULE-SET`.

- **Supported Rules**:

  - Supports gfwlist rules (automatically merged into proxy rules, cannot be managed separately).

  - Supports ZeroOmega rules (automatically merged into proxy rules, cannot be managed separately).

## Deploy to Vercel

[![Deploy to Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FDavidKk%2Fvercel-proxy-rule)

### Environment Variable Configuration

Refer to the [`.env.example`](./.env.example) file to set the required environment variables.

#### Required Environment Variables

- `GIST_ID`: GitHub Gist Id

- `GIST_TOKEN`: GitHub Gist Token

- `ACCESS_USERNAME`: Admin username

- `ACCESS_PASSWORD`: Admin password

- `ACCESS_2FA_SECRET`: 2FA secret, can use [https://vercel-2fa.vercel.app](https://vercel-2fa.vercel.app) to generate token

- `JWT_SECRET`: JWT secret

- `JWT_EXPIRES_IN`: JWT expiration time

- `ZERO_OMEGA_URL`: ZZero Omega Config Backup URL

## Quick Start

1. Create a **GitHub Gist** and generate a **GitHub Access Token**.

2. Set the corresponding environment variables in Vercel.

3. Once deployed, you can manage proxy rules through the generated configuration.