Home

Awesome

2sic Imageflow Oqtane module middleware

Imageflow.NET Server image processing and optimizing middleware with querystring API for Oqtane 4

Release notes

Because nuget package with dependencies for all runtimes is very big separate smaller packages are created for different platforms. Recommendation is to install only packages that targets platforms in use. Installing more packages in same oqtane installation will effectively append runtime dependence from last package.

Install Imageflow module in Oqtane

Install it in standard way, as any other oqtane module.

Option a)

  1. Open Module Management in Admin Dashboard. On Download tab find Imageflow in list of modules. Click on its Download button. After download click on Install.

Option b)

  1. From https://github.com/2sic/oqtane-imageflow/releases download latest ToSic.Imageflow.Oqtane.x.x.x-*.nupkg.

  2. Open Module Management in Admin Dashboard and select Upload tab. Upload ToSic.Imageflow.Oqtane.x.x.x-*.nupkg and Install,

Option c)

  1. From https://github.com/2sic/oqtane-imageflow/releases download latest ToSic.Imageflow.Oqtane.x.x.x-*.nupkg.

  2. Just copy ToSic.Imageflow.Oqtane.x.x.x-*.nupkg package to your Oqtane.Server\wwwroot\Modules\ and next oqtane website restart will auto-install Imageflow module as part of oqtane application startup process.

Development in Oqtane.Framework with Imageflow nuget dependency

  1. It is required to have Oqtane.Framework development environment in folder oqtane.framework.

    git clone https://github.com/oqtane/oqtane.framework.git
    
  2. In Visual Studio open oqtane.framework\Oqtane.sln.

  3. Open Manage nuget packages for solution.., find ToSic.Imageflow.Oqtane nuget package and Install to Oqtane.Server project as dependency.

  4. Or, from https://github.com/2sic/oqtane-imageflow/releases download latest ToSic.Imageflow.Oqtane.x.x.x-*.nupkg and just copy ToSic.Imageflow.Oqtane.x.x.x-*.nupkg package to your Oqtane.Server\wwwroot\Modules\

Develop Imageflow module in Oqtane.Framework

  1. It is required to have Oqtane.Framework development environment in folder oqtane.framework.

    git clone https://github.com/oqtane/oqtane.framework.git
    
  2. By convention if you place the Imageflow module root folder at the same level as the oqtane.framework, then you will not have to modify any folder configuration in the oqtane-imageflow\Src\Package\ToSic.Imageflow.Oqtane.Package.csproj project.

    git clone https://github.com/2sic/oqtane-imageflow.git
    

How to deploy Imageflow to Oqtane.Framework?

  1. In Visual Studio open oqtane-imageflow\Src\ToSic.Imageflow.Oqtane.sln.

  2. Build Debug or Release configuration and script will deploy Imageflow module to Oqtane.Framework.

  3. In Visual Studio open oqtane.framework\Oqtane.sln and Run it.

How to locally package ToSic.Imageflow.Oqtane.x.x.x-*.nupkg?

  1. Build release version and pack to ToSic.Imageflow.Oqtane.x.x.x-*.nupkg

    cd InstallPackages
    pack.cmd
    

More info

  1. Querystring API documentation
  2. Imageflow.NET Server
  3. Imageflow
  4. Oqtane