Getting Started

Signup Account

  • Go to the SloopEngine website and signup to create your free trial Account.
  • Your Account will be pending for approval by the SloopEngine team.
  • After your Account is approved, you will get an email containing the Account portal URL.
  • Go to your SloopEngine portal using the Account portal URL.
  • You will get into the User Login form.

The portal URL is unique for every Account that has been created on SloopEngine. You can login to your Account only via the portal URL. So, please make a note of your Account portal URL, else contact customer support.

Whitelist SloopEngine Gateway IPs

  • Navigate to Settings view by clicking the Manage Account dropdown menu on the top menu bar.
  • Get the list of SloopEngine Gateway IPs and whitelist the same on your firewall to allow SSH access on port 22.

SSH Access Management and Online IDE features won't work if you didn't whitelist the SloopEngine Gateway IPs on your firewall.

Add Stack

  • Navigate to the Stacks view by clicking the Stack icon on the left side menu bar in the Dashboard view.
  • To add a new Stack, click Add Stack link on the top right corner of the Stacks view.
  • You will get into the Add Stack form.
  • Navigate to the Stack which you created and add resources.

Further proceeding, we assume that you are in a specific Stack view and not in the Dashboard view.

Add Identity

  • Navigate to the Identities view by clicking the Identity icon on the left side menu bar in the Stack view.
  • To add a new Identity, click Add Identity link on the top right corner of the Identities view.
  • You will get into the Add Identity form.

We recommend allowing SloopEngine to automatically generate an SSH key pair while adding a new Identity. To accomplish this, enable the Generate key pair checkbox.

Add Server

  • Navigate to the Servers view by clicking the Server icon on the left side menu bar in the Stack view.
  • To add a new Server, click Add Server link on the top right corner of the Servers view.
  • You will get into the Add Server form.

Sync Identity

  • SSH to your Server (via host terminal) and deploy SloopEngine CLI in it.
  • Navigate to the Identities view by clicking the Identity icon on the left side menu bar in the Stack view.
  • Click the refresh icon of the Identity which you want to sync to the Server.
  • Copy the command in the popup and execute it in your Server.
sudo sloopengine identity sync --stack-id 1224 --id 3852
              

Add Repository

  • Navigate to the Repositories view by clicking the Repository icon on the left side menu bar in the Stack view.
  • To add a new Repository, click Add Repository link on the top right corner of the Repositories view.
  • You will get into the Add Repository form.

You don't have to perform this step, if you are not planning to launch IDE Session.

Add Rule

  • Navigate to the Rules view by clicking the Rule icon on the left side menu bar in the Stack view.
  • To add a new Rule, click Add Rule link on the top right corner of the Rules view.
  • You will get into the Add Rule form.

Launch IDE Session

  • Navigate to the My Rules view by clicking the Rule icon on the left side menu bar in the Stack view.
  • Click the Identity icon of the Rule from which you want to launch an IDE Session.
  • Copy the SSH public key in the popup and add it in the profile settings of your Git service provider.
  • Click the IDE icon of the Rule from which you want to launch an IDE Session.
  • You will get into the Launch IDE Session form.

SloopEngine supports major Git service providers, which include GitHub, Bitbucket, and GitLab.

Launch SSH Session

  • Navigate to the My Rules view by clicking the Rule icon on the left side menu bar in the Stack view.
  • Click the SSH icon of the Rule from which you want to launch an SSH Session.
  • You will get into the Launch SSH Session form.