NetMirror - A Modern Looking-glass Server

NetMirror is a modern, feature-rich looking-glass server with a beautiful web interface for network diagnostics and performance testing.

• Modern UI: A clean and responsive user interface built with Vue.js.
• Network Tools: A suite of tools including Ping, iPerf3, and Speedtest.
• Real-time Traffic: Live monitoring of network interface traffic.
• Interactive Shell: A fake shell environment for basic diagnostics.
• Easy Deployment: Ships as a single Docker container.
• Customizable: Configure features and server details via environment variables.

Run directly from DockerHub:

services:
 als:
 image: soyorins/netmirror:latest
 container_name: looking-glass-e
 restart: always
 network_mode: host
 user: root
 env_file:
 - .env
 volumes:
 - ./data:/data
 - ./.air.toml:/app/.air.toml
 healthcheck:
 test: ["CMD", "wget", "--quiet", "--tries=1", "--spider", "http://localhost:${HTTP_PORT:-80}/"]
 interval: 30s
 timeout: 10s
 retries: 3
 logging:
 driver: "json-file"
 options:
 max-size: "10m"
 max-file: "3"

1. Clone the repository:

   git clone https://github.com/Yuri-NagaSaki/NetMirror.git
   cd NetMirror

2. Create an environment file:

   Copy the example environment file to create your own configuration.

   cp .env.example .env

   Note: If .env.example does not exist, you can create a blank .env file and add the variables you need from the table below.

3. Customize your configuration (optional):

   Edit the .env file to set your server location, public IP addresses, and other options.

4. Start the server:

   docker compose up -d

The application will be accessible at http://<your-server-ip>. The default port is 3000, which can be changed via the HTTP_PORT environment variable.

Pre-built multi-architecture Docker images are available on DockerHub:

• Supported architectures: linux/amd64, linux/arm64
• Image repository: soyorins/netmirror
• Available tags: latest, version tags (e.g., v1.0.0), branch names

Images are automatically built and published via GitHub Actions when code is pushed to the main branch or when new tags are created.

Configure NetMirror by setting environment variables in the .env file.

• Go
• Node.js & npm
• Docker

1. Build the Frontend:

   cd ui
   npm install
   npm run build

2. Build the Backend:

   cd ../backend
   go build -o ../NetMirror

3. Run the application:

   The final binary will be in the project root. Before running, ensure any necessary environment variables are set.

   ./NetMirror

Apache License, Version 2.0 and the Commons Clause Restriction.