ExternalVendorCode/balena-supervisor
1
0
Fork 0
mirror of https://github.com/balena-os/balena-supervisor.git synced 2025-02-20 17:52:51 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add intro align with current resin.io docs

Browse Source 
Resin.io docs are pulling this file when ever they are updated to keep official docs site in sync. So need to add intro paragraph to give context.
This commit is contained in:
Craig Mulligan 2016-03-31 13:50:19 +01:00
parent 1b76b8ae45
commit bbcca77812
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/API.md
View File

@ -1,3 +1,11 @@
# Interacting with the Resin Supervisor
The Resin Supervisor is resin.io's agent that runs on devices. Its main role is to ensure your app is running, and keep communications with the Resin API server.
The Supervisor itself has its own API, with means for user applications to communicate and execute some special actions that affect the host OS or the application itself. There are two main ways for the application to interact with the Supervisor: the update lockfile and the HTTP API.
Only Supervisors after version 1.1.0 have all of this functionality. This corresponds to OS images downloaded after October 14th 2015.
## HTTP API reference
The supervisor exposes an HTTP API on port 48484 (`RESIN_SUPERVISOR_PORT`).