ergosteur/ipinfo repository overview

⁠ipinfo

⁠Overview

ipinfo is a Python/Flask "what is my IP" service that provides your IP address and related information through a simple web interface. It supports multiple output formats including JSON, plain text, CSV, pfSense compatible output, and themed HTML pages.

⁠Features

• Displays your IP address and related info.
• Multiple output formats: JSON, text, CSV, pfSense.
• Themed web interface with different visual styles, including a Windows 98 theme.
• Security: Runs as a non-root user in both Docker and manual deployments.
• Rate Limiting: Built-in rate limiting with support for IP whitelisting.
• Automated Tests: Includes a comprehensive pytest suite.
• Easy deployment with Docker Compose.
• Supports multiple Traefik deployment modes for HTTPS.
• Configuration through environment variables.

The Windows 98 theme is inspired by and uses the 98.js project (https://github.com/1j01/98⁠) to recreate the classic UI look and feel.

⁠Deployment

Note:
For accurate detection of client IP addresses, ipinfo is best deployed on a VPS or VM with its own public IP address. The default Traefik or Caddy configuration requires that ports 80 and 443 are available on the host. If you prefer not to use the included Traefik setup, the Flask app can also be integrated into your own existing reverse proxy configuration.

⁠Quickstart with systemd

The deploy.sh script autonomously installs all dependencies (including Caddy), sets up the ipinfo user, and configures the systemd service.

git clone https://github.com/ergosteur/ipinfo.git
cd ipinfo/
# Use -h to see all available options (whitelist, cloudflare, etc.)
sudo ./deploy.sh -h

# Standard deploy
sudo ./deploy.sh -d yourdomain.com -e [email protected]

⁠Quickstart with docker compose

The Docker Compose setup provides three deployment modes, including a DNS-01 challenge mode for Cloudflare to support wildcard certificates. It uses the official ergosteur/ipinfo⁠ image from Docker Hub.

git clone https://github.com/ergosteur/ipinfo.git
cd ipinfo/
cp example.env .env
# Edit .env and set your BASE_DOMAIN, EMAIL, and optional CF tokens
docker compose up -d

⁠DNS Setup

For the application to function correctly and provide separate IPv4/IPv6 endpoints, you should configure the following DNS records in your DNS provider:

Note: Ensure that your server has a public IPv6 address if you intend to use the IPv6/AAAA records.

⁠Manual Deployment (deploy.sh)

The deploy.sh script is provided for users who prefer a traditional systemd + reverse proxy (Caddy) setup without Docker. It handles environment checks, user creation, dependency installation, and SSL configuration.

⁠Usage

# First deployment with domain and email
./deploy.sh -d example.com -e [email protected] -w "1.1.1.1,2.2.2.2"

# Update an existing deployment
./deploy.sh -u

⁠Cloudflare DNS Automation

The script supports optional Cloudflare DNS automation to simplify DNS setup and enable wildcard DNS-01 challenges in Caddy.

./deploy.sh -d example.com -e [email protected] -t YOUR_CF_TOKEN -z YOUR_CF_ZONE

⁠Docker Deployment Modes

The Docker Compose setup uses Traefik v3 as a reverse proxy. There are three primary modes:

1. HTTP-01 (Default)
   Uses Traefik's HTTP-01 challenge to obtain Let's Encrypt certificates automatically. Suitable for most standard setups.

2. DNS-01 Cloudflare (Wildcard)
   Uses Traefik's DNS-01 challenge with Cloudflare to obtain wildcard certificates. Requires Cloudflare API tokens configured via environment variables.

3. LAN Development Mode
   Intended for local development on a LAN. Uses ephemeral self-signed certificates instead of Let's Encrypt.

⁠Configuration via .env

The application and infrastructure are configured via environment variables in a .env file:

• BASE_DOMAIN — The base domain name for your deployment.
• LETSENCRYPT_EMAIL — Email address used for Let's Encrypt registration.
• WHITELIST_IPS — Comma-separated list of IPs to exempt from rate limiting.
• STRICT_HOST_CHECK — Set to false to disable host validation (default: true).
• NO_IP_VERSION_SUBDOMAINS — Set to true to hide the IPv4/IPv6 version switcher UI (default: false).
• WIN98_DEFAULT — Set to true to make the Windows 98 theme the default page at / (default: false).
• CLOUDFLARE_API_TOKEN — Cloudflare API token for DNS-01 challenge mode and DNS automation.

Refer to example.env for all configurable variables.

⁠Development

To develop or customize the application:

1. Install dependencies:

   pip install -r requirements.txt
   

   Copy
2. Run tests:

   pytest
   

   Copy
3. Run locally:

   # Set your real domain or a dummy one
   export BASE_DOMAIN="ip.example.com"
   # Disable strict host check for easier local testing
   export STRICT_HOST_CHECK="false"
   python app.py
   

   Copy

⁠License

Like the upstream 98.css, this project is not yet licensed.
This project is currently source-available / shared source⁠, but not open source⁠.

Enjoy using ipinfo for your IP address needs!