Next Whois

repository·main·Indexed 20 days ago

https://github.com/zmh-program/next-whois

A high-performance WHOIS and RDAP lookup tool built with Next.js. It supports searching for domains, IPv4, IPv6, ASN, and CIDR, prioritizing RDAP with a WHOIS fallback. Key features include a responsive UI with PWA support, server-side caching via Redis, Moz metric integration (DA/PA/Spam Score), and an Open API for programmatic lookups and dynamic Open Graph image generation via Satori.

Tokens
7.1K
Snippets
26
Records
33
Agent score
68%

What's inside next-whois

  1. Overview of Next Whois

    main

    Next Whois is a fast and modern WHOIS/RDAP search tool built with Next.js. It supports searching for domains, IPv4, IPv6, ASN, and CIDR, prioritizing RDAP with a fallback to WHOIS. Key features include:

    • Dynamic OG Images: Generated via /api/og using Satori.
    • Responsive UI: Built with Shadcn UI and Tailwind CSS, including PWA support.
    • Search Capabilities: Local history with search/filtering, EPP status descriptions, and registrar/NS branding detection.
    • Performance: Server-side caching with Redis and Cache-Control headers.
    • Extensibility: Open API for programmatic access and Moz metric integration (DA/PA/Spam Score).
  2. Deploy Next Whois

    main

    You can deploy Next Whois using managed platforms, Docker, or by running the source code locally.

    One-click deployment is available for:

    Docker

    Run the pre-built image using Docker:

    docker run -d -p 3000:3000 programzmh/next-whois-ui

    Local Development

    To run the project from source, use pnpm:

    git clone https://github.com/zmh-program/next-whois-ui
    cd next-whois-ui
    pnpm install
    pnpm dev
  3. Deploy Next Whois from source

    main

    To run the project locally for development or custom builds, clone the repository and use pnpm to install dependencies and start the development server.

    git clone https://github.com/zmh-program/next-whois-ui
    cd next-whois-ui
    pnpm install
    pnpm dev
  4. Install and run Next Whois from source

    main

    To set up the development environment from the source code, follow these steps:

    1. Clone the repository.
    2. Navigate to the directory.
    3. Install dependencies using pnpm.
    4. Start the development server.
    git clone https://github.com/zmh-program/next-whois-ui
    cd next-whois-ui
    pnpm install
    pnpm dev
  5. Configure Next Whois with environment variables

    main

    Use the following environment variables to configure site metadata, history limits, Moz metrics, and Redis caching.

    | Variable | Description | Default |
    |----------|-------------|---------|
    | `NEXT_PUBLIC_SITE_TITLE` | Site title | Next Whois |
    | `NEXT_PUBLIC_SITE_DESCRIPTION` | Site description | — |
    | `NEXT_PUBLIC_SITE_KEYWORDS` | Site keywords | — |
    | `NEXT_PUBLIC_HISTORY_LIMIT` | Max history items (-1 = unlimited) | -1 |
    | `NEXT_PUBLIC_MAX_WHOIS_FOLLOW` | Max domain WHOIS follow depth | 0 |
    | `MOZ_ACCESS_ID` | Moz API Access ID | — |
    | `MOZ_SECRET_KEY` | Moz API Secret Key | — |
    | `REDIS_HOST` | Redis host (empty = cache disabled) | — |
    | `REDIS_PORT` | Redis port | 6379 |
    | `REDIS_PASSWORD` | Redis password | — |
    | `REDIS_DB` | Redis database index | 0 |
    | `REDIS_CACHE_TTL` | Cache TTL in seconds | 3600 |
  6. Configure Next Whois via environment variables

    main

    Use the following environment variables to customize the site behavior, SEO, Moz integration, and Redis caching.

    NEXT_PUBLIC_SITE_TITLE      # Site title (Default: Next Whois)
    NEXT_PUBLIC_SITE_DESCRIPTION # Site description
    NEXT_PUBLIC_SITE_KEYWORDS    # Site keywords
    NEXT_PUBLIC_HISTORY_LIMIT     # Max history records (-1 = unlimited, Default: -1)
    NEXT_PUBLIC_MAX_WHOIS_FOLLOW # Max WHOIS follow depth (Default: 0)
    MOZ_ACCESS_ID                 # Moz API Access ID
    MOZ_SECRET_KEY                # Moz API Secret Key
    REDIS_HOST                    # Redis host (Leave empty to disable caching)
    REDIS_PORT                    # Redis port (Default: 6379)
    REDIS_PASSWORD                # Redis password
    REDIS_DB                      # Redis database index (Default: 0)
    REDIS_CACHE_TTL               # Cache TTL in seconds (Default: 3600)
  7. Configure Next Whois environment variables

    main

    Use the following environment variables to customize the site behavior, SEO, and integrations.

    VariableDescriptionDefault
    NEXT_PUBLIC_SITE_TITLESite titleNext Whois
    NEXT_PUBLIC_SITE_DESCRIPTIONSite description
    NEXT_PUBLIC_SITE_KEYWORDSSite keywords
    NEXT_PUBLIC_HISTORY_LIMITMaximum number of history items (-1 for unlimited)-1
    NEXT_PUBLIC_MAX_WHOIS_FOLLOWMaximum depth for domain WHOIS tracking0
    MOZ_ACCESS_IDMoz API Access ID
    MOZ_SECRET_KEYMoz API Secret Key
    REDIS_HOSTRedis host (leave empty to disable caching)
    REDIS_PORTRedis port6379
    REDIS_PASSWORDRedis password
    REDIS_DBRedis database index0
    REDIS_CACHE_TTLCache TTL in seconds3600