Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ankane/blazer-docker
A Docker image for Blazer
https://github.com/ankane/blazer-docker
Last synced: 3 days ago
JSON representation
A Docker image for Blazer
- Host: GitHub
- URL: https://github.com/ankane/blazer-docker
- Owner: ankane
- License: mit
- Created: 2020-02-05T21:42:58.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-16T20:50:38.000Z (18 days ago)
- Last Synced: 2024-10-18T20:17:06.436Z (16 days ago)
- Language: Ruby
- Homepage:
- Size: 63.5 KB
- Stars: 30
- Watchers: 6
- Forks: 15
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome - ankane/blazer-docker - A Docker image for Blazer (others)
README
# Blazer Docker
A Docker image for [Blazer](https://github.com/ankane/blazer)
## Getting Started
Pull the image:
```sh
docker pull ankane/blazer
```
Create database tables:
```sh
docker run -ti -e DATABASE_URL=postgres://user:password@hostname:5432/dbname ankane/blazer rails db:migrate
```
Run the web server:
```sh
docker run -ti -e DATABASE_URL=postgres://user:password@hostname:5432/dbname -p 8080:8080 ankane/blazer
```
Use 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](http://localhost:8080).
## Authentication
Add basic authentication with:
```sh
-e BLAZER_USERNAME=admin -e BLAZER_PASSWORD=secret
```
Or use a reverse proxy like [OAuth2 Proxy](https://github.com/oauth2-proxy/oauth2-proxy).
## Checks
TODO: SMTP instructions
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.
```sh
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).
```sh
docker run ... rake blazer:send_failing_checks
```
For Slack notifications, create an [incoming webhook](https://slack.com/apps/A0F7XDUAZ-incoming-webhooks) and set:
```sh
-e BLAZER_SLACK_WEBHOOK_URL=https://hooks.slack.com/...
```
Name the webhook “Blazer” and add a cool icon.
## Customization
Create a `blazer.yml` file with:
```yml
# 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: main
```
Create a `Dockerfile` with:
```Dockerfile
FROM ankane/blazer
COPY blazer.yml /app/config/blazer.yml
```
And build your image:
```sh
docker build -t my-blazer .
```
## Deployment
### Health Checks
Use the `/health` endpoint for health checks. Status code `200` indicates healthy.
## History
View the [changelog](https://github.com/ankane/blazer-docker/blob/master/CHANGELOG.md)
## Contributing
Everyone is encouraged to help improve this project. Here are a few ways you can help:
- [Report bugs](https://github.com/ankane/blazer-docker/issues)
- Fix bugs and [submit pull requests](https://github.com/ankane/blazer-docker/pulls)
- Write, clarify, or fix documentation
- Suggest or add new features
To get started with development:
```sh
git clone https://github.com/ankane/blazer-docker.git
cd blazer-docker
docker build -t ankane/blazer:latest .
```