Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/kevinobee/Sitecore.Ship

Ship provides a CI service layer for Sitecore
https://github.com/kevinobee/Sitecore.Ship

Last synced: 3 months ago
JSON representation

Ship provides a CI service layer for Sitecore

Lists

README 

        
# Sitecore.Ship



[![Join the chat at https://gitter.im/kevinobee/Sitecore.Ship](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/kevinobee/Sitecore.Ship?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)



Sitecore.Ship is a lightweight means to install Sitecore Update packages via HTTP requests.



## API Documentation



[Sitecore.Ship documentation](http://docs.sitecoreship.apiary.io/) can be found on Apiary.io



## Instructions for Use



The latest release versions of the Sitecore.Ship packages can be found in the [NuGet package gallery](https://www.nuget.org/packages/)



* [Sitecore.Ship](http://www.nuget.org/packages/Sitecore.Ship/)

* [Sitecore.Ship.AspNet](http://www.nuget.org/packages/Sitecore.Ship.AspNet/)



Early releases of the Sitecore.Ship packages can be found on a public feed from [MyGet](https://www.myget.org/)



* [NuGet V3 feed - Visual Studio 2015+](https://www.myget.org/F/sitecore-ship-prerelease/api/v3/index.json)

* [NuGet V2 feed - Visual Studio 2012+](https://www.myget.org/F/sitecore-ship-prerelease/api/v2)



### Installing Sitecore.Ship via NuGet



* Ensure that the website project is set to run with `.NET Framework 4.5`



* Ensure that the `web.config` file for the target project if already existing is included into your project.



* Run the following powershell command in the package manager console of the Visual Studio solution for the target website to install the Nancy based version of Sitecore.Ship:



```Shell

PM:> install-package Sitecore.Ship

```



or to use the ASP Net HTTP Handler only option install the following package:



```Shell

PM:> install-package Sitecore.Ship.AspNet

```



Installing the package will do the following:



* Add a new `packageInstallation` section to your `web.config` file. You can set configuration options in this section to enable remote access to the installer and to enable the package streaming functionality. These options are safe by default, that is, no remote access and package streaming disabled.



  **Note:** the configuration settings are ignored in this branch of Sitecore.Ship.



* Register a single new HTTP handler section in ``. Support for classic mode in IIS has been removed.



* Add a `ship.config` Sitecore include file to the `App_Config\include` folder.

### Configuration Options



Shown below is a fully specified configuration section for Sitecore.Ship:



```xml



    

        

        

        

    



```



Default configuration:



* `enabled` = false

* `allowRemote` = false

* `allowPackageStreaming` = false

* `recordInstallationHistory` = false

* IP address whitelisting is disabled if no elements are specified below the `` element or if the element is omited.



When `recordInstallationHistory` has been set to true packages should follow the naming conventions set out below:



Packages should follow the following naming conventions. Id should be an int.



```text

{ID}-DescriptiveName.{Extension}

```



where:



* *ID* should be an integer

* *Extension* should be either *update* or *zip*



For example:



```text

01-AboutPage.update

02-HomePage.zip

```



### Uninstalling Sitecore.Ship



Run the following commands from the package manage console within Visual Studio:



```Shell

PM:> uninstall-package Sitecore.Ship

```



## Contributing to the Project



If you are interested in contributing to the growth and development of Sitecore.Ship in even a small way, please read the notes below.



Your participation in the project is very much welcomed.



### Working with Sitecore.Ship Source Code



* Clone this repository to your local file system



* From a command prompt type `.\build.cmd` and press Enter



A successful command line build will generate a NuGet package in the `artifacts\Packages\` folder.



Please ensure that there are no compilation or test failures and no code analysis warnings are being reported by the command line build.



### Running Smoke Tests



The `build.proj` file contains a set of smoke tests to verify that the Sitecore.Ship features all run successfully when the package has been installed in a Sitecore website.



In order to run these smoke tests you will need to:



* Have a local install of Sitecore.



* Set the *TestWebsitePath* and *TestWebsiteUrl* in the **build\environment.props** to reference the local Sitecore website.



* Ensure that the test website has the Ship package installed by running the following in the Package Manager Console:



```shell

install-package Sitecore.Ship -Source 

```



You can then run the smoke tests by entering:



```Shell

.\build.cmd RunSmokeTests

```



A series of curl commands fire off HTTP requests to the Sitecore.Ship service routes and the results are printed out to the console. Each of these commands should execute successfully before you send a pull request back to the main project.



### Developer Tooling



* [POSTMAN](http://www.getpostman.com/) is a powerful HTTP client that runs as a Chrome browser extension and greatly helps with testing test REST web services.



* [cUrl Documentation](http://curl.haxx.se/docs/httpscripting.html) - see section 4.3 File Upload POST