Prerequisites
- Linux host with /dev/fuse available
- Any Linux distribution with GLIBC >= 2.34 (x86_64 or arm64)
- root privileges for install/mount/umount
- For io_uring support: Linux kernel 6.18 or later required
Step 1: Install mapfs
# redhat/centos/etc
$ rpm -ivh <folder>/mapfs-<version>.x86_64.rpm
OR
$ dnf install <folder>/mapfs-<version>.x86_64.rpm
# debian/ubuntu
$ dpkg -i <folder>/mapfs_<version>.deb
Step 2: Import Your Mapfs License
$ mapfs license import <email> <token>
Get your email and token from https://mapfs.cloud/
Step 3: Add a Volume (Configure Your Cloud Storage Backend)
$ mapfs add <VolumeName> <CloudVendor> <CloudOptions> <CacheOptions>
Example (AWS S3):
$ mapfs add my-volume aws -i <AccessKeyID> -k <SecretAccessKey> \
-b my-bucket -r us-east-1
Step 4: Start Channel Server [Optional if there is already one ChannelServer running]
$ channeld start [-p port]
Step 5: Mount the Volume
$ sudo mapfs mount <VolumeName> <MountPoint> [--channel IP|DNS[:Port]] [--iouring]
Note: the [iouring] option only works on Linux kernel 6.18+; omit it otherwise.
Step 6: Check Status / Logs
$ mapfs status
$ tail -f <CacheDir>/mapfs.log
Step 7: Unmount
$ sudo mapfs umount <VolumeName>
$ sudo umount <MountPoint> [-f]
Full Documentation
For additional commands including listing/removing volumes and configuring cache parameters, see:
/docs/rpmdeb/commands.html