Ruby gem to interact with CloudFlare API v4
Add this line to your application's Gemfile:
gem 'glare'
And then execute:
$ bundle
Or install it yourself as:
$ gem install glare
In order to configure credentials used to interact with Cloudflare API you will need to setup the following environment variable:
CF_API_TOKEN
: Scoped API token defined in a Cloudflare account
or both of the following variables:
CF_EMAIL
: Email used to create a Cloudflare accountCF_AUTH_KEY
: Auth key of the given user
Additionally, you can set other environment variables:
CF_DEBUG
: Set to1
to enable HTTP requests' debug
require 'glare'
Glare.register('example.domain.com', 'destination.com' ,'CNAME')
Glare.register('example.domain.com', 'destination.com' ,'CNAME', proxied: true)
Glare.register('example.domain.com', 'destination.com' ,'CNAME', ttl: 300)
Where:
example.domain.com
: Name of the record to createdestination.com
: Name(s) of the values of the recordCNAME
: Type of the DNS record
require 'glare'
Glare.deregister('example.domain.com', 'CNAME')
Where:
example.domain.com
: Name of the record to destroyCNAME
: Type of the DNS record
require 'glare'
Glare.resolve('example.domain.com', 'CNAME')
Where:
example.domain.com
: Name of the record to resolveCNAME
: Type of the DNS record
After checking out the repo, run bin/setup
to install dependencies. Then, run bin/console
for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install
. To release a new version, update the version number in version.rb
, and then run bundle exec rake release
to create a git tag for the version, push git commits and tags, and push the .gem
file to rubygems.org.
- Fork it ( https://github.com/peertransfer/glare/fork )
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request