mirror of
https://github.com/house-of-vanity/mus-fuse.git
synced 2025-07-07 05:34:08 +00:00
Update README.md
This commit is contained in:
46
README.md
46
README.md
@ -12,6 +12,31 @@ MusFuse is a FUSE filesystem over HTTP for music. It is using [playongo](https:/
|
|||||||
- Using cache.
|
- Using cache.
|
||||||
- Leverages Rust correctness.
|
- Leverages Rust correctness.
|
||||||
|
|
||||||
|
## How to use
|
||||||
|
Here is a [binary release](https://github.com/house-of-vanity/mus_fuse/releases/latest) or compile it yourself. Anyway mond about dependencies listed below.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
# Compile
|
||||||
|
$ cargo build --release
|
||||||
|
|
||||||
|
# And run
|
||||||
|
# to baypass Basic Auth set
|
||||||
|
# $HTTP_USER and $HTTP_PASS
|
||||||
|
# environment variables before run.
|
||||||
|
$ ./target/release/musfuse <mountpoint> <server>
|
||||||
|
|
||||||
|
# To get metrics
|
||||||
|
$ cat <mountpoint>/METRICS.TXT
|
||||||
|
http_requests: 1818
|
||||||
|
ingress: 243595644
|
||||||
|
hit_len_cache: 1878
|
||||||
|
hit_data_cache: 82
|
||||||
|
miss_len_cache: 11
|
||||||
|
miss_data_cache: 11
|
||||||
|
server_addr: https://mus.hexor.ru
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
## Dependencies
|
## Dependencies
|
||||||
|
|
||||||
FUSE must be installed to build or run programs that use fuse-rs (i.e. kernel driver and libraries. Some platforms may also require userland utils like `fusermount`). A default installation of FUSE is usually sufficient.
|
FUSE must be installed to build or run programs that use fuse-rs (i.e. kernel driver and libraries. Some platforms may also require userland utils like `fusermount`). A default installation of FUSE is usually sufficient.
|
||||||
@ -50,25 +75,4 @@ sudo apt-get install libfuse-dev pkg-config
|
|||||||
sudo yum install fuse-devel pkgconfig
|
sudo yum install fuse-devel pkgconfig
|
||||||
```
|
```
|
||||||
|
|
||||||
# How to use
|
|
||||||
Here is a [binary release](https://github.com/house-of-vanity/mus_fuse/releases/latest) or compile it yourself.
|
|
||||||
|
|
||||||
```sh
|
|
||||||
# Compile
|
|
||||||
$ cargo build --release
|
|
||||||
# And run
|
|
||||||
# to baypass Basic Auth set
|
|
||||||
# $HTTP_USER and $HTTP_PASS
|
|
||||||
# environment variables before run.
|
|
||||||
$ ./target/release/musfuse <mountpoint> <server>
|
|
||||||
# To get metrics
|
|
||||||
$ cat <mountpoint>/METRICS.TXT
|
|
||||||
http_requests: 1818
|
|
||||||
ingress: 243595644
|
|
||||||
hit_len_cache: 1878
|
|
||||||
hit_data_cache: 82
|
|
||||||
miss_len_cache: 11
|
|
||||||
miss_data_cache: 11
|
|
||||||
server_addr: https://mus.hexor.ru
|
|
||||||
|
|
||||||
```
|
|
||||||
|
Reference in New Issue
Block a user