Local Setup

Local runner installation

This guide will help you install the deployment runner locally on your device.

A local installation is recommended only for individual usage. For teams and automations, the AWS cloud setup is preferable.

Prerequisites

1. You will need to have AWS API credentials configured. What works for AWS CLI or any other tools (eksctl, kops, Terraform, etc.) should be sufficient. You can use ~/.aws/credentials or environment variables . For more information read AWS documentation.
   
2. The IAM account used for deployments should have these minimal access levels.
   
   For static site deployment

   AWS service	Access
   S3	Full access
   Cloudfront	Full access

   For web service deployment

   For logs management

   For custom domain certificate creation
   
   
3. A running Docker daemon for building your code.
   
4. A deployment.io account with valid user key and user secret.
   

Installation

Linux and MacOS

Type and execute the following command in your terminal:-

shell
curl -O https://raw.githubusercontent.com/deployment-io/runner/master/install-deployment-runner.sh && source install-deployment-runner.sh

Windows

Download and unzip the latest binary from Windows releases at

https://github.com/deployment-io/runner/releases/latest

Usage

Type and execute the following command in your terminal:-

shell
TargetCloud=aws UserSecret=yourUserSecret UserKey=yourUserKey deployment-runner