starred/godoxy-yusing
1
0
Fork 0
mirror of https://github.com/yusing/godoxy.git synced 2026-03-26 19:11:08 +01:00
Code Issues 18 Packages Projects Releases 10 Wiki Activity

docs and makefile changes

Browse Source
This commit is contained in:
yusing
2025-01-05 03:58:56 +08:00
parent 6f35a6f5e9
commit b7802f4e3e
4 changed files with 116 additions and 82 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@@ -46,7 +46,7 @@ _Join our [Discord](https://discord.gg/umReR62nRd) for help and discussions_
- [HTTP middleware support](https://github.com/yusing/go-proxy/wiki/Middlewares)
- [Custom error pages support](https://github.com/yusing/go-proxy/wiki/Middlewares#custom-error-pages)
- TCP and UDP port forwarding
- **Web UI with App dashboard**
- **Web UI with App dashboard and config editor**
- Supports linux/amd64, linux/arm64
- Written in **[Go](https://go.dev)**
@@ -54,6 +54,8 @@ _Join our [Discord](https://discord.gg/umReR62nRd) for help and discussions_
## Getting Started
For full documentation, **[See Wiki](https://github.com/yusing/go-proxy/wiki)**
### Prerequisites
Setup DNS Records point to machine which runs `GoDoxy`, e.g.
@@ -95,8 +97,7 @@ Setup DNS Records point to machine which runs `GoDoxy`, e.g.
6. You may now do some extra configuration
- With text editor (e.g. Visual Studio Code)
- With Web UI via `http://localhost:3000` or `https://gp.y.z`
- For more info, [See Wiki](<[wiki](https://github.com/yusing/go-proxy/wiki)>)
- With Web UI via `https://gp.y.z`
[🔼Back to top](#table-of-content)
@@ -104,15 +105,15 @@ Setup DNS Records point to machine which runs `GoDoxy`, e.g.
1. Make `config` directory then grab `config.example.yml` into `config/config.yml`
`mkdir -p config && wget https://raw.githubusercontent.com/yusing/go-proxy/v0.7/config.example.yml -O config/config.yml`
`mkdir -p config && wget https://raw.githubusercontent.com/yusing/go-proxy/v0.8/config.example.yml -O config/config.yml`
2. Grab `.env.example` into `.env`
`wget https://raw.githubusercontent.com/yusing/go-proxy/v0.7/.env.example -O .env`
`wget https://raw.githubusercontent.com/yusing/go-proxy/v0.8/.env.example -O .env`
3. Grab `compose.example.yml` into `compose.yml`
`wget https://raw.githubusercontent.com/yusing/go-proxy/v0.7/compose.example.yml -O compose.yml`
`wget https://raw.githubusercontent.com/yusing/go-proxy/v0.8/compose.example.yml -O compose.yml`
### Folder structrue