Skip to content

Commit

Permalink
Merge pull request #47 from sergiitk/doc/readme
Browse files Browse the repository at this point in the history
[DOC readme] Add dockerhub link, update roadmap
  • Loading branch information
sergiitk authored Dec 19, 2018
2 parents bfba05d + 2f237ee commit d29e398
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Add concise PagerDuty on-calls widget to your wallboard

## Running
### Using Docker
Docker repo: [`sergiitk/pagerbeauty`](https://hub.docker.com/r/sergiitk/pagerbeauty)

```sh
docker run --rm -p 8080:8080 --env-file=.env -it sergiitk/pagerbeauty:latest
Expand All @@ -28,6 +29,7 @@ PAGERBEAUTY_PD_SCHEDULES=SCHEDL1,SCHEDL2
PAGERBEAUTY_REFRESH_RATE_MINUTES=10

# Optional: Enable basic http authentication
# Note: embedding iframes with basic HTTP auth is not supported by all browsers.
PAGERBEAUTY_HTTP_USER=basic_username
PAGERBEAUTY_HTTP_PASSWORD=basic_password
```
Expand All @@ -36,7 +38,7 @@ PAGERBEAUTY_HTTP_PASSWORD=basic_password

![Add PagerDuty to DataDog wallboard](https://user-images.githubusercontent.com/672669/46853316-ad0a7900-cdcb-11e8-80b3-ddedb7c8f2eb.gif)

1. Open the schedules list `/v1/schedules.html`
1. Open the schedules list in deployed app. Make sure the app is running behind HTTPS
2. Find the schedule you want to embed
3. Open your DataDog dashboard, click "Edit Board".
4. Drag "IFrame" widget to the board
Expand All @@ -56,9 +58,10 @@ This project is under active development.
- [x] Configurable refresh period
- [x] HTTP Basic Authentication
- [x] On-call TimeZone is loaded from the PagerDuty schedule settings
- [ ] Full README.md and examples
- [ ] Unit testing
- [ ] Load all API pages
- [ ] HTTP authentication bypass support for embeds
- [ ] Full README.md and examples
- [ ] Ajax refresh
- [ ] Change color to red when an incident is triggered
- [ ] Functional testing
Expand Down

0 comments on commit d29e398

Please sign in to comment.