1 of 16

Start Usage

Start user in windows

Step 1 Download Installer

Download url：https://github.com/memoio/go-mefs-release/releases/

Step 2 Unzip Package

Unzip mefs-user-install.zip

Step 3 Install

Enter "mefs-user-install" file folder, double click install.exe for regestering user.

Step 4 Check Account Address

After successfully registered user, you can see the content of installation directory as follows:

Open “account.txt.” It will contain your wallet address and created password as shown below.

Contact the Memolabs team to recharge your wallet with some tokens before proceeding to the next stage.

Step 5 Top Up

Starting node needs both the Memo and cMemo token.

To get the cMemo token, there is one faucet,

This is the MemoChain information.

Memochain information

Chain RPC:

Currency name: CMEMO

Chain ID: 985

Chain browser:

To get Memo Tokens for your wallet, you can transfer some Memo Tokens from other wallet address which has enough Memo Tokens. The user needs minimum 1 Memo Tokens.

Join our discussing with Slack Link:

If you want to check the account balance,Please refer to this link

Step 6

When your installation completed, the content of installation folder is as follows:

Mmeanwhile there are 2 more icons appeared on your desktop.

Run 'memo_start' icon on desktop to start user.

The running window will show that user node is starting, and data is being synchronized. This will take about 5 hours to complete, please be patient.

Step 7 Check Running Status

Now you can see two "mefs-user.exe" in the task manager shows the user node and gateway is running.

Step 8 Using User with Webui

Open URL in your web browser to use user WebUI

Open the account.txt in the memouser folder to view your login imformation

Create bucket

Caution: If this is the first run of your User node, you need to wait about 10~20 minutes for node to complete synchronization. If sync is not complete yet, you will get a "lfs service is read only" error.

After that you can begin create bucket.

Upload file

Caution: When a new bucket is created, it needs about 2 minutes to be confirmed. So wait a moment before you start to upload files into a new bucket.

Download file

Stop User

You can stop user node with following 2 methods. But this just closes node service, the gateway service is not closed, you have to manually close it in the task manager for now.

Start user in docker

How to start

Step by step

Step 1: Environment Deployment

View Docker Installation section to install docker.

Step 2: Set up the node directory

Node home directory: ~/memo_user as an example:

Node data storage directory: ~/memo_user_data as an example.

The node home directory is the user directory and the node storage directory is the user node data storage directory.

Step 3: Pull image(User)

Step 4: Initialization（Create new wallet）

Explanation of parameters:

--password: Enter your user node password, the default is memoriae.

init: Execute the initialization command, which will generate your wallet address and generate a configuration file.

Step 5: Get wallet address

Explanation of parameters:

wallet default: Get the default wallet address

Step 6: Top up

Starting node needs both the Memo and cMemo token.

To get the cMemo token, there is one faucet,

This is the MemoChain information.

Memochain information

Chain RPC:

Currency name: CMEMO

Chain ID: 985

Chain browser:

To get Memo Tokens for your wallet, you can transfer some Memo Tokens from other wallet address which has enough Memo Tokens. The user needs minimum 1 Memo Tokens.

Join our discussing with Slack Link:

Step 7: Modify the configuration file

Step 8:Start node

Default in web, account: admin; password: memoriae.
Please make sure your user home directory and password are the same as in the previous step.

If you have any technical problems, please join our Discord server for help.

Check running status

Step 1: Enter the container

Step 2: Check user information

Check net status

Get local node network information

Command description: Enter command net info to view the network id (cid), ip address and port of the current node.

Get the network connection information of the node

Command description: Enter command net peers to view the network connection information of the current node.

Connect to any node

Command description: Enter command net connect to connect to any node; if there is any problem with your node network, please enter command net connect to connect to our public node.

Restart after poweroff

If the account has been started, and then the computer has been shutted down, Docker, or "Windows PowerShell" was been closed, if you need to restart MEMO again, you need to open Docker first, then run the command line " docker start mefs-user" to start.

How to use

Bucket Operation

Create bucket

Command description: Enter createBucket to create a bucket according to the BucketName. Each bucket can be set with a different redundancy policy. The redundancy policy is multi-replica or erasure code. The redundancy level can be determined by adjusting the number of the data block and parity block. 3 data blocks and erasure code of 2 parity blocks are used by default, the loss of two blocks is tolerable.

mefs provides dedicated encrypted storage space (LFS) for each user, each storage space contains multiple buckets, buckets are containers that users use to store objects, and each bucket contains multiple objects. We can think of objects as files. The redundancy policy of a bucket can be specified at creation time (all objects stored in the bucket use this redundancy policy).

When creating a bucket policy, the value of dc+pc should be less than the number of providers in the group where the current user belongs. Users can modify the number of dc and pc according to their own needs.

Check bucket list

Command description: Enter listBuckets to display all buckets created by this user, including the name of each bucket, creation time, redundancy policy and redundancy parameters (DataCount, ParityCount).

Check bucket information

Command description: If BucketName exists, entering headBucket displays its creation time, redundancy policy and redundancy parameters. If BucketName does not exist, it displays that bucket does not exist.

Upload and Download

Upload file

Command description: Entering putObject to upload an object named ObjectName into BucketName; if the bucket does not exist, it will display that the bucket does not exist; if the object already exists, it will display that the object already exists.

echo "hello MEMO" >~/test.file
mefs-user lfs putObject --bn=test2 --on=obj1 --path=~/test.file

Check file information

Command description: Enter listObjects to list all objects in BucketName, including object size, creation time, MD5 value, and the most recent challenge time.

Download file

Command description: Enter getObject to download an object named ObjectName from BucketName; if the bucket does not exist, it displays that the bucket does not exist; if the object does not exist, it displays that the object does not exist.

Start provider in docker

How to start

Step 1: Environment Deployment

View Docker Installation section to install docker.

Step 2: Set up the node directory

Node home directory:

Using "~/memo_provider" as an example:

Node data storage directory: ~/memo_user_data as an example.

The node home directory is the provider directory and the node storage directory is the provider node data storage directory.

Step 3: Pull image(provider)

Step 4: Initialization（Create new wallet）

Explanation of parameters:

--password: Enter your provider node password, the default is memoriae.

Init: Execute the initialize command, which will generate your wallet address and generate a configuration file.

Step 5: Get wallet address

Explanation of parameters:

wallet default: Get the default wallet address

Step 6: Top up

Starting node needs both the Memo and cMemo token.

To get the cMemo token, there is one faucet,

This is the MemoChain information.

Memochain information

Chain RPC:

Currency name: CMEMO

Chain ID: 985

Chain browser:

To get Memo Tokens for your wallet, you can transfer some Memo Tokens from other wallet address which has enough Memo Tokens. The provider needs minimum 30 Memo Tokens.

Join our discussing with Slack Link:

Step 7: Modify the configuration file

Step 8:Start node

Please make sure your user home directory and password are the same as in the previous step.

If there is any deploy issue. Please join the deploy-node discussing with Slack Link:

Checking the running status

Step 1: Enter the container

Step 2: Check provider information

Step 3: Declare

• When participating as a provider node, you need to execute the declare command (declare the public network address) for communication between nodes;

• Get your public network ip+port ready, I will show you below;

• Note: Execute the command in the container;

• The command mefs-provider info can only be executed after the sync information displays as true. Although the synchronization can be successful without doing so, it will not be able to communicate with other nodes.

Parameter explanation

X.X.X.X is your public ip address.

Port 4007 is your public network port, and the mapped port is the host's port 4001 (-p 4001: the first port 4001 of the boot parameter).

Check net status

Get local node network information

Command description: Enter command net info to view the network id (cid), ip address and port of the current node.

Get the network connection information of the node

Command description: Enter command net peers to view the network connection information of the current node.

Connect to any node

Command description: Enter command net connect to connect to any node; if there is any problem with your node network, please enter command net connect to connect to our public node.

COMMON MISTAKES

ERROR: not have tx fee on chain

Solution: Check the node, both of the cMemo token balance, and the memo balance. The Memo token balance must meet the minimum amount for node startup.

ERROR: execution reversed: can't unpledge during 180d

The node pledge amount needs to be withdrawn 180 days after the last pledge.

If the log reports that the meta and state files are missing, you can perform the Recover operation.

mefs-provider recover db --path /home/mcloud/provider2/.memo-provider/meta

mefs-provider recover db --path /home/mcloud/provider2/.memo-provider/state

Hardware Recommendation

If you want to be the Provider, you can set a detailed basic configuration information.

Do you want to earn income from unused storage space and bandwidth?

If you have spare storage space and bandwidth and want to make some profit from it, you can participate in Memo as a provider.

Recommended configuration：

8 cores, 16G memory, 2TB storage, 20Mbps bandwidth;
External network IP, port 4001 is usable;
Docker environment;

How to use user

This document is detailed about how to use user node, the installation guide is in another document. Use LFS command to operate upload and download functions.

lfs command

Introduction

This command creates, uploads, downloads, and views a collection of containers and files for the user.

Usage

Subcommands

Introduction

This command creates buckets

Usage

Options

Example

Bucket name: test, storage policy: erasure code, number of data blocks: 10, number of check blocks 5

Introduction

This command is used to view the status of all buckets

Usage

Introduction

This command is used to view all the information of the specified bucket, the following is an example (test is the bucket name)

Usage

Introduction

This command specifies the file for upload

Usage

USAGE: mefs-user lfs putObject [command options] [arguments...]

OPTIONS: --bucket value, --bn value use bucket name --object value, --on value file name after upload --path value upload file path --etag value select verification method (default: md5) --enc value Select encryption method (default: aes) --help, -h View help

Introduction

This command is used to view the specified file status

Usage

Example

Introduction

Download the file to the specified path

Usage

Example

Introduction

View all file information of a specified bucket

Usage

Example

Introductioin

delete specified file

Usage

Example

Introduction

Download objects using rpc

Usage

Example

Introduction

Display the storage information of the node

Example

Introduction

View the bucket user list

Example

Gateway Mode

Multiple users can share one mefs's running program.

User Agent Start

After mefs is started, other users can also be started as a proxy.

Parameter explanation:

After mefs is started, other users can also be shut down by proxy.

Parameter explanation:

Http

The user whose address is the public key obtains the file named ObjectName from the BucketName bucket.

Http

HTTP Operation

Mefs commands can all be operated using HTTP.

Configuration

Before mefs-user starts, confirm the following configuration is set in the config.json:

// mefs api port setting, default is 5001

api.address is set to: /ip4/0.0.0.0/tcp/5001

// cross-domain access

api.accessControlAllowOrigin is set to: ["*"]

api.accessControlAllowMethods is set to: ["PUT","GET", "POST"]

Then restart mefs-user to use HTTP to operate.

Usage

A command similar to the following:

The corresponding HTTP request is:

IP is the network address of the machine where mefs-user is started. The port defaults to 5001. If cross-domain access is configured before running, you can use the external network IP to access, otherwise you can only access it through 127.0.0.1.

The output is in standard JSON format:

Docker Installation

For Windows

Before starting the memo, you must install docker.

Windows install Docker：

1、Docker official website

2、Download docker for windows

Wait for the download to complete.

Double click to install.

Wait, finish.

After the installation is complete, you will be prompted to restart the computer

Double-click the icon to start docker

Install WSL 2 (a program necessary for installing docker on windows)

For Linux

Before starting the memo, you must install docker.

Docker: Install on Linux

How to install Docker in Linux(Ubuntu)：

1、Update apt package index

2、Install the following packages to enable apt to use the repository over HTTPS

3、Add the GPG key of Docker official

4、Run the following command line to set up the stable repository

5、 Update the apt package index again

6、 Install the latest version of Docker CE

7、 Verify whether the installation is successful

Check the version of docker installed

Start docker and pull hello-world to verify whether the installation is successful

Since sudo access is required to use docker, enter the password here and it will be started successfully.

Next, run the following command line

You can see the container being downloaded from the remote for testing： Pulling from library/hello-world

When you see the message： Hello from Docker! It means the docker is successfully installed.

How to start

Step 1: Environment Deployment

View Docker Installation section to install docker.

Step 2: Set up the node directory

Node home directory:

Using "~/memo_provider" as an example:

Node data storage directory: ~/memo_user_data as an example.

The node home directory is the provider directory and the node storage directory is the provider node data storage directory.

Step 3: Pull image(provider)

Step 4: Initialization（Create new wallet）

Explanation of parameters:

--password: Enter your provider node password, the default is memoriae.

Init: Execute the initialize command, which will generate your wallet address and generate a configuration file.

Step 5: Get wallet address

Explanation of parameters:

wallet default: Get the default wallet address

Step 6: Top up

Starting node needs both the Memo and cMemo token.

To get the cMemo token, there is one faucet,

This is the MemoChain information.

Memochain information

Chain RPC:

Currency name: CMEMO

Chain ID: 985

Chain browser:

To get Memo Tokens for your wallet, you can transfer some Memo Tokens from other wallet address which has enough Memo Tokens. The provider needs minimum 30 Memo Tokens.

Join our discussing with Slack Link:

Step 7: Modify the configuration file

Step 8:Start node

Please make sure your user home directory and password are the same as in the previous step.

If there is any deploy issue. Please join the deploy-node discussing with Slack Link:

Checking the running status

Step 1: Enter the container

Step 2: Check provider information

Step 3: Declare

• When participating as a provider node, you need to execute the declare command (declare the public network address) for communication between nodes;

• Get your public network ip+port ready, I will show you below;

• Note: Execute the command in the container;

Parameter explanation

X.X.X.X is your public ip address.

Port 4007 is your public network port, and the mapped port is the host's port 4001 (-p 4001: the first port 4001 of the boot parameter).

Check net status

Get local node network information

Command description: Enter command net info to view the network id (cid), ip address and port of the current node.

Get the network connection information of the node

Command description: Enter command net peers to view the network connection information of the current node.

Connect to any node

Command description: Enter command net connect to connect to any node; if there is any problem with your node network, please enter command net connect to connect to our public node.

COMMON MISTAKES

ERROR: not have tx fee on chain

Solution: Check the node, both of the cMemo token balance, and the memo balance. The Memo token balance must meet the minimum amount for node startup.

ERROR: execution reversed: can't unpledge during 180d

The node pledge amount needs to be withdrawn 180 days after the last pledge.

If the log reports that the meta and state files are missing, you can perform the Recover operation.

mefs-provider recover db --path /home/mcloud/provider2/.memo-provider/meta

mefs-provider recover db --path /home/mcloud/provider2/.memo-provider/state

Start Usage

Start user in windows

hashtagStep 1 Download Installer

hashtagDownload url：https://github.com/memoio/go-mefs-release/releases/arrow-up-right

hashtagStep 2 Unzip Package

hashtagUnzip mefs-user-install.zip

hashtagStep 3 Install

hashtagStep 4 Check Account Address

hashtagAfter successfully registered user, you can see the content of installation directory as follows:

hashtagOpen “account.txt.” It will contain your wallet address and created password as shown below.

hashtagContact the Memolabs team to recharge your wallet with some tokens before proceeding to the next stage.

hashtagStep 5 Top Up

hashtagStep 6

hashtagStep 7 Check Running Status

hashtagStep 8 Using User with Webui

hashtagCreate bucket

hashtagUpload file

hashtagCaution: When a new bucket is created, it needs about 2 minutes to be confirmed. So wait a moment before you start to upload files into a new bucket.

hashtagDownload file

hashtagStop User

hashtagYou can stop user node with following 2 methods. But this just closes node service, the gateway service is not closed, you have to manually close it in the task manager for now.

Start user in docker

How to start

hashtagStep by step

hashtagStep 1: Environment Deployment

hashtagStep 2: Set up the node directory

hashtagStep 3: Pull image(User)

hashtagStep 4: Initialization（Create new wallet）

hashtagStep 5: Get wallet address

hashtagStep 6: Top up

hashtagStep 7: Modify the configuration file

hashtagStep 8:Start node

hashtagCheck running status

hashtagStep 1: Enter the container

hashtagStep 2: Check user information

hashtagCheck net status

hashtagGet local node network information

hashtagGet the network connection information of the node

hashtagConnect to any node

hashtagRestart after poweroff

How to use

Bucket Operation

hashtagCreate bucket

hashtagCheck bucket list

hashtagCheck bucket information

Upload and Download

hashtagUpload file

hashtagCheck file information

hashtagDownload file

Start provider in docker

How to start

hashtagStep 1: Environment Deployment

hashtagStep 2: Set up the node directory

hashtagStep 3: Pull image(provider)

hashtagStep 4: Initialization（Create new wallet）

hashtagStep 5: Get wallet address

hashtagStep 6: Top up

hashtagStep 7: Modify the configuration file

hashtagStep 8:Start node

hashtagChecking the running status

hashtagStep 1: Enter the container

hashtagStep 2: Check provider information

hashtagStep 3: Declare

hashtagCheck net status

hashtagGet local node network information

hashtagGet the network connection information of the node

hashtagConnect to any node

Hardware Recommendation

hashtagDo you want to earn income from unused storage space and bandwidth?

hashtagRecommended configuration：

How to use user

Gateway Mode

HTTP Operation

Docker Installation

For Windows

hashtagWindows install Docker：

hashtagWait for the download to complete.

hashtagDouble click to install.

hashtagWait, finish.

hashtagAfter the installation is complete, you will be prompted to restart the computer

Step 1 Download Installer

Download url：https://github.com/memoio/go-mefs-release/releases/

Step 2 Unzip Package

Unzip mefs-user-install.zip

Step 3 Install

Step 4 Check Account Address

After successfully registered user, you can see the content of installation directory as follows:

Open “account.txt.” It will contain your wallet address and created password as shown below.

Contact the Memolabs team to recharge your wallet with some tokens before proceeding to the next stage.

Step 5 Top Up

Step 6

Step 7 Check Running Status

Step 8 Using User with Webui

Create bucket

Upload file

Caution: When a new bucket is created, it needs about 2 minutes to be confirmed. So wait a moment before you start to upload files into a new bucket.

Download file

Stop User

You can stop user node with following 2 methods. But this just closes node service, the gateway service is not closed, you have to manually close it in the task manager for now.

Step by step

Step 1: Environment Deployment

Step 2: Set up the node directory

Step 3: Pull image(User)

Step 4: Initialization（Create new wallet）

Step 5: Get wallet address

Step 6: Top up

Step 7: Modify the configuration file

Step 8:Start node

Check running status

Step 1: Enter the container

Step 2: Check user information

Check net status

Get local node network information

Get the network connection information of the node

Connect to any node

Restart after poweroff

Create bucket

Check bucket list

Check bucket information

Upload file

Check file information

Download file

Step 1: Environment Deployment

Step 2: Set up the node directory

Step 3: Pull image(provider)

Step 4: Initialization（Create new wallet）

Step 5: Get wallet address

Step 6: Top up

Step 7: Modify the configuration file

Step 8:Start node

Checking the running status

Step 1: Enter the container

Step 2: Check provider information

Step 3: Declare

Check net status

Get local node network information

Get the network connection information of the node

Connect to any node

Do you want to earn income from unused storage space and bandwidth?

Recommended configuration：

Windows install Docker：

Wait for the download to complete.

Double click to install.

Wait, finish.

After the installation is complete, you will be prompted to restart the computer

Double-click the icon to start docker

Install WSL 2 (a program necessary for installing docker on windows)

Docker: Install on Linux

How to install Docker in Linux(Ubuntu)：

1、Update apt package index

2、Install the following packages to enable apt to use the repository over HTTPS

3、Add the GPG key of Docker official

4、Run the following command line to set up the stable repository

5、 Update the apt package index again

6、 Install the latest version of Docker CE

7、 Verify whether the installation is successful

Create bucket

Check bucket list

Check bucket information

Do you want to earn income from unused storage space and bandwidth?