ERPNext
Learn how to use ERPNext to store backups on the ScPrime distributed datacenter using the XNS Relayer
Overview
ERPNext is an open-source integrated Enterprise Resource Planning (ERP) system produced by Frappe Technologies that allows for automated system backups. ERPNext can copy this data to S3 protocol destinations, so it makes a good match for XNS storage.
Read this guide for how to configure ERPNext to store backups with XNS.
Prerequisites
- A working instance of ERPNext
- A working instance of the XNS Relayer
- Configure the XNS Relayer’s Endpoint Access Key and Endpoint Secret Key
Considerations
- ERPNext requires a valid SSL certificate to use the XNS Relayer as an HTTPS endpoint. Please configure the XNS Relayer with a valid SSL certificate or change the Endpoint Certificate Type to not require SSL. These settings can be accessed in the Relayer UI by going to Configuration > General Configuration and editing the Select Endpoint Certificate Type setting to ‘No SSL’.
Application Version Used in Guide
ERPNext: v14.18.3
Frappe Framework: v14.28.1
Guide Revision Date
2023-03-19
Setup Guide
Step 1: Open ERPNext
Open ERPNext and locate the Search bar.
Step 2: Open Cloud Credentials
Type ‘S3’ and click on S3 Backup Settings.
Step 3: Enable Automatic Backups
Click the checkbox for Enable Automatic Backup.
Step 4: Configure S3 Backup Settings
Configure the S3 Backup Settings so that ERPNext can communicate with the XNS Relayer, the backup jobs are defined, and notifications are configured.
| Access Key ID | [Endpoint Access Key (Username)] | This is defined in the XNS Relayer General Configuration. |
| Secret Access Key | [Endpoint Secret Key (Password)] | This is defined in the XNS Relayer General Configuration. |
| Send Notifications To | [Backup monitoring email] | This is the email address that backup job status notifications will be sent to. |
| Send Email for Successful Backup | This will send a notification in the case of a successful backup. | |
| Bucket Name | [Your Bucket Name] | This is the name of the bucket where the backup will be sent to on the XNS Relayer.
n.b., the bucket must be created on the XNS Relayer for it to populate here. ERPNext cannot create a new bucket for you on the XNS Relayer. Additionally, directories are not able to be specified in ERPNext, so the backup will be saved to the root directory of the bucket. |
| Endpoint URL | http://[Your IP]:[MinIO Port]/ | The use of HTTP and HTTPS must align to the settings on the XNS Relayer. ERPNext requires a valid SSL certificate. If you do not have a valid SSL certificate, you can configure the ‘No SSL’ option in XNS Relayer and use HTTP in ERPNext as this example shows.
n.b., ERPNext can be configured to encrypt data prior to sending over the network to mitigate the usage of HTTP. |
| Backup Frequency | This is how often the backup will be taken. | |
| Backup Files | This is to backup public and private files along with the database. |
Step 5: Verify that the S3 Backup Settings are functional
If ERPNext can successfully communicate with the XNS Relayer, a message will indicate that the S3 Backup Settings were saved. Click Take Backup Now to perform your first backup and fully test the setup.
Step 6: Monitor Backup
ERPNext will indicate if the backup has started. To determine if the backup was taken successfully, refer to notification emails or browse to the bucket used on the XNS Relayer to validate that the backup `was stored.
