sfz, or Static File Zerver, is a simple command-line tool serving static files for you.
The name sfz is derived from a accented note Sforzando in music, which meaning “suddenly with force.”
.gitignore fileIf you are a macOS Homebrew user, you can install sfz from a custom tap:
bash
brew tap weihanglo/sfz https://github.com/weihanglo/sfz.git
brew install sfz
Disclaimer: Formula on Linuxbrew did not fully tested.
If you are a Rust programmer, you can install sfz directly from GitHub via Cargo.
bash
cargo install --git https://github.com/weihanglo/sfz
Archives of prebuilt binaries are available on GitHub Release for Linux, maxOS and Windows. Download a compatible binary for your system. For convenience, make sure you place sfz under $PATH if you want access it from the command line.
sfz is written in Rust. You need to install Rust in order to compile it.
bash
$ git clone https://github.com/weihanglo/sfz.git
$ cd sfz
$ cargo build --release
$ ./target/release/sfz --version
0.1.0
The simplest way to start serving files is to run this command:
bash
sfz [FLAGS] [OPTIONS] [path]
The command above will start serving your current working directory on 127.0.0.1:8888 by default.
If you want to serve another directory, pass [path] positional argument in with either absolute or relaitve path.
```bash sfz /usr/local
/usr/local directory.```
sfz aims to be simple but configurable. Here is a list of available options:
| Option | Default Value |
| :---------------------- | ------------------------- |
| Base directory | current working directory |
| Address | 127.0.0.1 |
| Port | 8888 |
| Enable CORS | false |
| Caching files for | 0 second |
| HTTP compression | true |
| Serve hidden files | false |
| Respect to .gitignore | true |
| Follow symlinks | false |
For more infomation, run following command:
bash
sfz --help
Contributions are highly appreciated! Feel free to open issues or send pull requests directly.
sfz was originally inspired by another static serving tool serve, and sfz's directory-listing UI is mainly borrowed from GitHub.
sfz is built on the top of awesome Rust community. Thanks for all Rust and crates contributors.
This project is licensed under either of
at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in sfz by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.