Skip to content

Commit 0aa8c10

Browse files
committed
Added check instructions
1 parent 5140d1f commit 0aa8c10

File tree

1 file changed

+28
-2
lines changed

1 file changed

+28
-2
lines changed

README.md

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ docker pull ankane/blazer
1313
Create database tables
1414

1515
```sh
16-
docker run -ti -e DATABASE_URL=postgres://user:password@hostname:5432/dbname ankane/blazer bin/rails db:migrate
16+
docker run -ti -e DATABASE_URL=postgres://user:password@hostname:5432/dbname ankane/blazer rails db:migrate
1717
```
1818

1919
Run the web server
@@ -30,10 +30,36 @@ And visit [http://localhost:8080](http://localhost:8080)
3030

3131
For basic authentication, use:
3232

33-
```txt
33+
```sh
3434
-e BLAZER_USERNAME=admin -e BLAZER_PASSWORD=secret
3535
```
3636

37+
## Checks
38+
39+
TODO: SMTP instructions
40+
41+
Schedule checks to run (with cron, [Heroku Scheduler](https://elements.heroku.com/addons/scheduler), etc). The default options are every 5 minutes, 1 hour, or 1 day, which you can customize. For each of these options, set up a task to run.
42+
43+
```sh
44+
docker run ... rake blazer:run_checks SCHEDULE="5 minutes"
45+
docker run ... rake blazer:run_checks SCHEDULE="1 hour"
46+
docker run ... rake blazer:run_checks SCHEDULE="1 day"
47+
```
48+
49+
You can also set up failing checks to be sent once a day (or whatever you prefer).
50+
51+
```sh
52+
docker run ... rake blazer:send_failing_checks
53+
```
54+
55+
For Slack notifications, create an [incoming webhook](https://slack.com/apps/A0F7XDUAZ-incoming-webhooks) and set:
56+
57+
```sh
58+
-e BLAZER_SLACK_WEBHOOK_URL=https://hooks.slack.com/...
59+
```
60+
61+
Name the webhook “Blazer” and add a cool icon.
62+
3763
## Customization
3864

3965
Create a `blazer.yml` file with:

0 commit comments

Comments
 (0)