Installation
Check for the installation to be successful.
Configuration
When running the server with no options or flags provided, a set of default configurations will be set, you can always change this behavior by either creating your own config with the Configuration TOML file or by providing CLI arguments described in the usage section.
Name | Description | Default |
---|---|---|
Host | Address to bind the server | 127.0.0.1 |
Port | Port to bind the server | 7878 |
Root Directory | The directory to serve files from | CWD |
File Explorer UI | A File Explorer UI for the directory configured as the Root Directory | Enabled |
Configuration File | Specifies a configuration file. Example | Disabled |
HTTPS (TLS) | HTTPS Secure connection configuration. Refer to TLS (HTTPS) reference | Disabled |
CORS | Cross-Origin-Resource-Sharing headers support. Refer to CORS reference | Disabled |
Compression | GZip compression for HTTP Response Bodies. Refer to Compression reference | Disabled |
Verbose | Print server details when running. This doesn't include any logging capabilities. | Disabled |
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 |
GZip Compression | N/A | --gzip |
Enable GZip compression for responses |
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.
Compression
Even when compression is supported, by default the server will not compress any HTTP response contents.
You must specify the compression configuration you want to use, as of today
the server only supports compression with the GZip algorithm, but brotli
is
also planed to be supported, that's why theres two ways to configure this
server to use compression.
The following MIME types will be skipped from compression:
application/gzip
application/octet-stream
application/wasm
application/zip
image/*
video/*
The Configuration File's Compression Section
As suppport for other compression algorithms is planned to be provided in the future, the configuration file already supports compression settings.
[]
= true
The --gzip
flag
Provide the --gzip
argument to the server when executing it.
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:
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.
[]
= false
= ["content-type", "authorization", "content-length"]
= ["GET", "PATCH", "POST", "PUT", "DELETE"]
= "example.com"
= ["*", "authorization"]
= 600
= ["x-app-version"]
= "GET"
Release
In order to create a release you must push a Git tag as follows
Example
Tags must follow semver conventions Tags must be prefixed with a lowercase
v
letter.
Then push tags as follows:
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)