docs: add install document

master
Shengjing Zhu 2022-07-23 17:22:00 +08:00
parent d502e541fd
commit 140e39f0c0
2 changed files with 26 additions and 1 deletions

View File

@ -11,4 +11,4 @@ from proxy server goes to WireGuard network.
In local exit mode, the proxy is served on WireGuard network, and the traffic
from WireGuard goes to local network.
For detail usage, see <https://github.com/zhsj/wghttp/tree/master/docs>.
For detailed usage, see <https://github.com/zhsj/wghttp/tree/master/docs>.

25
docs/install.md Normal file
View File

@ -0,0 +1,25 @@
# Install
## From source
```bash
go install github.com/zhsj/wghttp@latest
```
## Docker
Docker images are publish at:
- [Docker Hub](https://hub.docker.com/r/zhusj/wghttp)
```bash
docker pull zhusj/wghttp:latest
```
- [GitHub](https://github.com/zhsj/wghttp/pkgs/container/wghttp)
```bash
docker pull ghcr.io/zhsj/wghttp:latest
```