lsm/Orchard
1
0
Fork 0
mirror of https://github.com/OrchardCMS/Orchard.git synced 2025-10-15 19:54:57 +08:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

Updating the Readme.txt file for the Orchard.Azure.MediaServices module.

Browse Source
This commit is contained in:
Daniel Stolt
2014-03-26 00:21:46 +01:00
parent 64da4c2d47
commit 46999e6748
1 changed files with 13 additions and 72 deletions
Download Patch File Download Diff File Expand all files Collapse all files

85
src/Orchard.Web/Modules/Orchard.Azure.MediaServices/Readme.txt
View File

@@ -1,79 +1,15 @@
INSTALLING THE MODULE
*********************
The module has been continuously built and tested against the latest version of Orchard in the 1.x branch of the official Orchard Codeplex repository.
The module can be installed into an Orchard site in a few different ways:
Use the full Orchard source code committed in the module's TFS repository
------------------------------------------------------------------------------
1. Clone the repository to the local developer machine.
2. Use Visual Studio to either run the site locally or publish Orchard through any of the standard publishing mechanisms.
For convenience, a recipe named "Orchard.Azure.MediaServices" has been added to Orchard.Setup in this repository that makes it quicker to get a site up and running where the module is already enabled and configured for use.
Add it to another copy of the Orchard source code for a "develop + publish" workflow
------------------------------------------------------------------------------------
1. Copy the whole module project folder into the Orchard.Web/Modules folder of the Orchard source code.
2. Add the Orchard.Azure.MediaServices and Orchard.Azure.MediaServices.Tests projects to the Orchard.sln solution.
3. Add a project reference from Orchard.Azure.Web to Orchard.Azure.MediaServices to ensure the module is included when publishing to a Windows Azure Cloud Service.
4. Make the necessary modifications to the Web.config files in Orchard.Web and Orchard.Azure.Web (see below for details).
"XCopy" deploy it into an already published Orchard site
--------------------------------------------------------
When dynamic compilation is enabled:
1. If the deployed Orchard site is configured to use dynamic compilation, upload the module's folder without the bin and obj folders to the /Modules folder.
When dynamic compilation is disabled:
1. If the deployed Orchard site is not configured to use dynamic compilation, upload the module's folder, including the bin folder, to the /Modules folder. To prevent unnecessary duplicate DLLs from being uploaded as part of the module's bin folder, skip this step and instead follow the steps described in the next section.
When dynamic compilation is disabled and you don't want to upload duplicate DLLs:
1. To prevent unnecessary duplicate DLLs from being uploaded as part of the module's bin folder, build the solution using the ClickToBuild.cmd file that can be found in the root directory of the project.
2. When ClickToBuild.cmd is done, a number of new folders will have been created. Go to "\build\Stage\Modules", and upload the Orchard.Azure.MediaServices folder to the Modules folder of the installation on the hosting server.

CONFIGURING ORCHARD FOR THE MODULE
**********************************
1. Add assembly binding redirects to Orchard
--------------------------------------------
The module includes Windows Azure Media Services SDK for .NET version 3.0.0.0 which is distributed via Nuget. This client SDK library in turn depends on specific versions of a number of other libraries, also distributed via Nuget. Orchard ships with newer versions of some of these assemblies, and in the Orchard process there can only be one version of any given assembly at a time.
Therefore, for the module to work, a few assembly binding redirects need to be added to the main Orchard Web.config file. These redirects cause the Windows Azure Media Services SDK for .NET client library to bind to the newer versions of these dependencies, which are present in the Bin folder of the web application. Without these redirects, the assembly binding will fail and the module will not work.
Specifically, the following redirects must be added to the the Web.config file in the Orchard.Web and Orchard.Azure.web projects:
<dependentAssembly>
<assemblyIdentity name="System.Spatial" publicKeyToken="31bf3856ad364e35" culture="neutral"/>
<bindingRedirect oldVersion="0.0.0.0-5.6.0.0" newVersion="5.6.0.0"/>
</dependentAssembly>
<dependentAssembly>
<assemblyIdentity name="Microsoft.Data.Services.Client" publicKeyToken="31bf3856ad364e35" culture="neutral"/>
<bindingRedirect oldVersion="0.0.0.0-5.6.0.0" newVersion="5.6.0.0"/>
</dependentAssembly>
<dependentAssembly>
<assemblyIdentity name="Microsoft.Data.Edm" publicKeyToken="31bf3856ad364e35" culture="neutral"/>
<bindingRedirect oldVersion="0.0.0.0-5.6.0.0" newVersion="5.6.0.0"/>
</dependentAssembly>
<dependentAssembly>
<assemblyIdentity name="Microsoft.Data.OData" publicKeyToken="31bf3856ad364e35" culture="neutral"/>
<bindingRedirect oldVersion="0.0.0.0-5.6.0.0" newVersion="5.6.0.0"/>
</dependentAssembly>
<dependentAssembly>
<assemblyIdentity name="Microsoft.WindowsAzure.Storage" publicKeyToken="31bf3856ad364e35" culture="neutral"/>
<bindingRedirect oldVersion="0.0.0.0-3.0.0.0" newVersion="3.0.0.0"/>
</dependentAssembly>
2. Increase the maximum request content length for Orchard
1. Increase the maximum request content length for Orchard
----------------------------------------------------------
When uploading large media files using the module, the files are first uploaded to Orchard where they are kept in local file system storage temporarily, before being ingested into WAMS by a server-side background process. By default, Orchard is configured in its Web.config to allow file uploads of up to 64 MB.
The module provides two ways of uploading media files to Windows Azure Media Services (WAMS):
* Direct CORS-based upload to Windows Azure Blob Storage. This is used by default if the browser supports CORS.
* Proxied upload where files are first uploaded to Orchard where they are kept in local file system storage temporarily, before being ingested into WAMS by a server-side background process. This is used as a fallback for browsers that don't support CORS.
If the module will be used to ingest media files larger than 64 MB these values need to be increased, or the first upload step (from the user's/editor's local machine to Orchard temporary storage) will fail.
When using proxied upload, IIS places limits on the maximum allowed upload file sizes. By default, Orchard is configured in its Web.config to allow file uploads of up to 64 MB. If the module will be used to ingest media files larger than 64 MB these values need to be increased, or the first upload step (from the user's/editor's local machine to Orchard temporary storage) will fail.
Specifically, the following attributes need to be reconfigured with a value appropriate for the size of media files with which the module is intended to be used:
- system.web/httpRuntime/@maxRequestLength
@@ -81,7 +17,7 @@ Specifically, the following attributes need to be reconfigured with a value appr
Both of these attributes must be configured with the same value, or whichever value is smaller will effectively impose a limit on the allowed media file upload size.
3. Configuring the logging level for the module
2. Configuring the logging level for the module
-----------------------------------------------
The module logs messages of different severity levels and verbosity through the standard Orchard logging pipeline.
@@ -102,4 +38,9 @@ CONFIGURING THE MODULE
1. Configuring the WAMS account credentials
-------------------------------------------
After the module is installed and the feature "Windows Azure Media Services" is enabled, the WAMS account credentials must be configured in the "Windows Azure Media" settings section in the Orchard administration dashboard.
After the module is installed and the feature "Windows Azure Media Services" is enabled, the WAMS account credentials must be configured in the "Windows Azure Media" settings section in the Orchard administration dashboard. This information can be obtained from the Windows Azure management portal.
2. Configuring the Windows Azure Storage account credentials
------------------------------------------------------------
To use the direct CORS-based upload a CORS rule must be added to the Windows Azure Storage account used by the configured WAMS instance. The module can do this automatically, but it needs the Windows Azure Storage account credentials. Specify the account key for the underlying Windows Azure Storage account used by your Windows Azure Media Services instance if you want to automatically enable CORS support with the appropriate origin URLs for the Orchard site. CORS rules will be added to the storage account for both the configured base URL of the site, and the URL on which you are accessing the site when saving the credentials. If you leave this field blank you will have to manually enable the appropriate CORS support for your Windows Azure Storage account using PowerShell.