Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thewawar/simple-http-server
Simple http server in Rust (Windows/Mac/Linux)
https://github.com/thewawar/simple-http-server
file http rust server simplehttpserver static
Last synced: 7 days ago
JSON representation
Simple http server in Rust (Windows/Mac/Linux)
- Host: GitHub
- URL: https://github.com/thewawar/simple-http-server
- Owner: TheWaWaR
- License: mit
- Created: 2017-05-27T10:52:10.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-11-04T13:24:44.000Z (3 months ago)
- Last Synced: 2024-12-31T04:02:09.757Z (21 days ago)
- Topics: file, http, rust, server, simplehttpserver, static
- Language: Rust
- Homepage:
- Size: 696 KB
- Stars: 2,737
- Watchers: 30
- Forks: 177
- Open Issues: 43
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# How it looks like?
### Screenshot
### Command Line Arguments
```
Simple HTTP(s) Server 0.6.3
USAGE:
simple-http-server [FLAGS] [OPTIONS] [--] [root]
FLAGS:
--coep Add "Cross-Origin-Embedder-Policy" HTTP header and set it to "require-corp"
--coop Add "Cross-Origin-Opener-Policy" HTTP header and set it to "same-origin"
--cors Enable CORS via the "Access-Control-Allow-Origin" header
-h, --help Prints help information
-i, --index Enable automatic render index page [index.html, index.htm]
--nocache Disable http cache
--norange Disable header::Range support (partial request)
--nosort Disable directory entries sort (by: name, modified, size)
-s, --silent Disable all outputs
-u, --upload Enable upload files (multiple select) (CSRF token required)
-V, --version Prints version information
OPTIONS:
-a, --auth HTTP Basic Auth (username:password)
--cert TLS/SSL certificate (pkcs#12 format)
--certpass TLS/SSL certificate password
-c, --compress ...
Enable file compression: gzip/deflate
Example: -c=js,d.ts
Note: disabled on partial request!
--ip IP address to bind [default: 0.0.0.0]
-p, --port Port number [default: 8000]
--redirect takes a URL to redirect to using HTTP 301 Moved Permanently
-t, --threads How many worker threads [default: 3]
--try-file
serve this file (server root relative) in place of missing files (useful for single page apps) [aliases:
try-file-404]
-l, --upload-size-limit Upload file size limit [bytes] [default: 8000000]
```
### Website hosting example
- Point the program to the website folder
- The Home page of the website should be available on the root of the folder
- The Home page should be named as `index.html`
```sh
simple-http-server -i -p 80 folder-name
```
This command will use the port 80 (the certified port for HTTP servers), you can change as you wish.
# Installation
### Download binary
[Goto Download](https://github.com/TheWaWaR/simple-http-server/releases)
- windows-64bit
- osx-64bit
- linux-64bit
### Install by cargo
``` bash
# Install Rust
curl https://sh.rustup.rs -sSf | sh
# Install simple-http-server
cargo install simple-http-server
rehash
simple-http-server -h
```
# Features
- [x] Windows support (with colored log)
- [x] Specify listen address (ip, port)
- [x] Specify running threads
- [x] Specify root directory
- [x] Pretty log
- [x] Nginx like directory view (directory entries, link, filesize, modified date)
- [x] Breadcrumb navigation
- [x] (default enabled) Guess mime type
- [x] (default enabled) HTTP cache control
- Sending Last-Modified / ETag
- Replying 304 to If-Modified-Since
- [x] (default enabled) Partial request
- Accept-Ranges: bytes([ByteRangeSpec; length=1])
- [Range, If-Range, If-Match] => [Content-Range, 206, 416]
- [x] (default disabled) Automatic render index page [index.html, index.htm]
- [x] (default disabled) Upload file
- A CSRF token is generated when upload is enabled and must be sent as a parameter when uploading a file
- [x] (default disabled) HTTP Basic Authentication (by username:password)
- [x] Sort by: filename, filesize, modified date
- [x] HTTPS support
- [x] Content-Encoding: gzip/deflate
- [x] Added CORS headers support
- [x] Silent mode