Installation Guide

WeBlog can either be installed using a Sitecore package, or from source.

Sitecore Package

:exclamation: This is the preferred installation method.

WeBlog can be installed from a Sitecore package. The WeBlog Sitecore package may be built from source (see the how to build.md file in the root of the repo), or downloaded from the official releases page on github at https://github.com/WeTeam/WeBlog/releases.

1. Either prepare the package manually, or download the desired official release from https://github.com/WeTeam/WeBlog/releases for the Sitecore version you're deploying onto.
   • Different WeBlog versions support different Sitecore versions. Make sure you download the package appropriate to the version of Sitecore which you're running.
2. Use the Sitecore Installation Wizard to install the Sitecore package.
   • Follow the instructions included in the Sitecore package to complete post-install steps.
3. Create your blog using the /sitecore/Templates/Branches/Modules/WeBlog/Blog MVC branch template.
4. Perform an incremental publish to all publishing targets.
5. Rebuild the weblog-master and weblog-web indexes.

From Source

The how to build.md file in the root of the repository includes information on how to build the project from source.

Upgrades

WeBlog supports in-place upgrades. Simply follow the installation instructions from above using the desired version package or code. The new version of WeBlog will replace the old version. Multiple versions of WeBlog cannot be run on the same Sitecore instance.

To ensure an upgrade doesn't overwrite any customizations it's important not to change any WeBlog items or files. Instead, extend the WeBlog provided resource.

For example, use a separate config patch file to adjust any WeBlog provided configuration. Rather than changing a WeBlog provided template, create a new template which uses the WeBlog template as a base template. This allows you to make changes in your sub-template and keep them separate from WeBlog templates so upgrades don't overwrite your changes.

Breaking changes to the WeBlog API are generally called out through deprecation (marking members which will be removed with the Obsolete attribute). If you're using the WeBlog API directly, it is advised to apply each release in turn, so any obsolete usages will be reported by the compiler and can be fixed before that member is removed and causes a breaking change.

Version Specific Steps

Occasionally a specific WeBlog release will require some specific steps to complete the upgrade.

WeBlog 4.0.1

WeBlog 4.0.1 deprecated the NVelocity based email workflow action used to inform of new comments posted to entries. This workflow action must be removed manually from the WeBlog Comments workflow.