Skip to content

Commit f2ae973

Browse files
committed
adding readme
1 parent 613674f commit f2ae973

File tree

1 file changed

+95
-0
lines changed

1 file changed

+95
-0
lines changed

README.md

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
<h1 align="center">
2+
<img src="static/simplehttpserver-logo.png" alt="simplehttpserver" width="200px"></a>
3+
<br>
4+
</h1>
5+
6+
[![License](https://img.shields.io/badge/license-MIT-_red.svg)](https://opensource.org/licenses/MIT)
7+
[![Go Report Card](https://goreportcard.com/badge/github.com/projectdiscovery/simplehttpserver)](https://goreportcard.com/report/github.com/projectdiscovery/simplehttpserver)
8+
[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/projectdiscovery/simplehttpserver/issues)
9+
[![GitHub Release](https://img.shields.io/github/release/projectdiscovery/simplehttpserver)](https://github.com/projectdiscovery/simplehttpserver/releases)
10+
[![Follow on Twitter](https://img.shields.io/twitter/follow/pdiscoveryio.svg?logo=twitter)](https://twitter.com/pdiscoveryio)
11+
[![Docker Images](https://img.shields.io/docker/pulls/projectdiscovery/simplehttpserver.svg)](https://hub.docker.com/r/projectdiscovery/simplehttpserver)
12+
[![Chat on Discord](https://img.shields.io/discord/695645237418131507.svg?logo=discord)](https://discord.gg/KECAGdH)
13+
14+
simplehttpserver is a go enhanced version of the well known python simplehttpserver.
15+
16+
# Resources
17+
- [Resources](#resources)
18+
- [Features](#features)
19+
- [Usage](#usage)
20+
- [Installation Instructions](#installation-instructions)
21+
- [From Binary](#from-binary)
22+
- [From Source](#from-source)
23+
- [From Github](#from-github)
24+
- [Running simplehttpserver in the current folder ](#Running simplehttpserver in the current folder )
25+
- [Thanks](#thanks)
26+
27+
# Features
28+
29+
<h1 align="left">
30+
<img src="static/simplehttpserver-run.png" alt="simplehttpserver" width="700px"></a>
31+
<br>
32+
</h1>
33+
34+
- File server in arbitrary directory
35+
- Full request/response dump
36+
- Configurable ip address and listening port
37+
38+
39+
# Installation Instructions
40+
41+
42+
### From Binary
43+
44+
The installation is easy. You can download the pre-built binaries for your platform from the [Releases](https://github.com/projectdiscovery/simplehttpserver/releases/) page. Extract them using tar, move it to your `$PATH`and you're ready to go.
45+
46+
```sh
47+
Download latest binary from https://github.com/projectdiscovery/simplehttpserver/releases
48+
49+
▶ tar -xvf simplehttpserver-linux-amd64.tar
50+
▶ mv simplehttpserver-linux-amd64 /usr/local/bin/simplehttpserver
51+
▶ simplehttpserver -h
52+
```
53+
54+
### From Source
55+
56+
simplehttpserver requires **go1.14+** to install successfully. Run the following command to get the repo -
57+
58+
```sh
59+
▶ GO111MODULE=on go get -v github.com/projectdiscovery/simplehttpserver
60+
```
61+
62+
### From Github
63+
64+
```sh
65+
▶ git clone https://github.com/projectdiscovery/simplehttpserver.git; cd simplehttpserver; go build; mv simplehttpserver /usr/local/bin/; simplehttpserver -version
66+
```
67+
68+
# Usage
69+
70+
```sh
71+
simplehttpserver -h
72+
```
73+
74+
This will display help for the tool. Here are all the switches it supports.
75+
76+
| Flag | Description | Example |
77+
|-------------------------|---------------------------------------------------------|----------------------------------------------------|
78+
| listen | Configure listening ip:port (default 127.0.0.1:8000) | simplehttpserver -listen 127.0.0.1:8000 |
79+
| path | Fileserver folder (default current directory) | simplehttpserver -path /var/docs |
80+
| v | Verbose (dump request/response, default false) | simplehttpserver -v |
81+
82+
### Running simplehttpserver in the current folder
83+
84+
This will run the tool exposing the current directory on port 8000
85+
86+
```sh
87+
▶ simplehttpserver
88+
2021/01/11 21:40:48 Serving . on http://0.0.0.0:8000/...
89+
2021/01/11 21:41:15 [::1]:50181 "GET / HTTP/1.1" 200 383
90+
2021/01/11 21:41:15 [::1]:50181 "GET /favicon.ico HTTP/1.1" 404 19
91+
```
92+
93+
# Thanks
94+
95+
simplehttpserver is made with 🖤 by the [projectdiscovery](https://projectdiscovery.io) team. Community contributions have made the project what it is. See the **[Thanks.md](https://github.com/projectdiscovery/simplehttpserver/blob/master/THANKS.md)** file for more details.

0 commit comments

Comments
 (0)