Installation on Windows

Windows Server 2012 + IIS 8

Software needed

Install Git

1. Execute the installation file
2. Accept all default options and finish the installation
3. Test it by right click on any folder and choose Bit Bash Here then run git --version

Redis

Redis does not officialy build Windows binaries, but you can use the ones officially supported by the Microsoft Open Technologies team.

1. Execute the installation file
2. Use default port (6379) or change it if needed
3. Set the Max Memory limit to 256MB

Install IIS

1. Go to the Server Manager and on the Manage menu chose the Add Roles and Features
2. Click Next until the Select server roles window and select the Web Server (IIS) Checkbox
3. Click Add Features
4. Click Next until the Select role services window
5. Expand the Application Development branch and check the CGI option
6. Click Next and then Install
7. Install the IIS Rewrite Module

Install PHP

This guide was base on the official installation instructions: http://php.net/install.windows

1. Install the Visual C++ Redistributable for Visual Studio 2015
2. Unzip the PHP installation file to a folder, something like c:\php
3. Create a copy of the file php.ini-production and rename it to php.ini
4. Add the php folder to the Windows PATH
5. Do the following changes to the php.ini file (uncomment if needed)

7. If the software is configured to use https you may need the curl certificate which you can download it here. Save it somewhere on the machine (Ex: c:\php) and configure it in php.ini on the curl.cainfo directive, Ex: curl.cainfo = 'c:/php/cacert.pem'

PHP Extensions

Uncomment/Add the following extension in php.ini file

• curl
• fileinfo
• gd
• intl
• ldap
• mbstring
• openssl
• soap
• sodium
• mysql - If using MySQL/MariaDB
• sqlsrv - If using SQL Server
• redis
• imagick

Installing the sqlsrv driver

1. Extract the files from the downloaded zip and copy the appropriate PDO dll (php_pdo_sqlsrv_81_nts.dll) to the PHP extensions folder
2. Next add the extension to php.ini: extension=php_pdo_sqlsrv_81_nts

Configuring the frontend and backend

Folder permissions

You must give the user IUSR and the group IIS_IUSR permissions to read both folders, and write permissions to the folder storage and bootstrap/cache on the backend folder

You have 2 choice, either use sub-domains (best option) or use different ports

Using different ports

The frontend and the backend need to be on a different website, you can use the default web site for the frontend and create a new one for the backend.

Frontend

If you can use the frontend just rename it to frontend and go to step 3

1. Right-click on the Sites branch and click Add Website
2. Name it frontend, fill the other fields accordingly. If needed, change the port to something available (you don't need to fill the Host name field)
3. Select the frontend branch and on the right panel click Basic Settings
4. Change the Physical path to the frontend folder.
5. Still on the frontend double-click the MIME Types option and add a new mime type application/font-woff2 for the extension .woff2
6. Check if it worked by executing http://localhost/ on the browser

Backend

For the backend we need to configure PHP, so there's some extra steps.

1. Right-click on the Sites branch and click Add Website
2. Name it backend, Fill the fields accordingly and change the port to something available like 8080 (you don't need to fill the Host name field)
3. Next choose the website just created and in the middle panel, double click on the Handler Mapping
4. Then on the right panel choose the option Add Module Mapping and fill the fields accordingly.
5. Click on the Request Restrictions..." button, and on the Verb tab be sure to have the All verbs option selected
6. Click OK twice and then click Yes again

7. Next, select the backend branch and double click the Default Document option.
8. Right click, choose Add Default Document, add index.php to textbox and click ok
9. Re-order the option so that index.html is first and index.php is second
10. Create a phpinfo.php file on the backend folder with the following code: <?php phpinfo()
11. On the browser run the url: http://localhost/phpinfo.php (be sure to use the port defined previously for the backend) if everything went right you should the PHP information page. Check if all the extensions are loaded. You should delete the file after.

Using sub-domains

This is similar to the Using different ports method, the only difference is that you must fill the Host name with the corresponding sub-domain for each website and you don't need to specify different ports for the frontend and backend since IIS will redirect the request base on the sub-domain

Common configurations

If IIS is configured with the WebDAVModule you may have errors using the PUT verb. To solve it you have to remove it by adding the following lines to the webconfig file

<modules>
    <remove name="WebDAVModule"/>
</modules>
<handlers>
<remove name="WebDAV"/>
</handlers>

Composer

1. Execute the installation file
2. Click Next and confirm the location of php.exe
3. Click Next, if needed, configure the proxy, then click Install
4. Click Next, read the instructions and click Finish
5. Test it by launching the command line terminal and running composer --version

Install SGI

Backend

1. git clone https://gitlab.wemake.pt/wemake/sgi/backend/core backend
2. cd backend
3. Run cp .env.example .env, edit it and change the configurations accordingly.
4. Run cp laravel-echo-server.example.json laravel-echo-server.json, edit it and change the configurations accordingly.
5. Run composer install
6. Run php artisan key:generate
7. Run php artisan jwt:secret
8. Use composer to add the modules to install: composer require wemake/sgi-....
9. Run php artisan migrate

Frontend

Install NodeJS

1. Execute the installation file
2. Accept default options and finish the installation
3. Test it by launching the command line terminal and running node --version and npm --version

NSSM - the Non-Sucking Service Manager

NSSM is used to create services on windows. We need this to better handle laravel-echo-server and laravel queues

1. Extract the downloads file
2. Copy the mssm.exe file located in the win32 or win64 folder to a folder that is part of the Windows PATH (Ex: C:\windows) so you can execute from everywhere

Laravel Echo Server

1. On the backend folder execute npm install -g laravel-echo-server.
2. Copy the laravel-echo-server.example.json file to laravel-echo-server.json and configure accordingly.
3. Use the nssm to create a service to run laravel-echo-server: nssm install wemake-laravel-echo-server and configure and configure accordingly (change the paths if needed)

Application tab

Details tab

I/O tab

4. Start the service using the Windows services interface or by executing nssm start wemake-laravel-echo-server

Laravel Queue

1. Use the nssm to create a service to run laravel queues: nssm install wemake-laravel-queue-work and configure accordingly (change the paths if needed)

Application tab

Details tab

I/O tab

wkhtmltopdf

1. Execute the installation file
2. Accept all default options or change the installation folder if needed

3. Update the .env file accordingly. Example:

   WKHTML_PDF_BINARY="C:/<instalation_path>/bin/wkhtmltopdf.exe"
   WKHTML_IMG_BINARY="C:/<instalation_path>/bin/wkhtmltoimage.exe"

You also have to add the IUSR and IIS_IUSRS users to the security properties with read permissions for the wkhtmltopdf folder.

Notes

Don't forget to check if IUSR and IIS_IUSRS users have permissions to the backend folder of the application and if they have access to the temp files folder. If not you can create a new temporary files folder with the right permissions for the users. Edit the php.ini and update the following

sys_temp_dir = "<New-directory-created>"

Or you can change the access permissions to the Windows temporary files' directory.