Skip to content

Commit

Permalink
add Chinese README link
Browse files Browse the repository at this point in the history
  • Loading branch information
shimmeris committed Jan 12, 2023
1 parent a13a7c3 commit 7bd07f7
Showing 1 changed file with 11 additions and 8 deletions.
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# SCFProxy

[README](README.md) | [中文文档](README_zh.md)

SCFProxy is a tool that implements multiple proxies based on cloud functions and API gateway functions provided by cloud
providers.

Expand Down Expand Up @@ -142,7 +144,7 @@ equivalent to `0.0.0.0:port`
Running HTTP proxy will load the records in `~/.config/scfproxy/http.json`, and if there are multiple deployed cloud
functions (regardless of provider), each HTTP request will randomly pick one of them to proxy.

### Cleanup
### Clear

```console
scfproxy clear http -p provider_list -r region_list [--completely]
Expand Down Expand Up @@ -196,7 +198,7 @@ there is no disconnection between commands.
Similar to http, each connection will trigger the execution of the function
![short](img/socks.jpg)

### Cleanup
### Clear

```console
scfproxy clear socks -p provider_list -r region_list
Expand Down Expand Up @@ -263,7 +265,7 @@ This scenario requires intranet penetration software that supports websocket pro
scfproxy deploy reverse ... -o ws://vps --ip victim
```

Using the frp as an example, the client configuration.
Using [frp](https://github.com/fatedier/frp) as an example, the client configuration.

```ini
[common]
Expand All @@ -280,20 +282,21 @@ use_encryption = true
use_compression = true
```

The effect is as shown in the picture
The effect is as shown in the E

![frp](img/frp.png)

### Cleanup
### Clear

```console
scfproxy clear http -p provider_list -r region_list -o origin
scfproxy clear reverse -p provider_list -r region_list -o origin
```

The ``-o origin`` argument is used to locate the service to be removed
The `-o origin` argument is used to locate the service to be removed

# TODO

- [x] Optimize and add reverse proxy functionality from other providers
- [x] Optimize and add reverse proxy functionality for other providers
- [ ] Optimize the code
- [ ] Beautify the output and error handling
- [ ] Add other cloud providers such as Huawei Cloud, GCP, Azure, etc.
Expand Down

0 comments on commit 7bd07f7

Please sign in to comment.