Getting Started with the SSH Gateway


This article walks you through setting up the SSH Gateway and configuring access to your first gateway node. Gateway nodes can be any SSH server that is accessible from the SSH Gateway host, either private behind your corporate firewall or publicly available over the Internet.


Step 1. Installing the server

Download the appropriate distribution for your chosen operating system. The Gateway can be installed on any Windows, OSX or Linux host.

You can follow the installation steps using the articles below:

Linux Installation

Windows Installation

OSX Installation


Step 2. Logging in for the first time

Now that you have installed the server you can login for the first time. Connect using your browser to https://<hostname> where <hostname> is the IP address, hostname or FQDN of the server you have installed the product on. You should be presented with the logon screen below. 


To login enter the default credentials and reset the password when prompted.

Username: admin
Password: admin

Once logged in you will be presented with the dashboard providing an overview of your server with session history graph for the past 24 hours and OS/Browser charts detailing the split of different clients accessing the system.



Step 3. Creating a Gateway Node

Gateway Nodes are the key resource you need to configure in the SSH Gateway. You can add as many nodes as your license allows and they can be used for users access, or  for the automation features of the product to schedule tasks such as remote script execution.

Let's now create our first Gateway Node. Under Resources menu click the Gateway Nodes menu item to bring up the gateway nodes table.



Click on Create button to bring up the Create Gateway Node dialog.

The first step is to give the resource a name, think about how you or your users will be using this before naming it. If for example your users are used to calling this server by its host name you could simply use that. Users will access the host using the resource name and not its hostname so make sure you get it right to avoid confusion later. 



 Next, click on the Authentication tab to enter the credentials for this server. You have a number of choices:

  • Use a static username and password - your password will be encrypted.
  • Use the pass-thru replacement variables ${username} and ${password} to pass thru the gateway users credentials.
  • Use a private key hosted on the gateway for authentication - the key is encrypted with a passphrase that is also encrypted in the database

For my example I am just going to use a fixed username and password.



Finally you need to assign the resource to any number of Roles. Only users that are members of these Roles will be able to access the resource. As my example does not need to be complex I will select the Everyone Role.




We can now click on Create to complete the resource. We can now view the resource back in the Gateway Nodes table.




Step 4. Accessing the Node

You can immediately test the resource by accessing the server through the web-based terminal by clicking on the Screen_Shot_2015-08-14_at_16.09.00.png icon in the Gateway Nodes table. Use this to verify that the server configuration is correct. 




You can also use any standard SSH client to access your node. Just pass the resource name as part of your username, the default way to do this is to append the resource name onto your username in the format <username>#<resource name>. For example if I want to access this resource using the gateway admin user I could execute the following ssh command line:




Important: Remember you are connecting to the gateway server SSH server using a gateway user account.



In this article we have installed and setup the SSH Gateway with a single node to demonstrate the basic functionality of the gateway server. You may want to consider following some of these further articles to secure your gateway server.

Adding Authentication Alerts [TODO]

Enable SSH Two-Factor Authentication [TODO]


Have more questions? Submit a request


Please sign in to leave a comment.