httprs 0.2.5

A fast simple command line http server tool
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160

# httprs

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/10fish/httprs/blob/main/LICENSE.txt)
[![CI Status](https://github.com/10fish/httprs/actions/workflows/ci.yml/badge.svg)](https://github.com/10fish/httprs/actions/workflows/ci.yml)
[![Audit](https://github.com/10fish/httprs/actions/workflows/audit.yml/badge.svg)](https://github.com/10fish/httprs/actions/workflows/audit.yml)
[![Dependency status](https://deps.rs/repo/github/10fish/httprs/status.svg)](https://deps.rs/repo/github/10fish/httprs)
[![Version](https://img.shields.io/crates/v/httprs.svg)](https://crates.io/crates/httprs)
[![Docs](https://docs.rs/httprs/badge.svg)](https://docs.rs/httprs)
[![Lines of Code](https://tokei.rs/b1/github/10fish/httprs)](https://github.com/10fish/httprs)

A fast simple command line http server tool. 

### Why httprs ?
If you're looking for a simple, fast, easy-to-use, generic-MIME-types-supporting 
and partial-content-supporting static file server like me, it might be an option.

*Warning: It is currently an experimental project. Use it at your own risk!!!*

### Features
the main features are as followings, and certainly more will be added:
- performant and essy to use
- multi-platform support
- multiple MIME support
- colored logs
- partial content support

### HTTP Server Standards & Benchmarks

#### Implemented Features

1. HTTP/1.1 Standard Support:
- ✅ Basic HTTP/1.1 protocol support
- ✅ Standard HTTP methods
- ✅ Standard HTTP headers
- ✅ Status codes

2. Performance Features:
- ✅ Asynchronous I/O (using tokio)
- ✅ Chunked file transfer (Range request support)
- ✅ Static file serving
- ✅ Directory listing
- ✅ Graceful shutdown

3. Security Features:
- ✅ HTTPS support (TLS/SSL)
- ✅ Basic error handling
- ✅ Request logging

4. Functional Features:
- ✅ MIME type support
- ✅ File system navigation
- ✅ Breadcrumb navigation
- ✅ Response time tracking

#### Planned Features

1. HTTP Standards:
- ⏳ HTTP/2 support
- ⏳ HTTP/3 support
- ⏳ WebSocket support
- ⏳ Compression support (gzip, deflate)

2. Performance Optimizations:
- ⏳ Connection pool management
- ⏳ Cache control
- ⏳ Compression transmission
- ⏳ Load balancing
- ⏳ Request rate limiting

3. Security Enhancements:
- ⏳ CORS support
- ⏳ Security headers (HSTS, etc.)
- ⏳ Request validation
- ⏳ Access control

4. Advanced Features:
- ⏳ Dynamic content generation
- ⏳ Session management
- ⏳ Authentication & Authorization
- ⏳ API support
- ⏳ Reverse proxy

5. Monitoring & Management:
- ⏳ Performance metrics collection
- ⏳ Health checks
- ⏳ Management interface
- ⏳ Hot reload configuration

### Installation
Download pre-built binaries from [release](https://github.com/10fish/httprs/releases) page.

or install with `cargo` in terminal:
```shell
cargo install httprs
```

### Usage
```shell
# quick start, running on all network interfaces (0.0.0.0:9900)
httprs
# run on specific local IP address
httprs -H 192.168.10.1
# run in secure mode
httprs --secure --key /path/to/keyfile --cert /path/to/certfile
# run with graceful shutdown
httprs --graceful-shutdown
# help for more details
httprs --help
```

> Note: By default, the server binds to `0.0.0.0` which means it will listen on all available network interfaces. This makes the server accessible from other devices on the network. If you want to restrict access to localhost only, use `-H 127.0.0.1`.

### Roadmap

- [ ] Logging
    - [x] Request/Response Logging
    - [x] Silent Mode
    - [ ] Logging Level
    - [ ] Logging Output into File
- [ ] File Browser Support
    - [x] Generic File Type Supporting: image/text/video/binary
    - [ ] File Metadata Details
      - [x] File Size
      - [x] Last Modified
      - [ ] More if Necessary
    - [ ] File List Ordering
    - [ ] Content-Type Customization
- [ ] Multiplatform Support
    - [x] macOS
    - [x] Linux
    - [x] Windows
- [x] HTTPS/TLS Transmission Encryption
- [ ] Partial Request/Response Support
    - [ ] `If-Range` REQUEST Header
    - [ ] `If-Match` REQUEST Header
    - [x] `Range` REQUEST Header: when file size exceeds 50MB
    - [x] `Accept-Ranges` RESPONSE Header
    - [x] `Content-Range` RESPONSE Header
    - [x] CODE `206` - Partial Content
    - [ ] CODE `416` - Range Not Satisfiable
- [ ] CORS Support
- [ ] Transmission Compression
- [ ] Authentication
  - [ ] Simple Basic
  - [ ] Token Based
- [x] Graceful Shutdown
- [ ] Proxy
- [ ] Themes and Appearances Customization

### How to contribute
Any advice is welcomed and feel free to make a fork and push your own code.

### Acknowledgements
Thanks to those who are inspiring me, supporting me, providing me with ideas, advice, solutions, and all users who bear much using this.
- [http-server-rs/http-server](https://github.com/http-server-rs/http-server) for initial thoughts.
- [egmkang/local_ipaddress](https://github.com/egmkang/local_ipaddress) for resolving intranet binding IP addresses.

### Licenses

MIT License