cfs

README

Cloud File System (CFS) Client Application

Target operating system is Linux.
Other operating systems to follow.

Quick Start

1. Install FUSE

sudo apt-get install fuse   # Debian or Ubuntu
sudo yum install fuse       # CentOS
sudo dnf install fuse       # Fedora

CFS requires FUSE version 2.6 or greater, which you can verify with the following command.

$ fusermount -V
fusermount version: 2.9.3

1. Install CFS

wget https://github.com/getcfs/megacfs/releases/download/<latest_release>/cfs
echo -e '#!/bin/sh\ncfs mount -o $4 $1 $2 > /dev/null &' > mount.cfs  # create the mount helper script
chmod +x cfs mount.cfs   # mark them executable
mv cfs mount.cfs /sbin/  # place them on the path

1. Configure the CFS Client

cfs configure  # requires an Auth URL, Username, Password, and CFS Server

1. Create a Filesystem

cfs create myfs  # returns the fsid

1. Grant Access to the Filesystem

cfs grant <fsid>  # allows the filesystem to be mounted from this client's ip

1. Mount the Filesystem

mkdir -p /mnt/myfs                                                            # create the mountpoint
echo "<cfs_server_ip>:<fsid> /mnt/myfs cfs rw,allow_other 0 0" >> /etc/fstab  # add filesystem to /etc/fstab
mount /mnt/myfs                                                               # mount the filesystem

Documentation

Overview

Package main builds a 'cfs' executable that is the client application for CFS.