Download latest Release

Description

The SNMP Sim UI (short for SNMP Simulator User Interface) is both a Web and Desktop Application used to manage multiple simulated SNMP objects such as Agents, Engines, Endpoints, and Users which are grouped into Labs.

This tool is designed to work hand-in-hand with the main SNMP Simulator Rest API running on a dedicated Server. This tool then communicates with the Management and Metrics Endpoints of the SNMP Simulator Rest API.

Installation

For the installation of the core SNMP Simulator, please visit this page.

There are two seperate installation guides depending on whether you want to install the SNMP Sim UI on a Web Server and make it accessible through the browsers or if you want to run it as a local app on your Desktop, which updates itself automatically.

Web App

Installation Guide

• First things first, you need to have a Web Server such as Nginx or Apache installed already (Express works too, as long as its set up to serve static files).
• The second step is to go to the latest release and download the SNMP.Simulator-X.X.X-Web.zip-file which includes all the files needed for the deployment of the Web App.
• Last but not least, extract the files contents and upload them onto your web server. Please note, that the prebuild Web App can only run in the root directory of the web server!
• That's it! 🎉 You should now be able to go to your configured domain (or the IP Address) of your web server and get started.

Desktop App

Installation Guide

• First, go to the latest release and click on "Assets". There you can download the latest version for your operating system.
• This will download an installer which lets you choose where to install the SNMP Sim UI and also where future updates will be installed.
• That's it! 🎉 You should now be able to open the App and continue with the initial setup!

Initial Setup

Initial Setup Guide

• When opening the App for the first time (or after signing out), you will be prompted to do a first time setup:
• After clicking on "Get Started", you will be taken to the second page where you are prompted to enter the details for the Management Endpoint of the SNMP Sim Rest API. You need to provide the Address and the Port on which the Management API is listening on. Optionally, you can also specify Authentication details, if you set any up on your web server.
• The next step is the same for the Metrics API. You again have to specify the Address and the Port on which the Metrics API is listening. Most of the information will be prefilled from the previous step.
• In the last step of the initial setup process, you can review your configuration and then start a validation reqeust against the Management and Metrics Endpoints. Once successful, you will be redirected to the welcome page of the SNMP Sim UI.
  
  All of your entered information will be stored until you log out using the red "log out" button in the top right corner. If you log out though, you will have to go through the setup again.

Run or Build from Source

You can of course also run and build the app from source!

First, clone this repository and install its dependencies

$ git clone git@github.com:inexio/snmp-sim-ui.git
$ cd snmp-sim-ui/
$ npm install

After that's done, you can run the following npm package scripts to run or build the app:

# Run the App in development mode
$ npm run serve:web       # Run the Web App with hot reloading
$ npm run serve:desktop   # Run the Desktop App with hot reloading

# Build the App for production
$ npm run build:web       # Build the Web App
$ npm run build:mac       # Build the Desktop App for Mac
$ npm run build:win       # Build the Desktop App for Windows
$ npm run build:linux     # Build the Desktop App for Linux

Authors

• Juri Adams - Initial Work - @4dams

License

This project is underlying the MIT-License. For more information, take a look at this projects LICENSE.md file.