Skip to content

Latest commit

 

History

History
92 lines (63 loc) · 3 KB

README.md

File metadata and controls

92 lines (63 loc) · 3 KB
Raw

LookingGlass

Overview

LookingGlass is a user-friendly PHP based looking glass that allows the public (via a web interface) to execute network commands on behalf of your server.

Current version: v1.3.0

It's recommended that everyone updates their existing install!

Features

  • Automated install via bash script
  • IPv4 & IPv6 support
  • Live output via long polling
  • Multiple themes
  • Rate limiting of network commands

Implemented commands

  • host
  • mtr
  • mtr6 (IPv6)
  • ping
  • ping6 (IPv6)
  • traceroute
  • traceroute6 (IPv6)

IPv6 commands will only work if your server has external IPv6 setup (or tunneled)

Requirements

  • PHP >= 5.3
  • PHP PDO with SQLite driver (required for rate-limit)
  • SSH/Terminal access (able to install commands/functions if non-existent)

Install

  1. Download LookingGlass to the intended folder within your web directory
  2. Extract archive:
    • Option #1 - Extract archive to the current directory:
      • tar -zxvf LookingGlass-1.3.0.tar.gz --strip-components 1
    • Option #2 - Extract archive to a directory named LookingGlass:
      • tar -zxvf LookingGlass-1.3.0.tar.gz --transform 's!^[^/]\+\($\|/\)!LookingGlass\1!'
  3. Navigate to the LookingGlass subdirectory in terminal
  4. Run bash configure.sh
  5. Follow the instructions and configure.sh will take care of the rest

Forgot a setting? Simply run the configure.sh script again

Updating

  1. Download LookingGlass to the folder containing your existing install
  2. Extract archive: tar -zxvf LookingGlass-1.3.0.tar.gz --overwrite --strip-components 1
    • This will overwrite/update existing files
  3. Navigate to the LookingGlass subdirectory in terminal
  4. Run bash configure.sh
  5. Follow the instructions and configure.sh will take care of the rest
    • Note: Re-enter test files to create random test files from GNU shred

Forgot a setting? Simply run the configure.sh script again

Apache

An .htaccess is included which protects the rate-limit database, disables indexes, and disables gzip on test files. Ensure AllowOverride is on for .htaccess to take effect.

Output buffering should work by default.

For an HTTPS setup, please visit:

Nginx

To enable output buffering, and disable gzip on test files please refer to the provided configuration:

HTTP setup

The provided config is setup for LookingGlass to be on a subdomain/domain root.

For an HTTPS setup please visit:

License

Code is licensed under MIT Public License.

  • If you wish to support my efforts, keep the "Powered by LookingGlass" link intact.