mirror of
https://github.com/house-of-vanity/furumi.git
synced 2025-07-07 13:44:07 +00:00
73 lines
1.7 KiB
Markdown
73 lines
1.7 KiB
Markdown
# Furumi
|
|
|
|
[](https://github.com/house-of-vanity/furumi/actions)
|
|
|
|
Furumi is a FUSE filesystem working over NGINX JSON autoindex. It's written in Rust stable.
|
|
|
|
|
|
# Features
|
|
- Using NGINX for indexing remote files.
|
|
- Security relies on HTTPS.
|
|
- Using cache.
|
|
|
|
## Usage
|
|
Here is a [binary release](https://github.com/house-of-vanity/furumi/releases/latest) or compile it yourself. Anyway mind about dependencies listed below. Also there is a systemd unit file for managing service. Place it into `~/.config/systemd/user/furumi.service`
|
|
|
|
```sh
|
|
# Compile binary
|
|
$ cargo build --release
|
|
|
|
# Create config
|
|
cat > furumi.ylm <<EOF
|
|
---
|
|
server: https://server
|
|
mountpoint: /mnt
|
|
# Basic auth creds
|
|
username: user
|
|
password: pass
|
|
|
|
# Run
|
|
$ ./target/release/furumi --config furumi.yml
|
|
|
|
```
|
|
|
|
## Dependencies
|
|
|
|
FUSE must be installed to build and run furumi. (i.e. kernel driver and libraries. Some platforms may also require userland utils like `fusermount`). A default installation of FUSE is usually sufficient.
|
|
|
|
!? To build fuse-rs or any program that depends on it, `pkg-config` needs to be installed as well.
|
|
|
|
### Linux
|
|
|
|
[FUSE for Linux][libfuse] is available in most Linux distributions and usually called `fuse`.
|
|
|
|
Install on Arch Linux:
|
|
|
|
```sh
|
|
sudo pacman -S fuse
|
|
```
|
|
|
|
Install on Debian based system:
|
|
|
|
```sh
|
|
sudo apt-get install fuse
|
|
```
|
|
|
|
Install on CentOS:
|
|
|
|
```sh
|
|
sudo yum install fuse
|
|
```
|
|
|
|
To build, FUSE libraries and headers are required. The package is usually called `libfuse-dev` or `fuse-devel`. Also `pkg-config` is required for locating libraries and headers.
|
|
|
|
```sh
|
|
sudo apt-get install libfuse-dev pkg-config
|
|
```
|
|
|
|
```sh
|
|
sudo yum install fuse-devel pkgconfig
|
|
```
|
|
|
|
|