uSync.Commands.Server
10.0.0
See the version list below for details.
dotnet add package uSync.Commands.Server --version 10.0.0
NuGet\Install-Package uSync.Commands.Server -Version 10.0.0
<PackageReference Include="uSync.Commands.Server" Version="10.0.0" />
paket add uSync.Commands.Server --version 10.0.0
#r "nuget: uSync.Commands.Server, 10.0.0"
// Install uSync.Commands.Server as a Cake Addin #addin nuget:?package=uSync.Commands.Server&version=10.0.0 // Install uSync.Commands.Server as a Cake Tool #tool nuget:?package=uSync.Commands.Server&version=10.0.0
uSync.Commands.Server
uSycnc commands library for Umbraco.
This is the package to install on the Umbraco site to Enable the uSync command line to run against your site.
dotnet install package uSync.Commands.server
Note: this is the root command it doesn't include the uSync specific commands use uSync.Commands to also get them.
Configuration
By default the command line library is disabled for your site, to enable it you need to add values to the appsettings.json file for your site.
"uSync": {
"Commands": {
"Enabled": "hmac,basic",
"key": "HMAC-KEY-VALUE",
"UserId" : -1
}
}
Options
Enabled
Turns on the Authentication methods for the command line - acceptible values are hmac (key based) and basic (username and password based)
Key
The security key to use when using hmac (key based) authentication, this is the key that you would then need to use on the command line when running remote commands against your site.
usync run [command] https://you-site.com/umbraco -k <KEY-VALUE-HERE>
TIP: You can generate a key with the usync key-gen command
uSync key-gen
this will give you the correct config values to add the key to your site.
UserId
When using Key based authentication Umbraco will authenticate the commands against the default user (-1) unless you set the UserId value - this will then set the permissions for the user to be the same as for the user id you set.
Commands
the core commands included with this package.
info
return information about an umbraco installation
Ping
Ping a server until it is up (at least until Umbraco controllers respond).
Rebuild-DBCache
Rebuiold the database cache
Rebuild-Index
Rebuild an examine index on the server
Reload MemCache
Reload the in-memory cache of items
Test
Run a test command 10 times (test the looping of commands.)
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
-
net6.0
- Umbraco.Cms.Web.BackOffice (>= 10.0.1)
- uSync.Commands.Core (>= 10.0.0)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on uSync.Commands.Server:
Package | Downloads |
---|---|
uSync.Commands
uSync Command line - server Commands for uSync |
GitHub repositories
This package is not used by any popular GitHub repositories.
10.0 Initial release