Skip to content
raydak-labsPublic

About

No description, website, or topics provided.

Resources

Contributing

Stars

5 stars

Watchers

0 watching

Forks

Latest commit

 

History

558 Commits

Folders and files

Repository files navigation

Travo

Travo logo

A modern, mobile-first web UI for OpenWRT-based travel routers (GL.iNet Beryl AX MT3000, Slate AXT1800).

Provides an intuitive dashboard, WiFi management with hotel captive portal support, VPN/service management, and system configuration. Built as a Go backend + React frontend monorepo that coexists with LuCI.

Dashboard

Documentation

Quick Install

SSH into your OpenWRT router and run:

wget -O- https://raw.githubusercontent.com/raydak-labs/travo/main/scripts/install.sh | \
  sh -s -- --password 'your-strong-password'

The installer has no default password — it is the LuCI, SSH and Travo login for the whole device, so pass --password (min 8 characters) or run the script from a terminal to be prompted.

This installs Travo on port 80, AdGuard Home on port 3000 (DNS on 5353 via dnsmasq forwarding), and moves LuCI to port 8080. See docs/guides/deployment.md for all options and manual install instructions.

AdGuard credentials: no default account is installed. Create one from System → AdGuard Password in the Travo UI, which keeps the password out of your terminal's scrollback.

⚠️ AdGuard's own web UI on port 3000 is reachable by anyone on the LAN, and until an account exists it shows a first-run setup wizard that whoever completes first owns — so a guest on your hotel's network could take over DNS filtering for everyone. Set the password straight after installing, before handing the network to anyone else. Creating it from Travo adds an account rather than replacing one, so if the wizard was already completed by someone else you will share control with them. See ADR 0001 §2.5.

General

Architecture

┌─────────────────────────────────────────────┐
│              Browser (React SPA)            │
│  TanStack Query/Router, Shadcn/UI, Zustand  │
└──────────────────┬──────────────────────────┘
                   │ REST + WebSocket
┌──────────────────▼──────────────────────────┐
│           Go Backend (Fiber)                │
│  ┌─────────┐ ┌──────────┐ ┌──────────────┐ │
│  │ Auth    │ │ REST API │ │ WebSocket    │ │
│  │ (session│ │ handlers │ │ (live stats) │ │
│  │  +JWT)  │ │          │ │              │ │
│  └────┬────┘ └────┬─────┘ └──────┬───────┘ │
│       │           │               │         │
│  ┌────▼───────────▼───────────────▼───────┐ │
│  │        Service Layer                   │ │
│  │  UCI wrapper │ ubus client │ opkg mgr  │ │
│  └────────────────────────────────────────┘ │
│       │ (mock mode: in-memory fakes)        │
└───────┼─────────────────────────────────────┘
        │ exec / socket
┌───────▼─────────────────────────────────────┐
│            OpenWRT System                   │
│  UCI configs │ ubus │ init.d │ iwinfo      │
└─────────────────────────────────────────────┘

Features

  • Dashboard — Real-time system stats, connection status, quick actions
  • WiFi Management — Scan, connect, mode switching (client/repeater/AP)
  • Hotel Captive Portal — Automatic detection and one-click login
  • VPN Management — WireGuard and Tailscale configuration
  • Service Management — Install/manage AdGuard Home and other services
  • System Settings — Network, DNS, firewall configuration
  • Mobile-First — Responsive design optimized for phone access
  • Dark/Light Theme — System preference detection with manual toggle
  • LuCI Coexistence — Runs on port 80/443, LuCI relocated to 8080

Quickstart

Prerequisites

make install resolves all of these through mise (pnpm install + go mod download), so install mise first and let it pick the versions.

Setup

# Clone the repository
git clone https://github.com/raydak-labs/travo.git
cd travo

# Install Node + Go dependencies through the pinned mise toolchain
make install

# Run development servers
make dev

Troubleshooting: If the frontend shows a white page, the MSW service worker may be missing. Run cd frontend && pnpm exec msw init public --save to regenerate it.

Commands

Command Description
make install Install Node and Go dependencies (run once after cloning)
make dev Run frontend + backend dev servers
make build Build frontend and backend
make test Run all tests (Go + shared + frontend), with -count=1 on Go
make test-race Run the Go suite with the race detector
make lint pnpm lint (oxlint) + golangci-lint run over the Go packages
make format pnpm format (Prettier) + goimports -w over the Go packages
make format-check CI-style format gate: fails if any file is unformatted
make shellcheck Lint the device-mutating shell scripts
make coverage Go coverage summary (informational; not a gate)
make clean Remove build artifacts
make build-prod Cross-compile for OpenWRT (aarch64)
make build-all Cross-compile for aarch64 and x86_64
make package Create release .tar.gz (install layout)
make package-all Tarballs for aarch64 and x86_64
make deploy Deploy to router (needs ROUTER_IP)
make integration Run the on-device integration suites (mutates a real router)
make docker-dev Start Docker dev environment

Docker Development

docker compose up

Runs frontend (Vite + HMR) and backend (Air hot reload) in containers. Same ports: frontend on :5173, backend on :3000.

Building for OpenWRT

# Cross-compile binary for aarch64
make build-prod

# Create install tarball (matches GitHub Releases)
make package

See docs/guides/deployment.md for full details.

Deployment

# Deploy to router
make deploy ROUTER_IP=192.168.8.1

This copies the dev build to the router over SSH (default: binary + UI; use DEPLOY_METHOD=release for a full tree like the release tarball). Production installs use scripts/install.sh instead. See docs/guides/deployment.md.

Project Structure

travo/
├── frontend/          # React + TypeScript + Vite + TailwindCSS
│   ├── src/
│   │   ├── components/  # UI components
│   │   ├── pages/       # Page components
│   │   ├── lib/         # Utilities, API client
│   │   └── main.tsx     # Entry point
│   ├── index.html
│   └── vite.config.ts
├── backend/           # Go + Fiber
│   ├── cmd/server/    # Main server entry
│   └── internal/      # Internal packages
├── shared/            # Shared TypeScript types
│   └── src/
├── scripts/           # Dev and build scripts
├── Makefile
└── package.json       # Workspace root

Target Devices

  • GL.iNet Beryl AX (MT3000) — aarch64
  • GL.iNet Slate AXT1800 — aarch64
  • Any OpenWRT 23.05+ device (aarch64 or x86_64)

Releases

Pre-built install tarballs for aarch64 and x86_64 are available on GitHub Releases.

To create a new release, tag and push:

git tag v1.0.0
git push origin v1.0.0

The CI/CD pipeline automatically builds all artifacts and publishes a GitHub Release.

Contributing

See CONTRIBUTING.md for guidelines.

License

MIT — Copyright 2026 openwrt-travel-gui contributors

About

No description, website, or topics provided.

Resources

Contributing

Stars

5 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages