diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..69abf2d --- /dev/null +++ b/LICENSE @@ -0,0 +1,19 @@ +Copyright (c) 2013 Zaid Abdulla + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/README.md b/README.md index e7656f6..3302bde 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,14 @@ -# genied +# genie -Auto-Configuration Server (ACS) built with node.js and MongoDB +A blazing fast TR-069 auto configuration server (ACS) built with node.js and MongoDB. + +## Features + +* *Massively concurrent*: Can handle handreds of thousands of connected devices on a single server even with low inform interval. +* *Preset-based configurations*: Predefine sets of configurations that devices will pick up and apply based on given preconditions. +* *Tagging*: Use tags to group devices for more managable presets. +* *Searching*: Query for devices on any parameter (supports all common operators including regular expressions). +* *Parameter aliases*: Define aliases to unify paramter paths from different types of devices. Aliases behave like normal parameters (i.e. can query on it or set it's value). ## Requirements @@ -13,5 +21,5 @@ Auto-Configuration Server (ACS) built with node.js and MongoDB ## Installation notes * Make sure you enable sockets for memcached and mongodb -* genied keeps all running tasks in memcached. Increase memcached cache size depending on the number of available devices. +* Genie keeps all running tasks in memcached. Increase memcached cache size depending on the number of available devices. diff --git a/package.json b/package.json new file mode 100644 index 0000000..2e66a1e --- /dev/null +++ b/package.json @@ -0,0 +1,33 @@ +{ + "name": "genie", + "version": "0.9.0", + "description": "A blazing fast TR-069 auto configuration server (ACS) built with node.js and MongoDB", + "directories": { + "test": "test" + }, + "dependencies": { + "libxmljs": "~0.7.1", + "memcached": "~0.2.2", + "mongodb": "~1.2.14" + }, + "devDependencies": { + "coffee-script": "~1.6.2" + }, + "scripts": { + "prepublish": "coffee -c *.coffee", + "test": "node test" + }, + "repository": { + "type": "git", + "url": "https://github.com/zaidka/genie.git" + }, + "keywords": [ + "TR-069", + "CWMP", + "ACS" + ], + "author": "Zaid Abdulla", + "license": "MIT", + "readmeFilename": "README.md", + "gitHead": "af9ca0c2aede261efe09305e67ad2442940e1436" +}