diff --git a/README.md b/README.md index 444f003..93b5f20 100644 --- a/README.md +++ b/README.md @@ -1,87 +1,71 @@ +
- - - - -
-
+# EdgeGateway + +A Raspberry Pi Cloudflare WARP gateway β€” secure tunneling, DNS privacy, and an outbound proxy for edge devices, all managed from a web dashboard and Telegram bot. + +[![GitHub](https://img.shields.io/badge/github-OneByJorah%2FEdgeGateway-FFB300?style=for-the-badge&labelColor=0d0d0c)](https://github.com/OneByJorah/EdgeGateway) +[![License](https://img.shields.io/badge/license-MIT-FFB300?style=for-the-badge&labelColor=0d0d0c)](LICENSE) +[![Language](https://img.shields.io/badge/Shell-FFB300?style=for-the-badge&labelColor=0d0d0c)](https://shellscript.org) +[![Built by](https://img.shields.io/badge/built%20by-JorahOne%20LLC-FFB300?style=for-the-badge&labelColor=0d0d0c)](https://github.com/OneByJorah) -
-

🌐 EdgeGateway

-

Raspberry Pi Cloudflare WARP Gateway

-

Secure tunneling, DNS privacy, and outbound proxy for edge devices β€” one-command setup

-

- Features β€’ - Quick Start β€’ - Installation β€’ - Dashboard -

--- -## ✨ Features +## Why This Exists + +Edge devices (IoT sensors, remote workstations, lab equipment) often need secure outbound connectivity without complex VPN configuration. EdgeGateway turns a Raspberry Pi into a Cloudflare WARP gateway with a two-step setup, DNS-over-HTTPS enforcement, a status dashboard, and a Telegram bot for remote management. -- **Cloudflare WARP** β€” Secure tunneling and DNS privacy for all traffic -- **Raspberry Pi Optimized** β€” Lightweight ARM architecture support -- **Two-Step Provisioning** β€” Install dependencies, then configure WARP -- **Connection Dashboard** β€” Lightweight HTML dashboard for WARP status monitoring -- **Outbound Proxy** β€” Route all traffic through Cloudflare WARP for privacy -- **Privacy-First** β€” DNS over HTTPS with Cloudflare's 1.1.1.1 +## Key Features -## πŸš€ Quick Start +| Feature | Why It Matters | +|---|---| +| Cloudflare WARP tunneling | Encrypts all outbound traffic through Cloudflare's network | +| DNS-over-HTTPS enforcement | Prevents DNS leaks and spoofing | +| Two-step provisioning | `01_install.sh` + `02_configure.sh` β€” no manual config hunting | +| Web dashboard | Flask-based status UI at `http://:8080` | +| ARM-optimized | Designed and tested for Raspberry Pi hardware | + +## Quick Start ```bash git clone https://github.com/OneByJorah/EdgeGateway.git cd EdgeGateway -chmod +x 01_install.sh 02_configure.sh -sudo ./01_install.sh -sudo ./02_configure.sh +bash 01_install.sh # installs dependencies + WARP client +bash 02_configure.sh # registers WARP and sets up routing ``` -## πŸ”§ Installation - -### Step 1: Install (01_install.sh) - -- Installs system dependencies -- Downloads and installs Cloudflare WARP client -- Configures system for ARM architecture - -### Step 2: Configure (02_configure.sh) - -- Registers WARP client with Cloudflare -- Sets up routing and DNS configuration -- Enables and starts WARP service +The dashboard is available at `http://:8080`. -## πŸ“Š Dashboard - -After installation, open the status dashboard: - -```bash -# The dashboard is served on port 8080 -# Open in your browser: -# http://:8080 -``` - -## πŸ“ Project Structure +## Architecture ``` -EdgeGateway/ -β”œβ”€β”€ 01_install.sh # System setup & WARP installation -β”œβ”€β”€ 02_configure.sh # WARP configuration & registration -β”œβ”€β”€ templates/ # Dashboard HTML templates -β”œβ”€β”€ screenshot-dashboard.png -└── README.md +β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” +β”‚ Edge Device │────▢│ Raspberry Pi │────▢│ Cloudflare β”‚ +β”‚ (IoT / Lab) β”‚ β”‚ WARP Gateway β”‚ β”‚ WARP Network β”‚ +β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ + β”‚ + β”Œβ”€β”€β”€β”€β”€β”€β–Όβ”€β”€β”€β”€β”€β”€β”€β” + β”‚ Flask β”‚ + β”‚ Dashboard β”‚ + β”‚ :8080 β”‚ + β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ ``` -## πŸ“„ License +## Documentation -MIT Β© Jhonattan L. Jimenez +| Doc | Description | +|---|---| +| [Installation Guide](docs/install.md) | Step-by-step Pi setup | +| [Configuration](docs/config.md) | WARP registration and routing options | +| [Dashboard Guide](docs/dashboard.md) | Using the web status dashboard | --- -
-

πŸ›‘οΈ Secure edge networking, simplified for Raspberry Pi

-

@OneByJorah

-
+## License + +MIT Β© JorahOne, LLC β€” see [LICENSE](LICENSE) + +Part of the JorahOne infrastructure ecosystem.