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 field or the first email address fields if any one of those is filled in.

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.

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 Corporate or premium 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 and restrict commands.

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 by category. Search also allows searching by command_alias name or description across the commands table. In premium versions you will be able to add/edit categories and commands 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.

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 have added descriptions to show when a command is clicked. We also plan to have an extensive command index of what each thing does and what it can and should be used for in the future. All 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 dns lookup button is submitted a Whois/DNS lookup is done for the domain variable parsed from the domain 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.

Example showing Cloudflare Full Zone in use and DNSSEC Detected.

Undock BYOT(Bring Your Own Terminal) mode

Another common request based on the beta testing was to be able to use a custom terminal vs the built in one in the app. This is going to be a premium feature but is available now for testing in the beta test. This also allows you to split the widgets across multiple monitors or desktops if desired for maximum productivity. As more tools are released there will be more selectable and configurable widgets added.

To undock widgets you select the left Undock icon for each widget.
Here is an example of the forms and widgets undocked and the main window resized.
Here is an example of me using the native OS terminal vs the built in one.
Here is an example of me using Terminus terminal for the SSH terminal.

Theme Light/Dark mode Toggling

Toggling Theme Mode

To change from the default Dark Mode theme you can toggle this in the menu by selecting the desired mode and then closing and restarting the app. It will then load in that mode going forward.

App loaded with Light theme.