Developers Forum for XinFin XDC Network: StorX Network

StorX Integration Series: Backup with cPanel.

StorX Network — Thu, 06 Mar 2025 07:23:10 +0000

What is cPanel (Control Panel for Website Management)?
cPanel is a web-based control panel that allows users to manage their websites, domains, emails, databases, and files easily.
It is mainly used by website owners and hosting clients.
Provides a graphical interface for managing web hosting without needing to use command-line tools.

What are the use cases of integrating the cpanel with StorX?

Website & Database Backups

Automatically backup website files, databases, and emails from cPanel to StorX.
Ensure disaster recovery in case of server failures, hacking, or accidental deletions.
Use cron jobs to automate periodic backups (daily, weekly, or monthly).

Migration & Disaster Recovery

Quickly restore websites, databases, and configurations from StorX in case of system crashes.
Migrate cPanel accounts easily by restoring data from StorX to a new server.

Offsite Backup for Hosting Providers

Hosting providers can offer remote backups to clients as an add-on service.
Protect customer data from local hardware failures and data loss risks.

Log & Configuration File Archiving

Store server logs, configurations, SSL certificates, and other important files securely.
Retain logs for compliance, security auditing, and troubleshooting.

Version Control & File History

Keep multiple versions of backups for easy rollbacks.
Restore a specific version of a file if an update breaks a website or database.

Email Backup & Archiving

Backup all cPanel email accounts to StorX to ensure no email loss.
Useful for businesses needing long-term email storage & compliance.

Reducing Local Storage Costs

Free up cPanel server storage by moving older backups to StorX.
Avoid disk space overages on web hosting plans.

Secure & Encrypted Data Storage

Use StorX’s decentralized, encrypted storage to prevent data breaches & cyberattacks.
Ensure compliance with GDPR, HIPAA, and other data protection regulations.

Backup Automation with Scripts & Tools

Use s3cmd, rclone, or cron jobs to automate backups from cPanel to StorX.
Integrate with cPanel backup tools (JetBackup, WHM backup, etc.) to store backups directly in StorX.

Prerequisite

Account in the cPanel and the Data in the Cpanel.
Account in StorX to get the Access credentials.
s3cmd tool
Operating system (Alma Linux, rocky Linux, etc..)
How to get the access key, secret key, and endpoints from the StorX?

Once you login, you will reach the dashboard. In this dashboard, click on user icon at the top.

When you click on user icon, it will open dropdown list. From that list click on access.

When you click on the access list, it will open this screen from where you can create an access token.

When you click on Create button it will open this popup
Provide a name to your access key and click on “Continue” button

Once you confirm all the details and click on confirm it will open this popup with all required tokens
To copy All keys you can click on “copy” button
To download All keys you can click on “Download” button
If you click on Show Key it will show key for that block

These are the example values for how access key, secret key and Endpoint will have values.
Let’s look at how we can integrate the Cpanel with storX and automate the backup.

Step 1. Configure cPanel Backups

a. Enable Native cPanel Backup:

In WHM, navigate to Backup Configuration.
Enable backups and choose your preferred backup type (full or incremental).
Set the backup schedule (daily, weekly, etc.) and specify a local backup destination (e.g., a dedicated folder such as /home/backup/).
b. Verify Backup Output:

Ensure that the backups include customer accounts, databases, and configuration files that you need to protect.
Test a manual backup from cPanel to confirm that files are generated in the designated directory.
C. Let’s configure s3cmd with the storx using the access credentials:

Install s3cmd using the command below.
dnf install -y s3cmd

Once the installation is done you can check the version of the s3cmd using the command below for the confirmation.
s3cmd — version

So now you can see the s3cmd is successfully installed and is an updated version. Now we will start the configuration of the s3cmd using the command below.
s3cmd — configure

Once the configuration is made successfully using the access credentials of storX now lets see how we can transfer the file to the storX and automate the process.
Manually you can use the below command

s3cmd put /backup/your_backup_file_location s3://your_bucket_name/

Let’s Automate the process using the below Commands

Edit the crontab using the command below.
crontab -e

Add this line to back up daily at 2 AM
0 2 * * * tar -czvf /backup/cpanel-test.tar.gz -C /backup cpanel-test && s3cmd put /backup/your_file_location s3://your_bucket_name/

To confirm you can visit to storX and view the upload happening based on the time set.

StorX Integration Series: BackUp with Duplicati +CyberDuck +CloudBerry

StorX Network — Mon, 03 Mar 2025 08:41:58 +0000

Duplicati

Installation
This section takes you through how to install Duplicati. For more installation instructions, see the documentation for duplicati here.

Go to the download page and download the installer for Duplicati that matches your operating system.
Go to your downloads folder and run the downloaded file.

The installer will guide you through the installation steps.

Get API key and secret
From the top-left corner of the storx dashboard, click the account button and a drop down menu will appear.

Click Access.
Create s3 credentials.

After successful creation, click download all, then finish.
The downloaded file will have all the details you need to backup your files to the storx from your desktop.
json
Access Key:jucp2o2qXXXXXXXXXXXXXXXXXXXX
Secret Key: j3lolq5453ktsnnjfXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX Endpoint:https://gateway.storx.io
Create a vault that will be used.

Backing up files

Navigate to the start menu and open Duplicati.
Duplicati is likely to run in the background. Check the system tray to see if it is open already. If it is open, head to the browser and open http://localhost:8200

3.To create a backup, click + Add backup

Continue configuring a new backup. On the next page, add the backup folder name, description, and preferred encryption algorithm. Leave the encryption algorithm “none” if you do not want the data encrypted, but encryption is highly recommended.
On the next page, Select Storage Type as s3 compatible, and for the server, use the custom server URL and the URL from the downloaded credentials. Fill in the other details, such as the access key and secret from the credentials file.
After filling out all the details, click test connection. If everything has been done correctly, the connection will print as working.
On the next page, select files/folders you would like backed up
In the next page configure the backup and sync frequency.
On the last page, select the preferred options and save.
Once you have completed the above steps, you need to return to the Home section. Here, you will find all the backup files created.
· You can click on the run link in the created repository and back up will start.
· Other settings can also be performed here related to the deletion, edit, export, etc.

Once the backup is complete, Navigate to the storx website on the detail page of the vault. You will find all the files backed up.

— — — — — — — — — — — — — — — — — — — — — — — — — — — — — — — — — — — — — —

CyberDuck

Cyberduck is an open-source client for FTP and SFTP, WebDAV, and cloud storage (OpenStack Swift, Amazon S3, Backblaze B2, and Microsoft Azure), available for macOS and Windows (as of version 4.0) licensed under the GPL.

Getting started with CyberDuck
Step 1: — Installation
Refer to the corresponding Help Center articles for comprehensive instructions on installing Cyber Duck on various platforms:

Installing Cyber Duck Personal on Windows
1) Download the latest version of Cyber Duck for Windows from our download page.

2) Once we have downloaded the application, we need to open it to install it.

3) Once the installation is complete, you will get the following Pop up.

Step 2: — How to obtain an Amazon S3 access key pair

Once you log in, you will be able to access this dashboard. In this dashboard, click on the user icon at the top

When you click on the user icon it will open a dropdown list. From that list, click on access.

When you click on the access list, it will open this screen, from which you can create an access token.

When you click on the Create button, it will open this popup
Provide a name to your access key and click on the “Continue” button

Once you confirm all the details and click on confirm, it will open this popup with all required tokens
To copy All keys, you can click on the “copy” button
To download All keys, you can click on the “Download” button.
If you click on Show Key, it will show the key for that block

These are the example values for how the access key, secret key, and Endpoint will have values.
Getting started with the integration of s3 with the storx

Open the Installed Cyberduck application from the start menu in windows.

Click on the Open connection. You will get the following pop-up asking for the following details.

Fill in the credentials according to the image below.

Note the below before you proceed further.
In the server: — Provide your endpoints.

In the Access Key ID: — Provide the access key generated.

In the secret access key: — Provide the secret access key as it is.

Now click on connect.

Once you have done this, you will see the data in the account populate. You can proceed with the auto-sync as per the settings.

— — — — — — — — Integration with Cyberduck completes here — — — — — — — —

CloudBerry
What is Cloudberry Explorer?

CloudBerry Explorer provides a user interface for accessing, moving, and managing files across your local and cloud storage.

Freeware cloud backup for Windows, Linux, Mac, Hyper-V, and VMware

File system backup and restore
Support for AWS, Microsoft Azure, Backblaze B2, Wasabi, Google Cloud Storage
Scheduling and flexible data retention policies
Compression and encryption
Downloading the CloudBerry explorer

To download the Cloudberry, visit the following address: https://www.msp360.com/free-products/ and click the MSP360 FREE BACKUP Download button.
Fill out the form, and you will get the downloaded file in the local disk-c.

Once you have downloaded the file, you can install the application.

Once the application is installed in the system, you can open it on the desktop. Click on the version you require and proceed.

Once you have opened the application, you can view the following interface.

Before we start next, let’s get the pre-request site: —
Access Key
Secret Key
EndPoint
How to obtain an Amazon S3 access key pair

Once you log in you will reach this dashboard. In this dashboard, click on the user icon at the top

When you click on the user icon it will open a dropdown list. From that list, click on access

When you click on the access list, it will open this screen, from which you can create an access token.

When you click on the Create button, it will open this popup
Provide a name to your access key and click on the “Continue” button

Once you confirm all the details and click on confirm, it will open this popup with all required tokens
To copy All keys, you can click on the “copy” button
To download All keys, you can click on the “Download” button
If you click on Show Key, it will show the key for that block

These are the example values for how the access key, secret key, and Endpoint will have values.
Setup in the Desktop

Once the application is installed on the PC you need to open the application. The interface would appear to be as follows:
Now, you must decide the source and the target file to transfer or back up the data.
From the below, select the source as my computer and target as s3 compatible
Click on the file in the top nav bar and add the account.
Select the S3 Compatible here in the below pop-up.
Provide the Access key, Secret Key, and end points.
Fill in all the details required in the above and test your connection.
We should get the success message while creating the connection.
Once you have made the connection, you can locate the file in the figure below.
Now, you can process all the attachments and delete the file at your convenience. You can also transfer the file from another source, such as Backblaze b2, Wasabi, Google Drive, etc.

StorX Integration Series: StorX + Kopia

StorX Network — Fri, 26 Jul 2024 10:44:31 +0000

Installation
This section explains how to install Kopia. For more installation instructions, see the Kopia documentation here.

Installation in Kali Linux(Ubuntu)
Kopia offers an APT repository compatible with Debian, Ubuntu, and similar distributions. To begin, install the GPG signing key to verify the authenticity of the releases.

curl -s https://kopia.io/signing-key | sudo gpg — dearmor -o /etc/apt/keyrings/kopia-keyring.gpg

Register APT source:
echo “deb [signed-by=/etc/apt/keyrings/kopia-keyring.gpg] http://packages.kopia.io/apt/ stable main” | sudo tee /etc/apt/sources.list.d/kopia.list
sudo apt update

By default, the stable channel provides official stable releases. If you prefer, you can select the testing channel (which also provides release candidates and is generally stable) or unstable, which includes all the latest changes but may not be stable.

Finally, install Kopia or KopiaUI:
sudo apt install kopia
sudo apt install kopia-ui

Kopia is installed!
*Now open the Kopia in your Desktop.

Installation in Windows

⦁ Go to the releases page, select the latest tag/version, and download the latest Kopia installer version of Kopia. During the writing of this documentation, the latest version is 0.17.0; therefore, the download will be KopiaUI-Setup-0.17.0.exe
⦁ Go to your downloads folder and run the downloaded file

The installer will guide you through the installation steps.

Get the API key and secret key

Click the account button from the storx dashboard's top-left corner, and a drop-down menu will appear.

Click Access

Create s3 credentials.

After successful creation, click download all then finish

The downloaded file will have all the details you need to backup your files to the StorX from your desktop
JSON
Access Key:jucp2o2qXXXXXXXXXXXXXXXXXXXX
Secret Key: j3lolq5453ktsnnjfXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX Endpoint: gateway.storx.io
Create a vault that will be used

Backing up files

From open the start menu, open Kopia.

From the options given, click s3 or compatible storage

Fill in the details by using the vault name as the bucket name and other details from the credentials file downloaded.

Create your New repository: — ⦁ Provide the repository password. ⦁ Confirm the same repository password. ⦁ Click on the show advanced option to learn more about the encryption, hash algorithm, splitter, repository format, error correction overhead, error correction algorithm, username, and hostname. ⦁ Click on Create Repository.

This is the view of the repository.

Create a new snapshot and select a folder to backup. See the documentation for more information about the settings. In this step, you can set the retention and sync periods.

Click snapshot now, and the file will be backed up.

The files will be automatically backed up.

StorX Integration Series: StorX + Rclone

StorX Network — Mon, 22 Jul 2024 12:52:44 +0000

Introduction:

Restic is a highly secure and efficient backup client written in Go. Each Restic backup is a snapshot of the server/files/directory, deduplicated from what was stored before. Restoring a given backup will restore the server/files/directories to their exact state at that time.

This is a quick-start tutorial that covers Restic usage with Storx.

This guide will cover only some of the tool's basic features. The complete documentation for Restic is located here at their complete command reference.

Installation
RCLONE
Rclone is needed to be able to interact with StorX using restic.

Install Rclone from source.
If you have Golang installed and $GOPATH/bin added to $PATH, you can install Rclone from the source using the following command. The command works for all the operating systems for Desktop and Laptop platforms

go install github.com/rclone/rclone@latest

If the bin folder of $GOPATH is added to $PATH, you can run Rclone from the terminal using the following command.

updated as of 4th July 2024 below:--

What can rclone do for you?
Rclone helps you:

· Backup (and encrypt) files to cloud storage

· Restore (and decrypt) files from cloud storage

· Mirror cloud data to other cloud services or locally

· Migrate data to the cloud or between cloud storage vendors

· Mount multiple, encrypted, cached, or diverse cloud storage as a disk

· Analyse and account for data held on cloud storage using lsf, ljson, size, ncdu

· Union file systems together to present multiple local and cloud file systems as one

Script download and install

To install Rclone on Linux/macOS/BSD systems, run the following:

Rclone

Download the precompiled binaries
Go to download page and download the latest binary for Rclone.

Unzip the downloaded file.
Open the terminal from the Rclone folder.
You can run Rclone from the command line.
You can add the binary's location to the path to make it easier to run in the future.

Alternative Rclone installations:
For alternative installation instructions, see the documentation.

Backing up data
Get API key and secret:
From the top-left corner of the storx dashboard, click the account button and a drop-down menu will appear.

Click access.
Create s3 credentials.

After successful creation, click download all, then finish.
The downloaded file will have all the details you need to backup your files to the storx from your desktop.

JSON
Access Key: jucp2o2qXXXXXXXXXXXXXXXXXXXX
SecretKey: j3lolq5453ktsnnjfXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX Endpoint: https://gateway.storx.io

Configuring Rclone
Edit the Rclone config file directly; you can find where it is stored by running the following:

· Run Rclone config to set up. See rclone config docs for more details.

To create a new repository via the terminal, follow the steps below:-

Rclone config
Current remotes:

Name Type

==== ====

DEFAULT

remote s3

e) Edit existing remote

n) New remote

d) Delete remote

r) Rename remote

c) Copy remote

s) Set configuration password

q) Quit config

e/n/d/r/c/s/q> n

Enter name for new remote.

name> storx

Option Storage.

Type of storage to configure.

Choose a number from below, or type in your value.

1 / 1Fichier

\ (fichier)

2 / Akamai NetStorage

\ (netstorage)

3 / Alias for an existing remote

\ (alias)

4 / Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, GCS, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Minio, Netease, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, StackPath, Storj, Synology, TencentCOS, Wasabi, Qiniu and others

\ (s3)

5 / Backblaze B2

\ (b2)

6 / Better checksums for other remotes

\ (hasher)

7 / Box

\ (box)

8 / Cache a remote

\ (cache)

9 / Citrix Sharefile

\ (sharefile)

10 / Combine several remotes into one

\ (combine)

11 / Compress a remote

\ (compress)

12 / Dropbox

\ (dropbox)

13 / Encrypt/Decrypt a remote

\ (crypt)

14 / Enterprise File Fabric

\ (filefabric)

15 / FTP

\ (ftp)

16 / Google Cloud Storage (this is not Google Drive)

\ (google cloud storage)

17 / Google Drive

\ (drive)

18 / Google Photos

\ (google photos)

19 / HTTP

\ (http)

20 / Hadoop distributed file system

\ (hdfs)

21 / HiDrive

\ (hidrive)

22 / ImageKit.io

\ (imagekit)

23 / In memory object storage system.

\ (memory)

24 / Internet Archive

\ (internetarchive)

25 / Jottacloud

\ (jottacloud)

26 / Koofr, Digi Storage and other Koofr-compatible storage providers

\ (koofr)

27 / Linkbox

\ (linkbox)

28 / Local Disk

\ (local)

29 / Mail.ru Cloud

\ (mailru)

30 / Mega

\ (mega)

31 / Microsoft Azure Blob Storage

\ (azureblob)

32 / Microsoft Azure Files

\ (azurefiles)

33 / Microsoft OneDrive

\ (onedrive)

34 / OpenDrive

\ (opendrive)

35 / OpenStack Swift (Rackspace Cloud Files, Blomp Cloud Storage, Memset Memstore, OVH)

\ (swift)

36 / Oracle Cloud Infrastructure Object Storage

\ (oracleobjectstorage)

37 / Pcloud

\ (pcloud)

38 / PikPak

\ (pikpak)

39 / Proton Drive

\ (protondrive)

40 / Put.io

\ (putio)

41 / QingCloud Object Storage

\ (qingstor)

42 / Quatrix by Maytech

\ (quatrix)

43 / SMB / CIFS

\ (smb)

44 / SSH/SFTP

\ (sftp)

45 / Sia Decentralized Cloud

\ (sia)

46 / Storj Decentralized Cloud Storage

\ (storj)

47 / Sugarsync

\ (sugarsync)

48 / Transparently chunk/split large files

\ (chunker)

49 / Uloz.to

\ (ulozto)

50 / Union merges the contents of several upstream fs

\ (union)

51 / Uptobox

\ (uptobox)

52 / WebDAV

\ (webdav)

53 / Yandex Disk

\ (yandex)

54 / Zoho

\ (zoho)

55 / premiumize.me

\ (premiumizeme)

56 / seafile

\ (seafile)

Storage> 4

Option provider.

Choose your S3 provider.

Choose a number from below, or type in your own value.

Press Enter to leave empty.

1 / Amazon Web Services (AWS) S3

\ (AWS)

2 / Alibaba Cloud Object Storage System (OSS) formerly Aliyun

\ (Alibaba)

3 / Arvan Cloud Object Storage (AOS)

\ (ArvanCloud)

4 / Ceph Object Storage

\ (Ceph)

5 / China Mobile Ecloud Elastic Object Storage (EOS)

\ (ChinaMobile)

6 / Cloudflare R2 Storage

\ (Cloudflare)

7 / DigitalOcean Spaces

\ (DigitalOcean)

8 / Dreamhost DreamObjects

\ (Dreamhost)

9 / Google Cloud Storage

\ (GCS)

10 / Huawei Object Storage Service

\ (HuaweiOBS)

11 / IBM COS S3

\ (IBMCOS)

12 / IDrive e2

\ (IDrive)

13 / IONOS Cloud

\ (IONOS)

14 / Seagate Lyve Cloud

\ (LyveCloud)

15 / Leviia Object Storage

\ (Leviia)

16 / Liara Object Storage

\ (Liara)

17 / Linode Object Storage

\ (Linode)

18 / Magalu Object Storage

\ (Magalu)

19 / Minio Object Storage

\ (Minio)

20 / Netease Object Storage (NOS)

\ (Netease)

21 / Petabox Object Storage

\ (Petabox)

22 / RackCorp Object Storage

\ (RackCorp)

23 / Rclone S3 Server

\ (Rclone)

24 / Scaleway Object Storage

\ (Scaleway)

25 / SeaweedFS S3

\ (SeaweedFS)

26 / StackPath Object Storage

\ (StackPath)

27 / Storj (S3 Compatible Gateway)

\ (Storj)

28 / Synology C2 Object Storage

\ (Synology)

29 / Tencent Cloud Object Storage (COS)

\ (TencentCOS)

30 / Wasabi Object Storage

\ (Wasabi)

31 / Qiniu Object Storage (Kodo)

\ (Qiniu)

32 / Any other S3 compatible provider

\ (Other)

provider> 1

Option env_auth.

Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars).

Only applies if access_key_id and secret_access_key is blank.

Choose a number from below, or type in your own boolean value (true or false).

Press Enter for the default (false).

1 / Enter AWS credentials in the next step.

\ (false)

2 / Get AWS credentials from the environment (env vars or IAM).

\ (true)

env_auth> 1

Option access_key_id.

AWS Access Key ID.

Leave blank for anonymous access or runtime credentials.

Enter a value. Press Enter to leave empty.

access_key_id>

Option secret_access_key.

AWS Secret Access Key (password).

Leave blank for anonymous access or runtime credentials.

Enter a value. Press Enter to leave empty.

secret_access_key>

Option region.

Region to connect to.

Choose a number from below, or type in your own value.

Press Enter to leave empty.

/ The default endpoint — a good choice if you are unsure.

1 | US Region, Northern Virginia, or Pacific Northwest.

| Leave location constraint empty.

\ (us-east-1)

/ US East (Ohio) Region.

2 | Needs location constraint us-east-2.

\ (us-east-2)

/ US West (Northern California) Region.

3 | Needs location constraint us-west-1.

\ (us-west-1)

/ US West (Oregon) Region.

4 | Needs location constraint us-west-2.

\ (us-west-2)

/ Canada (Central) Region.

5 | Needs location constraint ca-central-1.

\ (ca-central-1)

/ EU (Ireland) Region.

6 | Needs location constraint EU or eu-west-1.

\ (eu-west-1)

/ EU (London) Region.

7 | Needs location constraint eu-west-2.

\ (eu-west-2)

/ EU (Paris) Region.

8 | Needs location constraint eu-west-3.

\ (eu-west-3)

/ EU (Stockholm) Region.

9 | Needs location constraint eu-north-1.

\ (eu-north-1)

/ EU (Milan) Region.

10 | Needs location constraint eu-south-1.

\ (eu-south-1)

/ EU (Frankfurt) Region.

11 | Needs location constraint eu-central-1.

\ (eu-central-1)

/ Asia Pacific (Singapore) Region.

12 | Needs location constraint ap-southeast-1.

\ (ap-southeast-1)

/ Asia Pacific (Sydney) Region.

13 | Needs location constraint ap-southeast-2.

\ (ap-southeast-2)

/ Asia Pacific (Tokyo) Region.

14 | Needs location constraint ap-northeast-1.

\ (ap-northeast-1)

/ Asia Pacific (Seoul).

15 | Needs location constraint ap-northeast-2.

\ (ap-northeast-2)

/ Asia Pacific (Osaka-Local).

16 | Needs location constraint ap-northeast-3.

\ (ap-northeast-3)

/ Asia Pacific (Mumbai).

17 | Needs location constraint ap-south-1.

\ (ap-south-1)

/ Asia Pacific (Hong Kong) Region.

18 | Needs location constraint ap-east-1.

\ (ap-east-1)

/ South America (Sao Paulo) Region.

19 | Needs location constraint sa-east-1.

\ (sa-east-1)

/ Israel (Tel Aviv) Region.

20 | Needs location constraint il-central-1.

\ (il-central-1)

/ Middle East (Bahrain) Region.

21 | Needs location constraint me-south-1.

\ (me-south-1)

/ Africa (Cape Town) Region.

22 | Needs location constraint af-south-1.

\ (af-south-1)

/ China (Beijing) Region.

23 | Needs location constraint cn-north-1.

\ (cn-north-1)

/ China (Ningxia) Region.

24 | Needs location constraint cn-northwest-1.

\ (cn-northwest-1)

/ AWS GovCloud (US-East) Region.

25 | Needs location constraint us-gov-east-1.

\ (us-gov-east-1)

/ AWS GovCloud (US) Region.

26 | Needs location constraint us-gov-west-1.

\ (us-gov-west-1)

region> 1

Option endpoint.

Endpoint for S3 API.

Leave blank if using AWS to use the default endpoint for the region.

Enter a value. Press Enter to leave empty.

endpoint>

Option location_constraint.

Location constraint — must be set to match the Region.

Used when creating buckets only.

Choose a number from below, or type in your own value.

Press Enter to leave empty.

1 / Empty for US Region, Northern Virginia, or Pacific Northwest

\ ()

2 / US East (Ohio) Region

\ (us-east-2)

3 / US West (Northern California) Region

\ (us-west-1)

4 / US West (Oregon) Region

\ (us-west-2)

5 / Canada (Central) Region

\ (ca-central-1)

6 / EU (Ireland) Region

\ (eu-west-1)

7 / EU (London) Region

\ (eu-west-2)

8 / EU (Paris) Region

\ (eu-west-3)

9 / EU (Stockholm) Region

\ (eu-north-1)

10 / EU (Milan) Region

\ (eu-south-1)

11 / EU Region

\ (EU)

12 / Asia Pacific (Singapore) Region

\ (ap-southeast-1)

13 / Asia Pacific (Sydney) Region

\ (ap-southeast-2)

14 / Asia Pacific (Tokyo) Region

\ (ap-northeast-1)

15 / Asia Pacific (Seoul) Region

\ (ap-northeast-2)

16 / Asia Pacific (Osaka-Local) Region

\ (ap-northeast-3)

17 / Asia Pacific (Mumbai) Region

\ (ap-south-1)

18 / Asia Pacific (Hong Kong) Region

\ (ap-east-1)

19 / South America (Sao Paulo) Region

\ (sa-east-1)

20 / Israel (Tel Aviv) Region

\ (il-central-1)

21 / Middle East (Bahrain) Region

\ (me-south-1)

22 / Africa (Cape Town) Region

\ (af-south-1)

23 / China (Beijing) Region

\ (cn-north-1)

24 / China (Ningxia) Region

\ (cn-northwest-1)

25 / AWS GovCloud (US-East) Region

\ (us-gov-east-1)

26 / AWS GovCloud (US) Region

\ (us-gov-west-1)

location_constraint> 1

Option acl.

Canned ACL used when creating buckets and storing or copying objects.

This ACL is used for creating objects and if bucket_acl isn’t set, for creating buckets too.

For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl

Note that this ACL is applied when server-side copying objects, as S3 doesn’t copy the ACL from the source but writes a fresh one.

If the acl is an empty string, then no X-Amz-Acl: header is added, and
the default (private) will be used.

Choose a number from below, or type in your own value.

Press Enter to leave empty.

/ Owner gets FULL_CONTROL.

1 | No one else has access rights (default).

\ (private)

/ Owner gets FULL_CONTROL.

2 | The AllUsers group gets READ access.

\ (public-read)

/ Owner gets FULL_CONTROL.

3 | The AllUsers group gets READ and WRITE access.

| Granting this on a bucket is generally not recommended.

\ (public-read-write)

/ Owner gets FULL_CONTROL.

4 | The AuthenticatedUsers group gets READ access.

\ (authenticated-read)

/ Object owner gets FULL_CONTROL.

5 | Bucket owner gets READ access.

| If you specify this canned ACL when creating a bucket, Amazon S3 ignores it.

\ (bucket-owner-read)

/ Both the object and bucket owners get FULL_CONTROL over the object.

6 | If you specify this canned ACL when creating a bucket, Amazon S3 ignores it.

\ (bucket-owner-full-control)

acl> 1

Option server_side_encryption.

The server-side encryption algorithm used when storing this object in S3.

Choose a number from below, or type in your own value.

Press Enter to leave empty.

1 / None

\ ()

2 / AES256

\ (AES256)

3 / aws:kms

\ (aws:kms)

server_side_encryption> 1

Option sse_kms_key_id.

If using KMS ID, you must provide the ARN of the Key.

Choose a number from below, or type in your value.

Press Enter to leave empty.

1 / None

\ ()

2 / arn:aws:kms:*

\ (arn:aws:kms:us-east-1:*)

sse_kms_key_id>

Option storage_class.

The storage class to use when storing new objects in S3.

Choose a number from below, or type in your value.

Press Enter to leave empty.

1 / Default

\ ()

2 / Standard storage class

\ (STANDARD)

3 / Reduced redundancy storage class

\ (REDUCED_REDUNDANCY)

4 / Standard Infrequent Access storage class

\ (STANDARD_IA)

5 / One Zone Infrequent Access storage class

\ (ONEZONE_IA)

6 / Glacier storage class

\ (GLACIER)

7 / Glacier Deep Archive storage class

\ (DEEP_ARCHIVE)

8 / Intelligent-Tiering storage class

\ (INTELLIGENT_TIERING)

9 / Glacier Instant Retrieval storage class

\ (GLACIER_IR)

storage_class> 1

Edit advanced config?

y) Yes

n) No (default)

y/n> n

Configuration complete.

Options:

type: s3
provider: AWS
region: us-east-1
acl: private

Keep this “storx” remote?

y) Yes this is OK (default)

e) Edit this remote

d) Delete this remote

y/e/d>

· Once you have completed the repository creation, you can exit the above, enter ctrl+c, and exit.

· Run Rclone -h in the terminal.

(Or)

· Run the below command to find the config file and update it: —

Rclone config file

In clone.conf, set the access_key_id and secret_access_key with the S3-compatible credentials created above.

To edit the config file, open it using your preferred text editor or from your terminal

nano C:\Users\user\AppData\Roaming\rclone\rclone.conf # replace with your path to the config fi

Use the following config

[storx] type = s3

provider = Storx

access_key_id = jucp2o2qygzqois2ro5nowi4nvea # REPLACE ME

secret_access_key = j3lolq5453ktsnnjf73ci5px6y23vaos7d43hrz7ucxw6j47mtfj4 # REPLACE ME endpoint = gateway.storx.io

chunk_size = 64Mi disable_checksum: true

Remove a bucket

Rclone rmdir storx:restic-test-bucket/ — →>>(Note:-Put forward slash)

(If the slash is removed from the path, we will get the following error: — (caused by: Put "https://test2.gateway.storx.io/": dial tcp: lookup test2.gateway.storx.io on 127.0.0.00:00: no such host))

List vault using the command:-
Rclone lsf storx:

Now, to create the vault: —
Rclone mkdir storx:restic-test-bucket/

List the file inside the vault.
Rclone ls storx:qqq/

The bucket should be listed in the StorX dashboard.

You can find the changes in the web application once you log in to the account.

We are excited to announce the launch of the 1st StorX UAT SDK.

StorX Network — Fri, 28 Oct 2022 14:59:45 +0000

StorX UAT SDK allows developer community to connect to StorX Network Decentralized Cloud Storage UAT seamlessly and access Decentralized Cloud Storage securely. SDK is open-source and readily available for any developers to deploy.

SDK empowers user to create and access modules. This steps align with our vision to work closely with developer community and create host of use cases and utilities around StorX Network. This is an important milestone after the launch of UAT towards our mainnet scheduled at end of Q1 2023.

What's more, the StorX SDK is a capabilities-based system that allows developers to better reason about the security of interactions between modules.

For a deeper look at capabilities and how to integrate SDK into your app, follow the guidelines below:

The UAT app is hosted on http://109.169.55.25:3000/. You'll have to create your account in the platform. Once created please notify us to activate your account.
Once your account is activated, Go to http://109.169.55.28:3000/. Login with the credentials you created in the StorX app.
Copy the Secret key and the Secret Mnemonic. This will be needed for the SDK functions to authorise your account.
Now there are 2 ways to integrate StorX to your account. One is by using Node SDK which you can use if your backend is built on Node. Other is by the traditional REST APIs.

If your backend is built on Node, refer this link https://github.com/StorXNetwork/storx-storage-sdk and use the Github link to install the SDK package on your app. You can then intialize the SDK with those keys and use the functions in Readme file of Github link to integrate StorX.
If your backend is not on Node; refer to this Postman collection link https://www.postman.com/collections/0ee6ba856654d4983b8a. Here you can get the details of the APIs needed to integrate StorX in your app.

How to Store your $SRX token with Onto Wallet

StorX Network — Fri, 22 Jul 2022 07:37:46 +0000

Now let’s start step-by-step with the below guide that will guide you to store $SRX tokens on Onto wallet.

Step-1:- Go to https://onto.app/en/download/ and download the android or IOS app.

Step-2:- After clicking on create the wallet, it will open a new tab on your window; there will be two options available for you to create a new wallet or restore or import your wallet. If you click on restore or import account, you will have to go-to currency and select XinFin and will have to log in with the private key of XinFin web or android wallet, and you will find your SRX tokens on Onto wallet.

Step-3:- Click on “Create a new wallet”. After that, enter a password and click on “I’ve written it down”, make sure you have noted down your password. We strongly recommend you to take multiple backups of your password and never share it with anyone as it may risk you losing your tokens.

Step-4:- Search for XDC Network under Add Wallet and once created successfully, take the backup file of your account. We would recommend taking multiple backups of your file and storing your file safely.

Step-5:- After taking the backup, you will find the Dashboard of Onto wallet. Search for SRX under Assets and Click on StorX to select the token.

Step 6: Under your custom wallet, you should be able to see StorX $SRX token as an active asset to be able to send or receive.

Step 7:- After sending the SRX tokens to the Onto wallet address, you will find the SRX tokens on your Onto wallet.

Other Wallets
The StorX token $SRX can be stored also in the Dcent Wallet. Learn how to create a StorX account on the D’CENT wallet.
Apart from Dcent, SRX can be stored on XinFin Webwallet, XDCPay, Guarda Wallet, Ellipal Titan Cold Wallet, Infinity Wallet and other XRC20 compatible wallets.

Guide to set up Farmer/Storage Node on the StorX Network.

StorX Network — Sat, 28 May 2022 08:03:05 +0000

StorX Farmer Node
Run a Farmer/Storage Node on StorX Network

This guide will instruct you how to set up Farmer/Storage Node on the StorX Network

Preliminaries

Running a Storage Node on a live network is a responsible job. The credibility of the complete network depends upon the performance of Farmer/Storage Nodes.
If there are any issues the possibility of your node getting slashed.
To compensate for the efforts, running a community memes are rewarded with SRX Tokens, knowing that you contribute to the security of a decentralized network while growing your stash.
If you need help, please reach out on the Community Page. The community members are there to help answer questions and provide tips from experience.

How many SRX (StorX Native Tokens) do I need?

To qualify for Farmer/Storage Node on StorX Network, you need between 6000 - 1 Million SRX, with the existential deposit, plus XDC for transaction fees.

Note: The minimum staking amount will be updated as per the new incremental model from 03/08/2021 onwards. Refer

We requests Storage Node operators to maintain Good Node Reputation to ensure StorX Ecosystem works perfectly.

Tips for maintaining a Good Node Reputation:

Ensure Strong Cloud Infrastructure.
Higher SRX Stake adds value to “Good” Node Reputation.
Ensure 100% uptime.
Always ensure nodes maintain the latest software patch and OS updates.
Warning:

Underperformance can lead to disqualification of nodes, which can lead to No ‘hosting and staking rewards’. Repeated low reputation can lead to a penalty; Staked SRX might be burned as a penalty as it may harm StorX Storage Network.
Any SRX that you stake for Farmer/Storage Node on StorX Network is liable to be slashed, meaning that an insecure or improper setup may result in loss of reputation leading to slashing of Farmer/Storage Node on StorX Network.
Initial Set-up
Requirements

The most common way for a beginner to run a validator is on a cloud server running Linux. You may choose whatever VPS provider that you prefer, and whatever operating system you are comfortable with. For this guide we will be using Ubuntu 20.04 64-bit or higher, but the instructions should be similar for other platforms.

The storage operations in Farmer/Storage Node on StorX were benchmarked on standard hardware. It is recommended that you run at least the standard hardware in order to ensure they are able to process all storage requirements. The following are not minimum requirements but if you decide to run with less than this beware that you might have performance issues.

One Processor Core
Minimum 1 TB of available disk space
Minimum 10 TB of available bandwidth a month
Minimum upload speed of 25 MBPS
Minimum download speed of 25 MBPS
Ensure Node availability 24/7
Key Management

Private keys are the central primitive of any cryptographic system and need to be handled with extreme care.
Loss of your private key can lead to irreversible loss of value.
How to Setup StorX Farmer node
Method 1:- Setup StorX Farmer node Bootstrap Script

Bootstrap Command StorX Node Setup :-

sudo su -c "bash <(wget -qO- https://raw.githubusercontent.com/StorXNetwork/StorX-Node/main/bootstrap.sh)" root

Examples :-

root……..:~# sudo su -c "bash <(wget -qO- https://raw.githubusercontent.com/StorXNetwork/StorX-Node/main/bootstrap.sh)" root
Please enter your XDC Address for StorX Rewards:- xdc……

Method 2:- Setup StorX Farmer Node Docker

Operating System: Ubuntu 20.04 64-bit or higher Should be facing internet directly with public IP & without NAT

Tools: Docker, Docker Compose (1.29.2+) Setup (For Ubuntu 20.04 64-bit or higher Operating System)

Clone repository

git clone https://github.com/StorXNetwork/StorX-Node

Enter StorX-Node directory

cd StorX-Node

Step 1: Install docker & docker-compose

sudo bash ./install_docker.sh

Step 2: Update .env file with details

Create .env file by using the sample - .env.example
Enter either your StorX Rewards address in the WALLETADD field.
cp env.example .env
nano .env
Step 3: Start your Node

For MainNet Run:

sudo docker-compose -f docker-services.yml up -d

To stop the node or if you encounter any issues use::

sudo docker-compose -f docker-services.yml down

Step 4: Stake SRX token

After setting up FarmNode/StorageNode please Stake SRX token from the URL : https://farmer.storx.io/

IMP Note : You have to stake SRX token to get hosting and staking rewards.

How to Check Status
To check the status of your node:

sudo bash ./getstatus.sh

How to Upgrade your StorX Farmer Node
How to upgrade your StorX node with the latest changes?

git pull
sudo bash ./upgrade.sh

Troubleshooting:
Public discussions on the technical issues, post articles and request for Enhancements and Technical Contributions.

Telegram - Stay updated with all the Announcements.
Discord - Join the community to find answers to all your questions.
Reddit - Join the channel to have a healthy interaction with the community.
GitHub - Join the developers community on GitHub