fosrl/docs
1
0
Fork 0
mirror of https://github.com/fosrl/docs.git synced 2025-05-20 08:57:54 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

update config

Browse source
This commit is contained in:
miloschwartz 2025-05-13 12:21:24 -04:00
parent 2d2986a1a2
commit 8f586538ed
No known key found for this signature in database
2 changed files with 15 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
packages/docusaurus/docs/03-Pangolin/02-Configuration/02-config.md
View file

@ -23,7 +23,7 @@ Pangolin is configured using a `config.yml` file. The file is expected to be mou
### `server`
- `external_port`: int (optional)
- `integration_port`: int (optional)
- The port the integration API will listen on.
- `external_port`: int
- The port the front-end API will listen on.
@ -188,6 +188,8 @@ At least one domain must be configured.
- Whether to allow users to create raw TCP/UDP resources. If set to `false`, users will only be able to create http/https resources.
- `allow_base_domain_resources` (optional): boolean
- Whether to allow users to create resources on the base domain. If set to `false`, users will only be able to create resources on subdomains.
- `enable_integration_api` (optional): boolean
- Whether to enable and start the integration API.
## Example Configuration File

12
packages/docusaurus/docs/03-Pangolin/07-API/01-integration-api.md
View file

@ -32,6 +32,18 @@ OpenAPI documentation is served via Swagger UI. You can access the documentation
<img src={require("./img/swagger.png").default} alt="Preview"/>
## Enable Integration API
Update the Pangolin config file:
```yaml
server:
integration_port: 3003
flags:
enable_integration_api: true
```
## Configure Integration API
The below example shows how to expose the Integration API. It will be accessible at `https://api.example.com/v1`.