From cfa989d346402fcc49f0aee9f0160d474132cc9f Mon Sep 17 00:00:00 2001 From: Zaid Abdulla Date: Tue, 1 Sep 2020 06:55:17 -0700 Subject: [PATCH] Update README.md --- README.md | 49 ++++++++++++++++++++----------------------------- package.json | 2 +- 2 files changed, 21 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index c7287d9..1541acb 100644 --- a/README.md +++ b/README.md @@ -8,36 +8,31 @@ millions of concurrent devices. ## Quick Start -*Important: This is a pre-release branch. Use -[v1.1](https://github.com/genieacs/genieacs/tree/v1.1) for production -deployments.* - Install [Node.js](http://nodejs.org/) and [MongoDB](http://www.mongodb.org/). Refer to their corresponding documentation for installation instructions. The supported versions are: -- Node.js: 10.x through 12.x -- MongoDB: 2.6 through 4.1 +- Node.js: 12.3+ +- MongoDB: 3.6+ -Clone this repo or download the source archive then *cd* into the source -directory and install the required dependencies: +Install GenieACS from NPM: + + sudo npm install -g --unsafe-perm genieacs + +To build from source instead, clone this repo or download the source archive +then *cd* into the source directory then run: npm install - -Now build: - npm run build -Finally, run the following services from the build that's generated under -'dist' directory: +Finally, run the following services (found under `./dist/bin/` if building from +source): ### genieacs-cwmp This is the service that the CPEs will communicate with. It listens on port 7547 by default. Configure the ACS URL in your devices accordingly. - ./dist/bin/genieacs-cwmp - You may optionally use [genieacs-sim](https://github.com/genieacs/genieacs-sim) as a dummy TR-069 simulator if you don't have a CPE at hand. @@ -47,40 +42,36 @@ This is the northbound interface module. It exposes a REST API on port 7557 by default. This one is only required if you have an external system integrating with GenieACS using this API. - ./dist/bin/genieacs-nbi - ### genieacs-fs This is the file server from which the CPEs will download firmware images and -such. - - ./dist/bin/genieacs-fs +such. It listens on port 7567 by default. ### genieacs-ui This serves the web based user interface. It listens on port 3000 by default. +You must pass *--ui-jwt-secret* argument to supply the secret key used for +signing browser cookies: - ./dist/bin/genieacs-ui --ui-jwt-secret secret - -The argument *--ui-jwt-secret* supplies the key used for signing browser -cookies. + genieacs-ui --ui-jwt-secret secret The UI has plenty of configuration options. When you open GenieACS's UI in a browser you'll be greeted with a database initialization wizard to help you populate some initial configuration. +Visit [docs.genieacs.com](https://docs.genieacs.com) for more documentation and +a complete installation guide for production deployments. + ## Support The [forum](https://forum.genieacs.com) is a good place to get guidance and -help from the community. Head on over and join the conversation! In addition, -the [wiki](https://github.com/genieacs/genieacs/wiki) provides useful -documentation and tips from GenieACS users. +help from the community. Head on over and join the conversation! -For commercial support options and professional services, please visit +For commercial support options, please visit [genieacs.com](https://genieacs.com/support/). ## License -Copyright 2013-2019 GenieACS Inc. GenieACS is released under the [AGPLv3 +Copyright 2013-2020 GenieACS Inc. GenieACS is released under the [AGPLv3 license terms](https://raw.githubusercontent.com/genieacs/genieacs/master/LICENSE). diff --git a/package.json b/package.json index f2638a2..d170e91 100644 --- a/package.json +++ b/package.json @@ -74,7 +74,7 @@ "webpack": "^4.44.1" }, "engines": { - "node": ">=8.14.0" + "node": ">=12.13.0" }, "scripts": { "test": "ava --verbose --color",