Home → Installation and Upgrade Manual → HelpSpot 5 Installation → Installing HelpSpot 5 On Windows Step by Step
1.7. Installing HelpSpot 5 On Windows Step by Step
- Download the latest zip package of HelpSpot from https://store.helpspot.com
- Download your HelpSpot license file from https://store.helpspot.com
- You can follow Microsoft's provided documentation: https://docs.microsoft.com/en-us/iis/install/installing-iis-85/installing-iis-85-on-windows-server-2012-r2
- Make sure to enable the CGI Role under Web Server > Web Server > Application Development
- Go to https://windows.php.net/download and download the latest NTS (Non thread safe) build of php 8.0 for x64
- Extract the downloaded zip to a temporary location
- Create a new PHP directory at
- Paste the the contents of your downloaded php package into
- Rename C:\PHP\php.ini-production to C:\PHP\php.ini
- Edit the php.ini file and add
upload_tmp_dir=c:\PHP\tmpto the bottom of the file.
- Find the "Dynamic Extensions" area of your php.ini file and enable these extensions: curl, gd, imap, ldap, mbstring,fileinfo and openssl
- Create a directory at c:\PHP\tmp
Install Certificate Store for PHP
- Go to https://curl.se/docs/caextract.html and download the latest certificate bundle to C:\PHP\
- Edit the php.ini file in C:\PHP\ and add these two lines to the bottom of the file:
SQL Server Drivers For PHP
- Download the SQL Server drivers for PHP 8.0 from https://github.com/microsoft/msphpsql/releases/download/v5.10.0/Windows-8.0.zip
- Extract the Zip to a temporary location
- Open the x64 folder in the extracted folder.
- Copy php_sqlsrv_80_nts.dll and php_pdo_sqlsrv_80_nts.dll to C:\PHP\ext\
- Open the php.ini file in C:\PHP\php.ini in a editor of your choice
- Search for
- You will find a list of extensions in this section. Add the two new extensions needed:
Add PHP as an IIS FastCGI Module
- Open the IIS Manager
- Click on your server in the tree view and then select Handler Mappings
- Choose add Module Mapping
Request path: *.php
- Click Ok to save the new mapping
- Select "Yes" to add a entry to FastCGI Collection
Add IIS Default Document
- Click on your server in the tree view
- Click Add... in the Actions panel to add a new default document.
- Enter index.php as a new default document and click ok.
Set Default Directory to Public
- In IIS manager expand
Sitesin the tree view
- Click on the
- In the
Actionspanel under the Edit Site section, click
- Change the physical path to
Setup IIS URL Rewrite Extension
- Download the extension from https://www.iis.net/downloads/microsoft/url-rewrite
- Install the extension.
Create Your HelpSpot Database and User
- Open the SQL Server Management Studio and connect to your SQL Server
- Right click on
New > Login
- Enter the desired login name e.g. "helpspot_user"
- Choose SQL Server authentication and set a password
- Create the user.
- Right click on
- Enter the desired database name e.g. "helpspot_db"
- Set the owner to your previously created user
Setup HelpSpot Files
- Copy the contents of your extracted helpspot zip package to C:\inetpub\wwwroot\
- Your wwwroot directory should contain an app\ folder, bootstrap\ folder, config\ folder etc.
- Edit the properties of the storage directory
- In the Security tab give the IIS_IUSRS full control
HelpSpot requires a file named .env with configuration details.
HelpSpot includes a .env.example file. You can copy this file to create a file named .env and change the parameters as needed:
APP_DEBUG=false APP_URL=http://localhost APP_KEY= DB_CONNECTION=sqlsrv DB_HOST=localhost DB_PORT=1433 DB_DATABASE=helpspot_db DB_USERNAME=helpspot_user DB_PASSWORD=test QUEUE_CONNECTION=database
Here are some details on the configuration:
- APP_DEBUG - Setting this to true will show full error stack traces in the web browser if errors occur. Errors will always appear in the log file at storage/logs/helpspot.log whether this is set to true or false.
- APP_URL - The URL used to access HelpSpot from the web browser. This is important to set correctly so HelpSpot generates links correctly. This should include the "https://" portion and any trailing file paths, such as "https://example.org/helpspot".
- APP_KEY - This will be set during installation should be present but left blank (exactly as APP_KEY=).
- DB_CONNECTION - one of mysql or sqlsrv. On most windows installs you will be using sqlsrv
- DB_* - the connection details for the database
- QUEUE_CONNECTION - This should stay as database, but it's possible to use other queue connections, such as redis.
- Open the command line and cd to
- Run the HelpSpot Installer:
c:\PHP\php.exe hs install
- Enter the requested information in the install wizard
Setup Your Queue
- Navigate to c:\inetpub\wwwroot\helpers\windows
- The setup.bat file is preconfigured to use the default paths that are used in these docs. If your php or website are installed at different paths, modify the first two lines to reflect your paths.
- Run setup.bat. This will create your supervisor.conf file and install your queue services
This page was: Helpful | Not Helpful