Set Up ObjectiveFS With S3-Compatible Object Stores

Enterprise Plan Feature

This document covers the steps to set up your ObjectiveFS filesystem with an S3-compatible object store.

What You Need

Keys and endpoint for your S3-compatible object store
ObjectiveFS license key from the Filesystem section on your profile page
ObjectiveFS software installed on your machine (see Quick Start)

Steps

Configure Objectivefs

$ sudo mount.objectivefs config objectstore://
Creating config for Your Object Store Provider in /etc/objectivefs.env
Enter ObjectiveFS license: <your ObjectiveFS license>
Enter Endpoint URL (http[s]://example.com[:port]): <endpoint>
Enter Access Key: <your access key>
Enter Secret Key: <your secret key>
Enter Region: <your region>

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 objectstore://<filesystem>): <your passphrase>
Verify passphrase (for objectstore://<filesystem>): <your passphrase>
```

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 objectstore://<filesystem>): <your passphrase>

[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.

Useful Links

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.