A Docker image for Blazer
Pull the image:
docker pull ankane/blazerCreate database tables:
docker run -ti -e DATABASE_URL=postgres://user:password@hostname:5432/dbname ankane/blazer rails db:migrateRun the web server:
docker run -ti -e DATABASE_URL=postgres://user:password@hostname:5432/dbname -p 8080:8080 ankane/blazerUse URL-encoding for any special characters in the username or password. For databases on the host machine, use host.docker.internal as the hostname (on Linux, this requires Docker 20.04+ and --add-host=host.docker.internal:host-gateway).
Then visit http://localhost:8080.
Add basic authentication with:
-e BLAZER_USERNAME=admin -e BLAZER_PASSWORD=secretOr use a reverse proxy like OAuth2 Proxy.
TODO: SMTP instructions
Schedule checks to run (with cron, Heroku 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.
docker run ... rake blazer:run_checks SCHEDULE="5 minutes"
docker run ... rake blazer:run_checks SCHEDULE="1 hour"
docker run ... rake blazer:run_checks SCHEDULE="1 day"You can also set up failing checks to be sent once a day (or whatever you prefer).
docker run ... rake blazer:send_failing_checksFor Slack notifications, create an incoming webhook and set:
-e BLAZER_SLACK_WEBHOOK_URL=https://hooks.slack.com/...Name the webhook “Blazer” and add a cool icon.
Create a blazer.yml file with:
# see https://github.com/ankane/blazer for more info
data_sources:
main:
url: <%= ENV["DATABASE_URL"] %>
# statement timeout, in seconds
# none by default
# timeout: 15
# caching settings
# can greatly improve speed
# off by default
# cache:
# mode: slow # or all
# expires_in: 60 # min
# slow_threshold: 15 # sec, only used in slow mode
# wrap queries in a transaction for safety
# not necessary if you use a read-only user
# true by default
# use_transaction: false
smart_variables:
# zone_id: "SELECT id, name FROM zones ORDER BY name ASC"
# period: ["day", "week", "month"]
# status: {0: "Active", 1: "Archived"}
linked_columns:
# user_id: "/admin/users/{value}"
smart_columns:
# user_id: "SELECT id, name FROM users WHERE id IN {value}"
# create audits
audit: true
# change the time zone
# time_zone: "Pacific Time (US & Canada)"
# email to send checks from
# from_email: [email protected]
# webhook for Slack
# slack_webhook_url: <%= ENV["BLAZER_SLACK_WEBHOOK_URL"] %>
check_schedules:
- "1 day"
- "1 hour"
- "5 minutes"
# enable anomaly detection
# note: with trend, time series are sent to https://trendapi.org
# anomaly_checks: prophet / trend / anomaly_detection
# enable forecasting
# note: with trend, time series are sent to https://trendapi.org
# forecasting: prophet / trend
# enable map
# mapbox_access_token: <%= ENV["MAPBOX_ACCESS_TOKEN"] %>
# enable uploads
# uploads:
# url: <%= ENV["BLAZER_UPLOADS_URL"] %>
# schema: uploads
# data_source: mainCreate a Dockerfile with:
FROM ankane/blazer
COPY blazer.yml /app/config/blazer.ymlAnd build your image:
docker build -t my-blazer .Use the /health endpoint for health checks. Status code 200 indicates healthy.
View the changelog
Everyone is encouraged to help improve this project. Here are a few ways you can help:
- Report bugs
- Fix bugs and submit pull requests
- Write, clarify, or fix documentation
- Suggest or add new features
To get started with development:
git clone https://github.com/ankane/blazer-docker.git
cd blazer-docker
docker build -t ankane/blazer:latest .
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent