# simplewebserver

[![CI](https://github.com/L-french/simplewebserver/actions/workflows/CI.yaml/badge.svg)](https://github.com/L-french/simplewebserver/actions/workflows/CI.yaml)

A convenient, standalone web server in the style of Python's `SimpleHTTPServer`. 

![Example usage of simplewebserver](assets/example-1.gif "Example")

*Warning*: Like its Python cousin, simplewebserver is intended for development and local file sharing. It should not be used in production environments.

## Design Goals
* **Simple**: Easy to use CLI, with good defaults and reasonable security
* **Capable**: Multithreaded service and I/O powered by Tokio
* **Tiny**: Minimal binary size, while still using mature libraries and being standalone

## Installation

If you have a functional Rust installation, the simplest way to install simplewebserver is from crates.io:
```
cargo install simplewebserver
```
Binaries are available in GitHub Releases. They may be extracted and run directly.

## Usage

```
USAGE:
    simplewebserver [FLAGS] [OPTIONS] <FILE>...

FLAGS:
    -D, --dry-run      Print files which would be served and exit
    -h, --help         Prints help information
    -r, --recursive    Serve directories recursively
    -V, --version      Prints version information
    -v, --verbose      Print additional logging info

OPTIONS:
    -a, --address <address>    Serve on IP address [default: 127.0.0.1]
    -p, --port <port>          Bind to a port [default: 8080]

ARGS:
    <FILE>...    The file(s) to serve
```