Update integration api port docs and gerbil cli

This commit is contained in:
Owen
2025-08-25 14:42:54 -07:00
parent 155cae2efb
commit e126a20fff
4 changed files with 8 additions and 10 deletions

View File

@@ -139,10 +139,9 @@ The easiest way to resolve this is to run Gerbil and have it register in your de
```bash
./gerbil \
--remoteConfig http://localhost:3001/api/v1/gerbil/get-config \
--reportBandwidthTo http://localhost:3001/api/v1/gerbil/receive-bandwidth \
--generateAndSaveKeyTo=/var/key \
--reachableAt=http://localhost:3003
--reachableAt=http://gerbil:3003 \
--generateAndSaveKeyTo=/var/config/key \
--remoteConfig=http://pangolin:3001/api/v1/
```
</Note>

View File

@@ -133,7 +133,7 @@ This section contains the complete reference for all configuration options in `c
<ResponseField name="integration_port" type="integer">
The port for the integration API (optional).
**Example**: `3003`
**Example**: `3004`
</ResponseField>
<ResponseField name="internal_hostname" type="string">

View File

@@ -14,11 +14,11 @@ flags:
enable_integration_api: true
```
If you want to specify a port other than the default `3003`, you can do so in the config as well:
If you want to specify a port other than the default `3004`, you can do so in the config as well:
```yaml title="config.yml"
server:
integration_port: 3003 # Specify different port
integration_port: 3004 # Specify different port
```
## Configure Traefik Routing
@@ -53,7 +53,7 @@ http:
int-api-service:
loadBalancer:
servers:
- url: "http://pangolin:3003"
- url: "http://pangolin:3004"
```
## Access Documentation

View File

@@ -162,8 +162,7 @@ services:
command:
- --reachableAt=http://gerbil:3003
- --generateAndSaveKeyTo=/var/config/key
- --remoteConfig=http://pangolin:3001/api/v1/gerbil/get-config
- --reportBandwidthTo=http://pangolin:3001/api/v1/gerbil/receive-bandwidth
- --remoteConfig=http://pangolin:3001/api/v1/
volumes:
- ./config/:/var/config
cap_add: