Zy
Minimal and blazing-fast file server. For real, this time.
Features
- Single Page Application support
- Partial responses (Range support)
- Cross-Origin Resource Sharing (CORS)
- Automatic HTTP compression (Zstd, Gzip, Brotli, Deflate)
- Dynamic cache control (ETag, Last-Modified, Cache-Control)
- Auto-served
index.html
files - Sane defaults
- No access to hidden files
- No access to content outside the base directory
- No access to symbolic links outside the base directory
Installation
To install zy
, you need Rust 1.59.0
or higher. You can then use cargo
to build everything:
cargo install zy
You can also install the latest version (or a specific commit) of zy
directly from GitHub.
git clone https://github.com/miraclx/zy.git
cargo install --path zy
Usage
zy
This will start serving your current directory on http://localhost:3000 by default.
...you can also specify a different port or base directory:
zy /path/to/serve
...or perhaps different addresses:
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.
$ zy --help
Zy 0.1.4
Minimal and blazing-fast file server.
USAGE:
zy [OPTIONS] [DIR]
ARGS:
<DIR> Directory to serve [default: .]
OPTIONS:
-l, --listen <URI> Sets the address to listen on (repeatable) [default: 127.0.0.1:3000]
Valid: `3000`, `127.0.0.1`, `127.0.0.1:3000` [env: PORT]
-s, --spa Run as a Single Page Application
-i, --index <FILE> Index file to serve from the base directory [default: index.html]
--404 <FILE> 404 file to serve from the base directory [default: 404.html]
-c, --cache <TIME> Cache time (max-age) [default: 1h]
Valid: `10` for 10 seconds, `1h`, `1year 6months`
--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
-Z, --anonymize Hide the `Server` and `X-Powered-By` headers [alias: `--anon`]
-h, --help Print help information
-V, --version Print version information
The PORT environment variable is also supported.
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
- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.