OpenPaaS is a collaboration platform for enterprises & organizations.
1.clone the repository
git clone https://ci.open-paas.org/stash/scm/or/rse.git
# or
git clone https://github.com/linagora/openpaas-esn.git
2.Install dependencies
You can install dependencies yourself, or use the Docker environment as described in ./docker/doc/README.md.
- ElasticSearch v2.2.1
- MongoDB v2.6.5
- Redis 3.x
3.Install node.js
Please note that your version of node.js must be greater than version 0.10.28 but less than or equal to 0.10.36. We highly recommend that you use nvm to install a specific version of node.
4.You may need some additional packages. For example with a Debian installation, as an administrator you should use the following command:
apt-get install build-essential redis-server npm python-setuptools graphicsmagick graphicsmagick-imagemagick-compat
5.Install Sabre/dav
Follow sabre installation instructions.
6.Install the npm dependencies (as an administrator)
npm install -g bower
7.Go into the project directory and install project dependencies (not as an administrator)
npm install
If you have any problem relating to node-canvas during the dependencies installation,
make sure your system has installed Cairo. Documentation can be found here.
Note: You can also check Ubuntu-specific installation instructions.
First you must install some npm dependencies (as an administrator)
npm install -g mocha grunt-cli karma-cli
Then install the gjslint dependency (as an administrator)
easy_install http://closure-linter.googlecode.com/files/closure_linter-latest.tar.gz
More informations can be found here.
Finally, you can check that everything works by launching the test suite (this may be long):
grunt --chunk 1
Note that, due to the large amount of tests, you eventually need the --chunk 1 option. It will create one new nodejs process per js test file. It prevents the memory to be overused by mocha, which would lead to tests failures.
If you want to launch tests from a single test, you can specify the file as command line argument.
For example, you can launch the backend tests on the test/unit-backend/webserver/index.js file like this:
grunt test-unit-backend --test=test/unit-backend/webserver/index.js
Note: This works for backend and midway tests.
Some specialized Grunt tasks are available, check the Gruntfile.js for more:
grunt linters # launch hinter and linter against the codebase
grunt test-frontend # only run the fontend unit tests
grunt test-unit-backend # only run the unit backend tests
grunt test-midway-bakend # only run the midway backend tests
grunt test # launch all the testsuite
Fixtures can be configured in the fixtures folder and injected in the system using grunt:
grunt fixtures
Note that you must configure contents of files inside fixtures/config/data and fixtures/esn-config/data/ to match your environment, particularly fixtures/config/data/db.js in which the host of the mongodb database is defined. Also note that this will override all the current configuration resources with the fixtures ones.
You should first start mongodb, redis and elasticsearch and configure OpenPaaS.
Then 'npm start' to start the OpenPaaS web application:
npm start
Your ESN can be reached at the following address: http://localhost:8080. Now simply follow the setup wizard.
Running grunt dev will start the server in development mode. Whenever you
make changes to server files, the server will be restarted. Make sure you have
started the mongo, redis and elasticsearch servers beforehand.
In addition, you can run grunt debug to start the node-inspector debugger
server. Visit the displayed URL in Chrome or Opera to start the graphical
debugging session. Note that startup takes a while, you must wait until the ESN
webserver starts to do anything meaningful.
A Docker environment is provided to ease all the setup for various environments (development, demonstration, ...). It allows to start Docker containers for all the dependencies without having to install anything else than Docker and without having to configure all by hand.
For more details, check the documentation on ./docker/doc/README.md