ExternalVendorCode/balena-supervisor
1
0
Fork 0
mirror of https://github.com/balena-os/balena-supervisor.git synced 2025-01-31 16:35:23 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #831 from balena-io/830-api-docs-envvar-label

Browse Source 
docs: Clarify Supervisor envvars exposure via label
This commit is contained in:
Heds Simons 2018-12-04 16:50:56 +00:00 committed by GitHub
commit a8368104ef
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/API.md
View File

@ -12,6 +12,8 @@ Only Supervisors after version 1.1.0 have this functionality, and some of the en
The supervisor exposes an HTTP API on port 48484 (`BALENA_SUPERVISOR_PORT`). The supervisor exposes an HTTP API on port 48484 (`BALENA_SUPERVISOR_PORT`).
To enable these Supervisor environment variables, the `io.balena.features.supervisor-api` label must be applied for each service that requires them. See [here](https://www.balena.io/docs/learn/develop/multicontainer/#labels) for further details.
**All endpoints require an apikey parameter, which is exposed to the application as `BALENA_SUPERVISOR_API_KEY`.** **All endpoints require an apikey parameter, which is exposed to the application as `BALENA_SUPERVISOR_API_KEY`.**
The full address for the API, i.e. `"http://127.0.0.1:48484"`, is available as `BALENA_SUPERVISOR_ADDRESS`. **Always use these variables when communicating via the API, since address and port could change**. The full address for the API, i.e. `"http://127.0.0.1:48484"`, is available as `BALENA_SUPERVISOR_ADDRESS`. **Always use these variables when communicating via the API, since address and port could change**.