aboutsummaryrefslogtreecommitdiff
path: root/src/xsd/iis/WebSite.xsd
blob: c2fcd91876f2d9d8a67a2417122d1364a916f891 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
<element name="WebSite">
    <annotation>
      <appinfo>
        <parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="Component" />
        <parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="Fragment" />
        <parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="Module" />
        <parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="Package" />
        <remarks>
          Nesting WebSite under a Component element will result in a WebSite being installed to the machine as the package is installed.
          Nesting WebSite under Package, Fragment, or Module
          results in a web site "locator" record being created in
          the IIsWebSite table.  This means that the web site
          itself is neither installed nor uninstalled by the MSI
          package.  It does make the database available for referencing
          from a WebApplication, WebVirtualDir or WebDir record.  This allows an MSI to install
          WebApplications, WebVirtualDirs or WebDirs to already existing web sites on the machine.
          The install will fail if the web site does not exist in these cases.
        </remarks>
      </appinfo>
      <documentation>IIs Web Site</documentation>
    </annotation>
    <complexType>
      <choice minOccurs="0" maxOccurs="unbounded">
        <element ref="WebAddress" minOccurs="1" maxOccurs="unbounded" />
        <element ref="WebApplication" minOccurs="0" maxOccurs="1" />
        <element ref="WebDirProperties" minOccurs="0" maxOccurs="1" />
        <element ref="MimeMap" />
        <element ref="CertificateRef" />
        <element ref="HttpHeader" />
        <element ref="WebDir" />
        <element ref="WebError" />
        <element ref="WebFilter" />
        <element ref="WebVirtualDir" />
        <any namespace="##other" processContents="lax">
          <annotation>
            <documentation>
              Extensibility point in the WiX XML Schema. Schema extensions can register additional
              elements at this point in the schema.
            </documentation>
          </annotation>
        </any>
      </choice>
      <attribute name="Id" type="xs:string">
        <annotation>
          <documentation>Identifier for the WebSite. Used within the MSI package only. If the Id is not specified, it will be generated.</documentation>
        </annotation>
      </attribute>
      <attribute name="AutoStart" type="wxs:YesNoTypeUnion">
        <annotation>
          <documentation>Specifies whether to automatically start the web site.</documentation>
        </annotation>
      </attribute>
      <attribute name="ConfigureIfExists" type="wxs:YesNoTypeUnion">
        <annotation>
          <documentation>Specifies whether to configure the web site if it already exists.  Note: This will not affect uninstall behavior.  If the web site exists on uninstall, it will be removed.</documentation>
        </annotation>
      </attribute>
      <attribute name="ConnectionTimeout" type="xs:nonNegativeInteger">
        <annotation>
          <documentation>Sets the timeout value for connections in seconds.</documentation>
        </annotation>
      </attribute>
      <attribute name="Description" use="required" type="xs:string">
        <annotation>
          <documentation>This is the name of the web site that will show up in the IIS management console.</documentation>
        </annotation>
      </attribute>
      <attribute name="Directory" type="xs:string">
        <annotation>
          <documentation>Root directory of the web site.  Resolved to a directory in the Directory table at install time by the server custom actions.</documentation>
        </annotation>
      </attribute>
      <attribute name="DirProperties" type="xs:string">
        <annotation>
          <documentation>
            References the Id attribute for a WebDirProperties element that specifies the security and access properties for this website root directory.
            This attribute may not be specified if a WebDirProperties element is directly nested in this element.
          </documentation>
        </annotation>
      </attribute>
      <attribute name="Sequence" type="wxs:Integer">
        <annotation>
          <documentation>Sequence that the web site is to be created in.</documentation>
        </annotation>
      </attribute>
      <attribute name="SiteId" type="xs:string">
        <annotation>
          <documentation>
            Optional attribute to directly specify the site id of the WebSite.  Use this to ensure all web
            sites in a web garden get the same site id.  If a number is provided, the site id must be unique
            on all target machines.  If "*" is used, the Description attribute will be hashed to create a unique
            value for the site id. This value must be a positive number or a "*" or a formatted value that resolves
            to "-1" (for the same behavior as "*") or a positive number or blank.  If this attribute is absent then
            the web site will be located using the WebAddress element associated with the web site.
          </documentation>
        </annotation>
      </attribute>
      <attribute name="StartOnInstall" type="wxs:YesNoTypeUnion">
        <annotation>
          <documentation>Specifies whether to start the web site on install.</documentation>
        </annotation>
      </attribute>
      <attribute name="WebApplication" type="xs:string">
        <annotation>
          <documentation>Reference to a WebApplication that is to be installed as part of this web site.</documentation>
        </annotation>
      </attribute>
      <attribute name="WebLog" type="xs:string">
        <annotation>
          <documentation>Reference to WebLog definition.</documentation>
        </annotation>
      </attribute>
      <anyAttribute namespace="##other" processContents="lax">
        <annotation>
          <documentation>
            Extensibility point in the WiX XML Schema. Schema extensions can register additional
            attributes at this point in the schema.
          </documentation>
        </annotation>
      </anyAttribute>
    </complexType>
  </element>