Getting Started

Getting setup to use Merge

This guide covers the basic things you need to do to get started with Merge.

Account Setup

The first step to experimenting on a Merge testbed is to create an account on the Merge portal. Follow the instructions either using “Launch” (the graphical web interface) or through the Merge command line interface (CLI).

Account Creation through Launch

Navigate to the Merge “Launch” GUI at https://launch.redstartb.net. You’ll be greeted with a page that looks much like this

Click the Register new account link to load the account creation page.

Fill in your account details:

  • E-Mail - the email of the account
  • Password - the account password. The password will be rejected with a reason if it is not strong enough.
  • traits-username - the username you will use to login to Merge

Once done, click Sign Up.

Activate Your Merge Portal Account

Send a notification to the Merge portal administrators to have your account created and activated. They will use the Identity account created above to create an account for you on the Merge Portal. Speak with your project leader for up-to-date information on how best to contact them.

Until your account is activated, you’ll see that you do not have access to any projects on the portal. You can login, but you will not have access to anything so pages in Launch will be content-free.

Once your account has been activated, your data will load and you are ready to start using Merge!

Account Creation through the CLI

First download the Merge CLI mrg for the operating system and CPU architecture of your machine. Once you’ve downloaded the CLI, make it executable and rename it to mrg.

Operating SystemArchitectureDownload Link
Linuxx86_64mrg-linux-x86_64
Linuxarm64mrg-linux-arm64
FreeBSDx86_64mrg-freebsd-x86_64
FreeBSDarm64mrg-freebsd-arm64
Mac OSx86_64mrg-darwin-x86_64
Mac OSarm64mrg-darwin-arm64
Windowsx86_64mrg-windows-x86_64.exe
Windowsarm64mrg-windows-arm64.exe

Configuring the API endpoint

The mrg CLI needs to be configured to point to the GRPC API endpoint of the Merge portal. The address can be constructed by prepending “grpc.” to the portal address; e.g.,:

mrg config set server grpc.redstartb.net

As noted above, consult your project leader for the appropriate portal address.

Register account

Then, register your account using the mrg register command. For example, to create a user named “murphy” with email “murphy@mergetb.org” and password “muffins1701”:

mrg register murphy murphy@mergetb.org muffins1701

Account Approval

Once you have created an account using either the web interface or the CLI, you should send a notification to the Merge portal administrators to have your account approved. Speak with your project leader for up-to-date information on how best to contact them.

Once your account has been approved, you are ready to start using Merge!

Last modified August 18, 2022: cleanup (3501ab5)