Configuration

Learn how to configure IonFS CLI

Ionburst Cloud Setup

IonFS makes use of the Ionburst SDK, which can be configured using two main methods:

  • Environment variables, or
  • Credentials file.

This list should be taken as the order of precedence.

Environment Variables

If the credentials file is not used, then environment variables can be used:

  • Ionburst API ID: IONBURST_ID
  • Ionburst API Key: IONBURST_KEY
export IONBURST_ID=IB******************
export IONBURST_KEY=eW91aGF2ZXRvb211Y2h0aW1lb255b3VyaGFuZHMh

Credentials File

The Ionburst credentials file is stored within a well-known directory in the user's home folder.

  • MacOS/Linux: ~/.ionburst/credentials
  • Windows: %USERPROFILE%\.ionburst\credentials

The credentials file is INI formatted, and allows multiple sets of credentials to be used:

[example_profile]
ionburst_id=IB******************
ionburst_key=eW91aGF2ZXRvb211Y2h0aW1lb255b3VyaGFuZHMh
[example_profile2]
ionburst_id=IB******************
ionburst_key=c2VyaW91c2x5Li4uZ29vdXRzaWRlYW5kcGxheSEK
ionburst_uri=https://api.example.ionburst.io/

IonFS Setup

IonFS Configuration File

IonFS uses its own configuration file located within a well-known directory in the user's home folder.

  • MacOS/Linux: ~/.ionfs/appsettings.json
  • Windows: %USERPROFILE%\.ionfs\appsettings.json

The following is an example of an IonFS configuration:

{
"Logging": {
"LogLevel": {
"Default": "Information",
"Microsoft": "Warning",
"Microsoft.Hosting.Lifetime": "Information"
}
},
"IonFS": {
"MaxSize": "50000000",
"Verbose": "false",
"DefaultClassification": "Restricted",
"Repositories": [
{
"Name": "s3-example-ionfs",
"Class": "Ionburst.Apps.IonFS.MetadataS3",
"DataStore": "s3-example-ionfs"
}
],
"DefaultRepository": "s3-example-ionfs",
},
"Ionburst": {
"Profile": "default",
"API": "https://api.eu-west-1.ionburst.io/",
"IonburstUri": "https://api.eu-west-1.ionburst.io/",
"TraceCredentialsFile": "OFF"
},
"AWS": {
"Profile": "example_profile",
"Region": "eu-west-1"
},
"AllowedHosts": "*"
}

S3 Repository Setup

The IonFS S3 repository makes use of the AWS S3 SDK, which can be configured using two main methods:

  • Environment variables
  • Credentials file

This list should be taken as the order of precedence.

Environment Variables

If the credentials file is not used, then environment variables can be used:

  • AWS Access Key: AWS_ACCESS_KEY_ID
  • AWS Secret Key: AWS_SECRET_ACCESS_KEY
export AWS_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE
export AWS_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

Credentials File

The AWS credentials file is stored within a well-known directory in the user's home folder.

  • MacOS/Linux: ~/.aws/credentials
  • Windows: %USERPROFILE%\.aws\credentials

The credentials file is INI formatted, and allows multiple sets of credentials to be used:

[example_profile]
aws_access_key_id=AKIAIOSFODNN7EXAMPLE
aws_secret_access_key=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY