Secure software development for teams using SloopEngine

Create SloopEngine credential

A SloopEngine credential is confidential information employed to authenticate SSH connections to your nodes. SloopEngine, by default, encrypts and securely retains these credentials. When creating a SloopEngine credential, you have two options: either include an existing SSH key pair or allow the system to generate a new one automatically. For detailed insights, it is recommended to refer to the SloopEngine credential documentation. This resource will provide comprehensive information on the subject.

  1. Go to the SloopEngine account dashboard and navigate to the Workspaces listing view.
  2. Choose the specific SloopEngine workspace and navigate to Credentials listing view to create a new credential.

We suggest opting for SloopEngine's automatic generation of an SSH key pair when adding a new credential. This approach ensures a streamlined and secure process, where SloopEngine handles the creation of the necessary cryptographic keys for secure communication. This practice not only simplifies the setup but also maintains a higher level of data protection by adhering to industry-standard security protocols.

Sync credential to a node using SloopEngine CLI

The SloopEngine CLI facilitates the synchronization of credentials, specifically the SSH keys, from your SloopEngine account to your nodes (host machines, virtual machines, or containers). To initiate the process, your first step involves installing and configuring the SloopEngine CLI on the designated node where you intend to synchronize the credentials. Following this installation, proceed to execute the subsequent steps outlined below in order to successfully sync the SloopEngine credentials. These instructions will guide you through the steps necessary for ensuring a seamless and accurate deployment of the SSH keys, enhancing the security and accessibility of your SloopEngine nodes.

  1. Go to the SloopEngine account dashboard and navigate to the Workspaces listing view.
  2. Choose the specific SloopEngine workspace and navigate to the Credentials listing view.
  3. Copy the sync command of a specific SloopEngine credential and run it on the node.

Create SloopEngine node

A SloopEngine node serves as a versatile component encompassing various forms like a physical host machine, a virtual machine, or even a container. Accessible through either a Fully Qualified Domain Name (FQDN) based hostname or an IP address, this node constitutes a pivotal entity. It holds significance in the context of SloopEngine permission creation, as it can be pointed to and utilized during the process. For detailed insights, it is recommended to refer to the SloopEngine node documentation. This resource will provide comprehensive information on the subject.

  1. Go to the SloopEngine account dashboard and navigate to the Workspaces listing view.
  2. Choose the specific SloopEngine workspace and navigate to Nodes listing view to create a new node.

Create SloopEngine repository

In broad terms, a SloopEngine repository denotes a Git repository that encompasses the software's source code intended for development. Currently, SloopEngine exclusively accommodates and operates with Git repositories. This means that it focuses solely on facilitating version control, collaboration, and management of code using the Git version control system. For detailed insights, it is recommended to refer to the SloopEngine repository documentation. This resource will provide comprehensive information on the subject.

  1. Go to the SloopEngine account dashboard and navigate to the Workspaces listing view.
  2. Choose the specific SloopEngine workspace and navigate to Repositories listing view to create a new repository.

Create SloopEngine permission

A SloopEngine permission represents an explicit authorization conferred to a user, enabling them to access designated credentials, nodes, and repositories within the system. Notably, this permission encompasses the ability to initiate both SSH sessions, facilitating secure command-line interactions, and IDE sessions, providing a comprehensive environment for software development activities. In essence, SloopEngine permissions serve as a controlled pathway for users to engage with particular resources, enhancing security and facilitating efficient collaboration in the system. For detailed insights, it is recommended to refer to the SloopEngine permission documentation. This resource will provide comprehensive information on the subject.

  1. Go to the SloopEngine account dashboard and navigate to the Workspaces listing view.
  2. Choose the specific SloopEngine workspace and navigate to Permissions listing view to create a new permission.

Add SSH public key to your Git hosting service

Incorporating your SSH public key into your Git hosting service is an essential procedure for validating authenticity of Git repository when launching an IDE session. This practice ensures secure and streamlined access to your Git repository, allowing you to work within your preferred IDE seamlessly. By associating your SSH public key with your Git account, you establish a trusted connection that safeguards your source code and enables efficient collaboration with the version control system.

  1. Go to the SloopEngine account dashboard and navigate to the Workspaces listing view.
  2. Choose the specific SloopEngine workspace and navigate to the My Permissions listing view to copy a SSH public key.
  3. Go to the account settings in your Git hosting service like GitHub, GitLab, or Bitbucket and navigate to the SSH keys listing view to add a new SSH public key.

Launch SloopEngine IDE session

To launch an IDE session, you are required to possess a SloopEngine permission that has been specifically generated for you by a manager. This SloopEngine permission serves as the gateway to accessing the essential credentials, nodes, and repositories relevant to your work. With SloopEngine permission, you gain the ability to launch an IDE session, enabling you to commence your software development activities.

  1. Go to the SloopEngine account dashboard and navigate to the Workspaces listing view.
  2. Choose the specific SloopEngine workspace and navigate to the My Permissions listing view to launch a new IDE session.

On this document