Skip to content

Commit b0ce97c

Browse files
committed
Document env vars exposed to deployments
1 parent 6f25034 commit b0ce97c

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

docs/Advanced.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,22 @@ Current caveats:
7373
- Currently secrets only work for environment variables
7474
- Currently secrets work only for normal deployments (any template or recipe that uses `startFromParams` won't have secrets expanded)
7575

76+
## Accessing Exoframe data from within the deployed application
77+
78+
Exoframe provides a set of environment variables that are set on each deployment to allow getting project info and settings.
79+
Currently those are:
80+
81+
```bash
82+
# owner of current deployment
83+
EXOFRAME_USER=admin
84+
# project of current deployment
85+
EXOFRAME_PROJECT=projectName
86+
# full deployment ID
87+
EXOFRAME_DEPLOYMENT=exo-admin-deployName-ID
88+
# host used to expose current deployment (if any)
89+
EXOFRAME_HOST=exo-admin-deployName-ID.baseDomain
90+
```
91+
7692
## Plugins
7793

7894
Exoframe-Server supports extension of core features using plugins.

0 commit comments

Comments
 (0)