[DRAFT] Transporter - Quick Start Guide

Please follow these four simple steps to begin using Transporter:

In the Box

The following items should be present:

• The Transporter device

• A USB key

• A sheet with information about connecting to the device

Step 1: Set up

The whole setup needs three steps:

1. Plugin the USB key into the Transporter device.

2. Plug the Transporter device and computer/laptop into the same network switch.

3. Power on the device. The device will be accessible via the network and the will start up. Consult the sheet that came with the device for the URL to enter into your browser to view the console.

Boot

The boot process for Perifery Transporter can takes a few minutes, depending on the amount of data stored. No action is required on your part.

During boot, Perifery Transporter progresses through the following stages:

When the boot is complete, it shows a confirmation message.

Step 2: Login

1. Enter the default username and password available on the sheet that came with the device.

   1. Username – periferyadmin

   2. Password – password

2. Click Login.

Step 3: Update your password

This is a one-time update that must occur the first time the user logs in.

1. Enter the new password and re-enter it to confirm.

   

2. Click Update password.
   A confirmation message appears saying ‘Password updated successfully’.

Step 4: Dashboard

The dashboard screen provides:

Status overview – Provides the current state of hardware (CPU, RAM, network, and disks) and Perifery Transporter services.

• - Shows all the hardware/services are working fine.

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

Storage – Provides the total storage space of the device and how much space has been consumed in a bar format.

How to connect

This section is used to copy access URLs and tokens. Choose either option to copy and save access information in a text document or email:

• Click to copy everything in one go.

• Click to copy one by one.

Uploading content using S3

In the examples that follow, Cyberduck is being used for illustrative purposes, but the same information may be used for any application that uses an S3 connection.

1. Launch Cyberduck and click Open Connection.

   

2. Choose Amazon S3 from the dropdown list of protocols.

   

3. Fill in the following fields:

   • Server – The hostname of the Perifery S3 endpoint URL.

   • Port – A port in the Perifery S3 endpoint URL.

   • Access Key ID – The Perifery S3 Access Key.

   • Secret Access Key – The Perifery S3 Secret Key.
     Verify that the URL in Cyberduck matches the Perifery S3 Endpoint URL (it is okay if the port is not shown in the Cyberduck URL).

4. Click Connect.

5. Browse to the target S3 bucket in Cyberduck.

View Content Portal

Navigate to Advanced > Manage content > click the “Manage Content” link. This will open the Content Portal in a new browser tab to view and manage all the content (bucket, objects, etc.).

Data Migration

Perifery Transporter allows migrating bucket content to a remote S3 destination.

To move a bucket content, refer to the following steps:

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

   

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

   1. S3 endpoint URL – The target S3 endpoint URL.

   2. S3 region – Optional, a geographic area of the storage.

   3. S3 bucket – The target S3 bucket where the content is to be moved.

   4. Remote folder – Optional, a folder path within the remote bucket.

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

   6. Secret key – The S3 secret key that is generated with the access key.

3. Click Move. A confirmation message appears.

   

   
   Now, the S3 target is displayed in the S3 destination column for the corresponding bucket.

   

Generate report

When data is moved, irrespective of whether it is failed or successful, the report icon gets enabled for that bucket.

Refer to the following steps to generate a report:

1. Click corresponding to the bucket.

   1. Scenario 1: For successfully migrated data, the report provides a preview of bucket content as shown below:

      

   2. Scenario 2: In case of failed data migration, the report shows the cause of failure.

      

2. Click Download. It will either download or pop up in a browser tab depending on how the browser handles the content type of the JSON file.