ERPNext - Developer guide

Welcome to the Meetrix ERPNext Developer Guide! This guide is designed to assist you in seamlessly integrating ERPNext into your AWS environment through detailed, step-by-step instructions.

ERPNext is a versatile ERP system designed for businesses to streamline and integrate key processes, such as accounting, inventory, and customer relationship management, providing a customizable solution for efficient resource management.

Related Article

How to Deploy ERPNext on AWS via Pre-configured AMI

A comprehensive guide to integrating ERPNext into your AWS environment through detailed, step-by-step instructions.

By Kelum Sampath • Meetrix.io

Launching the AMI

Step 1: Find and Select 'ERPNext' AMI

1. Log in to your AWS Management Console.
2. Navigate to the 'ERPNext' in AWS Marketplace.

Step 2: Initial Setup & Configuration

1. Click the "Continue to Subscribe" button.
2. After subscribing, you will need to accept the terms and conditions. Click on "Accept Terms" to proceed.
3. Please wait for a few minutes while the processing takes place. Once it's completed, click on "Continue to Configuration".
4. Select the "CloudFormation Template" as the fulfilment option and choose your preferred region on the "Configure this software" page. Afterward, click the "Continue to Launch" button.
5. From the "Choose Action" dropdown menu in "Launch this software" page, select "Launch CloudFormation" and click "Launch" button.

Create CloudFormation Stack

Step1: Create stack

1. Ensure the "Template is ready" radio button is selected under "Prepare template".
2. Click "Next".

Step2: Specify stack options

After filling in the details, click Next.

Step3: Configure stack options

1. Under "Stack failure options," choose "Roll back all stack resources".
2. Click "Next".

Step4: Review

1. Review and verify the details you've entered.

2. Tick the box that says, "I acknowledge that AWS CloudFormation might create IAM resources with custom names".

3. Click "Submit".

Afterward, you'll be directed to the CloudFormation stacks page.

Please wait for 5-10 minutes until the stack has been successfully created.

Update DNS

Step1: Copy IP Address

Copy the public Ip labeled "PublicIp" in the "Outputs" tab.

Step2: Update DNS

1. Go to AWS Route 53 and navigate to "Hosted Zones".
2. From there, select the domain you provided to "DomainName".

3. Click "Edit record" in the "Record details" and then paste the copied "PublicIp" into the "value" textbox.
4. Click "Save".

Access ERPNext

You can access the ERPNext application through "DashboardUrl" or "DashboardUrlIp" provided in the "Outputs" tab.

Use "Administrator" as the username and "admin" as the password.

Generate SSL Manually

ERPNext will automatically try to setup SSL based on provided domain name, if that domain hosted on Route53. If its unsuccessful then you have to setup SSL manually.

Step1: Copy IP Address

1. Proceed with the instructions outlined in the above "Update DNS" section, if you have not already done so.
2. Copy the Public IP address indicated as "PublicIp" in the "Outputs" tab.

Step2: Log in to the server

1. Open the terminal and go to the directory where your private key is located.

ssh -i <your key name> ubuntu@<Public IP address>


2. Type "yes" and press Enter. This will log you into the server.

Step3: Generate SSL

Paste the following command into your terminal and press Enter and follow the instructions:

sudo /root/certificate_generate_standalone.sh

Admin Email is acquiring for generate SSL certificates.

Shutting Down ERPNext

1. In the CloudFormation stack's Resources tab, click the link for the Instance to go to the EC2 console.

2. Select the erpnext instance by marking the checkbox and click "Stop instance" from the "Instance state" dropdown. You can restart the instance at your convenience by selecting "Start instance".

Remove ERPNext

Delete the stack that has been created in the AWS Management Console under 'CloudFormation Stacks' by clicking the 'Delete' button.

API Documentation

For more information, refer to the Frappe API documentation.

Api Documentation

Upgrades

When there is an upgrade, we will update the product with a newer version. You can check the product version in AWS Marketplace. If a newer version is available, you can remove the previous version and launch the product again using the newer version. Remember to backup the necessary server data before removing.

Troubleshoot

1. If you face the following error, please follow https://meetrix.io/articles/how-to-increase-aws-quota/ blog to increase vCPU quota.

2. If you face the following error (do not have sufficient <instance_type> capacity...) while creating the stack, try changing the region or try creating the stack at a later time.

3. If you face the below error, when you try to access the API dashboard, please wait 5-10 minutes and then try.

Conclusion

The Meetrix ERPNext Developer Guide provides clear, step-by-step instructions for seamlessly integrating ERPNext into your AWS environment. Designed for businesses looking to streamline operations, ERPNext efficiently manages accounting, inventory, and CRM processes with customizable features. Whether you're new to AWS or an experienced developer, this guide ensures a smooth integration process. Trust Meetrix ERPNext to enhance your business operations with flexibility and efficiency in AWS.

Technical Support

Reach out to Meetrix Support (support@meetrix.io) for assistance with ERPNext issues.