rungeict/looking-glass repository overview

⁠Looking Glass

Looking Glass php:apache docker image.

⁠Description

This web application made in PHP is what we call a Looking Glass. This is a tool used to get some information about networks by giving the opportunity to execute some commands on routers. The output is sent back to the user.

For now this looking glass is quite simple. Here you have some features:

• Interface using Javascript and AJAX calls (needs a decent browser)
• Support of BIRD, Cisco, Juniper and Quagga routers
• Support of Telnet and SSH connection to routers using password authentication and SSH keys.
• Configurable list of routers
• Tweakable interface (title, logo, footer, elements order)
• Log all commands in a file
• Customizable output with regular expressions

And here is a list of what this looking glass should be able to do in the future:

• Support more routers
• Support of other types of authentication
• Configurable list of allowed commands

⁠Configuration

Map a copy the of configuration file config.php.example⁠ file to /var/www/html/config.php file. It contains all the values (PHP variables) used to customize the looking glass.

⁠Deployment

docker run -d -p 80:80 -v /config.php:/var/www/html/config.php --name="looking-glass" --restart=always rungeict/looking-glass:latest 

⁠Documentation

An up-to-date (hopefully) documentation is available in the https://github.com/respawner/looking-glass/tree/master/docs/⁠ directory. It gives enough details to setup the looking glass, to configure it and to prepare your routers.

⁠License

Looking Glass is released under the terms of the GNU GPLv3. Please read the LICENSE file for more information.

⁠Contact

If you have any bugs, errors, improvements, patches, ideas, you can contact me on my email address [email protected]⁠. You are also welcome to fork and make some pull requests.

If you use this looking glass in your company, please drop me a mail. I would be glad to know that this project was helpful for you, and I will update our documentation⁠ to include your company inside the list of users if you want me to.

⁠Thanks

• Bootstrap⁠ and jQuery⁠ for making CSS and Javascript less painful for people like me.
• Romain Boissat⁠ for all his great ideas, bug reports and contributions.
• RungeICT⁠ for contributing and maintaining a docker image