Skip to content

Latest commit

 

History

History
58 lines (47 loc) · 1.77 KB

README.md

File metadata and controls

58 lines (47 loc) · 1.77 KB

AlveoFS

Alveo File System - a FUSE filesystem capable of mounting Alveo HcsVlab API (HTTP-JSON) as a local read-only filesystem.

Based upon HTTPFS - https://github.com/Kurocon/HTTPfs

Requirements

Python dependencies (works on both Python 2 and 3):

  • requests
  • fusepy
  • six

Usage

usage: alveofs.py [-h] [--foreground] [--debug] [--nothreads] [--no_ssl_verify]
                 [--allow_other] 
                 http_resource mountpoint x-api-key

positional arguments:
  http_resource         Target web directory index
  mountpoint            Target directory
  x-api-key             Alveo X-API-KEY (generated by Alveo HcsVlab)

optional arguments:
  -h, --help            show this help message and exit
  --foreground          Do not fork into background (default: False)
  --debug               Enable debug logging (default: False)
  --nothreads           Disable fuse threads (default: False)
  --no_ssl_verify       Disable SSL Verification (default: False)
  --allow_other         Allow users other than the one running the command to
                        access the directory. (default: False)

Registering mount command

You can register this filesystem (so it can be used in fstab or with the mount command) in the following way:

# Clone the repository
git clone [email protected]:Alveo/AlveoFS.git

# Change into directory 
cd AlveoFS

# Make a symbolic link to /usr/local/bin
sudo ln -s `pwd`/alveofs.py /usr/local/bin/mount.alveofs

You should now be able to use the filesystem in the following ways:

# In a normal mount command
sudo mount.alveofs http://some.server/ /mnt/mountpoint <X-API-KEY> --debug --allow_other

# Or using the normal mount command
sudo mount -t alveofs http://some.server/ /mnt/mountpoint <X-API-KEY> --debug --allow_other