Get Started

This document is for release 5.0 and newer. For older releases, please refer to the 4.3.4 guide.


It’s quick and easy to get started with your ObjectiveFS file system.

Get Started with EC2 Shared Filesystem in 3 steps

What you need

3 easy steps

  1. Configure your credentials (one-time setup)
    Need your keys? See: how to get your S3 keys or GCS keys.
    For the default region, see the region list.

    $ sudo mount.objectivefs config
    Enter ObjectiveFS license: <your ObjectiveFS license>
    Enter Access Key Id: <your S3 or GCS access key>
    Enter Secret Access Key: <your S3 or GCS secret key>
    Enter Default Region (optional): <S3 or GCS region>

  2. Create a file system
    Use a globally unique, non-secret file system name (i.e. a new bucket that doesn’t exist).
    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 s3://<filesystem>): <your passphrase>
    Verify passphrase (for s3://<filesystem>): <your passphrase>
    Note: Your filesystem will be created in the default region for S3 if specified in step 1, or us-west-2 otherwise. For GCS, it will be created in your physical location. To specify your region, see here.

  3. Mount the file system
    You need an existing empty directory to mount your file system, e.g. /ofs.
    Process will run in the background.

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

    You can mount this file system on all machines (e.g. laptop, ec2 servers, etc) that you’d like to share your data.

And you are up and running! It’s that easy.

See the User Guide for all commands and options.

Get updates about ObjectiveFS