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 name | Short version (Unix only) | Description |
|---|---|---|
help | -h or -? | Displays switches and example calls of the installation script |
docs | none | Explicitly specifies that you want to install microservices specifically for SDL Tridion Docs. When you use this switch, you must still specify the all or -a switch. |
all | -a | Installs all services for SDL Tridion Docs. This switch does not work on a Linux environment. When you use this switch, you must still specify the docs switch, or a specific list of microservices to install. |
dx | none | Explicitly specifies that you want to install all services for both SDL Tridion Sites and SDL Tridion Docs, including a special SDL Tridion DX version of the Content Deployer, which can work with both products. Select this option to support a content mashup implementation of both products. When you use this switch, you must still specify the all or -a switch. |
install | -i | Does one of the following:
|
services-folder PATH | -s | The 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. |
target-folder PATH | -t | The folder location in which you want to install the services, where PATH is the path to the location. |
environment-file | -e | The name of the Powershell script file that sets the values for express installation variables. Defaults to setenv.ps1 if not specified. |
Individual microservice installation switches
| Switch name | Description |
|---|---|
enable-discovery | Enables the installation of the Discovery Service |
enable-deployer | Enables the installation of the Content Deployer endpoint |
enable-deployer-combined | Enables the installation of the Content Deployer microservice containing both endpoint and worker |
enable-deployer-worker | Enables the installation of the Content Deployer worker |
enable-content | Enables the installation of the Content Service |
enable-cid | Enables the installation of the Contextual Image Delivery service |
enable-context | Enables the installation of the Context Service |
enable-iq-combined | Enables the installation of the Combined IQ Service (combining the IQ Query and IQ Index Services) |
enable-iq-index | Enables the installation of the IQ Index Service |
enable-iq-query | Enables the installation of the IQ Query Service |
enable-ugc-community | Enables the installation of the UGC Community Service (deprecated) |
enable-ugc-moderation | Enables the installation of the UGC Moderation Service (deprecated) |
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 name | Description | Default if switch is omitted |
|---|---|---|
discovery-url URL | Sets the web address of the Discovery Service to URL | http://IPOFLOCALHOST:8082/disovery.svc |
deployer-url CAPABILITY_URL | Sets the web address of the Content Deployer endpoint Capability, or of the combined Content Deployer Capability, to CAPABILITY_URL | http://IPOFLOCALHOST:8084/httupload |
deployer-worker-url WORKER_URL | Sets the web address of the Content Deployer worker to WORKER_URL. You only need this URL in an outscale scenario in which the Content Deployer endpoint is on a different machine than the Content Deployer worker. | http://IPOFLOCALHOST:8089 |
content-url CAPABILITY_URL | Sets the web address of the Content Service Capability to CAPABILITY_URL | http://IPOFLOCALHOST:8081/content.svc |
cid-url CAPABILITY_URL | Sets the web address of the Contextual Image Delivery service Capability to CAPABILITY_URL | http://IPOFLOCALHOST:8088/cid |
context-url CAPABILITY_URL | Sets the web address of the Context Service Capability to CAPABILITY_URL | http://IPOFLOCALHOST:8087/context.svc |
iq-index-url CAPABILITY_URL | Sets the web address of the IQ Index Service Capability to CAPABILITY_URL | http://IPOFLOCALHOST:8097/context.svc |
iq-query-url CAPABILITY_URL | Sets the web address of the IQ Query Service Capability to CAPABILITY_URL | http://IPOFLOCALHOST:8098/context.svc |
token-url CAPABILITY_URL | Sets the web address of the Token service to CAPABILITY_URL | http://IPOFLOCALHOST:8082/token.svc |
ugc-community-url CAPABILITY_URL | Sets the web address of the UGC Community Service Capability to CAPABILITY_URL | http://IPOFLOCALHOST:8085/community.svc |
ugc-moderation-url CAPABILITY_URL | Sets the web address of the UGC Moderation Service Capability to CAPABILITY_URL | http://IPOFLOCALHOST:8086/moderation.svc |
Maintenance switches
| Switch name | Description |
|---|---|
auto-register | Automatically registers the installed microservices as Capabilities |
kill-services | On a Unix system, kills the SDL microservices |
remove-services | On a Windows system, removes the SDL microservices (but does not delete the microservice resources) |
clean-target | Stops or uninstall all microservices and then cleans (wipes) the target directory |