|
|
XML configuration |
|
|
|
|
|
XML configuration |
|
|
|
|
|
|
XML configuration |
|
|
|
|
|
XML configuration |
|
|
|
|
|
|
||
This topic provides reference on the format of the XML file used as a source of the Silent install configuration.
Instead of creating one from scratch, it is highly recommended to use one of the sample XML files located in the Examples folder within the SilentInstall.zip package and customize it according to your specific needs.
The Examples folder also contains the SilentInstall.xsd file, which is an XML schema file defining the configuration XML file format. You can use it to validate the XML configuration file you have created.
You can enter the boolean attribute values in these ways:
True value |
False value |
TRUE |
FALSE |
Yes |
No |
1 |
0 |
You can use macros in the following XML attributes to get the respective values dynamically:
•SilentInstall -> LogFile
•Setup -> SetupFolder
•IIS -> TargetFolder
•SQL -> Database
Macro expression |
Description |
Sample resolved value |
{%shortversion%} |
Build number of the installed Kentico CMS version. |
4709.166 |
{%longversion%} |
Full version number of the installed Kentico CMS version. |
7.0.4709.166 |
{%programfiles%} |
Path to the Program Files folder on your local drive. |
c:\Program Files (x86)\ |
{%machine%} |
Name of the current machine. |
PC-01 |
{%username%} |
User name of the currently used account. |
Andy |
{%date%} |
Current date in format yyyy-mm-dd. |
2012-12-21 |
{%time%} |
Current time in format hh:mm:ss. |
14:53:23 |
Note that these macros are completely independent of standard Kentico CMS macros that can be used in the system's user interface.
The root element of the XML file is SilentInstall. Using the attributes of this element, you can configure general options of the installation:
Attribute name |
Description |
Accepted values |
ShowProgress |
Determines if the Silent Install tool displays the progress of the installation or not.
•COMMAND_PROMPT - the progress is shown in the command line. •NO - the progress is not shown anywhere. |
NO | COMMAND_PROMPT |
Log |
Enables logging of import progress to a file. |
TRUE | FALSE |
OnError |
Determines the action the tool performs when an error occurs during the installation. |
STOP | CONTINUE |
LogFile |
File where the log is saved. The default value is <installation path>\setup.log. |
full path to a file |
CheckRequirements |
Indicates, if the tool checks whether the correct .NET version is installed on the target machine before executing the installation. If the installed .NET version is not matching, the installation is aborted. |
TRUE | FALSE |
The first sub-element that should be present under SilentInstall is Setup. This element allows you to configure the general options by means of attributes:
Attribute name |
Description |
Accepted values |
NET |
.NET version installed on the target machine. |
3.5 | 4.0 | 4.5 |
SetupFolder |
Folder where the tool installs the Kentico CMS setup files (not the web project). |
full path to a folder |
WebProject |
Determines if the project is installed as an ASP.NET web site, ASP.NET web application, or as a Windows Azure project. |
WebSite | WebApplication | WindowsAzure |
InstallContextHelp |
Indicates, if Context help (built-in documentation accessible by clicking the icon throughout the user interface) is installed with the project. |
TRUE | FALSE |
OpenAfterInstall |
Indicates, if the tool opens the newly installed website in a new browser window when the installation finishes. |
TRUE | FALSE |
RegisterCounters |
Indicates, if performance counters for Health Monitoring should be registered. This option has the same functionality as the Register performance counters for Health Monitoring option in Step 4 of Kentico CMS Web Installer. |
TRUE | FALSE |
InstallWinServices |
Indicates, if the tool installs Kentico CMS Windows services in Windows. |
TRUE | FALSE |
DeleteExisting |
Indicates, if the the tool deletes the existing setup files in a folder with the same name as set in the SetupFolder attribute. |
TRUE | FALSE |
The IIS sub-element is also located directly under SilentInstall. Its attributes allow you to adjust IIS-related settings of the installation:
Attribute name |
Description |
Accepted values |
AppPool |
Type of IIS application pool which the new website will use.
•Native - the application pool uses the mode that is default in the installed IIS version (Classic for IIS versions prior to 7 and Integrated for IIS 7 and higher). |
Native | Classic | Integrated |
WebSite |
Name of the website in IIS. |
string value |
TargetFolder |
Path to the folder where IIS websites are stored (typically C:\Inetpub\wwwroot\). |
full path to a folder |
RootFolder |
Indicates, if the tool installs the website into the IIS root.
•TRUE - the website is installed into the IIS root and no virtual directory is created. •FALSE - the website is installed into a new virtual directory. |
TRUE | FALSE |
DeleteExisting |
Indicates, if the the tool deletes an existing website with the same name as set in the WebSite attribute. |
TRUE | FALSE |
Location |
Determines where will the tool install the web files:
•Local - on a local IIS server. •VisualStudio - on a build-in server which is included in Visual Studio or Visual Web Developer Express Edition. •Remote - copies the files into a temporary folder on your disk. You will need to copy these files to your production server. •Modify - modifies an existing installation (adds or removes components) on a local machine.
See Kentico CMS Developer’s Guide -> Installation procedure -> Web installer for more details. |
Local | VisualStudio | Remote | Modify |
The SQL sub-element of the SilentInstall element allows you to configure database-related settings of the installation. It covers the configuration that is normally performed in Step 1 and Step 2 of the Database setup.
Attribute name |
Description |
Accepted values |
Database |
Name of the target database. |
string value |
SqlName |
User name of the account used for access to the SQL server. |
string value |
SqlPswd |
Password for the SQL server account. |
string value |
Server |
Name of the target SQL server. |
string value |
Operation |
Determines whether the tool creates a new database modifies an existing one. The default value is New. |
New | Modify |
Authentication |
Type of the authentication used to access the SQL server. |
SQL | WINDOWS | WIN |
DeleteExisting |
Indicates, if the tool deletes an existing database with the same name as set in the Database attribute. |
TRUE | FALSE |
The Notification sub-element allows you to configure the automatic notification e-mail messages. The system sends them to the specified e-mail address when an error occurs during the installation.
Attribute name |
Description |
Accepted values |
Enabled |
Indicates, if the tool sends notification e-mails when an error occurs during the installation. |
TRUE | FALSE |
From |
E-mail address of the sender of the notification e-mail. This value is required in the Notification element. |
e-mail address |
To |
E-mail address of the recipient of the notification e-mail. This value is required in the Notification element. |
e-mail address (or multiple addresses separated by a semicolon (;)) |
Server |
Name of the SMTP server used to send out the notification e-mail. |
string value |
Subject |
Subject of the notification e-mail message. |
string value |
UserName |
User name of the SMTP server account used to send out the notification e-mail. |
string value |
Password |
Password for the SMTP server account used to send out the notification e-mail. |
string value |
SSL |
Indicates, if SSL is used when sending the notification e-mail. |
TRUE | FALSE |
AttachLogFile |
Indicates, if the tool includes a compressed installation log file as an attachment. |
TRUE | FALSE |
The WebTemplates, UICultures, Modules and Dictionaries elements allow you to configure which web templates, UI cultures, modules and dictionaries will be installed by the Silent Install tool. If you chose to modify an existing Kentico CMS installation (by specifying the Modify value for the Location attribute), you can also use these elements to add new components to the existing installation or to remove unwanted components.
Each of these elements only has a single attribute:
Attribute name |
Description |
Accepted values |
type |
•InstallAll - the tool adds all components of the type to the installation. However, you can limit added components in the sub-elements by specifying No or Remove in their operation attribute.
•RemoveAll - the tool removes all components of the type from the installation. However, you can limit removed components in the sub-elements by specifying No or Add in their operation attribute.
•Mix - only configuration in the operation attribute of the sub-elements will be taken into account. |
Mix | InstallAll | RemoveAll |
Each of the WebTemplates, UICultures, Modules and Dictionaries elements can have any number of sub-elements named WebTemplate, UICulture, Module or Dictionary. These sub-elements represent particular web templates, UI cultures, modules or dictionaries and have the following attributes:
Attribute name |
Description |
Accepted values |
name |
Name of the web template, UI culture, module or dictionary. |
string value |
operation |
The operation that should be performed with the component:
•Add - the component is added to the installation. •Remove - the component is removed from the installation. •No - no action is taken. |
Add | Remove | No |
The WebSites element lets you configure which websites will be installed based on available web templates. It has no attributes itself — it only contains WebSite sub-elements representing particular websites to be installed. Each WebSite sub-element has the following attributes:
Attribute name |
Description |
Accepted values |
domain |
Domain used by the website. |
string value |
displayname |
Name of the website used in Kentico CMS user interface. |
string value |
codename |
Name of the website used in code. |
string value |
webtemplatename |
Code name of the chosen web template. |
available web template code name |
runsite |
Indicates, if the tool should run the website after it is imported to the system. |
TRUE | FALSE |
You can add any number of License sub-elements under the Licenses element. These sub-elements represent particular licenses for separate domains. You should state the domain in the domain attribute and add the actual key as a sub-element wrapped in a CDATA enclosure.
Here you can find an example of the configuration file. It installs Kentico CMS 7.0 with the sample Corporate site website and all the available web templates, UI cultures, modules and dictionaries.
<SilentInstall ShowProgress="COMMAND_PROMPT" Log="TRUE" OnError="STOP" LogFile="{%programfiles%}\KenticoCMS\7.0\setup.log" CheckRequirements="TRUE"> <Setup NET="4.5" SetupFolder="{%programfiles%}\KenticoCMS\7.0" InstallContextHelp="TRUE" /> <IIS AppPool="Native" Website="Default Web Site" TargetFolder="c:\Inetpub\wwwroot\KenticoCMSCorporateSite70" RootFolder="FALSE" Location="Local" /> <Sql SqlPswd="password" Database="KenticoCMSCorporateSite70" Operation="New" SqlName="login" Server="Artemis" Authentication="SQL" /> <WebTemplates type="InstallAll"> </WebTemplates> <UICultures type="InstallAll"> </UICultures> <Modules type="InstallAll"> </Modules> <Dictionaries type="InstallAll"> </Dictionaries> <WebSites> <WebSite domain="localhost" displayname="Corporate site" codename="CorporateSite" webtemplatename="CorporateSite" /> </WebSites> <Licenses> <License domain="localhost"><![CDATA[DOMAIN:localhost PRODUCT:CF07 EXPIRATION:00000000 PACKAGES: SERVERS:1 p8NrcXDSRiiEdH6Paef6MFISFY4Mihhwz9E+75fDKp1srPgxhTxEoLt0P2XXMkmCRSwhQk85/zjp017iCUIpwHhfgNQv/83ILVx3bIAEIZReY2Grs4Lah5jHSLlq3RUCX6d5ZL2Q2lxhKckPxMWjVhBlvDKLMttek+56QZmMp8oQlEMlqGYCIV+HMgD66Ob5ukdKYKvCw0Zcd2nhi+7W2KqJcWCRtRVxIY/Xi69ZgpT/Mae/8cxEfxZ+xzfw0Tn81Qf5vxVUkfG5UwVdmBQ1NFMqA6OTvx60kkRjGkUFNbsJVogsJ+WdMXr/MNhHx+qFAuMLdCOL13h4WMr/y8M+yA==]]></License> </Licenses> </SilentInstall> |