Skip to content

Commit 1cf7de9

Browse files
author
Jon
committed
Added new env variables to readme
1 parent 81ec6a1 commit 1cf7de9

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,11 @@ This project is configured using environment variables.
3333
| `OAUTH_TOKEN_URL` | OAuth2 token URL, set this to use OAuth2 authentication | `""` |
3434
| `OAUTH_PROFILE_URL` | Observation portal profile endpoint, used to retrieve details on user accounts | `""` |
3535
| `OAUTH_SERVER_KEY` | Observation portal server secret key to authenticate calls from the server | `""` |
36+
| `HEROIC_API_URL` | HEROIC server api url, required for submitting your observatory updates to the HEROIC service | `""` |
37+
| `HEROIC_API_TOKEN` | HEROIC server api token, required for submitting your observatory updates to the HEROIC service | `""` |
38+
| `HEROIC_OBSERVATORY` | HEROIC server observatory code, required for submitting your observatory updates to the HEROIC service | `""` |
39+
| `HEROIC_EXCLUDE_SITES` | Comma delimited list of site codes to ignore when sending updates to HEROIC | `""` |
40+
| `HEROIC_EXCLUDE_TELESCOPES` | Comma delimited list of site.enclosure.telescope codes to ignore when sending updates to HEROIC | `""` |
3641

3742
## Local Development
3843

@@ -145,3 +150,7 @@ Return a specific camera's configuration
145150
Return all instruments that are in the SCHEDULABLE state
146151

147152
GET /instruments/?state=SCHEDULABLE
153+
154+
## Sending data to HEROIC
155+
156+
HEROIC is a service provided by Scimma through the NSF that accepts and stores observatory information, including instrument configuration and telescope status. By default, no data will be sent to the HEROIC service. If you want to send your observatory updates to HEROIC, you must set all the `HEROIC_*` environment variables. You must login to the HEROIC server, retrieve your API token, and request that an Observatory is created for you with your account as the admin for that observatory. Afterwards, by setting the appropriate environment variables your configuration database should automatically send updates to HEROIC when updates are made through the API or admin interface.

0 commit comments

Comments
 (0)