Microservice express installation script switches

Control the behavior of the express installation script by supplying installation script switches. On the PowerShell command prompt, put a single hyphen (-) before a switch; on the Unix shell command prompt, put a double hyphen (--) before a switch, or a single hyphen if the switch is a short, one-letter version.

Overall switches

Switch nameShort version (Unix only)Description
help-hDisplays switches and example calls of the installation script
all-aInstalls all services (except for the Monitoring service)
install-iDoes one of the following:
  • On a Windows system: installs and starts services that are available in the folder specified under target-folder
  • On a Unix system: starts processes that are available in the folder specified under target-folder
services-location PATH-sThe location of the installation media Content Delivery\roles\ folder, where PATH is the path to that location. If you copied the entire installation media to your target machine and running the script from its original location, you can omit this switch.
license PATH-lThe folder location of the license file, where PATH is the path to the location.
target-folder PATH-tThe folder location in which you want to install the services, where PATH is the path to the location.

Individual microservice installation switches

Switch nameDescription
enable-discoveryEnables the installation of the Discovery Service
enable-deployerEnables the installation of the Content Deployer
enable-contentEnables the installation of the Content Service
enable-cidEnables the installation of the Contextual Image Delivery service
enable-contextEnables the installation of the Context Service
enable-previewEnables the installation of the Preview service
enable-sessionEnables the installation of the Session-enabled Content Service
enable-ugc-communityEnables the installation of the UGC Community Service
enable-ugc-moderationEnables the installation of the UGC Moderation Service
enable-monitoringEnables the installation of the Monitoring service

Microservice Capability URL switches

Only specify these switches if you want to make a microservice available on a different port or server IP address (the default is the IP address of localhost, represented in the table by IPOFLOCALHOST).

Switch nameDescriptionDefault if swtich is omitted
discovery-url URLSets the Web address of the Discovery Service to URLhttp://IPOFLOCALHOST:8082/disovery.svc
deployer-url CAPABILITY_URLSets the Web address of the Content Deployer Capability to CAPABILITY_URLhttp://IPOFLOCALHOST:8084/httupload
content-url CAPABILITY_URLSets the Web address of the Content Service Capability to CAPABILITY_URLhttp://IPOFLOCALHOST:8081/content.svc
cid-url CAPABILITY_URLSets the Web address of the Contextual Image Delivery service Capability to CAPABILITY_URLhttp://IPOFLOCALHOST:8088/cid
context-url CAPABILITY_URLSets the Web address of the Context Service Capability to CAPABILITY_URLhttp://IPOFLOCALHOST:8087/context.svc
preview-url CAPABILITY_URLSets the Web address of the Preview Service Capability to CAPABILITY_URLhttp://IPOFLOCALHOST:8083/ws/preview.svc
session-url CAPABILITY_URLSets the Web address of the Session-enabled Content Service Capability to CAPABILITY_URLhttp://IPOFLOCALHOST:8081/content.svc
token-url CAPABILITY_URLSets the Web address of the Token service to CAPABILITY_URLhttp://IPOFLOCALHOST:8082/token.svc
ugc-community-url CAPABILITY_URLSets the Web address of the UGC Community Service Capability to CAPABILITY_URLhttp://IPOFLOCALHOST:8085/community.svc
ugc-moderation-url CAPABILITY_URLSets the Web address of the UGC Moderation Service Capability to CAPABILITY_URLhttp://IPOFLOCALHOST:8086/moderation.svc

Maintenance switches

Switch nameDescription
auto-registerAutomatically registers the installed microservices as Capabilities
kill-servicesOn a Unix system, kills the SDL microservices
remove-servicesOn a Windows system, removes the SDL microservices (but does not delete the microservice resources)
clean-targetStops or uninstall all microservices and then cleans (wipes) the target directory