[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 (this is required to operate the Transporter)

• A sheet with information about connecting to the device

Step 1: Connect the Transporter

Connect the Transporter device and your computer/laptop to a switch that is configured for DHCP. Power on the Transporter device. Once it has powered on, the device will be accessible via the network. Consult the sheet that came with the device for the URL to enter into your browser to view the console.

Step 2: Login into Perifery

1. Enter the default username and password. These are also found on the sheet that came with the device.

   1. Username – periferyadmin

   2. Password – password

2. Click Login.

Step 3: Update your password

Change the default password to a human-readable and memorable password. The new password must be between 8-64 characters including at least one uppercase, one lowercase, one number, and one special character.

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

   

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

Step 4: Dashboard

The dashboard screen provides:

Status overview

The status overview provides the current state of hardware (CPU, RAM, network, and disks) and transporter services.

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

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

Storage

This section provides the total storage space of the device and how much space has been consumed. A bar view shows consumed space out of the total space available.

How to connect

Copy access URLs and tokens

There are two ways to copy access URLs and tokens:

• To copy all (S3 endpoint URL, bucket name, access key, and secret key) in one go, click Copy All and save them in a text document. These details will be used to move content into the Transporter.

• Copy access URLs and tokens one by one and save them.

How to upload content using S3?

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 to connect to the default Perifery S3 endpoint.

5. Browse to the target S3 bucket in Cyberduck.

View Content Portal

Go to Advanced > Manage content section. Click Manage content, which navigates to the Content Portal to view all the content (bucket, objects, etc.).

To learn more about functionalities like bucket, object, domain, and how to use them, see Using the Content UI. To know about how to configure and utilize these capabilities, see Swarm Content UI.

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

Data migration

This section provides a way to move bucket content to a remote S3 destination.

Move bucket

To move a bucket, refer to the following 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 region – Enter the S3 region, which is a geographic area of the storage if required by the remote storage vendor.

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

   4. Remote folder – Enter the folder path within the remote bucket. This is optional.

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

   6. Secret key – Enter an S3 secret key. It is generated with the access key.

3. Click Move. A confirmation message appears.

   

   The target remote bucket contains the content moved from the source and the source bucket contains only objects describing the move operation and results.

Report generation

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 on the report icon corresponding to the bucket.

   

   1. Scenario 1: When data is migrated successfully and the report is generated, all the objects available in the selected bucket are displayed along with their object name and object status. It gives a preview of the bucket content report.

      

   2. Scenario 2: When the data migration is failed for a bucket and the report is generated, it shows the reason for the data migration 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.

User Profile

1. Go to the top-right corner of the screen and click on the username. It shows two options, Change password and Logout.

   

2. To change the password, select Change password. It displays a form to update the password.

   

   1. Enter the current password.

   2. Enter a new password.

   3. Re-enter the new password in Confirm password field.

   4. Click Save. A confirmation message appears saying that ‘Password changed successfully'.

3. Click Logout to sign out of the account.