This add-on is operated by CloudBoost

One complete backend-as-a-service to build your app in half less time.

Last updated 09 October 2019

CloudBoost is an add-on providing backend and MongoDB database as a service. CloudBoost is a complete backend as a service which does data-storage, search, real-time, push notifications, offline sync, and a whole lot more, saving you as much as half of the time when you’re building your app.

CloudBoost has client libraries for Node.js and JavaScript applications.

Installing the add-on

CloudBoost can be attached to a Heroku application via the CLI:

$ heroku addons:create cloudboost
-----> Adding cloudboost to sharp-mountain-4005... done, v18 (free)

Once CloudBoost has been added a CLOUDBOOST_APP_ID,CLOUDBOOST_MASTER_KEY, CLOUDBOOST_CLIENT_KEY setting will be available in the app configuration and will contain the credentials used to access the newly provisioned CloudBoost service instance. This can be confirmed using the heroku config:get command.

$ heroku config:get CLOUDBOOST_APP_ID

After installing CloudBoost, you can then use the client libraries to implement the service in your application.

CloudBoost Dashboard

CloudBoost provides helpful web tools that allow to you query and interact with the data stored in your CloudBoost database. To access your database using our web tools, we nave provided integration with your Heroku log in, allowing you to access our app using your Heroku credentials. To do this, you will need to:

• Log into your Heroku account.
• Once logged in, click on the appropriate app.
• Click on the dropdown labeled “Add-Ons” in the top-right of the screen.
• Select CloudBoost.

Using with JavaScript / Node.js

CloudBoost SDK gives you access to all of the CloudBoost Backend as a Service features like data-storage, search, real-time, push notifications, offline sync, and a whole lot more. JavaScript applications including Node, AngularJS, ReactJS, Ionic, Phonegap can use CloudBoost JavaScript SDK to implement the service in their apps. To install the SDK you need to :

<script src="https://cloudboost.io/js-sdk/cloudboost.js"></script>

/*
   *Init your Application.
   *We recommend using Client Key if you're using the SDK for the Client side app.
   *You can find your App ID and Keys in the
   *Heroku App Environment Variables or on CloudBoost Dashboard
   *IMPORTANT : Never use Master Key on your client side app.
*/
CB.CloudApp.init('YOUR APP ID', 'YOUR CLIENT KEY');

in the main HTML file of your app.

or if you’re using NodeJS or Browserify, you can…

$ npm install cloudboost --save

var CB = require('cloudboost');

//Init your Application. We recommend using Master Key on your NodeJS Server.
CB.CloudApp.init(process.env.CLOUDBOOST_APP_ID, process.env.CLOUDBOOST_MASTER_KEY);

Before you start using CloudBoost, you need to find your App ID and Client Key / Master Key from your Heroku Config.

If you’re using the SDK on the client - we recommend that you use the Client Key

$ heroku config:get CLOUDBOOST_CLIENT_KEY

If you’re using the SDK on the server - we recommend that you use the Master Key

$ heroku config:get CLOUDBOOST_MASTER_KEY

//Data Storage : Create a CloudObject of type 'Custom' (Note: You need to create a table 'Custom' on CloudBoost Dashboard)

var obj = new CB.CloudObject('Custom');

//Set the property 'name' (Note: Create a column 'name' of type text on CloudBoost Dashboard)
obj.set('name','CloudBoost');

//Save the object
obj.save({
    success:function(res){
        console.log("object saved successfully");
    },
    error:function(err){
        console.log("error while saving object");
    }
});

Backups

We take (and maintain) daily snapshots of all databases hosted on the CloudBoost platform.

What if I have an issue?

If there is ever a serious issue or error and you need assistance, please contact CloudBoost Support at: support@cloudboost.io. It is most helpful if you include the CLOUDBOOST_APP_ID in your Heroku configs when you send us a note. That will ensure that we can act swiftly to restore data.

Help!

Common Issues

All the sudden, I can’t connect to my CloudBoost app? Wat!

If your app can no longer connect to your CloudBoost app, it may mean that CloudBoost or Heroku services are temporarily down. For status monitoring, please check Heroku Status at: http://status.heroku.com or CloudBoost Status at http://status.cloudboost.io/. If you still cannot connect to your app, we recommend going to the CloudBoost Admin Dashboard and changing your App Keys.

If the problem persists, talk to us at support@cloudboost.io

Support

At CloudBoost, we have a talented and friendly team and are always happy to support you as you develop with Heroku and our API. Feel free to reach out to us at: support@cloudboost.io. Make sure to include your App ID which can be found using.

$ heroku config:get CLOUDBOOST_APP_ID

All service instances on Heroku are supported by 24/7 support.

Status monitoring

For support requests, please contact Heroku Support. For status monitoring, please check Heroku Status or CloudBoost Status.

Additional documentation

Additional documentation, covering other topics about CloudBoost can be located at https://tutorials.cloudboost.io.

A CloudBoost quickstart is available in our documentation.