How to: Add new Host

Follow these instructions to configure a new Host in FarEarth

Prerequisites

• You need to have the Admin role in FarEarth

Step 1

• Navigate to the HOSTING page, under PROCESSING CONFIG

Step 2

• Click on the "CREATE DATA HOST" button on the right

Step 3

• In the New Data Host window, enter the following required fields:

Field	Details
App	The FarEarth application ID where the host will be created
Subscription	The subscription that will own the host configuration
ID	A unique ID for the host
Protocol	The protocol that this host will use

• Click on CREATE

After creating the host, FarEarth will add additional fields automatically to the host:

Field	Details
Enabled	Controls whether the archive is enabled or not
File Name	The JSON filename of the archive as stored on disk
Shareable	Controls whether the archive may be shared with other subscriptions
Exclusive	Limits the archive to be shareable with only one subscription

The new host will appear in the list. The host is pre-populated with a template that requires further editing.

Edit host

To edit the host, click on the 'File Name' in the hosts list.

note

Each host protocol has unique fields required in the configuration file

An example of a host configuration is provided below. For more examples, refer to the protocol specific documentation.

{
    "id": "farearth.aws-s3-host-101",
    "protocol": "amazon-s3",
    "dataRetentionWindow": "12 hours",
    "properties": {
        "baseUrl": "...",
        "bucketName": "hosting",
        "region": "...",
        "accessKey": "...",
        "secretKey": "..."
    }
}

Host details

The table below lists the various fields in a host configuration.

Field	Example Value	Details
id	farearth.azure-host-101, farearth.fs-host-101	Unique identifier of the host. The ID startss with the subscription ID (e.g., farearth). This ID is used to provide access to the host for specific users and subscriptions, and to track any activity related to the host
protocol	azure, amazon-s3, google-gcs, gdrive, filesystem, pyxis	The hosting protocol to use. This field determines the required properties.
dataRetentionWindow	12 hours	Defines how long data is retained in the host before automatically being removed
shareable	true, false (default)	Controls whether the host may be shared with other subscriptions. NOTE: setting this to true does not yet share the host
properties		Unique properties required by the specific protocol. For more details, see the protocol specific documentation

Expected outcome

• Outcome #1

Related links

• Related links #1
• Related links #2