mirror of
https://github.com/yusing/godoxy.git
synced 2025-06-09 04:52:35 +02:00
update readme
This commit is contained in:
parent
98443be80c
commit
10a0a8fe09
4 changed files with 13 additions and 16 deletions
4
.vscode/settings.example.json
vendored
4
.vscode/settings.example.json
vendored
|
@ -1,10 +1,10 @@
|
||||||
{
|
{
|
||||||
"yaml.schemas": {
|
"yaml.schemas": {
|
||||||
"https://github.com/yusing/go-proxy/raw/v0.8/schemas/config.schema.json": [
|
"https://github.com/yusing/go-proxy/raw/v0.9/schemas/config.schema.json": [
|
||||||
"config.example.yml",
|
"config.example.yml",
|
||||||
"config.yml"
|
"config.yml"
|
||||||
],
|
],
|
||||||
"https://github.com/yusing/go-proxy/raw/v0.8/schemas/routes.schema.json": [
|
"https://github.com/yusing/go-proxy/raw/v0.9/schemas/routes.schema.json": [
|
||||||
"providers.example.yml"
|
"providers.example.yml"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|
17
README.md
17
README.md
|
@ -11,9 +11,7 @@
|
||||||
|
|
||||||
A lightweight, easy-to-use, and [performant](https://github.com/yusing/go-proxy/wiki/Benchmarks) reverse proxy with a Web UI and dashboard.
|
A lightweight, easy-to-use, and [performant](https://github.com/yusing/go-proxy/wiki/Benchmarks) reverse proxy with a Web UI and dashboard.
|
||||||
|
|
||||||
**v0.9 will be out soon, with a brand new [WebUI](next-release.md)!!! Below one is the old one**
|

|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
_Join our [Discord](https://discord.gg/umReR62nRd) for help and discussions_
|
_Join our [Discord](https://discord.gg/umReR62nRd) for help and discussions_
|
||||||
|
|
||||||
|
@ -45,6 +43,7 @@ _Join our [Discord](https://discord.gg/umReR62nRd) for help and discussions_
|
||||||
- Auto hot-reload on container state / config file changes
|
- Auto hot-reload on container state / config file changes
|
||||||
- **idlesleeper**: stop containers on idle, wake it up on traffic _(optional, see [screenshots](#idlesleeper))_
|
- **idlesleeper**: stop containers on idle, wake it up on traffic _(optional, see [screenshots](#idlesleeper))_
|
||||||
- HTTP(s) reserve proxy
|
- HTTP(s) reserve proxy
|
||||||
|
- OpenID Connect support
|
||||||
- [HTTP middleware support](https://github.com/yusing/go-proxy/wiki/Middlewares)
|
- [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)
|
- [Custom error pages support](https://github.com/yusing/go-proxy/wiki/Middlewares#custom-error-pages)
|
||||||
- TCP and UDP port forwarding
|
- TCP and UDP port forwarding
|
||||||
|
@ -79,7 +78,7 @@ Setup DNS Records point to machine which runs `GoDoxy`, e.g.
|
||||||
docker run --rm -v .:/setup ghcr.io/yusing/go-proxy /app/godoxy setup
|
docker run --rm -v .:/setup ghcr.io/yusing/go-proxy /app/godoxy setup
|
||||||
```
|
```
|
||||||
|
|
||||||
3. _(Optional)_ setup WebUI login
|
3. _(Optional)_ setup WebUI login (skip if you use OIDC)
|
||||||
|
|
||||||
- set random JWT secret
|
- set random JWT secret
|
||||||
|
|
||||||
|
@ -99,9 +98,7 @@ Setup DNS Records point to machine which runs `GoDoxy`, e.g.
|
||||||
|
|
||||||
5. Start the container `docker compose up -d`
|
5. Start the container `docker compose up -d`
|
||||||
|
|
||||||
6. You may now do some extra configuration
|
6. You may now do some extra configuration on WebUI `https://gp.y.z`
|
||||||
- With text editor (e.g. Visual Studio Code)
|
|
||||||
- With Web UI via `https://gp.y.z`
|
|
||||||
|
|
||||||
[🔼Back to top](#table-of-content)
|
[🔼Back to top](#table-of-content)
|
||||||
|
|
||||||
|
@ -109,15 +106,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`
|
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.8/config.example.yml -O config/config.yml`
|
`mkdir -p config && wget https://raw.githubusercontent.com/yusing/go-proxy/v0.9/config.example.yml -O config/config.yml`
|
||||||
|
|
||||||
2. Grab `.env.example` into `.env`
|
2. Grab `.env.example` into `.env`
|
||||||
|
|
||||||
`wget https://raw.githubusercontent.com/yusing/go-proxy/v0.8/.env.example -O .env`
|
`wget https://raw.githubusercontent.com/yusing/go-proxy/v0.9/.env.example -O .env`
|
||||||
|
|
||||||
3. Grab `compose.example.yml` into `compose.yml`
|
3. Grab `compose.example.yml` into `compose.yml`
|
||||||
|
|
||||||
`wget https://raw.githubusercontent.com/yusing/go-proxy/v0.8/compose.example.yml -O compose.yml`
|
`wget https://raw.githubusercontent.com/yusing/go-proxy/v0.9/compose.example.yml -O compose.yml`
|
||||||
|
|
||||||
### Folder structrue
|
### Folder structrue
|
||||||
|
|
||||||
|
|
|
@ -107,15 +107,15 @@ _加入我們的 [Discord](https://discord.gg/umReR62nRd) 獲取幫助和討論_
|
||||||
|
|
||||||
1. 建立 `config` 目錄,然後將 `config.example.yml` 下載到 `config/config.yml`
|
1. 建立 `config` 目錄,然後將 `config.example.yml` 下載到 `config/config.yml`
|
||||||
|
|
||||||
`mkdir -p config && wget https://raw.githubusercontent.com/yusing/go-proxy/v0.8/config.example.yml -O config/config.yml`
|
`mkdir -p config && wget https://raw.githubusercontent.com/yusing/go-proxy/v0.9/config.example.yml -O config/config.yml`
|
||||||
|
|
||||||
2. 將 `.env.example` 下載到 `.env`
|
2. 將 `.env.example` 下載到 `.env`
|
||||||
|
|
||||||
`wget https://raw.githubusercontent.com/yusing/go-proxy/v0.8/.env.example -O .env`
|
`wget https://raw.githubusercontent.com/yusing/go-proxy/v0.9/.env.example -O .env`
|
||||||
|
|
||||||
3. 將 `compose.example.yml` 下載到 `compose.yml`
|
3. 將 `compose.example.yml` 下載到 `compose.yml`
|
||||||
|
|
||||||
`wget https://raw.githubusercontent.com/yusing/go-proxy/v0.8/compose.example.yml -O compose.yml`
|
`wget https://raw.githubusercontent.com/yusing/go-proxy/v0.9/compose.example.yml -O compose.yml`
|
||||||
|
|
||||||
### 資料夾結構
|
### 資料夾結構
|
||||||
|
|
||||||
|
|
|
@ -12,7 +12,7 @@ import (
|
||||||
)
|
)
|
||||||
|
|
||||||
var (
|
var (
|
||||||
branch = common.GetEnvString("BRANCH", "v0.8")
|
branch = common.GetEnvString("BRANCH", "v0.9")
|
||||||
baseURL = "https://github.com/yusing/go-proxy/raw/" + branch
|
baseURL = "https://github.com/yusing/go-proxy/raw/" + branch
|
||||||
requiredConfigs = []Config{
|
requiredConfigs = []Config{
|
||||||
{common.ConfigBasePath, true, false, ""},
|
{common.ConfigBasePath, true, false, ""},
|
||||||
|
|
Loading…
Add table
Reference in a new issue