Vercel Doorman

A simple CLI tool for managing Vercel Firewall rules as code, enabling version control and automated deployment of your project's security configuration.

Features

• 🔒 Manage Firewall Rules: Create, update, and delete Vercel Firewall rules using a simple configuration file
• 🔄 Sync Rules: Easily sync rules between your configuration file and Vercel
• ⬇️ Download Rules: Import existing firewall rules from your Vercel project
• ✅ Validation: Built-in configuration validation to prevent errors
• 📋 List Rules: View current firewall rules in table or JSON format
• 🚀 CI/CD Integration: Automate firewall rule management in your deployment pipeline

Installation

npm install vercel-doorman
# or
yarn add vercel-doorman
# or
pnpm add vercel-doorman

Configuration

Create a vercel-firewall.config.json file in your project root:

{
  "projectId": "your-project-id",
  "teamId": "your-team-id",
  "rules": [
    {
      "name": "block-country",
      "type": "country",
      "action": "deny",
      "values": ["CN", "RU"],
      "active": true,
      "description": "Block traffic from specific countries"
    },
    {
      "name": "rate-limit-api",
      "type": "path",
      "values": ["/api"],
      "active": true,
      "description": "Rate limit API endpoints",
      "action": {
        "type": "log",
        "rateLimit": {
          "requests": 100,
          "window": "60s"
        },
        "duration": "1h"
      }
    },
    {
      "name": "redirect-legacy",
      "type": "path",
      "values": ["/old-path"],
      "active": true,
      "description": "Redirect legacy paths",
      "action": {
        "type": "allow",
        "redirect": {
          "location": "/new-path",
          "permanent": false // or true
        }
      }
    }
  ]
}

Usage

First, create a Vercel API Token with appropriate permissions.

Available Commands

List Current Rules

vercel-doorman list --token YOUR_TOKEN

Options:

• --projectId, -p: Vercel Project ID
• --teamId, -t: Vercel Team ID
• --token: Vercel API token
• --format, -f: Output format (json or table, defaults to table)

Sync Rules

vercel-doorman sync --token YOUR_TOKEN

Options:

• --config, -c: Path to config file (defaults to vercel-firewall.config.json)
• --projectId, -p: Vercel Project ID (can be set in config file)
• --teamId, -t: Vercel Team ID (can be set in config file)
• --token: Vercel API token

Download Remote Rules

vercel-doorman download --token YOUR_TOKEN

Downloads remote firewall rules from your Vercel project and updates your local configuration file. Includes a confirmation prompt before making changes.

Options:

• --config, -c: Path to config file (defaults to vercel-firewall.config.json)
• --projectId, -p: Vercel Project ID (can be set in config file)
• --teamId, -t: Vercel Team ID (can be set in config file)
• --token: Vercel API token
• --dry-run, -d: Preview changes without modifying the config file

Example workflow:

# First, preview the rules that would be downloaded
vercel-doorman download --dry-run

# Then, if the rules look correct, download and update the config
vercel-doorman download

Validate Configuration

vercel-doorman validate

Options:

• --config, -c: Path to config file (defaults to vercel-firewall.config.json)
• --verbose, -v: Show detailed validation results

Environment Variables

Instead of passing command-line arguments, you can set these environment variables:

• VERCEL_TOKEN: Your Vercel API token
• VERCEL_PROJECT_ID: Your Vercel project ID
• VERCEL_TEAM_ID: Your Vercel team ID

Contributing

Contributions are welcome!

Project Stats

License

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