diff --git a/bin/ofs/README.md b/bin/ofs/README.md index eaf472caf3a7..82579452dcc1 100644 --- a/bin/ofs/README.md +++ b/bin/ofs/README.md @@ -2,6 +2,41 @@ OpenDAL File System (ofs) is a userspace filesystem backing by OpenDAL. +## Status + +`ofs` is a work in progress. we only support `fs` and `s3` as backend on `Linux` currently. + +## How to use `ofs` + +### Install `FUSE` on Linux + +```shell +sudo pacman -S fuse3 --noconfirm # archlinux +sudo apt-get -y install fuse # debian/ubuntu +``` + +### Install `ofs` + +`ofs` could be installed by `cargo`: + +```shell +cargo install ofs +``` + +> `cargo` is the Rust package manager. `cargo` could be installed by following the [Installation](https://www.rust-lang.org/tools/install) from Rust official website. + +### Mount directory + +```shell +ofs 'fs://?root=' +``` + +### Mount S3 bucket + +```shell +ofs 's3://?root=&bucket=&endpoint=®ion=&access_key_id=&secret_access_key=' +``` + ## License and Trademarks Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0