From 7f71312f5ed65ee00b47ca4b0023e3c088e63684 Mon Sep 17 00:00:00 2001 From: Gary Ewan Park Date: Fri, 7 Oct 2022 08:16:20 +0100 Subject: [PATCH] (doc) Use full option names Based on feedback from this issue: https://github.com/chocolatey/choco/issues/2850 --- input/en-us/agent/setup.md | 10 +++---- .../en-us/central-management/setup/client.md | 2 +- .../en-us/central-management/setup/website.md | 4 +-- input/en-us/choco/release-notes.md | 4 +-- input/en-us/choco/setup.md | 4 +-- .../create/create-packages-quick-start.md | 6 ++--- input/en-us/create/create-packages.md | 10 +++---- .../features/install-directory-override.md | 2 +- input/en-us/features/package-reducer.md | 10 +++---- .../packages-to-programs.md | 2 +- .../package-synchronization/sync-command.md | 2 +- input/en-us/features/package-throttle.md | 4 +-- input/en-us/features/private-cdn.md | 6 ++--- input/en-us/features/virus-check.md | 22 ++++++++-------- .../parse-packageparameters-argument.md | 2 +- .../organizational-deployment-guide.md | 26 +++++++++---------- input/en-us/guides/usage/change-cache.md | 2 +- ...install-upgrade-package-without-scripts.md | 10 +++---- .../usage/proxy-settings-for-chocolatey.md | 20 +++++++------- input/en-us/information/security.md | 2 +- .../en-us/licensed-extension/release-notes.md | 8 +++--- input/en-us/licensed-extension/setup.md | 8 +++--- .../quick-deployment/setup/internet-setup.md | 6 ++--- input/en-us/troubleshooting.md | 6 ++--- 24 files changed, 89 insertions(+), 89 deletions(-) diff --git a/input/en-us/agent/setup.md b/input/en-us/agent/setup.md index 5e528457f7..d1bdb4b464 100644 --- a/input/en-us/agent/setup.md +++ b/input/en-us/agent/setup.md @@ -82,7 +82,7 @@ To set Chocolatey in background mode, you need to run the following: * You also need to opt in sources in for self-service packages. See [choco source](xref:choco-command-source) (and `--allow-self-service`). You can also run `choco source -?` to get the help menu. * OPTIONAL (not recommended): Alternatively, you can allow any configured source to be used for self-service by running the following: `choco feature disable --name="'useBackgroundServiceWithSelfServiceSourcesOnly'"` (requires Chocolatey Extension v1.10.0+). We do not recommend this as it could be a security finding if you shut it off. * OPTIONAL (highly recommended): If you want self-service to apply only to non-administrators, run `choco feature enable --name="'useBackgroundServiceWithNonAdministratorsOnly'"` (requires Chocolatey Extension v1.11.1+). Do understand this means that a real non-administrator, not an administrator in a non-elevated UAC context (that scenario will go the normal route and will not go through background mode). -* OPTIONAL (varied recommendations): If you want to configure custom commands (not just install/upgrade), use something like `choco config set backgroundServiceAllowedCommands "install,upgrade,pin,sync"` (with the commands you want to allow, requires Chocolatey Extension v1.12.4+). See [commands consideration](#command-customization-consideration) below. +* OPTIONAL (varied recommendations): If you want to configure custom commands (not just install/upgrade), use something like `choco config set --name backgroundServiceAllowedCommands --value "install,upgrade,pin,sync"` (with the commands you want to allow, requires Chocolatey Extension v1.12.4+). See [commands consideration](#command-customization-consideration) below. * OPTIONAL (highly recommended): If you want to allow non-admins to uninstall packages, you can also restrict down to only the packages they have installed/upgraded. Run `choco feature enable --name="'allowBackgroundServiceUninstallsFromUserInstallsOnly'"` (requires Chocolatey Extension v2.0+). * OPTIONAL (highly recommended): For use with Chocolatey GUI, you need Chocolatey Extension v1.12.4+, and at least Chocolatey GUI v0.15.0. **Uninstall any version of the GUI you already have installed first**, then run `choco upgrade chocolateygui -y --allow-downgrade` (you will also need at least .NET 4.5.2 installed) * DOES NOT WORK WITH UAC, DO NOT USE UNTIL [FIX IS ANNOUNCED](https://groups.google.com/group/chocolatey-announce)! OPTIONAL (recommended if you use installers that are not completely silent): If you want self-service to interactively manage installations, run `choco feature enable --name="'useBackgroundServiceInteractively'"` (requires Chocolatey Extension v1.12.10+). This requires that you use the `ChocolateyLocalAdmin` account with the Chocolatey-managed password as passwords are not stored and the service would need to produce that at runtime. There are some security considerations and why this is not turned on by default. Please see [interactive self-service consideration](#interactive-self-service-consideration). @@ -101,7 +101,7 @@ choco feature disable --name="'showNonElevatedWarnings'" choco feature enable --name="'useBackgroundService'" choco feature enable --name="'useBackgroundServiceWithNonAdministratorsOnly'" # allow uninstalls as well: -#choco config set backgroundServiceAllowedCommands "install,upgrade,uninstall" +#choco config set --name backgroundServiceAllowedCommands --value "install,upgrade,uninstall" # restrict uninstalls to just packages the user has installed/upgraded (requires Chocolatey Extension v2.0+): #choco feature enable --name="'allowBackgroundServiceUninstallsFromUserInstallsOnly'" @@ -358,15 +358,15 @@ You can not pass custom source arguments to Chocolatey, it will error. You need > :memo: **NOTE** > -> If you have run `choco feature disable -n useBackgroundServiceWithSelfServiceSourcesOnly`, then all configured sources will be passed by the background service. +> If you have run `choco feature disable --name useBackgroundServiceWithSelfServiceSourcesOnly`, then all configured sources will be passed by the background service. ### I'm getting the following: "There are no sources enabled for packages and none were passed as arguments." This means you need to opt a source into self-service (new in Chocolatey Extension v1.10). -This just involves ensuring a source is set so that it allows self-service. To do this you run `choco source add -n name -s location <--other details need repeated> --allow-self-service`. Editing a source happens when the name is the same in `choco source add`. +This just involves ensuring a source is set so that it allows self-service. To do this you run `choco source add --name name --source location <--other details need repeated> --allow-self-service`. Editing a source happens when the name is the same in `choco source add`. -To change this behavior back to the way it was previously, simply run `choco disable -n useBackgroundServiceWithSelfServiceSourcesOnly`. For feature options, run `choco feature list` or see [Self-Service Feature Configuration](xref:configuration#self-service-background-mode) +To change this behavior back to the way it was previously, simply run `choco disable --name useBackgroundServiceWithSelfServiceSourcesOnly`. For feature options, run `choco feature list` or see [Self-Service Feature Configuration](xref:configuration#self-service-background-mode) ### I'm having trouble seeing packages on a file share source diff --git a/input/en-us/central-management/setup/client.md b/input/en-us/central-management/setup/client.md index 83e2d07cc0..b9db59ddcc 100644 --- a/input/en-us/central-management/setup/client.md +++ b/input/en-us/central-management/setup/client.md @@ -19,7 +19,7 @@ First you need Chocolatey Agent installed. As there may be some steps involved w At a minimum you need the following items set to be able to have a Chocolatey Agent be "opted-in" for both checking into Central Management and Deployments: ```powershell -choco config set CentralManagementServiceUrl https://:24020/ChocolateyManagementService +choco config set --name CentralManagementServiceUrl --value https://:24020/ChocolateyManagementService choco feature enable --name="'useChocolateyCentralManagement'" # Requires Chocolatey Licensed Extension v2.1.0+, Chocolatey-Agent v0.10.0+, and Chocolatey Central Management v0.2.0+: choco feature enable --name="'useChocolateyCentralManagementDeployments'" diff --git a/input/en-us/central-management/setup/website.md b/input/en-us/central-management/setup/website.md index cfc5d8b31a..13edc3cda7 100644 --- a/input/en-us/central-management/setup/website.md +++ b/input/en-us/central-management/setup/website.md @@ -30,8 +30,8 @@ The CCM Website is built on ASP.Net Core, and as such we need to ensure that it ### Script for some prerequisites ```powershell -choco install IIS-WebServer -s windowsfeatures --no-progress -y -choco install IIS-ApplicationInit -s windowsfeatures --no-progress -y +choco install IIS-WebServer --source windowsfeatures --no-progress -y +choco install IIS-ApplicationInit --source windowsfeatures --no-progress -y choco install dotnet-aspnetcoremodule-v2 --version 16.0.22108 --no-progress -y choco install dotnet-6.0-runtime --version 6.0.5 --no-progress -y choco install dotnet-6.0-aspnetruntime --version 6.0.5 --no-progress -y diff --git a/input/en-us/choco/release-notes.md b/input/en-us/choco/release-notes.md index cebb463e4b..479af69680 100644 --- a/input/en-us/choco/release-notes.md +++ b/input/en-us/choco/release-notes.md @@ -576,7 +576,7 @@ We've got a few possible breaking changes that could affect you, see what we've This also marks the first release that uses the [Chocolatey Software digital certificate for signing](https://github.com/chocolatey/choco/issues/1214) instead of the RealDimensions Software, LLC certificate. -Another major feature released in preview is [using remembered arguments on upgrade](https://github.com/chocolatey/choco/issues/797). This is in preview in 0.10.4 and will be turned to 'on' automatically in a future release. We are going to be continually making it better and won't turn it on by default until it is ready. If you want to turn it on and start using it, once you have 0.10.4 installed, run `choco feature enable -n useRememberedArgumentsForUpgrades`. You can also do this per command with `--use-remembered-arguments`. You can also turn it off per command with `--ignore-remembered-arguments`. We've also really described a lot of important considerations and thoughts related to using this so there are no surprises. Please do read the issue notes at length if you plan to use this feature to reduce confusion. +Another major feature released in preview is [using remembered arguments on upgrade](https://github.com/chocolatey/choco/issues/797). This is in preview in 0.10.4 and will be turned to 'on' automatically in a future release. We are going to be continually making it better and won't turn it on by default until it is ready. If you want to turn it on and start using it, once you have 0.10.4 installed, run `choco feature enable --name useRememberedArgumentsForUpgrades`. You can also do this per command with `--use-remembered-arguments`. You can also turn it off per command with `--ignore-remembered-arguments`. We've also really described a lot of important considerations and thoughts related to using this so there are no surprises. Please do read the issue notes at length if you plan to use this feature to reduce confusion. ### Breaking Changes @@ -873,7 +873,7 @@ You can also disable the feature `allowEmptyChecksumsSecure` to enforce checksum The "I got 99 problems, but a package manager ain't one" release. With the release of 0.9.10 (or if you prefer 0.9.10.0), we're about to make everything 100% better in your Windows package management world. We've addressed over 100 features and bugs in this release. We looked at how we could improve PowerShell and we've come out with a [competely internal host](https://github.com/chocolatey/choco/issues/8) that can Prompt and Read-Host in a way that times out and selects default values after a period of time. Speaking of PowerShell, how about some tab completion `choco ` to `choco install node`? How about never having to [close and reopen your shell again](https://github.com/chocolatey/choco/issues/664)? -Alternative sources (`-source webpi`, `-s windowsfeature`, etc) are back! I mean, am I right?! Have you heard of auto uninstaller? If Chocolatey has installed something that works with Programs and Features, Chocolatey knows how to uninstall it without an uninstall script about 90+% of the time. This feature was in beta for the 0.9.9 series, it is on by default in 0.9.10 (unless you disabled it after trying it, you will need to reenable it, see `choco feature` for more details). +Alternative sources (`-source webpi`, `--source windowsfeature`, etc) are back! I mean, am I right?! Have you heard of auto uninstaller? If Chocolatey has installed something that works with Programs and Features, Chocolatey knows how to uninstall it without an uninstall script about 90+% of the time. This feature was in beta for the 0.9.9 series, it is on by default in 0.9.10 (unless you disabled it after trying it, you will need to reenable it, see `choco feature` for more details). Here's one you probably never knew existed - extensions. Chocolatey has had the ability to extend itself by adding PowerShell modules for years, and most folks either didn't know it existed or have never used them. We've enhanced them a bit in preparation for the licensed version of Chocolatey. diff --git a/input/en-us/choco/setup.md b/input/en-us/choco/setup.md index 7a544aae97..44ba5537c7 100644 --- a/input/en-us/choco/setup.md +++ b/input/en-us/choco/setup.md @@ -115,7 +115,7 @@ Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManage ### Completely offline install -With completely offline use of Chocolatey, you want to ensure you remove the default community package source (`choco source list` followed by `choco source remove -n chocolatey`, or however you would do that with a configuration manager [like Puppet](https://forge.puppet.com/puppetlabs/chocolatey#sources-configuration)). +With completely offline use of Chocolatey, you want to ensure you remove the default community package source (`choco source list` followed by `choco source remove --name chocolatey`, or however you would do that with a configuration manager [like Puppet](https://forge.puppet.com/puppetlabs/chocolatey#sources-configuration)). 1. The first step with offline is to obtain a copy of the Chocolatey Nupkg (nupkg files are just fancy zip files). Go to https://community.chocolatey.org/packages/chocolatey and find a version you want. 1. Click on Download to download that version's nupkg file. @@ -422,7 +422,7 @@ Here's an example of setting Chocolatey up with Puppet that sets up and configur * Download the chocolatey.nupkg from the community repository - [download the latest chocolatey nupkg](https://community.chocolatey.org/api/v2/package/chocolatey) or see [Completely offline install](#completely-offline-install) to get an older version. * Optionally download the chocolatey.server package from the community repository - [download the latest chocolatey.server nupkg](https://community.chocolatey.org/api/v2/package/chocolatey.server). -* Use `choco push` to push those items to your internal package repository (e.g. `choco push chocolatey.0.10.7.nupkg -s http://internal_repo/ -k abc123`) +* Use `choco push` to push those items to your internal package repository (e.g. `choco push chocolatey.0.10.7.nupkg --source http://internal_repo/ --api-key abc123`) * Determine how to get the bare url to download the Chocolatey.Nupkg directly. You will need that for the internal url for installing Chocolatey offline. For the community repository, it is https://community.chocolatey.org/api/v2/package/chocolatey diff --git a/input/en-us/create/create-packages-quick-start.md b/input/en-us/create/create-packages-quick-start.md index 51f9ab9103..6f1d3a498a 100644 --- a/input/en-us/create/create-packages-quick-start.md +++ b/input/en-us/create/create-packages-quick-start.md @@ -41,13 +41,13 @@ Here's a TL;DR quick start version of the package creating tutorial. Follow thes * **Test the package** * **Testing should probably be done on a Virtual Machine** * In your package directory, use: - * `choco install package-name -s .` (package-name is the id element in the nuspec) + * `choco install package-name --source .` (package-name is the id element in the nuspec) * **Push the package** to the Chocolatey community package repository: * Get a Chocolatey account: * [Register](https://chocolatey.org/account/register) * Copy the API key from [your Chocolatey account](https://chocolatey.org/account). - * `choco apikey -k [API_KEY_HERE] -source https://push.chocolatey.org/` - * `choco push package-name.1.1.0.nupkg -s https://push.chocolatey.org/` - nupkg file can be ommitted if it is the only one in the directory. + * `choco apikey --api-key [API_KEY_HERE] -source https://push.chocolatey.org/` + * `choco push package-name.1.1.0.nupkg --source https://push.chocolatey.org/` - nupkg file can be omitted if it is the only one in the directory. ## Common Mistakes diff --git a/input/en-us/create/create-packages.md b/input/en-us/create/create-packages.md index a0c12cd290..0798464b68 100644 --- a/input/en-us/create/create-packages.md +++ b/input/en-us/create/create-packages.md @@ -383,7 +383,7 @@ Open a command line in the directory where the nuspec is and type [`choco pack`] To test the package you just built, open a command line shell and navigate to the directory where the `*.nupkg` file is located. Then type: ~~~powershell -choco install packageName -dv -s . +choco install packageName --debug --verbose --source . ~~~~ This will install the package right out of your source. As you find things you may need to fix, using `--force` (`-f`) will remove and reinstall the package from the updated `*.nupkg`. If you are specifically testing `chocolateyBeforeModify.ps1`, you need to be testing upgrade and uninstall scenarios. You need to install a version of the package with this file **first** as before modify is like uninstall, it runs from the installed package, not the package you are installing (like `chocolateyInstall.ps1` does). @@ -394,7 +394,7 @@ This will install the package right out of your source. As you find things you m > :memo: **NOTE** > -> If you are using a Semver dash in your package version (such as 1.0.0-beta), you will need to use the `-pre` switch or else you will get *Unable to find package* errors from `choco install`. You can also specify `-version 1.0.0-beta` to try to install that exact version. +> If you are using a Semver dash in your package version (such as 1.0.0-beta), you will need to use the `--pre` switch or else you will get *Unable to find package* errors from `choco install`. You can also specify `-version 1.0.0-beta` to try to install that exact version. `.` points to the current directory. You can specify multiple directories separated by a semicolon; @@ -407,7 +407,7 @@ When your `nuspec` specifies dependencies that are not in your source, you shoul ~~~ You'll need to append the API path like so: -`-source "'.;https://community.chocolatey.org/api/v2/'"` (note the double quotes bookending the apostrophes here, use `%cd%` in cmd.exe or `$pwd` in Powershell.exe if `.` doesn't resolve). See [passing options with quotes](xref:choco-commands#how-to-pass-options-switches). +`--source "'.;https://community.chocolatey.org/api/v2/'"` (note the double quotes bookending the apostrophes here, use `%cd%` in cmd.exe or `$pwd` in Powershell.exe if `.` doesn't resolve). See [passing options with quotes](xref:choco-commands#how-to-pass-options-switches). > :memo: **NOTE** > @@ -417,7 +417,7 @@ You can also use the `-debug` switch on `choco install` to provide more informat > :memo: **NOTE** > -> Do not call install with `.nupkg` - pointing to a file explicitly overrides source. You must call your install with the package name, not the nupkg file and location. You've already specified for choco to look in a local source with `-s "'.;https://community.chocolatey.org/api/v2/'"`. Call `choco install dude -s "'.;https://community.chocolatey.org/api/v2/'"`, not `choco install .\dude.nupkg -s "'.;https://community.chocolatey.org/api/v2/'"`. +> Do not call install with `.nupkg` - pointing to a file explicitly overrides source. You must call your install with the package name, not the nupkg file and location. You've already specified for choco to look in a local source with `--source "'.;https://community.chocolatey.org/api/v2/'"`. Call `choco install dude --source "'.;https://community.chocolatey.org/api/v2/'"`, not `choco install .\dude.nupkg --source "'.;https://community.chocolatey.org/api/v2/'"`. ### Alternative testing strategy You can also type `choco install -fdv path/to/nuspec` and choco will build the nupkg and attempt to install it. @@ -428,7 +428,7 @@ You can also type `choco install -fdv path/to/nuspec` and choco will build the n ## Push Your Package -To push your package after you have built and tested it, you type `choco push packageName.nupkg -s sourceLocation` where *packageName.nupkg* is the name of the nupkg that was built with a version number as part of the package name and *sourceLocation* is the location of the source you want to push to (e.g. `-s https://push.chocolatey.org/` for chocolatey's community feed). You must have an API key for https://push.chocolatey.org/ set. Take a look at [choco push](xref:choco-command-push) +To push your package after you have built and tested it, you type `choco push packageName.nupkg --source sourceLocation` where *packageName.nupkg* is the name of the nupkg that was built with a version number as part of the package name and *sourceLocation* is the location of the source you want to push to (e.g. `--source https://push.chocolatey.org/` for chocolatey's community feed). You must have an API key for https://push.chocolatey.org/ set. Take a look at [choco push](xref:choco-command-push) ## Automatic packaging? Yes - [Automatic Packaging](xref:automatic-packaging) diff --git a/input/en-us/features/install-directory-override.md b/input/en-us/features/install-directory-override.md index 844fec81a6..7643f4dee9 100644 --- a/input/en-us/features/install-directory-override.md +++ b/input/en-us/features/install-directory-override.md @@ -29,7 +29,7 @@ Override Install Directory - One Switch, All Installers - Chocolatey for Business (and Pro) can override the installation directory for compatible installer types automatically. - Save countless hours determining installers, their switches and the correct way to pass those switches. -The image shows installing 1password with Chocolatey for Business. The command passed is `choco install 1password -s . -y --dir c:\1password`, then shows that Chocolatey automatically determines the installer requires `/DIR="c:\1password"` and installs it to the proper location. +The image shows installing 1password with Chocolatey for Business. The command passed is `choco install 1password --source . -y --dir c:\1password`, then shows that Chocolatey automatically determines the installer requires `/DIR="c:\1password"` and installs it to the proper location. --> ## See It In Action diff --git a/input/en-us/features/package-reducer.md b/input/en-us/features/package-reducer.md index ebfcaaa6dc..8fa5a49680 100644 --- a/input/en-us/features/package-reducer.md +++ b/input/en-us/features/package-reducer.md @@ -55,8 +55,8 @@ So the space usage impact changes to what you'd normally experience outside of C To turn on Package Reducer, you need to run the following: * `choco upgrade chocolatey.extension ` -* `choco feature enable -n reduceInstalledPackageSpaceUsage` -* If you want to limit to just nupkg files being reduced and not automatically removing zips and installers, run the following: `choco feature enable -n reduceOnlyNupkgSize` +* `choco feature enable --name reduceInstalledPackageSpaceUsage` +* If you want to limit to just nupkg files being reduced and not automatically removing zips and installers, run the following: `choco feature enable --name reduceOnlyNupkgSize` ### See It In Action @@ -126,19 +126,19 @@ It just works. When you install or upgrade a package, it will automatically redu #### How do I turn this feature on? -* Globally - `choco feature enable -n reduceInstalledPackageSpaceUsage` +* Globally - `choco feature enable --name reduceInstalledPackageSpaceUsage` * Per command - use the option `--reduce-package-size` with install/upgrade commands. #### How do I turn this feature off? -* Globally - `choco feature disable -n reduceInstalledPackageSpaceUsage` +* Globally - `choco feature disable --name reduceInstalledPackageSpaceUsage` * Per command - use the option `--no-reduce-package-size` with install/upgrade commands. #### Can I just deflate nupkg file sizes? Yes! -* Globally - `choco feature disable -n reduceInstalledPackageSpaceUsage` +* Globally - `choco feature disable --name reduceInstalledPackageSpaceUsage` * Per command - use the option `--reduce-nupkg-only` with install/upgrade commands. #### Can I apply reducer to already installed packages? diff --git a/input/en-us/features/package-synchronization/packages-to-programs.md b/input/en-us/features/package-synchronization/packages-to-programs.md index dab184dfe5..7bb4672f99 100644 --- a/input/en-us/features/package-synchronization/packages-to-programs.md +++ b/input/en-us/features/package-synchronization/packages-to-programs.md @@ -34,7 +34,7 @@ This image shows a display of `choco list -lo` side by side with Programs and Fe ### Setup -* `choco feature enable -n showAllPackagesInProgramsAndFeatures` +* `choco feature enable --name showAllPackagesInProgramsAndFeatures` ### Options and Switches diff --git a/input/en-us/features/package-synchronization/sync-command.md b/input/en-us/features/package-synchronization/sync-command.md index 5fa3bf488a..fa9176ddb3 100644 --- a/input/en-us/features/package-synchronization/sync-command.md +++ b/input/en-us/features/package-synchronization/sync-command.md @@ -19,7 +19,7 @@ To synchronize your system, Simply call `choco sync` and Chocolatey will ensure At 1.9.0, sync is in preview. You need to turn it on by enabling the feature `allowPreviewFeatures`: -* `choco feature enable -n allowPreviewFeatures` +* `choco feature enable --name allowPreviewFeatures` ### See it in action diff --git a/input/en-us/features/package-throttle.md b/input/en-us/features/package-throttle.md index 952338de44..50c93a33f8 100644 --- a/input/en-us/features/package-throttle.md +++ b/input/en-us/features/package-throttle.md @@ -79,10 +79,10 @@ Package Throttle only works for resources downloaded with built-in Chocolatey Po ### How do I turn this feature on? -* Globally - `choco config set maximumDownloadRateBitsPerSecond ` +* Globally - `choco config set --name maximumDownloadRateBitsPerSecond --value ` * Per command - use the option `--max-download-bits-per-second="''"` with install/upgrade commands. ### How do I turn this feature off? -* Globally - `choco config unset maximumDownloadRateBitsPerSecond` +* Globally - `choco config unset --name maximumDownloadRateBitsPerSecond` * Per command - don't specify the `--max-download-bits-per-second` option (and don't have the config set) or `--max-download-bits-per-second="'0'"` if you want to temporarily disable it but keep the config setting. diff --git a/input/en-us/features/private-cdn.md b/input/en-us/features/private-cdn.md index c2e96d4328..95e1e64086 100644 --- a/input/en-us/features/private-cdn.md +++ b/input/en-us/features/private-cdn.md @@ -20,7 +20,7 @@ If you have questions or **prefer to opt out**, please [contact us](https://choc ## Usage -This is mostly automatic, but in case the feature is turned off, you may turn it on by setting the feature `downloadCache` (`choco feature enable -n downloadCache`). +This is mostly automatic, but in case the feature is turned off, you may turn it on by setting the feature `downloadCache` (`choco feature enable --name downloadCache`). To see if a package has content cached on the CDN, you can run `choco info packagename` and it will give you detailed information pertaining to a package. @@ -64,12 +64,12 @@ When you install packages from the community repository and a private cache beco ### How do I turn this feature on? -* Globally - `choco feature enable -n downloadCache` +* Globally - `choco feature enable --name downloadCache` * Per command - use the switch `--use-download-cache` with install/upgrade commands. ### How do I turn this feature off? -* Globally - `choco feature disable -n downloadCache` +* Globally - `choco feature disable --name downloadCache` * Per command - use the switch `--skip-download-cache` with install/upgrade commands. ### Is the content modified? diff --git a/input/en-us/features/virus-check.md b/input/en-us/features/virus-check.md index 24f9d73a27..2481a7f16a 100644 --- a/input/en-us/features/virus-check.md +++ b/input/en-us/features/virus-check.md @@ -30,14 +30,14 @@ By default, the virus scanner is already enabled and set to VirusTotal for Pro l > > If package contents are not recognized by VirusTotal they may be uploaded to be scanned, and be viewable in public. If you package internal components we do not recommend you enable this feature with the VirusTotal `virusScannerType`. - * `choco config set virusScannerType VirusTotal` - * `choco feature enable -n virusCheck` + * `choco config set --name virusScannerType --value VirusTotal` + * `choco feature enable --name virusCheck` Because some scanners can be quite aggressive and may falsely identify a binary as a false positive for malware, Chocolatey CLI doesn't flag a binary until a certain number of scanners have identified the binary as malware. This number defaults to `5` in the configuration. This means 5 anti-virus scanners need to flag the binary for Chocolatey CLI to stop and fail the install or upgrade. You can adjust this value in two ways, by adjusting the configuration and per Chocolatey CLI command. To adjust the configuration value, which will globally set the number, please run the following replacing `##` with the value you want as a minimum: - * `choco config set virusCheckMinimumPositives ##` + * `choco config set --name virusCheckMinimumPositives --value ##` If you need to override the minimum number of positives just for one install or upgrade, you can do that by passing `--virus-positives-minimum=VALUE` with your install or upgrade commands. @@ -50,11 +50,11 @@ Then you will get the same benefit of runtime virus checking as an added benefit If you need to configure the virus scanner to use your built-in anti-virus solution, please run the following two commands: - * `choco config set virusScannerType Generic` - * `choco config set genericVirusScannerPath "full path to av command line"` - * `choco config set genericVirusScannerArgs "[[File]]"` - * `choco config set genericVirusScannerValidExitCodes "0, ##"` - * `choco feature enable -n virusCheck` + * `choco config set --name virusScannerType --value Generic` + * `choco config set --name genericVirusScannerPath --value "full path to av command line"` + * `choco config set --name genericVirusScannerArgs --value "[[File]]"` + * `choco config set --name genericVirusScannerValidExitCodes --value "0, ##"` + * `choco feature enable --name virusCheck` The `genericVirusScannerPath` should be the full path to the anti-virus command line executable. What we are looking for is the command line interface to the scanner. @@ -123,19 +123,19 @@ When you install a package that download content, those items will automatically > > If package contents are not recognized by VirusTotal they may be uploaded to be scanned, and be viewable in public. If you package internal components we do not recommend you enable this feature with the VirusTotal `virusScannerType`. -* Globally - `choco feature enable -n virusCheck` +* Globally - `choco feature enable --name virusCheck` * Per command - use the switch `--virus-check` with install/upgrade commands. You need to provide additional configuration if you are using the Generic virus scanner. ### How do I turn this feature off? -* Globally - `choco feature disable -n virusCheck` +* Globally - `choco feature disable --name virusCheck` * Per command - use the switch `--skip-virus-check` with install/upgrade commands. ### How do I override the minium number of positives? -* Globally - `choco config set virusCheckMinimumPositives ` +* Globally - `choco config set --name virusCheckMinimumPositives --value ` * Per command - use the option `--virus-positives-minimum=` with install/upgrade commands. ### How does the VirusTotal integration work? diff --git a/input/en-us/guides/create/parse-packageparameters-argument.md b/input/en-us/guides/create/parse-packageparameters-argument.md index 664cad9d82..1c44fd9a83 100644 --- a/input/en-us/guides/create/parse-packageparameters-argument.md +++ b/input/en-us/guides/create/parse-packageparameters-argument.md @@ -267,7 +267,7 @@ choco install --params "'/key:value key2:value'" > :memo: **NOTE** > -> `` is synonymous with the value you put in the nuspec `` field. It is NEVER `name.version.nupkg` or `name.nuspec`. If you are testing a package locally, always use `choco install -d -s .`. That is a literal `-s .` (set source to local folder where the compiled nupkg is located), unless you have a dependency on another package, then use `-s "'.;other feeds here'"` - when you override the source (`--source` or `-s`), it means use ONLY this source for resolving packages. +> `` is synonymous with the value you put in the nuspec `` field. It is NEVER `name.version.nupkg` or `name.nuspec`. If you are testing a package locally, always use `choco install --debug --verbose --source .`. That is a literal `--source .` (set source to local folder where the compiled nupkg is located), unless you have a dependency on another package, then use `--source "'.;other feeds here'"` - when you override the source (`--source` or `-s`), it means use ONLY this source for resolving packages. Now, in this example, if we were to call: diff --git a/input/en-us/guides/organizations/organizational-deployment-guide.md b/input/en-us/guides/organizations/organizational-deployment-guide.md index 9147982040..3cc2d6dd35 100644 --- a/input/en-us/guides/organizations/organizational-deployment-guide.md +++ b/input/en-us/guides/organizations/organizational-deployment-guide.md @@ -132,8 +132,8 @@ From the machine with internet access: > It is normal to see an error at this point, the next steps which install the extension resolve this. 1. C4B / MSP / C4BTRIAL: Run `choco upgrade chocolatey.extension -y`. You will see what looks like an error message about not having chocolatey.extension installed. That's a warning and should clear up when this command completes. 1. Run `choco` - you should no longer see the error about not having chocolatey.extension installed. If you do, please circle back and use copy/paste for instructions as you may have mistyped something. -1. Run `choco config set cacheLocation $env:ALLUSERSPROFILE\choco-cache`. This moves the TEMP location in scripts to use this and makes clean up more deterministic. -1. Run `choco config set commandExecutionTimeoutSeconds 14400`. This increases the timeout more than the default 45 minutes, you may wish to set it higher. +1. Run `choco config set --name cacheLocation --value $env:ALLUSERSPROFILE\choco-cache`. This moves the TEMP location in scripts to use this and makes clean up more deterministic. +1. Run `choco config set --name commandExecutionTimeoutSeconds --value 14400`. This increases the timeout more than the default 45 minutes, you may wish to set it higher. 1. C4B / MSP / C4BTRIAL: Run `choco feature enable --name="'internalizeAppendUseOriginalLocation'"`. This sets Package Internalizer to append `-UseOriginalLocation` to the end of `Install-ChocolateyPackage` to make it behave more like `Install-ChocolateyInstallPackage`. Since the files are local, we won't need it copying them to temp prior to running it. 1. C4B / MSP / C4BTRIAL: Run `choco feature enable --name="'reduceInstalledPackageSpaceUsage'"` to ensure Package Reducer is turned on. 1. Set proxy configuration, virus scan configuration, or other configuration as described at [Chocolatey configuration](xref:configuration). @@ -188,8 +188,8 @@ choco upgrade chocolatey.extension -y --pre Write-Host "If you see what looks like an error about a missing extension, that is what this step does so it will clear up on the next command." # Set Configuration -choco config set cacheLocation $env:ALLUSERSPROFILE\choco-cache -choco config set commandExecutionTimeoutSeconds 14400 +choco config set --name cacheLocation --value $env:ALLUSERSPROFILE\choco-cache +choco config set --name commandExecutionTimeoutSeconds --value 14400 #TODO: Add other items you would configure here # https://docs.chocolatey.org/en-us/configuration @@ -239,8 +239,8 @@ Now that we've finished the first exercise and have those files over on our offl 1. C4B / MSP / C4BTRIAL: Copy the license file ("chocolatey.license.xml") into that folder that was just created. Run `Copy-Item "$env:SystemDrive\choco-setup\files\chocolatey.license.xml" $env:ChocolateyInstall\license\chocolatey.license.xml -Force`. 1. C4B / MSP / C4BTRIAL: Run `choco source disable --name="'chocolatey.licensed'"`. When the license is placed, Chocolatey automatically adds the license and we don't want to use that source. Note we can't remove the license because the existence of the license file will have Chocolatey adding it right back - so we just disable it. You will see what looks like an error message about not having chocolatey.extension installed. That's a warning and we are going to take care of that in the next step. 1. C4B / MSP / C4BTRIAL: Run `choco upgrade chocolatey.extension -y --pre`. You will see what looks like an error message about not having chocolatey.extension installed. That's a warning and should clear up when this command completes. -1. Run `choco config set cacheLocation $env:ALLUSERSPROFILE\choco-cache`. This moves the TEMP location in scripts to use this and makes clean up more deterministic. -1. Run `choco config set commandExecutionTimeoutSeconds 14400`. This increases the timeout more than the default 45 minutes, you may wish to set it higher. +1. Run `choco config set --name cacheLocation --value $env:ALLUSERSPROFILE\choco-cache`. This moves the TEMP location in scripts to use this and makes clean up more deterministic. +1. Run `choco config set --name commandExecutionTimeoutSeconds --value 14400`. This increases the timeout more than the default 45 minutes, you may wish to set it higher. 1. C4B / MSP / C4BTRIAL: Run `choco feature enable --name="'internalizeAppendUseOriginalLocation'"`. This sets Package Internalizer to append `-UseOriginalLocation` to the end of `Install-ChocolateyPackage` to make it behave more like `Install-ChocolateyInstallPackage`. Since the files are local, we won't need it copying them to temp prior to running it. 1. C4B / MSP / C4BTRIAL: Run `choco feature enable --name="'reduceInstalledPackageSpaceUsage'"` to ensure Package Reducer is turned on. 1. Set proxy configuration, virus scan configuration, or other configuration as described at [Chocolatey configuration](xref:configuration). @@ -272,8 +272,8 @@ Write-Host "You can ignore the red text in the output above, as it is more of a choco upgrade chocolatey.extension -y --pre # Set Configuration -choco config set cacheLocation $env:ALLUSERSPROFILE\choco-cache -choco config set commandExecutionTimeoutSeconds 14400 +choco config set --name cacheLocation --value $env:ALLUSERSPROFILE\choco-cache +choco config set --name commandExecutionTimeoutSeconds --value 14400 #TODO: Add other items you would configure here # https://docs.chocolatey.org/en-us/configuration @@ -408,7 +408,7 @@ We won't go into how to set up a distribution point, as you have places to learn ## Exercise 3: Add Packages To The Repository 1. Now we need to get the packages we have in `c:\choco-setup\packages` to the package repository. With Chocolatey.Server, we can cheat a little and simply copy the nupkg files to `$env:ChocolateyToolsLocation\Chocolatey.Server\App_Data\Packages`. -1. If we are using a different repository, we just need to run `choco push -s http:// -k ` +1. If we are using a different repository, we just need to run `choco push --source http:// --api-key ` > :memo: **NOTE** > @@ -583,8 +583,8 @@ Starting with Chocolatey.Server v0.2.3, you get a similar experience where you j 1. C4B / MSP / C4BTRIAL: Install the license package we've pushed - `choco upgrade chocolatey-license -y`. This may be a place you see an error if things are not configured correctly. If you run into an error, be sure that you have the source added properly with the right permissions (not api key - that is for pushes only). 1. C4B / MSP / C4BTRIAL: Run `choco source disable --name="'chocolatey.licensed'"`. When the license is placed, Chocolatey automatically adds the license and we don't want to use that source. Note we can't remove the license because the existence of the license file will have Chocolatey adding it right back - so we just disable it. You will see what looks like an error message about not having chocolatey.extension installed. That's a warning and we are going to take care of that in the next step. 1. C4B / MSP / C4BTRIAL: Run `choco upgrade chocolatey.extension -y --pre`. You will see what looks like an error message about not having chocolatey.extension installed. That's a warning and should clear up when this command completes. -1. Run `choco config set cacheLocation $env:ALLUSERSPROFILE\choco-cache`. This moves the TEMP location in scripts to use this and makes clean up more deterministic. -1. Run `choco config set commandExecutionTimeoutSeconds 14400`. This increases the timeout more than the default 45 minutes, you may wish to set it higher. +1. Run `choco config set --name cacheLocation --value $env:ALLUSERSPROFILE\choco-cache`. This moves the TEMP location in scripts to use this and makes clean up more deterministic. +1. Run `choco config set --name commandExecutionTimeoutSeconds --value 14400`. This increases the timeout more than the default 45 minutes, you may wish to set it higher. 1. C4B / MSP / C4BTRIAL: Run `choco feature enable --name="'internalizeAppendUseOriginalLocation'"`. This sets Package Internalizer to append `-UseOriginalLocation` to the end of `Install-ChocolateyPackage` to make it behave more like `Install-ChocolateyInstallPackage`. Since the files are local, we won't need it copying them to temp prior to running it. 1. C4B / MSP / C4BTRIAL: Run `choco feature enable --name="'reduceInstalledPackageSpaceUsage'"` to ensure Package Reducer is turned on. 1. Set proxy configuration, virus scan configuration, or other configuration as described at [Chocolatey configuration](xref:configuration). @@ -637,8 +637,8 @@ Write-Host "You can ignore the red text in the output above, as it is more of a choco upgrade chocolatey.extension -y --pre # Set Configuration -choco config set cacheLocation $env:ALLUSERSPROFILE\choco-cache -choco config set commandExecutionTimeoutSeconds 14400 +choco config set --name cacheLocation --value $env:ALLUSERSPROFILE\choco-cache +choco config set --name commandExecutionTimeoutSeconds --value 14400 #TODO: Add other items you would configure here # https://docs.chocolatey.org/en-us/configuration diff --git a/input/en-us/guides/usage/change-cache.md b/input/en-us/guides/usage/change-cache.md index b1294f21ae..cced0263eb 100644 --- a/input/en-us/guides/usage/change-cache.md +++ b/input/en-us/guides/usage/change-cache.md @@ -12,4 +12,4 @@ By default Chocolatey uses the Temp Folder for downloads. However that is someti If you are on less than [0.9.9.9](https://docs.chocolatey.org/en-us/choco/release-notes#october-2-2015), you will need to do that manually by opening the config file located at `$env:ChocolateyInstall\config\chocolatey.config` and changing the `cacheLocation` value. -If you are on 0.9.9.9 and above you can simple use `choco config set cacheLocation fullPath`. See [Config](xref:choco-command-config) for more details. +If you are on 0.9.9.9 and above you can simple use `choco config set --name cacheLocation --value fullPath`. See [Config](xref:choco-command-config) for more details. diff --git a/input/en-us/guides/usage/install-upgrade-package-without-scripts.md b/input/en-us/guides/usage/install-upgrade-package-without-scripts.md index 943cc9c2bc..a1917bc3e3 100644 --- a/input/en-us/guides/usage/install-upgrade-package-without-scripts.md +++ b/input/en-us/guides/usage/install-upgrade-package-without-scripts.md @@ -47,7 +47,7 @@ Consider the following scenario: Your command could be -`choco install firefox -n -y --version 1.0.0` +`choco install firefox --skip-automation-scripts -y --version 1.0.0` **Recommendation**: You should try to just install the package first and see what happens. In some cases the package may do additional things like update the path or do some helpful configuration for you (although this is not usually the case). If it fails or doesn't work, you can always fall back to skipping the install script as in the command above. @@ -72,7 +72,7 @@ Consider the following scenario: Your command could be: -`choco install firefox -n -y --version 1.8.0` +`choco install firefox --skip-automation-scripts -y --version 1.8.0` **Recommendation**: Ask the maintainer to update the package. Don't allow choco to know about an older version of a package. If the maintainer provides an update of 1.9.0 without also providing an update at or above your currently installed version, running upgrade later may put your installed software down to the version that is installed by the package. This is definitely not a situation you want to be in. @@ -92,7 +92,7 @@ Consider the following scenario: You should run -`choco pin add -n=googlechrome` +`choco pin add --name=googlechrome` For more information see [Pin Command](xref:choco-command-pin). @@ -125,6 +125,6 @@ See [Community Feed has a version older than your version](#community-feed-has-a **Additional Recommendation**: You may also want to bump it to 1.8.0 using the skip argument (`-n`) and then promptly [pin](xref:choco-command-pin) the package until a newer version is available. ~~~ -choco upgrade firefox -n -y --version 1.8.0 -choco pin add -n=firefox +choco upgrade firefox --name -y --version 1.8.0 +choco pin add --name=firefox ~~~ diff --git a/input/en-us/guides/usage/proxy-settings-for-chocolatey.md b/input/en-us/guides/usage/proxy-settings-for-chocolatey.md index ea7693dd32..db45cb9ff3 100644 --- a/input/en-us/guides/usage/proxy-settings-for-chocolatey.md +++ b/input/en-us/guides/usage/proxy-settings-for-chocolatey.md @@ -75,11 +75,11 @@ Chocolatey has explicit proxy support starting with 0.9.9.9. You can simply configure 1 up to 5 settings and Chocolatey will use a proxy server. `proxy` is required and is the location and port of the proxy server. The values for user/password are only used for credentials when both are present. ~~~sh -choco config set proxy -choco config set proxyUser #optional -choco config set proxyPassword # optional -choco config set proxyBypassList "''" # optional, Chocolatey v0.10.4 required -choco config set proxyBypassOnLocal true # optional, Chocolatey v0.10.4 required +choco config set --name proxy --value +choco config set --name proxyUser --value #optional +choco config set --name proxyPassword --value # optional +choco config set --name proxyBypassList --value "''" # optional, Chocolatey v0.10.4 required +choco config set --name proxyBypassOnLocal --value true # optional, Chocolatey v0.10.4 required ~~~~ ### Example @@ -87,11 +87,11 @@ choco config set proxyBypassOnLocal true # optional, Chocolatey v0.10.4 required Running the following commands in 0.9.9.9: ~~~sh -choco config set proxy http://localhost:8888 -choco config set proxyUser bob -choco config set proxyPassword 123Sup#rSecur3 -choco config set proxyBypassList "'http://localhost,http://this.location/'" #0.10.4 required -choco config set proxyBypassOnLocal true #0.10.4 required +choco config set --name proxy --value http://localhost:8888 +choco config set --name proxyUser --value bob +choco config set --name proxyPassword --value 123Sup#rSecur3 +choco config set --name proxyBypassList --value "'http://localhost,http://this.location/'" #0.10.4 required +choco config set --name proxyBypassOnLocal --value true #0.10.4 required ~~~ Results in the following items being added to the config file: diff --git a/input/en-us/information/security.md b/input/en-us/information/security.md index 170bff26e9..3812b85975 100644 --- a/input/en-us/information/security.md +++ b/input/en-us/information/security.md @@ -248,7 +248,7 @@ These are things that used to be security concerns. They are listed here for his 1. ~~Anybody can put packages up on the community feed and they could be malicious~~ - we put package moderation in place in October 2014. All packages coming in are now moderated BEFORE they are open to the public. See [http://codebetter.com/robreynolds/2014/10/27/chocolatey-now-has-package-moderation/](http://codebetter.com/robreynolds/2014/10/27/chocolatey-now-has-package-moderation/) for more details. 1. ~~Downloads packages from S3 over HTTP (subject to DNS poisoning)~~ - this was corrected in March 2014 ([https://github.com/chocolatey/chocolatey.org/issues/70](https://github.com/chocolatey/chocolatey.org/issues/70)) 1. ~~Site doesn't require HTTPS (could be subject to DNS poisoning)~~ - [https://github.com/chocolatey/chocolatey.org/issues/126](https://github.com/chocolatey/chocolatey.org/issues/126) (closed completely in November 2014) -1. ~~Downloads files from the internet with no integrity check~~ - we've added checksumming in August 2014 and started enforcing it by default for non-secure downloads with 0.10.0 in August 2016. Secure downloads will also require checksums sometime in 2017 (but can be flipped on with `choco feature disable -n allowEmptyChecksumsSecure` or with a runtime switch). +1. ~~Downloads files from the internet with no integrity check~~ - we've added checksumming in August 2014 and started enforcing it by default for non-secure downloads with 0.10.0 in August 2016. Secure downloads will also require checksums sometime in 2017 (but can be flipped on with `choco feature disable --name allowEmptyChecksumsSecure` or with a runtime switch). 1. ~~Poor permissions with `c:\Chocolatey` at root (allows attacker to gain Admin perms through specially crafted exes dropped in bin folder, among other things)~~ - we don't install here by default any more. We install to `C:\ProgramData\chocolatey` by default for more secure permissions. The default location is locked down explicitly to Administrators starting in 0.9.10. ### What about a non-administrative installation of Chocolatey? Is it secure? diff --git a/input/en-us/licensed-extension/release-notes.md b/input/en-us/licensed-extension/release-notes.md index d64ade40be..6876464d78 100644 --- a/input/en-us/licensed-extension/release-notes.md +++ b/input/en-us/licensed-extension/release-notes.md @@ -642,19 +642,19 @@ This release brings Package Throttle, Package Synchronizer's "Show All Packages If you are using self-service functionality, when you upgrade to v1.10, you will need to go to those sources that you allow to be self-service and ensure they are selected to allow self-service (`choco source list`). Otherwise by default users are going to be locked out of using those sources. The move to opt-in is best from a security standpoint and we want to give you the ability to have folks opt-in to the better behavior. - To change this behavior back to the way it was previously, simply run `choco disable -n useBackgroundServiceWithSelfServiceSourcesOnly`. For more details see `choco feature list` or https://docs.chocolatey.org/en-us/configuration#self-service-background-mode + To change this behavior back to the way it was previously, simply run `choco disable --name useBackgroundServiceWithSelfServiceSourcesOnly`. For more details see `choco feature list` or https://docs.chocolatey.org/en-us/configuration#self-service-background-mode ### Features - Package Throttle - Throttle Bandwidth / Rate Limit Download Speeds - By default, Chocolatey downloads packages and resources as fast as it can. Package Throttle gives you a way to slow down Chocolatey so it doesn't overwhelm any bandwidth restrictions you may have. This is done as both a setting and per package install/upgrade. This is in bits per second (not bytes, bits is what most network traffic is measured in). When adding at runtime, simply add `--bps=VALUE`. To set the value in the configuration, call `choco config set maximumDownloadRateBitsPerSecond VALUE`. For more details see https://docs.chocolatey.org/en-us/features/package-reducer. + By default, Chocolatey downloads packages and resources as fast as it can. Package Throttle gives you a way to slow down Chocolatey so it doesn't overwhelm any bandwidth restrictions you may have. This is done as both a setting and per package install/upgrade. This is in bits per second (not bytes, bits is what most network traffic is measured in). When adding at runtime, simply add `--bps=VALUE`. To set the value in the configuration, call `choco config set --name maximumDownloadRateBitsPerSecond --value VALUE`. For more details see https://docs.chocolatey.org/en-us/features/package-reducer. - Package Synchronizer's Show All Packages In Programs and Features This means packages that do not have an underlying installation can still show up in Programs and Features and be managed there as well, which allows for legacy inventory reporting systems to see all the software that is installed in the same way that Chocolatey is able to. A picture can probably best explain this feature, check out [All Package In Programs and Features](/assets/images/features/features_packages_in_programs_and_features.png) - To turn this feature on, simply run the following command `choco feature enable -n showAllPackagesInProgramsAndFeatures`. For more details on the feature, see https://docs.chocolatey.org/en-us/configuration#package-synchronizer and https://docs.chocolatey.org/en-us/features/package-synchronization. This does require one additional run of `choco` to take affect (same when disabling the feature), hopefully we can remove that in the future. + To turn this feature on, simply run the following command `choco feature enable --name showAllPackagesInProgramsAndFeatures`. For more details on the feature, see https://docs.chocolatey.org/en-us/configuration#package-synchronizer and https://docs.chocolatey.org/en-us/features/package-synchronization. This does require one additional run of `choco` to take affect (same when disabling the feature), hopefully we can remove that in the future. - Package-less Install / Direct Installer - Install and upgrade directly from installers (MSIs, EXEs, etc)! @@ -788,7 +788,7 @@ This release brings the coveted PackageBuilder UI to the Pro+ license (minus aut ### Improvements -- User can turn on Preview Features - `choco feature enable -n allowPreviewFeatures` +- User can turn on Preview Features - `choco feature enable --name allowPreviewFeatures` - InstallDirectory switch added to Install-ChocolateyInstallPackage - Package Internalizer (Choco Download) - option to ignore dependencies `--ignore-dependencies` diff --git a/input/en-us/licensed-extension/setup.md b/input/en-us/licensed-extension/setup.md index 778217e2e4..5abdc6078d 100644 --- a/input/en-us/licensed-extension/setup.md +++ b/input/en-us/licensed-extension/setup.md @@ -140,7 +140,7 @@ You can even script this or add it to a CI job that would automatically make the > :warning: **WARNING** > -> The licensed source that is automatically added can be disabled, but it cannot be removed. So just run `choco source disable -n chocolatey.licensed` to disable it or set that up in your configuration management solution scripts. Some of them, like Puppet, have a resource dedicated strictly to this: +> The licensed source that is automatically added can be disabled, but it cannot be removed. So just run `choco source disable --name chocolatey.licensed` to disable it or set that up in your configuration management solution scripts. Some of them, like Puppet, have a resource dedicated strictly to this: ~~~puppet ## Disable the licensed source, it can't be removed @@ -167,7 +167,7 @@ Most organizations using Chocolatey and Puppet are going to do so with zero inte * `choco download chocolatey.server --source https://community.chocolatey.org/api/v2/` * `choco download chocolatey.extension --source https://licensedpackages.chocolatey.org/api/v2/ --ignore-dependencies` * `choco download chocolatey-agent --source https://licensedpackages.chocolatey.org/api/v2/ --ignore-dependencies` -* Use `choco push` to push those items to your internal package repository (e.g. `choco push chocolatey.0.10.7.nupkg -s http://internal_repo/ -k abc123`) +* Use `choco push` to push those items to your internal package repository (e.g. `choco push chocolatey.0.10.7.nupkg --source http://internal_repo/ --api-key abc123`) * Determine how to get the bare url to download the Chocolatey.Nupkg directly. You will need that for the internal url for installing Chocolatey offline. For the community repository, it is https://community.chocolatey.org/api/v2/package/chocolatey Here is what a completely offline use of Chocolatey looks like (complete with a Chocolatey.Server instance): @@ -384,7 +384,7 @@ This is used in conjunction with the script in [Set Up Licensed Edition With Pup Here are some additional commands and scripts you will need for that setup: * `choco download chocolatey-agent --source https://licensedpackages.chocolatey.org/api/v2/ --ignore-dependencies` -* Use `choco push` to push packages to your internal package repository (e.g. `choco push chocolatey-agent.0.8.0.nupkg -s http://internal_repo/ -k abc123`) +* Use `choco push` to push packages to your internal package repository (e.g. `choco push chocolatey-agent.0.8.0.nupkg --source http://internal_repo/ --api-key abc123`) ~~~puppet ## - Chocolatey Agent (Additional optional Chocolatey for Business install) - @@ -422,7 +422,7 @@ For setting up Self-Service / Background Mode, add the following elements: * `choco download chocolateygui --pre --source="'https://www.myget.org/F/chocolateygui/;https://chocolatey.org/api/v2'" --ignore-dependencies` * `choco download dotnet4.5.2 --internalize --source https://chocolatey.org/api/v2` -* Use `choco push` to push those items to your internal package repository (e.g. `choco push chocolatey.0.10.7.nupkg -s http://internal_repo/ -k abc123`) +* Use `choco push` to push those items to your internal package repository (e.g. `choco push chocolatey.0.10.7.nupkg --source http://internal_repo/ -api-key abc123`) ~~~puppet diff --git a/input/en-us/quick-deployment/setup/internet-setup.md b/input/en-us/quick-deployment/setup/internet-setup.md index 1bb03a7a2b..e17e36c939 100644 --- a/input/en-us/quick-deployment/setup/internet-setup.md +++ b/input/en-us/quick-deployment/setup/internet-setup.md @@ -303,7 +303,7 @@ Set-ExecutionPolicy Bypass -Scope Process -Force ; . C:\choco-setup\files\Set-QD The below command is an example; please adjust according to your FQDN, repository name, and user credential created: ```powershell - choco source add -n "'ChocolateyInternal'" -s "'https://chocoserver:8443/repository/ChocolateyInternal/'" --user='chocouser' --password='YOUR_PASSWORD' --allow-self-service + choco source add --name "'ChocolateyInternal'" --source "'https://chocoserver:8443/repository/ChocolateyInternal/'" --user='chocouser' --password='YOUR_PASSWORD' --allow-self-service ``` ## CCM Setup @@ -322,8 +322,8 @@ These salt additives should be at least 8 characters, and you will need to provi These are both configuration items that can be set using the `choco config` command, as shown in the example here: ```powershell -choco config set centralManagementClientCommunicationSaltAdditivePassword 'YourSuperSecureSalt1' -choco config set centralManagementServiceCommunicationSaltAdditivePassword 'YourSuperSecureSalt2' +choco config set --name centralManagementClientCommunicationSaltAdditivePassword --value 'YourSuperSecureSalt1' +choco config set --name centralManagementServiceCommunicationSaltAdditivePassword --value 'YourSuperSecureSalt2' ``` Further details on configuring CCM, and all available settings, can be found in the [Central Management Client Setup](xref:ccm-client#config-settings) documentation. diff --git a/input/en-us/troubleshooting.md b/input/en-us/troubleshooting.md index 8f830e8a4d..191dcd7d47 100644 --- a/input/en-us/troubleshooting.md +++ b/input/en-us/troubleshooting.md @@ -357,9 +357,9 @@ Also take a look at [Already referencing a newer version of 'packagename'](#alre By the way, calling install directly from a nupkg/nuspec can be an anti-pattern. Use it VERY rarely, like not at all if you can help it. - **Fix:** Stop pointing directly to the nupkg/nuspec. Call `choco install name -s .` instead. + **Fix:** Stop pointing directly to the nupkg/nuspec. Call `choco install name --source .` instead. -If you have determined all of this is good to go, take a look at what Chocolatey tells you when you run with `-dv --noop` and see how it is setting sources, etc. +If you have determined all of this is good to go, take a look at what Chocolatey tells you when you run with `--debug --verbose --noop` and see how it is setting sources, etc. ### Package not installed. The package was not found with the source(s) listed. @@ -373,7 +373,7 @@ If you have determined all of this is good to go, take a look at what Chocolatey * For your next step in troubleshooting, please see [403 unauthorized issues](#im-getting-a-403-unauthorized-issue-when-attempting-to-use-the-community-package-repository). -If you have determined all of this is good to go, take a look at what Chocolatey tells you when you run with `-dv --noop` and see how it is setting sources, etc. +If you have determined all of this is good to go, take a look at what Chocolatey tells you when you run with `--debug --verbose --noop` and see how it is setting sources, etc. ### Access to the path is denied.