mirror of
https://github.com/yusing/godoxy.git
synced 2026-04-25 01:38:30 +02:00
updated auto and manual setup guide
This commit is contained in:
21
README.md
21
README.md
@@ -24,6 +24,7 @@ _Join our [Discord](https://discord.gg/umReR62nRd) for help and discussions_
|
|||||||
- [Key Features](#key-features)
|
- [Key Features](#key-features)
|
||||||
- [Getting Started](#getting-started)
|
- [Getting Started](#getting-started)
|
||||||
- [Setup](#setup)
|
- [Setup](#setup)
|
||||||
|
- [Manual Setup](#manual-setup)
|
||||||
- [Use JSON Schema in VSCode](#use-json-schema-in-vscode)
|
- [Use JSON Schema in VSCode](#use-json-schema-in-vscode)
|
||||||
- [Screenshots](#screenshots)
|
- [Screenshots](#screenshots)
|
||||||
- [idlesleeper](#idlesleeper)
|
- [idlesleeper](#idlesleeper)
|
||||||
@@ -59,10 +60,12 @@ _Join our [Discord](https://discord.gg/umReR62nRd) for help and discussions_
|
|||||||
docker pull ghcr.io/yusing/go-proxy:latest
|
docker pull ghcr.io/yusing/go-proxy:latest
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Create new directory, `cd` into it, then run setup
|
2. Create new directory, `cd` into it, then run setup, or [set up manually](#manual-setup)
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
docker run --rm -v .:/setup ghcr.io/yusing/go-proxy /app/go-proxy setup
|
docker run --rm -v .:/setup ghcr.io/yusing/go-proxy /app/go-proxy setup
|
||||||
|
# Then set the JWT secret
|
||||||
|
sed -i "s|GOPROXY_API_JWT_SECRET=.*|GOPROXY_API_JWT_SECRET=$(openssl rand -base64 32)|g" .env
|
||||||
```
|
```
|
||||||
|
|
||||||
3. Setup DNS Records point to machine which runs `go-proxy`, e.g.
|
3. Setup DNS Records point to machine which runs `go-proxy`, e.g.
|
||||||
@@ -83,6 +86,22 @@ _Join our [Discord](https://discord.gg/umReR62nRd) for help and discussions_
|
|||||||
|
|
||||||
[🔼Back to top](#table-of-content)
|
[🔼Back to top](#table-of-content)
|
||||||
|
|
||||||
|
### Manual Setup
|
||||||
|
|
||||||
|
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`
|
||||||
|
|
||||||
|
2. Grab `.env.example` into `.env`
|
||||||
|
`wget https://raw.githubusercontent.com/yusing/go-proxy/v0.7/.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`
|
||||||
|
|
||||||
|
4. Set the JWT secret
|
||||||
|
`sed -i "s|GOPROXY_API_JWT_SECRET=.*|GOPROXY_API_JWT_SECRET=$(openssl rand -base64 32)|g" .env`
|
||||||
|
|
||||||
|
5. Start the container `docker compose up -d`
|
||||||
|
|
||||||
### Use JSON Schema in VSCode
|
### Use JSON Schema in VSCode
|
||||||
|
|
||||||
Copy [`.vscode/settings.example.json`](.vscode/settings.example.json) to `.vscode/settings.json` and modify it to fit your needs
|
Copy [`.vscode/settings.example.json`](.vscode/settings.example.json) to `.vscode/settings.json` and modify it to fit your needs
|
||||||
|
|||||||
Reference in New Issue
Block a user