Infrastructure Prerequisites
- Web server and SQL server:
| Environments | Web Server | SQL Server |
|---|
| Production | - Windows Server 2019 Version 1809.
- CPU: 8 core
- RAM: 16 GB
- Free disk space: 100 GB
- Enable outbound internet connection
| - SQL Server (dedicated or shared instance)
- SQL Server 2016 or later
- Databases:
- onelist_p
- comms_p
- rolemanager_p
- SQL log in with db_owner role of the databases
|
| Non-production | - Windows Server 2019 Version 1809.
- CPU: 8 core
- RAM: 16 GB
- Free disk space: 100 GB
- Enable outbound internet connection
| - SQL Server (dedicated or shared instance)
- SQL Server 2016 or later
- Databases for each non-prod environment: the "x" represents the environment tag, e.g. d for Development, q for QA.
- onelist_x
- comms_x
- rolemanager_x
- SQL log in with db_owner role of the database
|
- Determine the DNS for each OneList environment, e.g. onelist.company.com, onelist-dev.company.com, onelist-test.company.com;
- Configure reverse proxy and firewall rules;
- Provision SSL certificate:
- SMTP server connection detail and dedicated or shared email address for OneList.
Deployment Prerequisites
- Domain user account requirements:
- Local Administrator of the Web Server;
- Has VPN and RDP access to the Web Server;
- Define the label for the OneList environment to be deployed. This is a short label, e.g. dev, qa, prod. The first letter must be unique in all the environments planned and it is used as the suffix of the database names.
- Use this value to replace the <environment> placeholder in the instructions below.
- Request for login to IQX container registry;
- Generate the Machine key for each environment. This is a Base64 string representing an array of 50 bytes;
Deployment Instructions
Install Docker Engine - Enterprise
Open PowerShell console as Administrator. Run 2 commands below.
Install-Module DockerMsftProvider -Force
Install-Package Docker -ProviderName DockerMsftProvider -Force
Restart server.
Install docker-compose
Run command:
Invoke-WebRequest "https://github.com/docker/compose/releases/download/1.25.0/docker-compose-Windows-x86_64.exe" -UseBasicParsing -OutFile $Env:ProgramFiles\Docker\docker-compose.exe
Prepare the deployment file
Create a new folder. Name it as the <environment> value. Download and save docker-compose.yml and .env file to the folder.
Open the ".env" file in notepad and update the following fields with the actual value.
- RoleManager__MachineKey
The value is the generated machine key. - Database__ConnectionString
The value is the SQL Server connection string. The name of the databases will be automatically specified by the services. - ASPNETCORE_ENVIRONMENT
The value is <environment>. - Smtp__UserName
- Smtp__Password
- Smtp__From
This is the sender email address of notifications from OneList - Smtp__Host
This is the SMTP server OneList use to send notifications. - Smtp__Port
This is the port of SMTP server. - Smtp__UseSsl
Define if SMTP server uses SSL connection. For Office365 SMTP service, the value is always false.
Save the ".env" file then run the command below.
Start OneList applications
Open PowerShell console from the folder created in previous step then run following commands.
- Pull images: docker-compose pull
- Start OneList applications: docker-compose up -d
Configure IIS Proxy
Enable WebSocket Protocol and Dynamic Content Compression feature.
Open "Server Manager" → Select "Add Roles and Features" → "Server Roles" → "Web Server"
- → "Application Development" → Check "WebSocket Protocol"
- → "Performance" → Check "Dynamic Content Compression"
Install IIS modules
Download and Install URL Rewrite and Application Request Routing IIS module.
Create OneList site on IIS
Right click Sites → select "Add Website...".
Fill in details as below and click OK.
Activate reverse proxy
Select IIS root → Open “Application Request Routing Cache”
Select “Server Proxy Settings”
Check the box “Enable Proxy”, uncheck "Reverse rewrite host in response headers" and click Apply
Configure URL Rewrite rules
Select OneList site → Open URL Rewrite
Select "View Server Variables"
Add following variables: HTTP_X_Forwarded_Host, HTTP_X_Forwarded_Port, HTTP_X_Forwarded_Proto, HTTP_X_Original_URI
Setup the OneList site
Place web.config file to root folder of the IIS site.
The web.config file contains:
- URL rewrite rules that route inbound traffic to OneList containers.
- Add following headers to the request header.
- X_Forwarded_Host, value: host name of original request
- X_Original_URI. value: URL path of original request
- X_Forwarded_Port, value: 80