http-server 0.3.3

Installation

cargo install http-server

Check for the installation to be successful.

http-server --help

Usage

http-server [FLAGS] [OPTIONS] [root-dir]

Flags

Flags are provided without any values. For example:

http-server --help

Name	Short	Long	Description
Cross-Origin Resource Sharing	N/A	`--cors`	Enable Cross-Origin Resource Sharing allowing any origin
Help	N/A	`--help`	Prints help information
Version	`-V`	`--version`	Prints version information
Verbose	`-v`	`--verbose`	Prints output to console

Options

Options receives a value and have support for default values as well.

http-server --host 127.0.0.1

Name	Short	Long	Description	Default Value
Host	`-h`	`--host`	Address to bind the server	`127.0.0.1`
Port	`-p`	`--port`	Port to bind the server	`7878`
Configuration File	`-c`	`--config`	Specifies a configuration file. Example	N/A
TLS	N/A	`--tls`	Enable TLS for HTTPS connections. Requires a Certificate and Key. Reference	N/A
TLS Ceritificate	N/A	`--tls-cert`	Path to TLS certificate file. Depends on `--tls`	`cert.pem`
TLS Key	N/A	`--tls-key`	Path to TLS key file. Depends on `--tls`	`key.rsa`
TLS Key Algorithm	N/A	`--tls-key-algorithm`	Algorithm used to generate certificate key. Depends on `--tls`	`rsa`

References

The following are some relevant details on features supported by this HTTP Server solution that may be of the interest of the user.

TLS (HTTPS)

The TLS solution supported for this HTTP Server is built with rustls crate along with hyper-rustls.

When running with TLS support you will need:

A certificate
A RSA Private Key for such certificate

A script to generate certificates and keys is available here tls-cert.sh. This script relies on openssl, so make sure you have it installed in your system.

Run http-server as follows:

http-server --tls --tls-cert <PATH TO YOUR CERTIFICATE> --tls-key <PATH TO YOUR KEY> --tls-key-algorithm pkcs8

Cross-Origin Resource Sharing (CORS)

This HTTP Server brings support to CORS headers out of the box. Based on the headers you want to provide to your HTTP Responses, 2 different methods for CORS configuration are available.

By providing the --cors option to the http-server, CORS headers will be appended to every HTTP Response, allowing any origin.

For more complex configurations, like specifying an origin, a set of allowed HTTP methods and more, you should specify the configuration via the configuration TOML file.

The following example shows all the options available, these options are mapped to the server configuration during initialization.

[cors]
allow_credentials = false
allow_headers = ["content-type", "authorization", "content-length"]
allow_methods = ["GET", "PATCH", "POST", "PUT", "DELETE"]
allow_origin = "example.com"
expose_headers = ["*", "authorization"]
max_age = 600
request_headers = ["x-app-version"]
request_method = "GET"

Release

In order to create a release you must push a Git tag as follows

git tag -a <version> -m <message>

Example

git tag -a  v0.1.0 -m "First release"

Tags must follow semver conventions Tags must be prefixed with a lowercase v letter.

Then push tags as follows:

git push origin main --follow-tags

Contributing

Every contribution to this project is welcome. Feel free to open a pull request, an issue or just by starting this project.

License

Distributed under the terms of both the MIT license and the Apache License (Version 2.0)