Skip to content

trusted-technologies/cuttlefish

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

30 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ¦‘ Cuttlefish Looking Glass

An open-source Looking Glass with a master/slave architecture, written in Go. The master provides a web UI for selecting a slave, viewing its IPv4/IPv6 addresses, running network tools (ping, mtr, traceroute, iperf3), and downloading test files.

✨ Features

  • πŸ–₯️ Web UI in the style of shadcn (Tailwind CSS).
  • 🐳 Master and Slave written in Go, packaged in separate Docker images.
  • πŸ“‘ Streaming command output via Server-Sent Events.
  • πŸ“Š Real-time network interface traffic charts (RX/TX area charts).
  • πŸ“ Test files: 1M, 10M, 100M, 1G, 10G, 100G (configurable).
  • πŸš€ Ready-to-use images built via GitHub Actions and published to GHCR.

🌐 Demo

A live Looking Glass demo is available as the ApexNodes hosting page: https://cuttlefish.apexnodes.xyz/

πŸ“Έ Screenshots

Slaves list

Slave details

⚑ Quick install

The installer is interactive. It installs Docker, generates tokens, optionally sets up Nginx with SSL, and configures the master or slave for you. It reads prompts from /dev/tty, so it works through curl | bash.

sudo bash -c "$(curl -sSL https://raw.githubusercontent.com/trusted-technologies/cuttlefish/main/scripts/install.sh)"

πŸ”„ Update or uninstall

Run the same installer again and choose Update existing installation or Uninstall from the menu.

πŸ“– Full installation guide

For manual Docker commands, Docker Compose examples, environment variables and building from source, see INSTALL.md.

πŸ—οΈ Architecture

  • Master β€” web server and slave registry.
  • Slave β€” agent that registers with the master and executes network commands.
  • Communication between master and slave uses HTTP/REST.

πŸ“œ License

MIT β€” see LICENSE.

About

πŸ¦‘ An open-source Looking Glass with a master/slave architecture, written in Go. The master provides a web UI for selecting a slave, viewing its IPv4/IPv6 addresses, running network tools ping, mtr, traceroute, iperf3, and downloading test files.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors