docs(README.md): Update usage, proxy server instructions & license info
This commit is contained in:
parent
570ce3723b
commit
e2b6029102
45
README.md
45
README.md
|
@ -10,13 +10,48 @@ This is a lightweight proxy server written in Go that supports HTTP requests and
|
||||||
- Customizable port, username, and password using command-line arguments
|
- Customizable port, username, and password using command-line arguments
|
||||||
- Logging
|
- Logging
|
||||||
|
|
||||||
## Requirements
|
## Prerequisites
|
||||||
|
|
||||||
- Go (version 1.x+)
|
- Golang (if building from source)
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
### Running the Proxy from source
|
### Running the Proxy
|
||||||
|
|
||||||
|
#### For Darwin/Linux:
|
||||||
|
|
||||||
|
1. Download the latest release for your platform from GitHub releases
|
||||||
|
2. Extract the downloaded archive:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
tar -xvzf http-proxy-server-v{version}-{platform}-{arch}.tar.gz
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Navigate to the extracted folder:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd http-proxy-server-v{version}-{platform}-{arch}
|
||||||
|
```
|
||||||
|
|
||||||
|
4. Run the proxy:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./http-proxy-server --port <PORT> [--username <USERNAME> --password <PASSWORD>]
|
||||||
|
```
|
||||||
|
|
||||||
|
#### For Windows:
|
||||||
|
|
||||||
|
1. Download the latest release for Windows from GitHub releases
|
||||||
|
2. Extract the downloaded ZIP archive
|
||||||
|
3. Navigate to the extracted folder.
|
||||||
|
4. Open a command prompt in this directory.
|
||||||
|
5. Run the proxy:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
proxy_name.exe --port <PORT> [--username <USERNAME> --password <PASSWORD>]
|
||||||
|
```
|
||||||
|
|
||||||
|
#### From Source
|
||||||
|
|
||||||
1. Clone the repository:
|
1. Clone the repository:
|
||||||
```bash
|
```bash
|
||||||
|
@ -46,3 +81,7 @@ go run main.go --port 1489 --username admin --password admin123
|
||||||
### Authentication
|
### Authentication
|
||||||
|
|
||||||
If you specify both `--username` and `--password` when starting the proxy, it will enforce Basic Proxy Authentication with the given credentials. If these parameters are omitted, the proxy will not require authentication.
|
If you specify both `--username` and `--password` when starting the proxy, it will enforce Basic Proxy Authentication with the given credentials. If these parameters are omitted, the proxy will not require authentication.
|
||||||
|
|
||||||
|
### License
|
||||||
|
|
||||||
|
This project is licensed under the MIT License.
|
Loading…
Reference in New Issue