Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@
* [Utilize priority setting from database to visualize charts](deployment/customization/Studyview.md)
* [Integration with Other Webservices]()
* [OncoKB Data Access](deployment/integration-with-other-webservices/OncoKB-Data-Access.md)
* [UptimeRobot Integration](deployment/integration-with-other-webservices/UptimeRobot-Integration.md)
* [Data Loading Overview](Data-Loading.md)
* [Downloads](Downloads.md)
* [Using the Dataset Validator](Using-the-dataset-validator.md)
Expand Down
13 changes: 13 additions & 0 deletions docs/deployment/customization/application.properties-Reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -821,3 +821,16 @@ Custom Buttons can be defined which will conditionally appear in all group compa
```
download_custom_buttons_json=classpath:custom_buttons/download_custom_button_avm.json
```

## UptimeRobot Integration

Display automatic service status banners when incidents or maintenance are detected from UptimeRobot.

```properties
uptime_robot_status_page_url=https://status.cbioportal.org
uptime_robot_api_key=RlrzpsmAn
```

Both properties are required to enable the integration. When configured, the portal will automatically fetch and display active events as banners at the top of the page.

See [UptimeRobot Integration](../integration-with-other-webservices/UptimeRobot-Integration.md) for setup instructions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# UptimeRobot Integration

## Configuration

Both configuration properties must be set to enable the integration:

```properties
uptime_robot_status_page_url=https://status.cbioportal.org
uptime_robot_api_key=YOUR_API_KEY_HERE
```

Add these to your `application.properties` file.

### Getting Your UptimeRobot API Key

1. Log in to your [UptimeRobot account](https://uptimerobot.com/)
2. Navigate to "Status Pages"
3. Open your status page settings
4. Look for the "Event Feed" or "API" section
5. Copy the API key (e.g., `RlrzpsmAn`)
6. Note your status page URL (e.g., `https://status.cbioportal.org`)

### Testing the Configuration

You can test your API endpoint manually:

```bash
curl https://status.cbioportal.org/api/getEventFeed/YOUR_API_KEY
```

You should receive a JSON response containing event data.

## Disabling the Integration

To disable the integration, simply remove or comment out both configuration properties:

```properties
# uptime_robot_status_page_url=https://status.cbioportal.org
# uptime_robot_api_key=YOUR_API_KEY_HERE
```

The integration will automatically disable if either property is missing.
6 changes: 6 additions & 0 deletions src/main/resources/application.properties.EXAMPLE
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,12 @@ skin.study_view.link_text=To build your own case set, try out our enhanced Study
## setting controlling whether Download tabs and download/copy-to-clipboard controls should be shown
# skin.hide_download_controls=false

## UptimeRobot Status Page Integration
## Automatically displays service status banners for ongoing events from UptimeRobot
## Both properties are required to enable the integration
# uptime_robot_status_page_url=https://status.cbioportal.org
# uptime_robot_api_key=YOUR_API_KEY_HERE

## enable and set this property to specify a study group to be used to identify public studies for which no specific authorization entries are needed in the `authorities` table
# always_show_study_group=

Expand Down
Loading