Set Up ObjectiveFS With Amazon S3

This document covers the steps to set up your ObjectiveFS filesystem with Amazon S3 using S3 keys. For ObjectiveFS versions older than 7.0, see this doc.

What You Need

  1. S3 access and secret keys (how to get your S3 keys). For IAM role, use this guide.
  2. ObjectiveFS license key from the Filesystem section on your profile page.
  3. ObjectiveFS software installed on your machine (see Quick Start).

Steps

  1. Configure Objectivefs

    $ sudo mount.objectivefs config s3://
    Creating config for Amazon in /etc/objectivefs.env
    Enter ObjectiveFS license: <your ObjectiveFS license>
    Enter Access Key Id: <your S3 access key>
    Enter Secret Access Key: <your S3 secret key>
    Enter Default Region (optional): <your S3 region, e.g. eu-west-1>
    

  2. Create your filesystem (one-time only)

    • Choose a unique filesystem name. ObjectiveFS will create a new bucket with this name.
    • Choose a strong passphrase, write it down and store it somewhere safe.
      IMPORTANT: Without the passphrase, there is no way to recover any files.

    $ sudo mount.objectivefs create <your filesystem name>
    Passphrase (for <filesystem>): <your passphrase>
    Verify passphrase (for <filesystem>): <your passphrase>
    

  3. Mount your filesystem
    Mount your filesystem on an existing empty directory, e.g. /ofs. The ObjectiveFS process will run in the background.

    $ sudo mkdir /ofs
    $ sudo mount.objectivefs <your filesystem name> /ofs
    Passphrase (for //<filesystem>): <your passphrase>
    

  4. [Optional] Multi-server setup
    Mount this filesystem on as many servers as you wish by running steps 1 and 3 on each server after installing ObjectiveFS. Each server can read and write to the same filesystem at the same time.

If you have questions, please email us at support@objectivefs.com.

Last updated by ObjectiveFS staff, October 3, 2022


ObjectiveFS is a shared filesystem for Linux and macOS that automatically scales up and out with high performance. In production use by Fortune 500 companies since 2013.