ドキュメント

Set Up ObjectiveFS With Amazon S3

This document covers the steps to set up your ObjectiveFS filesystem with Amazon S3 using S3 keys.

What You Need

• S3 access and secret keys
• ObjectiveFS license key on your profile page

Steps

1. Download and install ObjectiveFS

2. Configure your credentials(one-time setup)

   The config parameters will be stored in /etc/objectivefs.env/

   $ sudo mount.objectivefs config
                                           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): <S3 region>
                               

3. Create your filesystem (one-time only)

   Use a globally unique, non-secret file system 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 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.

4. Mount your filesystem

   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>
                               

5. [Optional] Multi-server setup

   Mount this filesystem on as many servers as you wish by running steps 1, 2 and 4 on each server. Each server can read and write to the same filesystem at the same time.

Tips

• Store your filesystem passphrase in /etc/objectivefs.env/OBJECTIVEFS_PASSPHRASE to mount the filesystem without manually entering the passphrase each time.
• To mount the filesystem via /etc/fstab, see the mount on boot guide.

Reference

• Installation Guide
• User Guide
• Mount on Boot Guide for Linux
• Mount on Boot Guide for macOS