Skip to content

Commit 5e11841

Browse files
Documentation update: "go install" instead of "go get"
1 parent c19fbd5 commit 5e11841

File tree

2 files changed

+22
-22
lines changed

2 files changed

+22
-22
lines changed

README.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,10 @@ SimpleHTTPserver is a go enhanced version of the well known python simplehttpser
3535

3636
# Installing SimpleHTTPserver
3737

38-
SimpleHTTPserver requires **go1.14+** to install successfully. Run the following command to get the repo -
38+
SimpleHTTPserver requires **go1.17+** to install successfully. Run the following command to get the repo -
3939

4040
```sh
41-
GO111MODULE=on go get -v github.com/projectdiscovery/simplehttpserver/cmd/simplehttpserver
41+
go install -v github.com/projectdiscovery/simplehttpserver/cmd/simplehttpserver@latest
4242
```
4343

4444
# Usage
@@ -49,25 +49,25 @@ simplehttpserver -h
4949

5050
This will display help for the tool. Here are all the switches it supports.
5151

52-
| Flag | Description | Example |
53-
| ------------- | ------------------------------------------------------- | ------------------------------------------------ |
54-
| listen | Configure listening ip:port (default 127.0.0.1:8000) | simplehttpserver -listen 127.0.0.1:8000 |
55-
| path | Fileserver folder (default current directory) | simplehttpserver -path /var/docs |
56-
| verbose | Verbose (dump request/response, default false) | simplehttpserver -verbose |
57-
| tcp | TCP server (default 127.0.0.1:8000) | simplehttpserver -tcp 127.0.0.1:8000 |
58-
| tls | Enable TLS for TCP server | simplehttpserver -tls |
59-
| rules | File containing yaml rules | simplehttpserver -rules rule.yaml |
60-
| upload | Enable file upload in case of http server | simplehttpserver -upload |
61-
| max-file-size | Max Upload File Size (default 50 MB) | simplehttpserver -max-file-size 100 |
62-
| sandbox | Enable sandbox mode | simplehttpserver -sandbox |
63-
| https | Enable HTTPS in case of http server | simplehttpserver -https |
64-
| cert | HTTPS/TLS certificate (self generated if not specified) | simplehttpserver -cert cert.pem |
65-
| key | HTTPS/TLS certificate private key | simplehttpserver -key cert.key |
66-
| domain | Domain name to use for the self-generated certificate | simplehttpserver -domain projectdiscovery.io |
67-
| basic-auth | Basic auth (username:password) | simplehttpserver -basic-auth user:password |
68-
| realm | Basic auth message | simplehttpserver -realm "insert the credentials" |
69-
| version | Show version | simplehttpserver -version |
70-
| silent | Show only results | simplehttpserver -silent |
52+
| Flag | Description | Example |
53+
|------------------|---------------------------------------------------------|----------------------------------------------------|
54+
| `-listen` | Configure listening ip:port (default 127.0.0.1:8000) | `simplehttpserver -listen 127.0.0.1:8000` |
55+
| `-path` | Fileserver folder (default current directory) | `simplehttpserver -path /var/docs` |
56+
| `-verbose` | Verbose (dump request/response, default false) | `simplehttpserver -verbose` |
57+
| `-tcp` | TCP server (default 127.0.0.1:8000) | `simplehttpserver -tcp 127.0.0.1:8000` |
58+
| `-tls` | Enable TLS for TCP server | `simplehttpserver -tls` |
59+
| `-rules` | File containing yaml rules | `simplehttpserver -rules rule.yaml` |
60+
| `-upload` | Enable file upload in case of http server | `simplehttpserver -upload` |
61+
| `-max-file-size` | Max Upload File Size (default 50 MB) | `simplehttpserver -max-file-size 100` |
62+
| `-sandbox` | Enable sandbox mode | `simplehttpserver -sandbox` |
63+
| `-https` | Enable HTTPS in case of http server | `simplehttpserver -https` |
64+
| `-cert` | HTTPS/TLS certificate (self generated if not specified) | `simplehttpserver -cert cert.pem` |
65+
| `-key` | HTTPS/TLS certificate private key | `simplehttpserver -key cert.key` |
66+
| `-domain` | Domain name to use for the self-generated certificate | `simplehttpserver -domain projectdiscovery.io` |
67+
| `-basic-auth` | Basic auth (username:password) | `simplehttpserver -basic-auth user:password` |
68+
| `-realm` | Basic auth message | `simplehttpserver -realm "insert the credentials"` |
69+
| `-version` | Show version | `simplehttpserver -version` |
70+
| `-silent` | Show only results | `simplehttpserver -silent` |
7171

7272
### Running simplehttpserver in the current folder
7373

SECURITY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22

33
## Reporting a Vulnerability
44

5-
DO NOT CREATE AN ISSUE to report a security problem. Instead, please send an email to security@projectdiscovery.io and we will acknowledge it within 3 working days.
5+
DO NOT CREATE AN ISSUE to report a security problem. Instead, please send an email to [security@projectdiscovery.io](mailto:security@projectdiscovery.io), and we will acknowledge it within 3 working days.

0 commit comments

Comments
 (0)