Deploy to Cloud (AWS)

Typical Platform Deployment Time : 10 ~15 minutes

Deploy the platform to AWS using our provided script. The script simplifies the process and provides the platform URL upon completion. With this, your platform will be hosted on the cloud and accessible from anywhere in the world.

Security Credentials

• AWS Access key - Obtain your AWS access and secret keys from the AWS IAM console. Log in to your AWS account and follow the official AWS documentation to generate these keys.

Software Prerequisites

If any of the packages listed below are missing on your machine, you can use our automated script to install them.

• Git

• Make

• Terraform

• AWS CLI

1. On your local machine, open a terminal and download the dependencies

   curl -L -O https://raw.githubusercontent.com/tokamak-network/trh-platform/main/install.sh
   

2. Change permission of the dependency script

   chmod +x install.sh

3. Install the dependencies

   ./install.sh 

4. After successful installation, you will see the below message.

Deploy Tokamak Rollup Hub Platform

1. On your local machine, open a terminal and clone the TRH-Platform repository.

   # clone the trh-platform repository
   git clone https://github.com/tokamak-network/trh-platform
   # change directory to trh-platform
   cd trh-platform
   

2. Run the below command in your terminal for the configuration.

   # setup for ec2 deployment
   make ec2-setup

   You will be asked to put the following parameters. You can use default values for some of them.

   • Key credentials: AWS access key & AWS secret access key (If you don’t have any AWS access key, please refer this guide and create new one.)

   • AWS region (default: ap-northeast-2): The region where the ec2 instance for platform is installed

   • SSH key pair: The key pair name for SSH access. Please keep this noted so you can use it when you try to access EC2 instance via SSH. The key is generated to ~/.ssh

   Note: Terraform will automatically generate and store a new key pair on AWS and your machine (~/.ssh). Do not create this manually - just provide a name (e.g., "my-ec2-key").

3. Run the below command in your terminal. This will launch an EC2 instance and deploy the platform on it. After deployment, a success message will appear along with the platform URL for access.

   # deploy ec2
   make ec2-deploy

   • Instance Type (default: t2.large): The T-shirt size of EC2 instance

   • Instance Name: The name of your EC2 instance

   Platform Auth configuration (The below credentials will help you to login to the platform)

   • Admin Email (default: [email protected]): The email which will be used for platform login

   • Admin Password (default: admin): The password which will be used for platform login

   After deployment, you will receive the instance hostname as shown in the below screenshot, along with the platform dashboard URL.

   
4. Get AWS EC2 information

   make ec2-status

5. Destroy AWS EC2 instance

   Note : Terminating the EC2 instance will not remove any deployed chains. Chains must be deleted directly from the platform. Destroying the EC2 instance only removes the instance itself along with the platform running on it.

   make ec2-destroy