--- title: Install alongside Sitecore in Azure PaaS slug: '2910' canonical_url: https://docs.coveo.com/en/2910/ collection: coveo-for-sitecore-v5 source_format: adoc --- # Install alongside Sitecore in Azure PaaS The following article contains instructions and general information regarding the deployment of Coveo for Sitecore alongside a Sitecore instance in a Microsoft Azure PaaS environment using WDPs (Web Deployment Packages). > **Important** > > Installing Sitecore and Coveo for Sitecore simultaneously on Azure using WDPs comes with the following limitations: > > * Sitecore SXA and Coveo for Sitecore SXA modules aren't deployed. > If necessary, SXA and Coveo for Sitecore SXA would need to be installed subsequently, and in that order, using traditional Sitecore packages, through the Installation Wizard. > > * Coveo has tested the successful installation of Sitecore 9.1/10.0/10.1 and Coveo for Sitecore using the **XP Single** Sitecore topology. > Instructions, configurations and the deployment PowerShell script provided below are for this use case. > > * Activation and configuration of Coveo for Sitecore must be performed manually. > > * The Coveo for Sitecore WDP is designed for content management instances. > It's not optimized for content delivery instances as it contains items. > > * The Coveo for Sitecore Scaling Guide must be followed for the content delivery Azure App Service. ## Prerequisites The deployment of Sitecore and Coveo for Sitecore WDP packages on Azure PaaS requires: * an Azure account access with the necessary deployment resources uploaded to it * a computer with the **Sitecore Azure Toolkit** and its dependencies to run the PowerShell deployment commands locally. In more detail, here are the prerequisites for both. ### Your Azure account prerequisites You need 5 WDPs: * the Sitecore site WDP > **Important** > > To ensure special characters in queries don't lock up your search pages, changes to the `Content/Website/Web.config` file are required before uploading the WDP to your Azure account (see [Ajax error 500 when using special characters in a query - Workaround](https://docs.coveo.com/en/3077.md#workaround)). * the Sitecore xConnect site WDP * Sitecore Identity Server WDP, matching the Sitecore version to be installed * the Sitecore Bootloader module WDP (provided in the Sitecore Azure Toolkit in the `\resources\\Addons` folder) * the Coveo for Sitecore module WDP (use the WDP for the latest build accessible through the [Releases and downloads](https://docs.coveo.com/en/2274.md) page). You must also have 2 JSON deployment parameters files, one for the Sitecore Bootloader module and one for the Coveo for Sitecore module: * `bootloader.json`: It's available in the [Sitecore Azure Quickstart Templates GitHub repository](https://github.com/Sitecore/Sitecore-Azure-Quickstart-Templates). Select your Sitecore version followed by the topology. The `bootloader.json` file is located in the `addons` folder. * `coveoforsitecore-module.json`: To download it, [click here](https://docs.coveo.com/en/assets/images/c4sc-v5/coveoforsitecore-module.json). In summary, your Azure storage needs to contain the seven resources below for deployment: ![Screenshot of Azure portal showing the seven required resources | Coveo](https://docs.coveo.com/en/assets/images/c4sc-v5/azure-prerequisite-resources.png) Additionally, you'll need to generate a Shared Access Signature token in your storage account. You'll append the generated query string to your Azure resources references in the deployment configurations. ### Your local computer prerequisites On the computer you'll use to run the Sitecore Azure Toolkit commands to deploy the WDPs, you must install the following: * the Azure PowerShell module (see [Install the Azure PowerShell module](https://docs.microsoft.com/en-us/powershell/azure/install-az-ps?view=azps-2.1.0&viewFallbackFrom=azps-2.0.1)) * the latest version of the [Sitecore Azure Toolkit](https://developers.sitecore.com/Downloads/Sitecore_Azure_Toolkit) Additionally, you want a working folder structure such as the following before launching deployment: ![Screenshot of a Windows folder showing resources and tools folders](https://docs.coveo.com/en/assets/images/c4sc-v5/wdp-deploy-on-azure-local-working-folder.png) where * The `resources` and `tools` folders are copies of the Sitecore Azure Toolkit `resources` and `tools` folders respectively. * The `.pfx` file is a [Sitecore authentication certificate](https://doc.sitecore.com/xp/en/developers/91/sitecore-experience-manager/the-client-certificate-for-sitecore-deployments.html) `.pfx` file. You'll need the client certificate password in the deployment configurations. * The `azuredeploy.parameters.json` file is the deployment configuration file matching the version of your Sitecore WDP, which you've copied/downloaded and edited (see [Editing the azuredeploy.parameters.json file](#editing-the-azuredeploy-parameters-json-file)). * The `license.xml` file is the Sitecore license file. ## Editing the `azuredeploy.parameters.json` file The `azuredeploy.parameters.json` file configurations determine the way a given Sitecore version topology and its modules are deployed. The base `azuredeploy.parameters.json` files available in the GitHub Sitecore Azure Quickstart Templates repository apply only for deployments of vanilla instances of Sitecore. The `azuredeploy.parameters.json` file must be edited to deploy Coveo for Sitecore, as a Sitecore module, along with Sitecore. 1. In the Sitecore Azure Quickstart Templates repository, select the Sitecore version that matches the Sitecore WDPs you've uploaded to Azure (see [Sitecore-Azure-Quickstart-Templates](https://github.com/Sitecore/Sitecore-Azure-Quickstart-Templates)). 1. Select the folder that matches your Sitecore WDP version. 1. Select the folder that matches your Sitecore WDP topology. 1. Click the `azuredeploy.parameters.json` link. 1. Click **Raw**. 1. Note the URL in your browser address box. You'll need it for a variable value in the PowerShell deployment script. 1. Save the displayed content as `azuredeploy.parameters.json` in your working folder, in accordance with the suggested folder structure (see [Your local computer prerequisites](#your-local-computer-prerequisites)). 1. Open the `azuredeploy.parameters.json` file in a text editor. 1. Set the base `azuredeploy.parameters.json` parameter values. [%header,cols="2"] |=== |Parameter |Value |deploymentId |Leave blank (It will be set by a PowerShell script.) |location |The geographic region of the current deployment (for example, East US) |sitecoreAdminPassword |The new password for the Sitecore admin account (at least 8 characters) |`licenseXml` |Leave blank (It will be set by a PowerShell script.) |sqlServerLogin |User name of the SQL system administrator account to be created |sqlServerPassword |The password for the SQL administrator account (requires a number and a special character) |siMsDeployPackageUrl |The concatenation of the uploaded Sitecore Identity SCWDP URL and the Shared Access Signature token query string (for example, `\https://?`) |singleMsDeployPackageUrl |The concatenation of the uploaded Sitecore SCWDP URL and the Shared Access Signature token query string (for example, `\https://?`) |xcSingleMsDeployPackageUrl |The concatenation of the uploaded Sitecore xConnect SCWDP URL and the Shared Access Signature token query string (for example, `\https://?`) |authCertificateBlob |Leave blank (It will be set by a PowerShell script.) |authCertificatePassword |The password you chose when creating the client auth certificate |All machineLearning* parameters |Leave blank if you don't want Sitecore Cortex 1. With the Sitecore XP topology, add an `allowInvalidClientCertificates` parameter to the file with a value of `true`. This parameter is available for the XM topology. + ```json "allowInvalidClientCertificates": { "value": true } ``` 1. Add the Coveo for Sitecore and Bootloader modules configurations. 1. Add a `modules` parameter with the following content to the list of parameters. ```json "modules":{ "value":{ "items":[ { "name": "coveoforsitecore", "templateLink": "", "parameters": { "singleMsDeployPackageUrl" : "" } }, { "name": "bootloader", "templateLink": "", "parameters": { "msDeployPackageUrl" : "" } } ] } } ``` 1. Set the Coveo for Sitecore module parameter values. [%header,cols="2"] |=== |Parameter |Value |templateLink |The concatenation of the uploaded Coveo for Sitecore module JSON file URL and the Shared Access Signature token query string (for example, `\https://?`) |singleMsDeployPackageUrl |The concatenation of the uploaded Coveo for Sitecore SCWDP and the Shared Access Signature token query string (for example, `\https://?`) 1. Set the Bootloader module parameter values. [%header,cols="2"] |=== |Parameter |Value |templateLink |The concatenation of the uploaded Sitecore Bootloader JSON file URL and the Shared Access Signature token query string (for example, `\https://?`) |msDeployPackageUrl |The concatenation of the uploaded Sitecore Bootloader WDP and the Shared Access Signature token query string (for example, `\https://?`) 1. Save the file. ### Creating the PowerShell deployment script > **Note** > > The script variable values below pertain to a Sitecore 9.1 installation. > Adjust the script variable values accordingly for your Sitecore version. 1. Create a new file in a text editor. 1. Paste the following script in your new file. ```powershell $SCSDK="D:\sitecore9\tools" $SCTemplates="https://raw.githubusercontent.com/Sitecore/Sitecore-Azure-Quickstart-Templates/master/Sitecore%209.1.0/XPSingle" $DeploymentId = "" $ResourceGroup = "" $LicenseFile = "D:\sitecore9\license.xml" $CertificateFile = "D:\sitecore9\.pfx" $SubscriptionId = "" $Location="East US" $ParamFile="D:\sitecore9\azuredeploy.parameters.json" $Parameters = @{ "deploymentId"=$DeploymentId; "authCertificateBlob" = [System.Convert]::ToBase64String([System.IO.File]::ReadAllBytes($CertificateFile)) } Import-Module $SCSDK\Sitecore.Cloud.Cmdlets.psm1 Add-AzureRMAccount Set-AzureRMContext -SubscriptionId $SubscriptionId Start-SitecoreAzureDeployment -Name $ResourceGroup -Location $Location -ArmTemplateUrl "$SCTemplates/azuredeploy.json" -ArmParametersPath $ParamFile -LicenseXmlPath $LicenseFile -SetKeyValue $Parameters -Verbose ``` 1. Edit the script variable values per the information below. [%header,cols="2"] |=== |Variable |Value |$SCSDK |The location of the `tools` directory that was copied from the Sitecore Azure Toolkit |$SCTemplates |The ARM Template URL of the `azuredeploy.parameters.json` file you saved, without the file name and the trailing slash (for example, `https://raw.githubusercontent.com/Sitecore/Sitecore-Azure-Quickstart-Templates/master/Sitecore%209.1.0/XPSingle`) |$DeploymentId |The prefix that will be added to all resources created in Azure (can be anything up to 60 characters long) |$ResourceGroup |The name of the Azure Resource Group to install the services in (one resource group per Sitecore installation) |$LicenseFile |The location of your `license.xml` file |$CertificateFile |The location of your client authentication certificate file |$SubscriptionId |The Azure account subscription ID |$Location |The same Azure geographic location as your `azuredeploy.parameters.json` file and blob storage |$ParamFile |The location of your `azuredeploy.parameters.json` file 1. Save your file. ### Running the PowerShell deployment script 1. Run PowerShell as an administrator. 1. Copy-paste the deployment script from your text file into your PowerShell window. 1. Run the script. ## What's next? You're now ready to configure and activate Coveo for Sitecore (see [Configuration and activation options](https://docs.coveo.com/en/3150.md)).