Update doc

doc/breadcrumbs.md

@@ -1,6 +1,6 @@
 # Breadcrumbs
 
-You need to add your breadcrumbs in `src/Cocorico/CoreBundle/Resources/content/breadcrumbs.yml`
+You need to add your breadcrumbs in `src/Cocorico/BreadcrumbBundle/Resources/content/breadcrumbs.yml`
 
 Format:
 

doc/index.md

@@ -3,7 +3,8 @@
 
 ## Table of Contents
 
-- [PHPdoc](http://docs.cocorico.io/phpdoc/index.html)
+- [Server installation](installation-server.md)
+- [Application installation](installation-application.md)
 - [Crons](crons.md)
 - [Mails](mails.md)
 - [Translations](translations.md)
@@ -19,4 +20,3 @@
 - [Deployment](deployment.md)
 - [Troubleshooting](troubleshooting.md)
 - [WkHtml2PDF](wkhtml2pdf.md)
-

doc/installation-application.md

@@ -0,0 +1,135 @@
+# Application installation
+
+## Get project sources
+             
+Fork Cocorico Git Repository then get sources:
+
+### From PhpStorm:
+
+ - Close all projects
+ - Menu > VCS > Checkout from VC > Git
+    - Git Repo: New forked repository address
+    - Parent Dir: Choose parent of Symfony folder
+    - Dir name: Symfony
+ - Menu > File > Open: Symfony folder 
+ - Change Project name
+ - Activate Symfony2 framework
+ - Configure automatically namespace root from Event log Dialog box for example
+
+### From command line:
+
+Go to to your parent "Document Root" directory and clone repository:
+
+    cd /var/www/cocorico.local/
+    git clone https://github.com/[gituser]/cocorico.git Symfony
+                     
+                     
+## Create services accounts
+
+See [Services account creation ](services-creation.md)
+
+
+## Install composer
+
+If you don't have Composer yet, run the following command in the root folder of your Symfony project:
+
+    cd Symfony
+    php -r "readfile('https://getcomposer.org/installer');" | php
+     
+
+## Install Cocorico dependencies
+
+    php composer.phar install
+
+Or to speed up:
+
+    php composer.phar install --prefer-dist -vvv
+
+Or in case of error with tarball (slower):
+
+    php composer.phar install --prefer-source -vvv
+
+This command will ask you the values of some of your application parameters. 
+You will find more informations on them in the following chapter.
+
+## Set your application parameters 
+
+  See `app/config/parameters.yml.dist`
+
+## Configure project
+
+Copy and paste web/.htaccess.dev.dist and rename it to web/.htaccess. (It's configured by default for dev environment).
+
+## Initialize the SQL and NoSQL database
+
+### SQL database initialisation:
+
+    #Linux
+    chmod 744 bin/init-db
+    ./bin/init-db php --env=dev
+
+    #Windows
+    .\bin\init-db.bat --env=dev
+        
+### MongoDB initialisation:
+
+    #Linux
+    chmod 744 bin/init-mongodb
+    ./bin/init-mongodb php --env=dev
+
+    #Windows
+    .\bin\init-mongodb.bat --env=dev
+
+## Check your System Configuration
+
+Before starting coding, make sure that your local system is properly configured for Cocorico.
+
+Execute this script to make sure that your local system is properly configured for Cocorico:
+
+    php bin/symfony_requirements
+
+The script returns a status code of `0` if all mandatory requirements are met, `1` otherwise.
+
+Access the `config.php` script from a browser:
+
+    http://cocorico.local/config.php
+
+If you get any warnings or recommendations, fix them before moving on.
+
+Check security dependencies:
+
+    bin/security-checker security:check composer.lock
+
+In case of error "An error occurred: SSL certificate problem: unable to get local issuer certificate.": 
+
+    bin/security-checker security:check --end-point=http://security.sensiolabs.org/check_lock composer.lock
+
+## Dump assets
+
+    php app/console assets:install --symlink web --env=dev
+    php app/console assetic:dump --env=dev
+
+## Add crons
+
+See [Crons documentation](crons.md)
+
+## Browsing the Demo Application
+
+Congratulations! You're now ready to use Cocorico [http://cocorico.local/](https://cocorico.local/)
+
+Admin access is here :
+
+    http://cocorico.local/admin/dashboard
+    super-admin@cocorico.rocks
+    super-admin
+
+Don't forget to Change your super-admin password. 
+
+Enjoy!
+
+## Troubleshooting
+
+Errors and exceptions are logged and rotated at the application level:
+
+    $ tail -f var/logs/dev-yyyy-mm-dd.log
+    $ tail -f var/logs/prod-yyyy-mm-dd.log

doc/installation-server-linux.md

@@ -0,0 +1,67 @@
+# Linux Installation 
+
+## Apache 2 (or Nginx)
+
+Activate following modules
+
+    - mod_headers
+    - mod_rewrite
+    - mod_ssl
+
+Create your virtual host: [dev virtual host sample](virtual-hosts.md)
+
+
+## MongoDB 
+
+### Install MongoDB 
+
+See https://docs.mongodb.com/manual/administration/install-on-linux/
+
+### Install PHP MongoDB Driver 
+
+See http://docs.mongodb.org/ecosystem/drivers/php/
+
+**Note:** *For PHP 7 install mongodb extension and not mongo extension*
+
+### Start MongoDB 
+
+See http://docs.mongodb.org/manual/tutorial/install-mongodb-on-debian/
+
+
+## PHP
+
+Install PHP 7.1
+
+Activate following extensions:
+
+    - curl (>= 7.36)
+    - intl
+    - fileinfo
+    - openssl
+    - soap
+    - exif
+    - mongodb
+    - imagick
+    - pdo_sqlite
+    - pdo_mysql
+    - opcache
+    - apcu
+
+Add the following lines to php.ini:
+
+    curl.cainfo = "pathto/cacert.pem"
+    memory_limit = 256M
+    upload_max_filesize = 12M
+    post_max_size = 240M
+
+Set the same php timezone to php and php-cli php.ini file:
+
+    date.timezone = UTC  
+        
+        
+## MySQL 
+
+Create your database and your database user
+
+    CREATE DATABASE IF NOT EXISTS {DB} DEFAULT CHARACTER SET utf8 COLLATE utf8_general_ci;
+    GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, INDEX, ALTER, CREATE TEMPORARY TABLES, LOCK TABLES, REFERENCES ON {DB}.* TO {DBUSER}@localhost IDENTIFIED BY '{DBUSERPWD}'

doc/installation-server-windows.md

@@ -0,0 +1,87 @@
+# Windows installation
+
+## Apache 2
+
+Cocorico works also with Nginx.
+
+### Activate following modules
+
+    - mod_headers
+    - mod_rewrite
+    - mod_ssl 
+
+### Install SSL with WAMP
+
+* Install Win32 OpenSSL here http://slproweb.com/products/Win32OpenSSL.html
+* Copy/paste libeay32.dll, ssleay32.dll into php bin folder (ex: C:\wamp64\bin\php\phpx.x)
+
+### Generate self signed certificate
+
+    cd C:\wamp\bin\apache\Apache2.4.4\conf
+
+    #Generate private key
+    openssl genrsa -aes256 -out key\private.key 2048
+
+    #Remove passphrase
+    openssl rsa -in private.key -out key\private.key
+
+    #Generate certificate
+    openssl req -new -x509 -nodes -sha1 -key key\private.key -out cert\cocorico.crt -days 36500 -config C:\wamp\bin\apache\apache2.4.4\conf\openssl.cnf
+            
+### Create your virtual host: 
+
+See [dev virtual host sample](virtual-hosts.md)
+
+## MongoDB
+
+### Install MongoDB
+
+See https://docs.mongodb.com/manual/tutorial/install-mongodb-on-windows/
+
+### Install PHP MongoDB Driver
+
+See http://docs.mongodb.org/ecosystem/drivers/php/
+
+**Note:** *For PHP 7 install mongodb extension and not mongo extension*
+
+### Start MongoDB
+
+    bin\start-mongodb.bat "C:\Program Files\MongoDB\data"
+            
+## PHP
+
+Install PHP >= 5.6 (tested on PHP 7.1, 5.6) 
+
+Activate following extensions:
+
+    - curl (>= 7.36)
+    - intl
+    - fileinfo
+    - openssl
+    - soap
+    - exif
+    - mongodb
+    - gd
+    - pdo_sqlite
+    - pdo_mysql
+    - opcache
+    - apcu
+
+Add the following lines to php.ini:
+
+    curl.cainfo = "pathto/cacert.pem"
+    memory_limit = 256M
+    upload_max_filesize = 12M 
+    post_max_size = 240M
+
+Set the same php timezone to php and php-cli php.ini file:
+
+    date.timezone = UTC  
+        
+        
+## MySQL 
+
+Create your database and your database user
+
+    CREATE DATABASE IF NOT EXISTS {DB} DEFAULT CHARACTER SET utf8 COLLATE utf8_general_ci;
+    GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, INDEX, ALTER, CREATE TEMPORARY TABLES, LOCK TABLES, REFERENCES ON {DB}.* TO {DBUSER}@localhost IDENTIFIED BY '{DBUSERPWD}'

doc/installation-server.md

@@ -0,0 +1,7 @@
+# Server Installation
+
+- For a quick installation based on Docker see [Docker installation](https://github.com/Cocolabs-SAS/cocorico-docker)
+
+- For a manual installation on Linux see [Linux installation](installation-server-linux.md)
+
+- For a manual installation on Windows see [Windows installation](installation-server-windows.md)