Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
ho-229 committed Mar 13, 2024
1 parent 02437f8 commit b1f107c
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions bin/ofs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <mount-point> 'fs://?root=<directory>'
```

### Mount S3 bucket

```shell
ofs <mount-point> 's3://?root=<path>&bucket=<bucket>&endpoint=<endpoint>&region=<region>&access_key_id=<access-key-id>&secret_access_key=<secret-access-key>'
```

## License and Trademarks

Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0
Expand Down

0 comments on commit b1f107c

Please sign in to comment.