kuzzle

Why Kuzzle ?

Kuzzle is a ready-to-use, on-premises backend that enables you to manage your persistent data and be notified in real-time on whatever happens to it. It also provides you with a flexible and powerful user-management system.

Kuzzle enables you to build modern web applications and complex IoT networks in no time.

• Persisted data: store your data and perform advanced searches on it.
• Real-time notifications: subscribe to fine-grained subsets of data.
• User Management: login, logout and security rules are no more a burden.
• Extensible: fit Kuzzle to your needs by leveraging the plugin system.

Installation

Docker install

If you are running Docker and just want to get your own Kuzzle running, you can use the provided docker-compose file.

Prerequisites:

• Docker (version >1.10.0)
• Docker Compose (version >1.7)

From Kuzzle's build repo:

$ sudo sysctl -w vm.max_map_count=262144
$ wget http://kuzzle.io/docker-compose.yml
$ docker-compose up

You can get detailed information about how to start kuzzle with docker on docs.kuzzle.io

Manual install

Check our complete installation guide on docs.kuzzle.io

Quick start with Kuzzle

• Install and start Kuzzle server
• Choose a SDK
• Build your application without caring about your backend !

Check the Getting started page on docs.kuzzle.io

NodeJS Sample

npm install kuzzle-sdk

const 
    Kuzzle = require('kuzzle-sdk'),
    kuzzle = new Kuzzle('http://localhost:7512')

const filter = {
    exists: {
        field: 'message'
    }
}

// Subscribe to data changes in an app
kuzzle
    .collection('mycollection', 'myindex')
    .subscribe(filter, function(error, result) {
        // triggered each time a document is updated !
        console.log('message received from kuzzle:', result)
    })
    
// Creating a document from an other app will notify all subscribers
kuzzle
    .collection('mycollection', 'myindex')
    .createDocument(document)

Usefull links

• Full documentation
• SDK Reference
• API Documentation
• Data Validation Documentation
• View release notes

Contributing to Kuzzle

You're welcome to contribute to Kuzzle! Feel free to report issues, ask for features or even make pull requests !

Check our contributing documentation to know about our coding and pull requests rules

Join our community

• Follow us on twitter to get latest news
• Register to our monthly newsletter to get highlighed news
• Visit our blog to be informed about what we are doing
• Come chat with us on gitter
• Ask technical questions on stack overflow

Kuzzle Enterprise

Kuzzle Enterprise is production-proof, and provides all the business-critical features your need for your business, as the scalability, the high-availability (multi-nodes), probes for BI, diagnostic tools & professional services,

Compare editions to learn more

License

Kuzzle is published under Apache 2 License.