https://github.com/arjsin/http_static
File serving using tower web
https://github.com/arjsin/http_static
async http-server rust static-server
Last synced: 7 months ago
JSON representation
File serving using tower web
- Host: GitHub
- URL: https://github.com/arjsin/http_static
- Owner: arjsin
- License: apache-2.0
- Created: 2018-12-15T07:37:36.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-02-03T05:37:22.000Z (about 7 years ago)
- Last Synced: 2024-08-10T14:19:19.276Z (over 1 year ago)
- Topics: async, http-server, rust, static-server
- Language: Rust
- Size: 63.5 KB
- Stars: 19
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# http_static
Simple static file command line HTTP server written in Rust language using tower-web.
This supports custom Index file and `404 Not Found` handler both default to `index.html`.
It can be useful for serving static websites.
It also provides an in memory file serving mode which can be useful when there is only a
small amount data which the server needs to serve. In memory file serving is much faster
and does not read files once the server is initialized which does all the reading.
This mode can be useful for serving web apps.
The project is work in progress.
## Compile
These instructions assume rust and cargo to be installed.
If you don't have them, please install using [rustup](https://rustup.rs).
### To getting the repository
```sh
git clone https://github.com/arjsin/http_static.git
cd http_static
# Future instructions assume this directory
```
### To build
Release build provides good performance while running the program.
```sh
cargo build --release
```
### To run
Run to listen on default port
```sh
cargo run --release
```
Run to listen on default port with in memory files
```sh
cargo run --release -- -m
```
The help prints all the possible options
```sh
cargo run --release -- -h
```
```
http_static
A lightweight static file server for HTTP
USAGE:
http_static [FLAGS] [OPTIONS]
FLAGS:
-h, --help Prints help information
-m, --in_memory Sets in memory file server
-V, --version Prints version information
OPTIONS:
-d, --default Sets path of a file which is served when the file requested in not available, default: index.html
-i, --index Sets file name inside each directory to be served at path of directory, default: index.html
-l, --listen
Sets the address to listen on, default: [::1]:8080
-r, --root Sets path of a directory for serving files, default: .
--tls_cert Sets file name for TLS certificate, must be present with TLS private key
--tls_key Sets file name for TLS private key, must be present with TLS certificate
```
## TODO
- [x] File serving
- [x] In memory file serving
- [ ] Logging
- [ ] In memory serving, `304 Not Modified` support
- [ ] In memory serving, file change notification support
- [x] HTTPS support
- [ ] Directory listing