DXP self-deployment guide
This topic describes how to access the DXP Management Portal, and the steps to deploy changes between the Integration, Preproduction, and Production environments, with Episerver Customer-Centric Digital Experience Platform (DXP).
In this topic
- Verifying site access before deployment
- Deployment steps
- Troubleshooting deployments
You need an Episerver cloud account to access the self-services for Episerver DXP. See Creating an Episerver cloud account how to get an account.
Note: Generic accounts like email@example.com, or private hotmail-type accounts like firstname.lastname@example.org, cannot be used. The self-deployment portal works best with browsers Chrome or Firefox.
Before starting a deployment, make sure the site in the source environment is running by accessing it in a browser. If the site has IP restrictions preventing you from navigating to it, ask the technical contact for the site to add your IP address in the exclusions list.
If you cannot reach the site, something is probably wrong and deployment cannot be done. Contact the technical contact for the site to solve the issue, and try again. When you have verified site availability, you can start the deployment.
This example deploys from the Integration to Preproduction environments, but the procedure is similar when deploying from Preproduction to Production.
If you have issues when deploying to Production and need urgent assistance, contact Episerver (24/7): Worldwide: +46 8 555 827 50; North America: 1-(877)-383-0885 (Toll Free); United Kingdom: +44 800 066 4784 (Toll Free); Australia: +61 2 9248 7215.
- Go to the DXP Service management portal on https://paasportal.episerver.net and log in with your account credentials. The Organizations section appears.
- Locate the organization and project for which you want to deploy changes, and click on the project name to open it.
- Click the Hostnames tab to see available hostnames.
- Click the Deployments tab of the Project page; it provides contact information and deployment options.
- In the Application Logs section, provide information about provisioned environments, site URLs for site verifications, and access to application logs for troubleshooting.
- Before deploying, ensure that the source site (Integration), is up and running.
- Select an Environment in the drop-down
- Use the displayed URL to browse to the site.
- When you have verified that it works, click Deploy to to start the deployment.
- Select the applicable options in the dialog box that appears:
- Use maintenance page. If the deployment includes database schema updates or changes to content types, select to display a maintenance page while the site is offline.
- Include Blobs & DB. If it is a first-time deployment to the target environment, select to copy these items over.
Existing BLOBS and database are overwritten if you select the Include Blobs & DB option. If this option is not selected, only code will be copied.
- Select applications. If you have multiple web applications, you can select which ones to deploy.
- Click Start Now. A progress bar displays the progress of the deployment. When the first part of the deployment is done, a confirmation message appears in the portal.
- Click View output log to see deployment step details. See Deployment process for information about the procedure.
- You can click Cancel to stop the deployment and roll back the changes, if needed.
- Click the Preview... link to verify that the sites in the slot is working as expected.
An email is also sent to the technical contact for the target site, with links to the slot URLs that you can use for site verification.
Note: DO NOT continue with the deployment if you cannot properly verify a site in a slot.
If there is a problem, you can fix the Integration environment and deploy it to Preproduction again, but the Use maintenance page or Include Blobs & DB options are not available. You cannot re-select the source applications as well; it auto-selects the source applications of the previous deployment.
- When you have successfully verified the sites in the previous step, click Complete to finalize the deployment. A progress bar appears, and the site in the slot is swapped into the Preproduction environment.
Alternatively, if the deployment did not succeed, click Reset to revert the changes. The Preproduction environment is reverted to its initial state if a site did not work as expected in the first deployment part. Click Reset in the confirmation dialog box, to complete the reset, and go to the troubleshooting section below to solve the issues.
If you selected Use maintenance page, you can roll back the database and validate the Reset progress.
- If you selected Validate before swap, click Preview to verify that the sites are working as expected after resetting, then click Complete reset to finalize the reset progress.
- When completed, the project page displays the Deploy option again. You can click the information icon next to the environment name to see when the latest deployment was completed.
- If the deployment succeeded, verify that the Preproduction environment works as expected.
Notifications may appear at the top of the screen sent by the system administrator. Also, support information is provided if you have issues during deployment.
If an unsuccessful deployment occurs, an error message appears in the Project page.
Click error log for detailed information to see a summary of the deployment issues.
If the information is not sufficient to identify the issues, click View Job Log to open the Job output view. This contains detailed deployment information as described in the following section.
This view provides information about the sites and environments involved in the deployment. You can also find exceptions, error messages, warnings and deployment output steps, useful when troubleshooting deployment issues.
Click Get Detailed Log to receive the same information in an email. This is useful if you want to share the information with someone without access to the portal.
The Log Stream options lets you view output from Episerver log files to help in troubleshooting deployment errors. This option requires diagnostics logging to a BLOB storage being enabled, as described in the article Enable diagnostics logging for web apps in Azure App Service.
Click Open Log Stream Window to access the log stream. You can hook on the Episerver logs to monitor the live log stream from all sites instances. Click Pause or Resume to stop or continue the streaming of log information. Click Clear to remove the recent log output.
- Continuous deployment of Episerver solutions
- Blog post: Setting up Continuous Integration with Azure DevOps and Episerver DXP
Last updated: Apr 27, 2020