Update README.md
This commit is contained in:
1 parent
b02c1df3b2
commit
cfa989d346
2 files changed
+21
-30
No files matched your search
@@ -8,36 +8,31 @@ millions of concurrent devices.
|
|||||||
|
|
||||||
## Quick Start
|
## 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/).
|
Install [Node.js](http://nodejs.org/) and [MongoDB](http://www.mongodb.org/).
|
||||||
Refer to their corresponding documentation for installation instructions. The
|
Refer to their corresponding documentation for installation instructions. The
|
||||||
supported versions are:
|
supported versions are:
|
||||||
|
|
||||||
- Node.js: 10.x through 12.x
|
- Node.js: 12.3+
|
||||||
- MongoDB: 2.6 through 4.1
|
- MongoDB: 3.6+
|
||||||
|
|
||||||
Clone this repo or download the source archive then *cd* into the source
|
Install GenieACS from NPM:
|
||||||
directory and install the required dependencies:
|
|
||||||
|
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
|
npm install
|
||||||
|
|
||||||
Now build:
|
|
||||||
|
|
||||||
npm run build
|
npm run build
|
||||||
|
|
||||||
Finally, run the following services from the build that's generated under
|
Finally, run the following services (found under `./dist/bin/` if building from
|
||||||
'dist' directory:
|
source):
|
||||||
|
|
||||||
### genieacs-cwmp
|
### genieacs-cwmp
|
||||||
|
|
||||||
This is the service that the CPEs will communicate with. It listens on port
|
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.
|
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)
|
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.
|
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
|
default. This one is only required if you have an external system integrating
|
||||||
with GenieACS using this API.
|
with GenieACS using this API.
|
||||||
|
|
||||||
./dist/bin/genieacs-nbi
|
|
||||||
|
|
||||||
### genieacs-fs
|
### genieacs-fs
|
||||||
|
|
||||||
This is the file server from which the CPEs will download firmware images and
|
This is the file server from which the CPEs will download firmware images and
|
||||||
such.
|
such. It listens on port 7567 by default.
|
||||||
|
|
||||||
./dist/bin/genieacs-fs
|
|
||||||
|
|
||||||
### genieacs-ui
|
### genieacs-ui
|
||||||
|
|
||||||
This serves the web based user interface. It listens on port 3000 by default.
|
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
|
genieacs-ui --ui-jwt-secret secret
|
||||||
|
|
||||||
The argument *--ui-jwt-secret* supplies the key used for signing browser
|
|
||||||
cookies.
|
|
||||||
|
|
||||||
The UI has plenty of configuration options. When you open GenieACS's UI in a
|
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
|
browser you'll be greeted with a database initialization wizard to help you
|
||||||
populate some initial configuration.
|
populate some initial configuration.
|
||||||
|
|
||||||
|
Visit [docs.genieacs.com](https://docs.genieacs.com) for more documentation and
|
||||||
|
a complete installation guide for production deployments.
|
||||||
|
|
||||||
## Support
|
## Support
|
||||||
|
|
||||||
The [forum](https://forum.genieacs.com) is a good place to get guidance and
|
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,
|
help from the community. Head on over and join the conversation!
|
||||||
the [wiki](https://github.com/genieacs/genieacs/wiki) provides useful
|
|
||||||
documentation and tips from GenieACS users.
|
|
||||||
|
|
||||||
For commercial support options and professional services, please visit
|
For commercial support options, please visit
|
||||||
[genieacs.com](https://genieacs.com/support/).
|
[genieacs.com](https://genieacs.com/support/).
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
Copyright 2013-2019 GenieACS Inc. GenieACS is released under the [AGPLv3
|
Copyright 2013-2020 GenieACS Inc. GenieACS is released under the [AGPLv3
|
||||||
license
|
license
|
||||||
terms](https://raw.githubusercontent.com/genieacs/genieacs/master/LICENSE).
|
terms](https://raw.githubusercontent.com/genieacs/genieacs/master/LICENSE).
|
||||||
+1
-1
@@ -74,7 +74,7 @@
|
|||||||
"webpack": "^4.44.1"
|
"webpack": "^4.44.1"
|
||||||
},
|
},
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">=8.14.0"
|
"node": ">=12.13.0"
|
||||||
},
|
},
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"test": "ava --verbose --color",
|
"test": "ava --verbose --color",
|
||||||
|
|||||||
Reference in new issue
Block a user