Conflux Toolbelt
Get up and running with Conflux by downloading the developer toolbelt. Connect to your services, add new team members, and much more, straight from the command line. Follow the guide below to get started, or view the source code on Github.
Before getting started, make sure you have a Conflux account. If you haven't signed up yet, create an account. Also check to make sure your operating system and app's language are supported.
1. Install the Toolbelt
Conflux Toolbelt for Mac OS X
For Linux, install the toolbelt by running the following in your command shell:
$ wget -O- https://goconflux.com/install.sh | sh
2. Log in
Once installed, you'll have access to the conflux command from your command shell (Note: type conflux help at any time to see a list of available commands).
Log in using the email address and password you used when creating your Conflux account:
$ conflux login
Enter your Conflux credentials.
Email: ben@example.com
Password (typing will be hidden):
Successfully logged in as ben@example.com
3. Connect your app to a Conflux bundle
If you haven't created a Conflux team yet, go ahead and create a new team. Your team should already come pre-configured with an empty Conflux bundle (i.e. a bundle of services).
Local Directory
To establish which Conflux bundle to use with your project's local environment, run conflux init from inside that project's root directory and choose the bundle you wish to use:
my-app $ conflux init

Which Conflux bundle do you wish to use for this project?

MyTeam:

(1) myteam-local
(2) myteam-dev-1
(3) myteam-prod

1
Configuring manifest.json...
Installing conflux ruby gem...
Adding conflux to Gemfile...
Successfully connected project to conflux bundle: myteam-local
Once this connection is established, you can go ahead and start provisioning some services for your bundle. For example, the following is all it takes to spin up a new Redis To Go instance for your app:
my-app $ conflux services:add redistogo
Successfully added redistogo to myteam-local.
Writing configs to conflux.yml...
Found 3 new jobs for redistogo...
Installing redis ruby gem...
Adding redis to Gemfile...
Creating file: config/initializers/redistogo.rb
Creating file: .conflux/redistogo/getting_started.rb
Done.
Now that Redis To Go has been provisioned, if you run conflux configs, you should see that REDISTOGO_URL has been added to the list of configs that are automatically made available when you boot your server.
my-app $ conflux configs
REDISTOGO_URL
...
Since Conflux ran a job to create a redistogo.rb initializer file, you should already have a $redis global variable pointing to your new redis instance:
my-app $ rails console
Loading development environment (Rails 4.x.x)
2.x.x :001 > $redis
=> #<Redis client v3.3.0 for redis://catfish.redistogo.com:10837/0>
That's it! One command is all it takes to get up and running with almost any Conflux service. Each service also comes with a getting_started file showing example code and other helpful tips. You can find these files inside of your .conflux/ directory.
Remote Directory
Instead of relying on the toolbelt to establish a Conflux connection on a remote server, you can utilize a rake task built into the Conflux ruby gem to do just that:
my-remote-app $ bundle exec rake conflux:use_bundle
Email: ben@example.com
Password (typing will be hidden):

Which Conflux bundle does this project belong to?

MyTeam:

(1) myteam-local
(2) myteam-dev-1
(3) myteam-prod

1
Configuring manifest.json...
Successfully connected project to conflux bundle: myteam-local
Heroku App
Connecting a Heroku app to a Conflux bundle can be done in just one command:
$ conflux apps:heroku_use my-conflux-bundle -a my-heroku-app
Setting CONFLUX_USER, CONFLUX_APP and restarting ⬢ my-heroku-app... done, v133
CONFLUX_APP: XXXXXXXX-XXXX-XXXX-XXXXX-XXXXXXXXXXXX
CONFLUX_USER: XXXXXXXX-XXXX-XXXX-XXXXX-XXXXXXXXXXXX
Successfully connected Heroku app 'my-heroku-app' to conflux bundle 'my-conflux-bundle'.
4. Start using your services
Once your project is connected to the Conflux bundle of your choice, your services will automatically be made available any time you start up your server. This way, you can stop worrying about setup and get back to building out your app. Enjoy your services!
Toolbelt Support
Operating systems:  Mac OS X, Windows, Linux
Languages:  Ruby (Rails), (Node and Python coming soon)
Dependencies:  ruby >= 2.0.0, wget/curl