MonarcAppBO/README.md

236 lines
6.3 KiB
Markdown
Raw Normal View History

2018-07-08 01:30:44 +02:00
MONARC - Back Office
====================
2016-04-12 14:39:18 +02:00
2018-07-08 01:30:44 +02:00
The back office is especially needed if you want to manage several clients.
For more information you can have a look at
[the differences](https://www.monarc.lu/product/#features-summary) with MONARC
itself or you can check the
[MONARC architecture](https://www.monarc.lu/technical-guide/#monarc-and-the-back-office).
2016-04-12 14:39:18 +02:00
2016-04-12 14:39:18 +02:00
Installation
------------
2017-02-01 11:14:15 +01:00
PHP & MySQL
-----------
2018-07-08 01:30:44 +02:00
Install PHP (version 7.0 recommended) with Apache with extensions:
xml, mbstring, mysql, zip, unzip, mcrypt, intl, imagick (extension php)
2017-02-01 11:14:15 +01:00
For Apache add mods : rewrite, ssl (a2enmod)
2018-07-08 01:30:44 +02:00
Install MariaDb.
2016-04-12 14:39:18 +02:00
Using Composer (recommended)
----------------------------
2018-07-08 01:30:44 +02:00
If not already done, install composer relevant to your distribution. Then,
clone the repository and manually invoke `composer`:
2016-04-12 14:39:18 +02:00
cd my/project/dir
2018-07-08 01:30:44 +02:00
git clone https://github.com/monarc-project/MonarcAppBO.git
cd MonarcAppBO/
composer self-update
composer install -o
2016-04-12 14:39:18 +02:00
2018-07-08 01:30:44 +02:00
The `self-update` ensures you have an up-to-date `composer.phar` available.
2016-04-12 14:39:18 +02:00
2017-02-06 13:48:01 +01:00
![Arbo](public/img/arbo1.png "Arbo")
2017-02-01 11:14:15 +01:00
2018-07-08 01:30:44 +02:00
2017-02-01 11:14:15 +01:00
Databases
---------
Create 2 databases:
CREATE DATABASE monarc_master DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_general_ci;
CREATE DATABASE monarc_common DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_general_ci;
2017-02-01 11:14:15 +01:00
2017-02-01 16:41:01 +01:00
Change Sql Mode in my.cnf:
2017-02-01 11:14:15 +01:00
2017-02-01 16:41:01 +01:00
sql-mode = MYSQL40
2018-07-08 01:30:44 +02:00
* monarc_common contains models and data create by CASES.
* monarc_master contains all user and authentication information.
2017-02-06 13:54:46 +01:00
2017-06-16 09:10:26 +02:00
Once the databases are created, extract and import the extracted file to the ***monarc_common*** database:
2017-08-17 15:11:47 +02:00
2017-08-25 08:22:32 +02:00
tar -xzvf db-bootstrap/monarc-common.tar.gz -C db-bootstrap/
mysql -u sqlmonarcuser -p monarc_common < db-bootstrap/monarc-common.sql
2017-02-06 13:48:01 +01:00
2018-07-08 01:30:44 +02:00
Back-end
--------
The project is splited on 2 parts:
2017-02-06 13:48:01 +01:00
* an Api in charge of retrieve data
* an interface to display data
2018-07-08 01:30:44 +02:00
The API is not a module of the project but libraries.
You must create modules with symbolic links to the libraries:
2017-02-01 11:14:15 +01:00
mkdir module
cd module
2018-07-08 01:30:44 +02:00
ln -s ./../vendor/monarc/core MonarcCore
ln -s ./../vendor/monarc/backoffice MonarcBO
There are 2 parts:
2017-02-06 13:54:46 +01:00
* one only for front office
* one common for front office and back office (private project)
![Arbo](public/img/arbo2.png "Arbo")
2018-07-08 01:30:44 +02:00
Front-end
---------
Repositories for AngularJS:
2017-02-01 11:14:15 +01:00
mkdir node_modules
cd node_modules
git clone https://github.com/monarc-project/ng-backoffice.git ng_backoffice
git clone https://github.com/monarc-project/ng-anr.git ng_anr
2017-02-06 13:54:46 +01:00
2018-07-08 01:30:44 +02:00
There are 2 parts:
2017-02-06 13:54:46 +01:00
* one only for front office (ng_client)
* one common for front office and back office (private project) (ng_anr)
2017-02-06 13:54:46 +01:00
![Arbo](public/img/arbo3.png "Arbo")
2018-07-08 01:30:44 +02:00
2016-04-12 14:39:18 +02:00
Web Server Setup
----------------
### PHP CLI Server
The simplest way to get started if you are using PHP 5.4 or above is to start the internal PHP cli-server in the root directory:
php -S 0.0.0.0:8080 -t public/ public/index.php
This will start the cli-server on port 8080, and bind it to all network
interfaces.
2017-08-17 15:11:47 +02:00
Note: The built-in CLI server is *for development only*.
2016-04-12 14:39:18 +02:00
### Apache Setup
To setup apache, setup a virtual host to point to the public/ directory of the
project and you should be ready to go! It should look something like below:
2017-08-17 15:11:47 +02:00
<VirtualHost 0.0.0.0:80>
2016-04-12 14:39:18 +02:00
ServerName monarc.localhost
DocumentRoot /path/to/monarc/public
SetEnv APPLICATION_ENV "development"
<Directory /path/to/monarc/public>
DirectoryIndex index.php
AllowOverride All
2017-07-13 15:28:43 +02:00
Require All Granted
2016-04-12 14:39:18 +02:00
</Directory>
</VirtualHost>
2016-04-12 17:40:50 +02:00
Database connection
-------------------
2017-02-01 11:14:15 +01:00
Create file `config/autoload/local.php`:
2016-04-12 17:40:50 +02:00
return array(
'doctrine' => array(
'connection' => array(
'orm_default' => array(
'params' => array(
'host' => 'host',
'user' => 'user',
'password' => 'password',
2017-02-01 11:14:15 +01:00
'dbname' => 'monarc_common',
),
),
'orm_cli' => array(
'params' => array(
'host' => 'host',
'user' => 'user',
'password' => 'password',
'dbname' => 'monarc_master',
2016-04-12 17:40:50 +02:00
),
),
),
),
);
2018-07-08 01:30:44 +02:00
2017-02-01 11:14:15 +01:00
Configuration
-------------
Create file configuration
sudo cp /config/autoload/local.php.dist /config/autoload/local.php
Update connexion information to local.php and global.php
Configuration files are stored in cache.
2017-02-01 11:14:15 +01:00
If yours changes have not been considered, empty cache by deleting file in /data/cache
You might need to create the folders if non-existant. Also, the /data/cache folder needs to be owned by the internet user (www-data in ubuntu).
2017-02-01 11:14:15 +01:00
Install Grunt
-------------
sudo apt-get install nodejs
sudo apt-get install npm
sudo npm install -g grunt-cli
2017-02-01 11:14:15 +01:00
Only for linux system:
2017-02-01 11:14:15 +01:00
sudo ln -s /usr/bin/nodejs /usr/bin/node (seulement linux)
Update project
--------------
Play script (mandatory from the root of the project)(pull and migrations):
2017-02-01 11:14:15 +01:00
sudo /bin/bash ./scripts/update-all.sh
2017-02-01 11:14:15 +01:00
2017-02-06 13:48:01 +01:00
Create Initial User and Client
------------------------------
2017-02-01 11:14:15 +01:00
Create first user:
2017-02-06 08:21:34 +01:00
php ./vendor/robmorgan/phinx/bin/phinx seed:run -c ./module/MonarcBO/migrations/phinx.php
2017-08-17 15:11:47 +02:00
The username is *admin@admin.test* and the password is *admin*.
2017-02-06 13:48:01 +01:00
Data Model
----------
monarc_common
![monarc_common](public/img/model-common.png "monarc_common")
2017-02-06 08:21:34 +01:00
2017-02-06 08:21:34 +01:00
License
-------
This software is licensed under
[GNU Affero General Public License version 3](http://www.gnu.org/licenses/agpl-3.0.html)
- Copyright (C) 2016-2018 Jérôme Lombardi - https://github.com/jerolomb
- Copyright (C) 2016-2018 Juan Rocha - https://github.com/jfrocha
- Copyright (C) 2016-2018 SMILE gie securitymadein.lu
- Copyright (C) 2017-2018 Cédric Bonhomme - https://github.com/cedricbonhomme
- Copyright (C) 2016-2017 Guillaume Lesniak
- Copyright (C) 2016-2017 Thomas Metois
- Copyright (C) 2016-2017 Jérôme De Almeida
For more information, [the list of authors and contributors](AUTHORS) is available.
2017-02-06 08:21:34 +01:00
Data provided with MONARC (threats, assets, vulnerabilities) are licensed under
[CC0 1.0 Universal (CC0 1.0)](https://creativecommons.org/publicdomain/zero/1.0/) - Public Domain Dedication.
If a specific author wants to license an object under a different license,
a pull request can be requested.