[DRAFT] How to Set Up Transporter?

Overview

<A brief overview of the Transporter>

Plug into the device

Make sure you have a Transporter device that is working fine. Plug one end of the ethernet cable into the Transporter device and another end into the computer/laptop to start the offline installation of the Transporter Beta 1.0.

Login

Once the device is ready, login into Perifery using the default email address which you registered with Symply for receiving the Transporter device.

1. Enter the email Id and password to login into the account.

2. Click Login. After successful login, your name should be visible at the top-right corner of the screen.

Update Password

The default password is not easy to remember, hence, it is advised to have a new strong password, which is unique and memorable for the user. This step is applicable to new users only. All the onboarding users must go through this step and update the password qualifying the following minimum requirements:

• Password length should be between 8-64 characters

• Combination of at least one uppercase, lowercase, and number

• One special character (e.g., @, #, $, !, %, etc.)

New Password – Enter the updated password. If it qualifies the above password criteria, all password checks appear in green.

Confirm Password – Re-enter the same password again.

Click Update Password and Continue. A message appears ‘Password updated successfully'.

Dashboard

The dashboard screen provides the following information:

Status Overview

This section provides an overview of all the services and hardware (all the disks and drives) and whether they all are working fine or if there is any service/hardware down which can cause the installation later. The status overview is displayed as per the current UTC date and time.
If any hardware or services are down, the status overview will provide that information.

• - This status shows all the hardware/services are working fine.

• ❗ – This status shows all the hardware/services are not up and running as expected.

Contact Support

For any query or assistance related to Transporter installation, feel free to contact the Symply Support team.

Go to the Status Overview section, and click Contact Support to get any assistance from the experts. This link navigates to the HTML form where you need to mention the issue and other basic information. Once you submit this form, the Symply team will contact you.

Storage

This section provides total storage space information of the device and how much space has been consumed. The user will see a bar view of consumed space out of the total space available.

How to Connect

This section contains access URLs and token information and provides an ability to copy either one by one or the whole information (access URLs and tokens) in one go.

• S3 Endpoint URL – A remote service endpoint

• S3 Bucket Name – A name of the S3 bucket

• S3 Access Key – An access key for the remote bucket, which must be generated within the remote cloud storage service.

• S3 Secret Key – An S3 secret key. It is generated with the access key.

To know more about S3 credentials, see https://perifery.atlassian.net/wiki/spaces/DOCS/pages/3134062601/DRAFT+Transporter+Installation-+Quick+Start+Guide#How-to-Use-S3-Credentials?.

There are two ways to copy:

• To copy all (S3 endpoint URL, bucket name, access key, and secret key) in one go, click Copy all and save them in a Notepad. These details will be used in the future while moving the bucket content to a remote location.

• Copy access URLs and tokens one by one and save them into a notepad.

Integrated Apps

This section contains all the apps integrated with Perifery.

Advanced

This section provides two options; one is to view the content portal and another is to monitor the system status.

Manage Content

Transporter is designed to make the task of providing basic S3 storage as simple as possible, for cases where a single user and a single domain are sufficient.

Go to Manage Content > click Browse Content, and this will navigate to the full Content Portal where you can browse and search all the content (buckets, objects, etc.). The Content Porta provides multiple functionalities including:

• Create and manage S3 tokens for security purposes

• Create additional tenants, storage domains, and buckets to support unique business workflows

• Manage content with Collections

• Take advantage of Partial File Restore functionality

You can learn more about these functionalities here. To know about how to utilize these capabilities, see Swarm Content UI.

For Transporter users, the documentation provided above will help you safely store content in no time.

Status Details

Go to the Status Details > click View Dashboard. This will navigate to the <Grafana dashboard> where you can monitor the current status of the system.  

Data Migration

This section helps to move data to the remote location (i.e. S3 destination). Data is available in a tabular format that contains the below columns:

• Bucket Name – The name of the bucket.

• S3 Destination – Current location of the S3 bucket.

• Object Count – The number of object counts.

• Move Content – This action item is used to move the bucket content to the remote location.

• Report Generation – This action item is used to generate the bucket report that you can download in raw JSON.

Move Bucket Content

You can move the bucket content to the desired remote location using the below steps:

1. Click on the Move icon corresponding to the bucket. It displays a form in the sliding panel.

2. Fill up the required fields marked with asterisks (*):

   

   1. S3 Endpoint URL – Enter the target S3 endpoint URL.

   2. S3 Bucket – Enter the target S3 bucket where the content is to be moved.

   3. Remote Folder – An optional folder path within the remote bucket.

   4. Access Key – An access key for the remote bucket. It must be generated within the remote cloud storage service.

   5. Secret Key – An S3 secret key. It is generated with the access key.

3. Click Move. A confirmation message appears “Bucket <x> moved to bucket <y> successfully”.

   

   The target remote bucket contains the content moved from the source, and now the source bucket is empty.

Report Generation

1. Click on the report icon corresponding to the bucket.

   

   All the objects available in the selected bucket are displayed along with their object size and object status. It gives a preview of the bucket content report.

   

2. Click Download. It generates the bucket content report in JSON.

User Profile

The user can view his/her profile from the top-right corner of the screen, which contains two options Change Password and Logout.

Change Password

This option is available for existing users. If they want to change the current password, refer to the following steps:

1. Click on the username from the top-right corner of the screen.

2. Select Change Password. It shows a form to change the password:

   

    

   1. Enter the current password.

   2. Enter a new password and re-enter it to confirm the same.

   3. Click Change. A confirmation message appears saying that ‘Password changed successfully'.

Logout

Go to the user profile > select Logout to log out of the account.

Learn More

• [DRAFT] Transporter Installation- Quick Start Guide

• [DRAFT] Factory Reset - Knowledge Base