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
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:
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:
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
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: