leo/lookingglass
1
0
Fork 0
mirror of https://github.com/hybula/lookingglass.git synced 2024-09-21 05:20:06 +00:00
Code Issues Packages Projects Releases Wiki Activity
Modern, simple and fresh looking glass based on Bootstrap 5 and PHP 8.
32 commits 1 branch 15 tags 900 KiB
PHP 99.3%
Dockerfile 0.7%
Find a file
Marc Hagen 06a4fe5f74
Ignore base config, not docker config
2022-11-23 12:53:47 +01:00
docker Move root out of location context 2022-07-29 13:59:52 +02:00
.gitignore Ignore base config, not docker config 2022-11-23 12:53:47 +01:00
backend.php Use constants to define methods 2022-11-23 12:03:16 +01:00
bootstrap.php Add bootstrap file for base vars, functions and includes 2022-11-23 12:48:11 +01:00
CHANGELOG.md Update CHANGELOG.md 2022-04-19 09:37:58 +02:00
config.dist.php Add LG_MAPS_QUERY 2022-11-23 12:46:55 +01:00
docker-compose.yml Looking Glass fully Dockerized. Not compatible with Alpine because the command 'ps' is different in BusyBox, so we use a Debian image. 2022-04-14 12:19:52 +02:00
index.php Rewrite method / session handling 2022-11-23 12:50:50 +01:00
LICENSE.md Initial commit 2022-01-15 19:40:44 +01:00
LookingGlass.php Add LG_MAPS_QUERY 2022-11-23 12:46:55 +01:00
README.md Update README.md 2022-11-06 10:55:33 +01:00
screenshot.png Initial commit 2022-01-15 19:40:44 +01:00

README.md

Looking Glass

Modern, simple and fresh looking glass based on Bootstrap 5 and PHP 8 (also compatible with 7). A looking glass is a network utility which is made user-friendly for everyone to use. It allows you to execute network related commands within a remote network, usually that of an ISP.

Demo

See it in action here!

Features

  • Bootstrap 5 UI.
  • Real time command output using JavaScript.
  • Supports ping/ping6, traceroute/traceroute6 and mtr/mtr6.
  • Easy to customize and to configure.
  • DNS checking to prevent unnecessary executions.

Requirements

  • Any Linux distribution, this has been tested on RHEL 8 + 9.
  • PHP 7.1 or higher, PHP 8 preferred.
  • IPv6 connectivity if you want to use the v6 equivalents.
  • Root access.

Installation

For this installation we will assume that we are working on AlmaLinux 8 or 9. Warning: This guide does not cover any security hardening or rate limiting. Note: These steps also work with AlmaLinux 9, but it will install PHP 8 instead of 7.

  1. Install the required network tools: dnf install mtr traceroute -y.
  2. Install the web server with PHP (by default it will install 7.2): dnf install httpd mod_ssl php -y.
  3. Enable and start Apache/PHP-FPM: systemctl enable httpd; systemctl enable php-fpm and systemctl start httpd; systemctl start php-fpm.
  4. Let's help MTR to work, execute the following command: ln -s /usr/sbin/mtr /usr/bin/mtr and also mtr helper called mtr-packet: ln -s /usr/sbin/mtr-packet /usr/bin/mtr-packet.
  5. You must configure SELinux before this all works, or you can disable SELinux using setenforce 0 and possibly make it permanent: nano /etc/selinux/config change to SELINUX=disabled.
  6. Upload the contents of the ZIP to /var/www/html/.
  7. Rename config.dist.php to config.php and adjust the settings.
  8. (Optional) You might want to enable SSL using LetsEncrypt, take a look at acme.sh.

Customization

If you open up config.dist.php you will see that there are some features that allows you to customize the looking glass, this includes a custom CSS override. You may also extend the looking glass with a custom block.

TODO

  • Move to Composer;
  • Software-based rate limiting;
  • Implement a template engine, for advanced customization;
  • Switch to WebSockets.

Contribute

We would love to receive code contributions in the form of a pull request. We prefer this over forking, so if you have any code improvements feel free to commit.

Credits

This project is inspired by the LookingGlass project of @telephone and uses his procExecute() function, although slightly modified.

License

Mozilla Public License Version 2.0