https://github.com/peplau/SscPublish

Publish extension to Sitecore.Services.Client - A Web API method to securely trigger a Sitecore publish
https://github.com/peplau/SscPublish

Last synced: 3 months ago
JSON representation

Publish extension to Sitecore.Services.Client - A Web API method to securely trigger a Sitecore publish

• Host: GitHub
• URL: https://github.com/peplau/SscPublish
• Owner: peplau
• License: gpl-3.0
• Created: 2019-07-08T20:29:24.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2021-11-19T00:02:28.000Z (almost 3 years ago)
• Last Synced: 2024-01-24T04:15:26.454Z (10 months ago)
• Language: C#
• Size: 62.5 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• Awesome-Sitecore - Sitecore Services Client Publish - A Web API method to securely trigger a Sitecore publish of an item or tree. (WebApi)

README

        
# SscPublish

Publish extension to Sitecore.Services.Client - A Web API method to securely trigger a Sitecore publish of an item or tree

## Installation

1. Download the package for your corresponding Sitecore version [from here](https://github.com/peplau/SscPublish/tree/master/Download "from here");

1. Install with Installation Wizard

### Post-installation:

Add an entry to ConnectionStrings.config with a SecurityToken to your SSC client:

``

Please, don't use this secret - instead, create a strong password (Eg: using https://passwordsgenerator.net/)

## Calling the SSC method

Follow the pattern: 

`/sitecore/api/ssc/SscPublish.Controllers/Publish/{itemId}?{parameters}`

- **ItemId** = your item ID (without brackets)

- **parameters** = Querystring parameters (Eg: ?async=true&deep=false)

> **IMPORTANT**:

In order to execute a publish, the user authenticated to SSC must be a member of the  role **sitecore\Sitecore Client Publishing**

## Parameters

- **deep** (bool) - Deep publish

Default: false

- **async** (bool) - Async publish

Default: false

- **targetDb** (string) - Target Database

Default: "web"

- **mode** (string) - Publish Mode

Default: "SingleItem"

### Example calls

- Publish with default values: http://yourserver/sitecore/api/ssc/SscPublish.Controllers/Publish/110D559F-DEA5-42EA-9C1C-8A5DF7E70EF9/

- Deep and Async publish: http://yourserver/sitecore/api/ssc/SscPublish.Controllers/Publish/110D559F-DEA5-42EA-9C1C-8A5DF7E70EF9/?deep=true&async=true

### Available Publish Modes

The implementation will cast the string passed at the **mode** parameter into the enum *Sitecore.Publishing.PublishMode*

Accepted values are:

- **Full** - Re-publishes everything

- **Incremental** - Every item change generates a record in list (f.e. PublishingQueue table). List is inspected during publishing

- **SingleItem** - Publishes single item

- **Smart** - Publishes items that have difference in source and target

- **Unknown** - Unknown mode