Skip to content

Commit

Permalink
Merge pull request #160 from ritishgumber/master
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
nawazdhandala authored Mar 28, 2017
2 parents 4df0858 + b14c232 commit 1dd4698
Showing 1 changed file with 23 additions and 23 deletions.
46 changes: 23 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,68 +12,68 @@ CloudBoost is the Complete NoSQL Database Service for your app. **Think of Cloud
- Queues
- More - ACL's, User Authentication, Server-less apps and more.

###Deploy CloudBoost to Heroku
### Deploy CloudBoost to Heroku

Use this button to connect your Heroku app with CloudBoost.

[![Heroku](https://www.herokucdn.com/deploy/button.svg)](https://elements.heroku.com/addons/cloudboost)

###Deploy CloudBoost with Docker Cloud
### Deploy CloudBoost with Docker Cloud

Use this button to deploy CloudBoost to any cloud with Docker Cloud.

[![Deploy to Docker Cloud](https://files.cloud.docker.com/images/deploy-to-dockercloud.svg)](https://github.com/CloudBoost/docker)

###Deploy CloudBoost to Azure
### Deploy CloudBoost to Azure

Use this button to deploy CloudBoost to Azure with Docker Cloud.

[![Deploy to Azure](http://azuredeploy.net/deploybutton.png)](https://github.com/CloudBoost/docker)

###Deploy CloudBoost to AWS
### Deploy CloudBoost to AWS

[Install CloudBoost on AWS](https://github.com/CloudBoost/docker)

###Deploy CloudBoost to DigitalOcean
### Deploy CloudBoost to DigitalOcean

Use this button to deploy CloudBoost to Digital Ocean with Docker Cloud.

[![Install on DigitalOcean](http://installer.71m.us/button.svg)](https://github.com/CloudBoost/docker)

###Deploy CloudBoost to SoftLayer
### Deploy CloudBoost to SoftLayer

[Install CloudBoost on SoftLayer](https://github.com/CloudBoost/docker)

###Deploy CloudBoost to Packet
### Deploy CloudBoost to Packet

[Install CloudBoost on Packet](https://github.com/CloudBoost/docker)


#CloudBoost Indexing Backends
# CloudBoost Indexing Backends

CloudBoost runs on MongoDB and Redis. You're responsible for managing the uptime, backups of your data in each of these databases. If you're running production apps. We recommend you to use the hosted service instead. Please check out CloudBoost.io

#Running the server with Docker (Recommended)
# Running the server with Docker (Recommended)

The easiest way to run the server is by using Docker. Check https://github.com/cloudboost/docker

#Running the server without Docker
# Running the server without Docker

###Step 1 : Git clone the project.
### Step 1 : Git clone the project.

`git clone https://github.com/CloudBoost/cloudboost.git`

###Step 2 : Change directory to CloudBoost.
### Step 2 : Change directory to CloudBoost.

`cd cloudboost`

###Step 3 : NPM Install.
### Step 3 : NPM Install.

`npm install`

Note : NPM requires NodeJS to be installed on your machine. If you don't have NodeJS, you need to install it from here : https://nodejs.org/en/download/

###Step 4 : Edit cloudboost.json.
### Step 4 : Edit cloudboost.json.

Create a `config` folder in project root if it does not exist. You need to create a new file `cloudboost.json` under `config` folder and save that file with MongoDB and Redis configuration. Here's a sample file :

Expand All @@ -90,7 +90,7 @@ Create a `config` folder in project root if it does not exist. You need to crea
}
```

###Step 6 : Edit smtp.json.
### Step 5 : Edit smtp.json.

In the `config` folder. Creare a new file called `smtp.json`. You need to create an account at MailGun (https://www.mailgun.com/) and get an API Key. This will help CloudBoost to send emails on your behalf. Here's a quick example :

Expand All @@ -104,11 +104,11 @@ In the `config` folder. Creare a new file called `smtp.json`. You need to create
}
```

###Step 6 : Enable HTTPS. (Optional)
### Step 6 : Enable HTTPS. (Optional)

If you want to enable HTTPS, place your certificate file `cert.crt` and key `key.key` in the config folder.

###Step 7 : Run the server.
### Step 7 : Run the server.

Make sure both Redis and MongoDB are running and then run the CloudBoost server

Expand All @@ -117,12 +117,12 @@ Make sure both Redis and MongoDB are running and then run the CloudBoost server
Once the server is running. You'll see the ClusterKey and SecureKey on the console whcih means you've successfully CloudBoost. If you don't see any of these keys, please raise a GitHub issue and let us know.


#Once the server is running, You can
# Once the server is running, You can

Once started, you'll see the CloudBoost Secure Key on the console. This is important, Please save it for future use.
Secure Key helps you create / delete apps.

###Create an app
### Create an app

To create an app, You need to :

Expand All @@ -142,7 +142,7 @@ curl -H "Content-Type: application/json" -X POST -d '{"secureKey":"xxxxxx-yyyy-x
```

###Delete an app
### Delete an app

To delete an app, You need to :

Expand All @@ -168,10 +168,10 @@ Once your app is ready, You can then get the latest SDK from https://tutorials.

You can then follow rest of the documentation from https://tutorials.cloudboost.io. You can also check out API Reference on https://docs.cloudboost.io

#App Settings
# App Settings
To read more about app settings, check [Click here](https://github.com/CloudBoost/cloudboost/tree/master/docs/app-settings)

#Contributing
# Contributing

Pull requests are very welcome!

Expand All @@ -194,7 +194,7 @@ If you're using CloudBoost Open Source and like what we've built, help us speed
<a href="https://opencollective.com/cloudboost/backer/10/website" target="_blank"><img src="https://opencollective.com/cloudboost/backer/10/avatar.svg"></a>


#LICENSE
# LICENSE

Copyright 2016 HackerBay, Inc.

Expand Down

0 comments on commit 1dd4698

Please sign in to comment.