Getting Started¶
Requirements¶
- Umbraco 18 or later
- SQL Server (or LocalDB / Express) as the site's database; SQLite sites are not supported
- .NET SDK required by Umbraco 18
- Node.js 22 or later, to build the backoffice client from source
Building from source¶
Prerequisites¶
- .NET 10 SDK
- .NET 8 runtime, to run the tests against the
netstandard2.0build of the validator
No other setup is needed: the fixed generator key and IV of the licensing system are part of the validator source.
Build, test and pack¶
dotnet build PackageGarden.Licensing.slnx -c Release
dotnet test PackageGarden.Licensing.slnx -c Release
dotnet pack PackageGarden.Licensing/PackageGarden.Licensing.csproj -c Release -o artifacts
dotnet pack PackageGarden.Licensing.Generator -c Release -o artifacts
dotnet pack PackageGarden.Licensing.Generator.Client -c Release -o artifacts
- The build fails on any obsolete .NET API.
- The tests run on
net10.0andnet8.0. Only the legacy license compatibility tests:dotnet test PackageGarden.Licensing.slnx --filter TestCategory=Compatibility. - The build of
PackageGarden.Licensing.Generator.Clientrunsnpm ciandnpm run buildfor the backoffice client (skip with-p:SkipClientBuild=true). - The pack steps produce
artifacts/PackageGarden.Licensing.<version>.nupkg(the validator), andPackageGarden.LicenseGenerator.<version>.nupkgplusPackageGarden.LicenseGenerator.Core.<version>.nupkg(the license manager). A local build has version0.0.0-local; released versions come from a git tag (see Releasing).
Installation and first run¶
The license manager installs into an existing Umbraco 18 site as one NuGet package:
dotnet add package PackageGarden.LicenseGenerator --version 2.1.0
The license manager packages are unlisted on nuget.org (they don't appear in search), so
always install an exact version. It brings PackageGarden.LicenseGenerator.Core (the
server side), which contains the validator assembly. Nothing else is needed: no files to
copy, no scripts to run.
On the first start of the site:
- The license manager creates its three tables in the site's database
(
PackageGardenLicensing_Product,PackageGardenLicensing_License,PackageGardenLicensing_LicenseDomainOrIp). Later versions update them the same way on start. If this fails, the error is logged, the site keeps running and the next start tries again. - The Administrators user group gets access to the Licensing section. This happens once; removing the section from the group later is kept.
Log in as an administrator and open Licensing. To give other users access, add the Licensing section to their user group under Users > User groups.
Licenses are assigned to existing Umbraco members by email, so make sure the customers exist in the Members section. Continue with the Backoffice Guide.
Uninstalling the package leaves the tables and their data in place.