Zy

Minimal and blazing-fast file server. For real, this time.

Features

Installation

To install zy, you need Rust 1.59.0 or higher. You can then use cargo to build everything:

console cargo install zy

You can also install the latest version (or a specific commit) of zy directly from GitHub.

console git clone https://github.com/miraclx/zy.git cargo install --path zy

Usage

console zy

This will start serving your current directory on http://localhost:3000 by default.

...you can also specify a different port or base directory:

console zy /path/to/serve

...or perhaps different addresses:

console zy -l 5000 -l 127.0.0.1:8080 -l 192.168.1.25

Configuration

You can run zy --help to see all available options.

```console $ zy --help Zy 0.1.1 Minimal and blazing-fast file server.

USAGE: zy [OPTIONS] [DIR]

ARGS:

Directory to serve [default: .]

OPTIONS: -l, --listen Sets the address to listen on (repeatable) Valid: 3000, 127.0.0.1, 127.0.0.1:3000 [default: 127.0.0.1:3000] -s, --spa Run as a Single Page Application -i, --index Index file to serve from the base directory [default: index.html] --404 404 file to serve from the base directory [default: 404.html] -c, --cache Cache time (max-age) in seconds [default: 3600] --no-cors Disable Cross-Origin Resource Sharing (CORS) -a, --all Serve hidden files -f, --follow-links Follow symlinks outside of the base directory (unsafe) -v, --verbose Be verbose -x, --confirm-exit Require confirmation before exiting on Ctrl+C -h, --help Print help information -V, --version Print version information ```

Credits

Zy was originally inspired by sfz, serve and http-server. It is written in Rust and uses actix as the web framework.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as below, without any additional terms or conditions.

License

Licensed under either of

at your option.