Ask a question Edit on GitHub Submit feature request Pricing

Production ready deployment

Deploy web client on AWS

In this section, you will be deploying the web client on your AWS account

What do you need to get started

  • An AWS account (you can create an account here if you do not have one)

Let's begin!

Note

You can directly start from Step 3 if you have installed and configured AWS CLI

Step 1 - Install or Update the AWS CLI

Run this on your terminal
curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "awscliv2.zip"
unzip awscliv2.zip
sudo ./aws/install

Confirm the installation with the following command

Verify AWS CLI is installed
aws --version

aws-cli/2.10.0 Python/3.11.2 Linux/4.14.133-113.105.amzn2.x86_64 botocore/2.4.5 --> expected response

For more information, click here

Step 2 - Configure the AWS CLI

For this step you would need the following from you AWS account

  1. Access key ID

  2. Secret Access Key

You can create or manage your access keys from the Security Credentials tab inside your AWS Console. For more information, click here

Once you have the keys run the below command

export AWS_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE
export AWS_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

Step 3 - Setup Hyperswitch Web Client

You can now deploy the Hyperswitch web client by running the below command in the same terminal session

Takes around 10-15 min to execute successfully

curl https://raw.githubusercontent.com/juspay/hyperswitch-web/main/aws/hyperswitch_aws_production_deployment.sh | bash

On running the above command, you will get an option to configure the following

  1. AWS region - This is the AWS region that you want your SDK to be deployed to. In case not provided, it will default to us-east-2

  2. Option to either create a new bucket on S3 or use your existing S3 bucket - You can enter either Y (Yes) or N (No) to create a new bucket depending on your preference.

  3. Bucket Details - If you choose to use your existing S3 bucket, you need to provide your S3 bucket location here. In case you choose to create a new S3 bucket, please provide a unique name here.

  4. Self-hosted App server URL - This is the self hosted app server URL (eg., http://34.207.75.225 ). If not provided, this will default to https://sandbox.hyperswitch.io and will work with Hyperswitch's SaaS app server.

Depending on the API version and changes made to the web client, the web client may or may not be compatible with the SaaS app server.

Once the script is executed, you will receive an URL as the response (e.g. http://my-bucket.s3.us-east-2.amazonaws.com/HyperLoader.js). This is the base URL of your web client.

That's it! Hyperswitch web client should be up and running on your AWS account

Verify the health of the web client at http://my-bucket.s3.us-east-2.amazonaws.com/HyperLoader.js. You should be able to see the bundled code in your browser.

Great! Your Web Client is hosted and can be accessed by this URL.

Now that the web client is hosted, you can integrate it with your app and go live. The detailed steps follow.

Troubleshooting/ FAQs

  • I cannot see anything on http://my-bucket.s3.us-east-2.amazonaws.com/HyperLoader.js or I get 404 Page not Found on this URL Please check your AWS S3 bucket details and make sure that the S3 bucket is created and has all the JS files. Post this, re-run the script to do a re-deployment.

  • While running the script for creating a new S3 bucket, I get an error from AWS - bucket name already exists Please re-run the script and enter an unique name for the S3 bucket.

  • AWS is throwing many errors while running the script Please ensure you have the relevant permissions to create and push on your AWS cloud. Also, ensure that there are no limits/ restrictions set to prevent cloud hosting.

Next step:

pageIntegrate web client on your web app

Last updated