Skip to content

Latest commit

 

History

History
89 lines (62 loc) · 2.99 KB

README.md

File metadata and controls

89 lines (62 loc) · 2.99 KB

Limbo Skyfish

GitHub license NuGet NuGet Limbo.Umbraco.Skyfish at packages.limbo.works

Limbo.Umbraco.Skyfish is a video picker property editor for the Umbraco backoffice that allows users to insert videos from Skyfish.

License: MIT License
Umbraco: Umbraco 10, 11 and 12
Target Framework: .NET 6



Installation

Umbraco 10+

Version 1 of this package supports Umbraco version 10, 11, and 12. The package is only available via NuGet.

To install the package, you can use either the .NET CLI:

dotnet add package Limbo.Umbraco.Skyfish --version 1.0.0-beta004

or the NuGet Package Manager:

Install-Package Limbo.Umbraco.Skyfish -Version 1.0.0-beta004



Configuration

Access to the Skyfish API requires a public key, secret key, username and a password. If you're logged into the Skyfish, you can find your public key and secret under API credentials.

In order for the package to access the API, you should add the credentials to the Limbo:Skyfish:Credentials array in your app settings. In appsettings.json, this would look like:

{
  "Limbo": {
    "Skyfish": {
      "Credentials": [
        {
          "Key": "1c9850b8-1861-4f20-a62f-e24acbbac063",
          "Name": "{ClientName} Skyfish",
          "Description": "Credentials for accessing {ClientName}'s Skyfish account via {email}",
          "PublicKey": "...",
          "SecretKey": "...",
          "Username": "...",
          "Password": "..."
        }
      ]
    }
  }
}

Key should be a random but unique GUID key that helps identifying the crendetials. The values for Name and Description are currently not used, but that may change in the future.

With the current implementation, the package will always use the first set of Credentials, meaning multiple credentials are not directly supported.