Get Started (3.1 and older)

Overview

Single Machine with Unlimited Storage
1. Install ObjectiveFS
2. Complete the one-time Setup
3. Create a new file system on one machine

Multiple Machines Sharing Data on a Live File System
1. Complete steps 1-3 in the single machine setup above
2. Mount the file system on other machines


One-Time Setup

Step 1. Create a directory to store the environment variables

$ mkdir /etc/objectivefs.env

Step 2. Create a file for each of the required environment variable, with filename as the environment variable and file content as the value:

Environment Variable Description
AWS_ACCESS_KEY_ID Your S3 access key from AWS or Google*
AWS_SECRET_ACCESS_KEY      Your secret S3 key from AWS or Google*
OBJECTIVEFS_LICENSE Your objectiveFS license from your profile page
$ cd /etc/objectivefs.env
$ echo <your access key> > AWS_ACCESS_KEY_ID
$ echo <your secret key> > AWS_SECRET_ACCESS_KEY
$ echo <your license key> > OBJECTIVEFS_LICENSE

*: If you need to create your S3 credential, see how to create your S3 credential


Create

  1. Pick a globally unique, non-secret, file system name e.g. myfs.
  2. Pick a strong passphrase, write it down and store it somewhere safe.
    IMPORTANT: Without the passphrase, there is no way to recover any files.
  3. Run the following command, and your new file system is now ready.

Synopsis:
sudo ./mount.objectivefs -n -o env=<env dir> <filesystem name>

Example:

$ sudo ./mount.objectivefs -n -o env=/etc/objectivefs.env myfs
Welcome to ObjectiveFS.
Passphrase (for myfs): [enter passphrase]
Verify passphrase (for myfs): [enter passphrase again]
Directory to mount [/objectivefs]: [enter dir]
INFO: new filesystem created

Mount

On each computer that you want to share this file system (e.g. myfs), run the following command.

Synopsis:
sudo ./mount.objectivefs -o env=<env dir> <filesystem name> <mount dir>

Example:

$ sudo ./mount.objectivefs -o env=/etc/objectivefs.env myfs /ofs
Welcome to ObjectiveFS.
Passphrase (for myfs): [enter passphrase]
INFO: objectivefs ready