0% found this document useful (0 votes)
20 views16 pages

Installation and Deployment Guide Template

This document provides an installation and deployment guide for software. It outlines the server configurations needed, including required roles, features, packages and configured values for a database server and web application server. It also provides step-by-step instructions for installing the software on each server, including prerequisites and configured values to record. The document is intended for technical stakeholders to coordinate the installation and deployment of the application.

Uploaded by

Muhammad Majid
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
20 views16 pages

Installation and Deployment Guide Template

This document provides an installation and deployment guide for software. It outlines the server configurations needed, including required roles, features, packages and configured values for a database server and web application server. It also provides step-by-step instructions for installing the software on each server, including prerequisites and configured values to record. The document is intended for technical stakeholders to coordinate the installation and deployment of the application.

Uploaded by

Muhammad Majid
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
You are on page 1/ 16

1

4 Error: Reference source not found


5 Installation and Deployment Guide
6 Software Version: #
7

10

11

12 December 12, 2016

13
14
15

16
17
1 Error! No text of specified style in document.

18 Contents
19 Installation Guide information ii

20 Installation Guide guidelines iii

21 Contents iii

22 1 Introduction 1-3
23 1.1 Purpose 1-3
24 1.2 Revision history 1-3
25 1.3 Signoffs Error! Bookmark not defined.
26 1.4 Intended audience and reading suggestions 1-3
27 1.5 Technical project stakeholders 1-3
28 1.6 References 1-3
29 1.7 Definitions, acronyms and abbreviations 1-3

30 2 Server Configurations 2-3


31 2.1 Server 1 (Database) 2-3
32 2.1.1 Roles, Features, and Packages 2-3
33 2.1.2 Configuration 2-3
34 2.1.3 Configured Values 2-3
35 2.2 Server 2 (Web Application) 2-3
36 2.2.1 Roles, Features, and Packages 2-3
37 2.2.2 Configured Values 2-3

38 3 Software Installation 3-3


39 3.1 Server 1 (Database) 3-3
40 3.1.1 Prerequisites 3-3
41 3.1.2 Installation Steps 3-3
42 3.1.3 Configured Values 3-3
43 3.2 Server 2 (Web Application) 3-3
44 3.2.1 Prerequisites 3-3
45 3.2.2 Installation Steps 3-3
46 3.2.3 Configured Values 3-3

47 4 Testing the Installation 4-3

48 5 Troubleshooting 5-3
2 Error! No text of specified style in document.
49

INSTALLATION GUIDE (DRAFT)


50 1 Introduction

51 1.1 Purpose
52 The purpose of this Installation and Deployment Guide is to describe in technical terms the steps
53 necessary to install the software and make it operational.

54 1.2 Revision history


55 The Revision history table shows the date, changes, and authors who have worked on this
56 document.
Version/Change
Version date Description of changes Author
request number
12/23/2011 First Draft

57 1.3 Intended audience and reading suggestions


58 This Installation and Deployment Guide is intended to be used by technical stakeholders of the
59 project who will be responsible for planning, performing, or maintaining the installation or
60 deployment, such as the Systems Administrator, Chief Information Officer (CIO), Analysts, or
61 Developers.
62 It is intended that stakeholders and software support personnel can read this document and
63 coordinate their efforts in the installation/deployment of the application.

64 1.4 Technical project stakeholders


65 This section provides a list of all known stakeholders with an interest in the project.
Name E-mail address Phone Role

Lead Developer
Systems Administrator
66

67 1.5 References
68 Replace the samples below with relevant references for the installation environment.

Reference No. Document Author(s)


Download WCF RIA Services Toolkit May
REF-1 Microsoft
2010
REF-2 How to: Install SQL Server 2008 R2 (Setup) Microsoft
Microsoft .NET Framework 4 (Standalone
REF-3 Microsoft
Installer)
69
INSTALLATION GUIDE (DRAFT) 1
70 1.6 Definitions, acronyms and abbreviations
Term Definition
This is anyone from the client that has been given administrative
Administrator
rights in the Error: Reference source not found.
IIS 7 Microsoft Internet Information Server 7
71
72

INSTALLATION GUIDE (DRAFT) 2


73 2 Server Configurations

74 Replace the examples in this section with similar information about the server configurations required to
75 provide the application environment.

76 2.1 Server 1 (Database)


77 Installation of this product is supported on the following operation systems and versions:

78  Windows Server 2008 x64 R2


79  Windows Server 2008 x64
80  Windows Server 2008 x86 R2
81  Windows Server 2008 x86
82  Windows Server 2003 x64
83  Windows Server 2003 x86

84 2.1.1 Roles, Features, and Packages

85 Packages

86 The following software packages must be installed on the operating system prior to installation of the
87 software:

88  Microsoft SQL Server 2008 R2 (see REF-2)


89 o Database Engine
90 o Connectivity Components
91 o Management Tools

92 2.1.2 Configuration

93 SQL Server Configuration:


94 Authentication
95 Mixed mode authentication should be enabled
96 SQL Server Network Configuration
97 TCP/IP should be enabled
98 Named Pipes should be enabled

INSTALLATION GUIDE (DRAFT) 1


3 SOFTWARE INSTALLATION

99
100

101 2.1.3 Configured Values

102 Use the table below to make note of the values for your installation environment for future
103 reference. (Note: recording of information throughout should be in keeping with your local policies
104 for system documentation and password security).
Information Value
Server name
SQL instance name
SQL Server Administrator account
name
SQL Server Administrator account
password
105
106

2 Error: Reference source not found


4 SOFTWARE INSTALLATION

107 2.2 Server 2 (Web Application)


108 Replace the examples in this section with similar information about the server configurations required to
109 provide the application environment.
110 Installation of this product is supported on the following operation systems and versions:

111  Windows Server 2008 x64 R2


112  Windows Server 2008 x64
113  Windows Server 2008 x86 R2
114  Windows Server 2008 x86
115  Windows Server 2003 x64
116  Windows Server 2003 x86

117 2.2.1 Roles, Features, and Packages

118 Roles

119 The following server roles must be enabled on the operating system prior to installation of the software:

120  Web Server (IIS)

121 Packages

122 The following software packages must be installed on the operating system prior to installation of the
123 software:

124  Microsoft .NET Framework 4.0 Standalone Installer (see REF-3)


125  Microsoft WCF RIA Services Toolkit May 2010 (see REF-1)

126 2.2.2 Configured Values

127 Use the table below to make note of the values for your installation environment for future
128 reference.
Information Value
Server Name
129

130

INSTALLATION GUIDE (DRAFT) 3


131 3 Software Installation

132 Replace the examples in this section with step by step instructions about the software installation or
133 deployment.

134 3.1 Server 1 (Database)


135 3.1.1 Prerequisites

136 1. All steps in section 2 “Server Configurations” have been performed.

137 3.1.2 Installation Steps

138 1. Open SQL Server Management Studio and log into the server and instance using the account
139 name and password you noted in section 2.1.3.
140 2. Create a new database catalog named “database”
141 3. Create a new user configured for SQL Authentication named “authentication_owner” and note
142 the password in section 3.1.3.
143 4. Update the user mapping for the user created in step 3 to add the database role membership
144 “db_owner” for the catalog created in step 2.
145 5. Restore the backup for the “database” catalog with the following options:
146  Overwrite the existing database
147  Leave the database ready to use by rolling back uncommitted transactions. Additional
148 transaction logs cannot be restored (RESTORE WITH RECOVERY)
149 6. Run the following script against the catalog configured in step 2:
150  sp_change_users_login ‘update_one’, ‘authentication_owner’,
151 ‘authentication2_owner’
152 7. Create a new database catalog named “applicationProviders”
153 8. Create a new user configured for SQL Authentication named “applicationproviders_owner” and
154 note the password in section 3.1.3.
155 9. Update the user mapping for the user created in step 8 to add the following database role
156 memberships for the catalog created in step 7:
157  aspnet_Membership_BasicAccess
158  aspnet_Membership_FullAccess
159  aspnet_Membership_ReportingAccess
160  aspnet_Personalization_BasicAccess
161  aspnet_Personalization_FullAccess
162  aspnet_Personalization_ReportingAccess
163  aspnet_Profile_BasicAccess
164  aspnet_Profile_FullAccess

INSTALLATION GUIDE (DRAFT) 1


5 SOFTWARE INSTALLATION
165  aspnet_Profile_ReportingAccess
166  aspnet_Roles_BasicAccess
167  aspnet_Roles_FullAccess
168  aspnet_Roles_ReportingAccess
169  aspnet_WebEvent_FullAccess
170  db_owner
171 10. Restore the backup for the “applicationProviders” catalog with the following options:
172  Overwrite the existing database
173  Leave the database ready to use by rolling back uncommitted transactions. Additional
174 transaction logs cannot be restored (RESTORE WITH RECOVERY)
175 11. Run the following script against the catalog configured in step 7:
176  sp_change_users_login ‘update_one’, ‘applicationproviders_owner’,
177 ‘applicationproviders_owner’
178 12. If you have not already doen so, determine who will be the initial Administrator of the
179 application with the ability to add and remove users and note the domain and account using all
180 lowercase characters in section 3.1.3.
181 13. If the user from step 12 has not already been added, make the following edits to the catalog you
182 created in step 12 to configure the initial Administrator:
183  Add a new record to the dbo.aspnet_Users table:
184 i. ApplicationId: anaanann-naaa-naaa-nana-nnabannnanna
185 ii. User ID: [null]
186 iii. UserName: [Initial Application Administrator Domain Account Name (domain\
187 account) from section 3.1.3]
188 iv. LoweredUserName [Initial Application Administrator Domain Account Name
189 (domain\account) from section 3.1.3]
190 v. MobileAlias: [null]
191 vi. IsAnonymous: False
192 vii. LastActivityDate: [Today]
193  Note the GUID that is created for the UserId field when the record is applied to the
194 dbo.aspnet_Users table in section 3.1.3
195  Add a new record to the dbo.aspnet_UsersInRoles table:
196 i. UserId: [dbo.aspnet_Users UserId from section 3.1.3]
197 ii. RoleId: anaanann-naaa-naaa-nana-nnabannnanna
198  Add a new record to the dbo.aspnet_UsersInRoles table:
199 i. UserId: [dbo.aspnet_Users UserId from section 3.1.3]
200 ii. RoleId: anaanann-naaa-naaa-nana-nnabannnanna
201  Add a new record to the dbo.aspnet_UsersInRoles table:
202 i. UserId: [dbo.aspnet_Users UserId from section 3.1.3]

2 Error: Reference source not found


6 SOFTWARE INSTALLATION
203 ii. RoleId: anaanann-naaa-naaa-nana-nnabannnanna
204  Add a new record to the dbo.aspnet_Membership table:
205 i. ApplicationId: anaanann-naaa-naaa-nana-nnabannnanna
206 ii. UserId: [dbo.aspnet_Users UserId from section 3.1.3]
207 iii. Password: 1234
208 iv. PasswordFormat: 0
209 v. PasswordSalt: 1234
210 vi. MobilePIN: [null]
211 vii. Email: [null]
212 viii. LoweredEmail: [null]
213 ix. PasswordQuestion: [null]
214 x. PasswordAnswer: [null]
215 xi. IsApproved: True
216 xii. IsLockedOut: False
217 xiii. CreateDate: [Today]
218 xiv. LastLoginDate: [Today]
219 xv. LastPasswordChangedDate: [Today]
220 xvi. LastLockoutDate: [Today]
221 xvii. FailedPasswordAttemptCount: 0
222 xviii. FailedPasswordAttemptWindowStart: [Today]
223 xix. FailedPasswordAnswerAttemptCount: 0
224 xx. FailedPasswordAnswerAttemptWindowStart: [Today]
225 xxi. Comment: [null]
226

227 3.1.3 Configured Values

228 Use the table below to make note of the values for your installation environment for future
229 reference.
Information Value
Initial application administrator
domain account name (domain\
account)
dbo.aspnet_Users UserId
application_owner account
password
applicationproviders_owner
account password
230

INSTALLATION GUIDE (DRAFT) 3


7 SOFTWARE INSTALLATION

231 3.2 Server 2 (Web Application)


232 Replace the examples in this section with step by step instructions about the web application installation or
233 deployment.

234 3.2.1 Prerequisites

235 1. All steps in section 2 “Server Configurations” have been performed.


236 2. All steps in section 3.1 “Software Installation, Server 1 (Database)” have been performed.

237 3.2.2 Installation Steps

238 1. Contact your SharePoint administrator and note the following in section 3.2.3:
239 a. SharePoint URL
240 b. SharePoint dashboard access domain
241 c. SharePoint dashboard access user name
242 d. SharePoint dashboard access password
243 2. Contact your ArcGIS administrator and note the following in section 3.2.3:
244 a. XYZ map layer service URL
245 b. ABC map layer service URL
246 3. Log in as a server administrator.
247 4. Create a folder to house the web application files and note the location in the Physical path field
248 in section 3.2.3.
249 5. Copy deployment files to the folder you created in step 2.
250 6. Open the IIS Manager console Snap-In.
251 7. The application should be assigned an application pool separate from other web applications
252 running on the server. The steps to create the application pool are:
253 a. Right-click “Application Pools” in the Internet Information Services (IIS) Manager Snap-In
254 and choose “Add Application Pool”
255 b. Configure the following values in the Add Application Pool dialog:
256 i. Name: “SYSTEM AppPool”
257 ii. .NET Framework Version: 4.0.30319
258 iii. Managed pipeline mode: Integrated
259 iv. Start application pool immediately: Checked
260 8. The application should be assigned to the root of a new web application in IIS. The steps to
261 create the web application are:
262 a. Right-click “Sites” and select “Add Web Site” from the context menu.
263 b. Configure the following values in the Add Application Pool dialog:
264 i. Site name: SYSTEM Dashboard
265 ii. Application pool: SYSTEM Dashboard AppPool
266 iii. Physical path: [Physical path noted in section 3.2.3]

4 Error: Reference source not found


8 SOFTWARE INSTALLATION
267 iv. Pass-through authentication: Application user (pass-through authentication)
268 v. Binding
269 1. Type: http
270 2. IP Address: [note IP in section 3.2.3 if static]
271 3. Port: 80
272 4. Host name: [enter host name and configure DNS for your environment,
273 note host name in section 3.2.3]
274 5. Start Web site immediately: checked
275 c. Select Authentication for the web application you created in step 6 and enable Windows
276 Authentication.
277 9. Open Windows Explorer and navigate to the Physical path noted in section 3.2.3.
278 10. Open the web.config file using a text editor (such as NotePad) and make the following edits:
279 a. AppSettings section:
280 i. SharePointUrl value: [SharePoint URL value from section 3.2.3]
281 ii. XyzDynamicLayerUrl value: [AET map layer service URL value from section
282 3.2.3]
283 iii. AbcDynamicLayerUrl value: [RTCS map layer service URL value from section
284 3.2.3]
285 iv. SharePointAccessDomain value: [SharePoint dashboard access domain value
286 from section 3.2.3]
287 v. SharePointAccessUserName value: [SharePoint dashboard access user name
288 value from section 3.2.3]
289 vi. SharePointAccessPassword value: [SharePoint dashboard access password
290 value from section 3.2.3]
291 b. ConnectionStrings section:
292 i. Modify “connectionString” value for name “applicationBdmsEntities”
293 1. DataSource: [ [Server name]\[SQL instance name] from section 2.1.3]
294 2. Password: [application_owner account password from section 3.1.3]
295 ii. Modify “connectionString” value for name “Provider”
296 1. DataSource: [ [Server name]\[SQL instance name] from section 2.1.3]
297 2. Password: [applicationproviders_owner account password from section
298 3.1.3]
299 11. Open a command prompt and perform the following command:
300 a. iisreset
301 12. Ensure you can access the web application using the host name you noted in section 3.2.3.
302 13. Contact your SharePoint administrator to configure the Web Part Page Viewer to access the
303 application via the SharePoint user interface.
304
305

INSTALLATION GUIDE (DRAFT) 5


9 SOFTWARE INSTALLATION
306 3.2.3 Configured Values

307 Use the table below to make note of the values for your installation environment for future
308 reference.
Information Value
Physical path
IP Address (if static)
Host name
SharePoint URL
SharePoint dashboard access
domain
SharePoint dashboard access user
name
SharePoint dashboard access
password
XYZ map layer service URL
ABC map layer service URL
309
310

6 Error: Reference source not found


311 4 Testing the Installation

312 1. Navigate your web browser to the Host Name you noted in section 3.2.3.
313 2. Ensure that the login prompt appears.
314

INSTALLATION GUIDE (DRAFT) 1


315 5 Troubleshooting

316 This section is optional. Here you can describe troubleshooting steps including log locations and other
317 information that may assist an administrator and the development team in determining the root cause and
318 resolution to any issues that arise.
319

INSTALLATION GUIDE (DRAFT) 1

You might also like