User guide

User interface overview.

Form Input:

The form input is where you put in anything you know about the issue such as domain email adddresses etc. Based on what you put in this populates the relevant commands dynamically.

Things to note:
Not all of the fields need filled in. You can fill in with only a username or nothing at all if its a static command.

The domain is parsed from the domain/url/or first email address fields if any one of those is filled in. The URL is there for convenience and for later on features we plan to add such as SSL checks etc.

SSH Terminal:

The ssh terminal central widget works with username/password and also the native ssh agent for Linux/Mac and the Putty pageant agent for Windows.

It also supports 2FA ssh logins thanks like Duo and will prompt you via push or offer interactive prompt to choose how to auth. You may received 2 2FA auth requests right away and then it shows the 2FA interactive prompt for the final push. This is normal and due to how the SSH terminal and webockets opens multiple sessions.

It is a multi-tabbed terminal so clicking to the right of the existing tab will spawn a new tab just like it does in a browser. For more information about how that works see the PyPi link here. This portion of the app is opensource.

Windows Users:
The Putty Installer with pageant can be installed by the download link below.
https://the.earth.li/~sgtatham/putty/latest/w64/putty-64bit-0.73-installer.msi
If you have not already converted your OpenSSH formatted keys to .ppk format you will need to do this via PuttyGen by importing the private key entering the pass and then exporting it in .ppk format. You will then need to add the converted private key .ppk to Pageant SSH agent.

Control Panel Dropdown:

This drop-down menu allows you to switch the OS/Control Panel profile loaded so that you can switch between working on say a cPanel or Cyberpanel server on the fly. Companies and individuals on the premimum subscription plans will be able to add custom profiles with all their specific log file paths and binaries and select it or set this as the default for their users.

Command Category Dropdown:

This drop-down menu allows you to switch the category of commands loaded in the commands list box below it. There are alot of commands so this helps filter them until we get the search section working. In premium versions you will be able to add/edit categories as desired.

Special Note: The categories that start with “Advanced” tend to be things that would require root access or sudo root level privileges commonly used by L2 or Advanced Level techs and sysadmins and should be used with care.

Commands:

In this section you will see commands based on the command category dropdown selected. Please Note: the search box is not currently functioning at this time.

When you single click(left click) on a command it automatically adds that command to your clipboard for use. For dynamic commands this will be based off the current form input and selected Control Panel profile loaded.

We plan to add tooltips and an extensive command index of what each thing does and what it can and should be used for in the future. Most of the commands already have the privileges required noted along with descriptions in the database the filtering for this is just not implemented at this time. This will be useful for companies which will want to hide or restrict commands for some things based on user level.

Special Note: If you have not used a command before we recommend clicking it to copy to clipboard and then paste it into a notepad first to review it if you are curious about what it does or how it does it. You can then paste it into the terminal when ready to execute it.

Example of me selecting a command and pasting it into the terminal.
Example of output from the above command.

Whois and DNS lookups:

This section should be self explanatory, but for clarity anytime the form is submitted a Whois/DNS lookup is done for the domain variable parsed from the domain/url/ or email address field. This helps you spot if the issue you working on is actually on the server you think it is and also provided insight to know if domain is using a Proxy like Sucuri/Cloudflare WAF which could be causing a problem.