miniserve
π For when you really just want to serve some files over HTTP right now!
File Explorer
Download Latest Version (.zip)- config.toml
- build-release.yml
- ci.yml
- dependabot.yml
- FUNDING.yml
- archlinux.scss
- ayu_dark.scss
- monokai.scss
- squirrel.scss
- zenburn.scss
- logo.svg
- style.scss
- miniserve@.service
- archive.rs
- args.rs
- auth.rs
- config.rs
- consts.rs
- errors.rs
- file_op.rs
- file_utils.rs
- listing.rs
- main.rs
- pipe.rs
- renderer.rs
- webdav_fs.rs
- auth1.txt
- cert.pem
- cert_ec.pem
- cert_rsa.pem
- generate_tls_certs.sh
- key_ec.pem
- key_pkcs1.pem
- key_pkcs8.pem
- mod.rs
- mod.rs
- api.rs
- archive.rs
- auth.rs
- auth_file.rs
- bind.rs
- cli.rs
- create_directories.rs
- header.rs
- navigation.rs
- paste.rs
- qrcode.rs
- raw.rs
- readme.rs
- rm_files.rs
- serve_request.rs
- tls.rs
- upload_files.rs
- webdav.rs
- .dockerignore
- .editorconfig
- .gitignore
- Cargo.lock
- Cargo.toml
- CHANGELOG.md
- Containerfile
- Containerfile.alpine
- LICENSE
- Makefile
- README.md
- release.toml
- rustfmt.toml
- screenshot.png
# Installation Guide
1. Get the code
git clone https://github.com/svenstaro/miniserve
Downloads the entire project code from GitHub to your computer.
cd miniserve
Moves into the project folder you just downloaded.
2. Official Install Script
Easy RecommendedPrerequisites
- Homebrew A package manager for macOS/Linux.
- Scoop A package manager for Windows.
- Rust (rustup) Rust is required to use cargo.
brew install miniserve
Installs the pre-built package via Homebrew β no source build required.
scoop install miniserve
Installs directly via Scoop (Windows).
cargo install --locked miniserve
Builds and installs the package published on crates.io β no need to clone the repo yourself.
After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.
Pulled directly from this repo's README.
3. Rust
MediumPrerequisites
- Git Needed to download the project code from GitHub.
- Rust (rustup) Installing via rustup also installs cargo.
cargo install --locked miniserve
Builds and installs the package published on crates.io β no need to clone the repo yourself.
If cargo build finishes without errors, it worked. The executable is created under target/.
Pulled directly from this repo's README.
4. Make
MediumPrerequisites
- Git Needed to download the project code from GitHub.
- Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make
Compiles the code based on the generated build configuration to produce an executable.
If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation
Was this content helpful?
(0 ratings)