Deploy Server Setup
|
Documentation on this page is intended for use by customers who have access to HeroEngine source code under their license agreement.
Overview
The deploy server is used to distribute new executables to both servers and clients. The use of HeroEngine's deploy mechanics is not a required component of HeroEngine as you can distribute executables by hand or via an alternate mechanism to the the launch server.
Who needs a Deploy Server?
- You are building your own installations for the server, the client tool (HeroBlade) or the player client and you need a convenient way to distribute the them to the launch server.
Required Third Party Technologies
The following third party technologies are required for the HeroEngine Deploy Server to function, these requirements are one reason the Deploy Server itself is optional.
- Windows (Server Edition recommended)
- Wise Installation Studio 7.0(build 7.3.0.250)
Installation
- Create C:\Deploy Server
- Add the following files
| File Name | Description | Origin |
| BugslayerUtil.NET.dll | Part of Bug Catcher | Build DeployServer solution |
| BugslayerUtil.NET.pdb | Part of Bug Catcher | Build DeployServer solution |
| BugslayerUtil.NET.xml | Part of Bug Catcher | Build DeployServer solution |
| BugzScoutDotNet.dll | Part of Bug Catcher | Build DeployServer solution |
| ChangeVersion.exe | Used by Deploy Server to change version numbers of executables | Build ChangeVersion solution |
| ChangeVersion.pdb | Debug symbols for ChangeVersion.exe | Build ChangeVersion solution |
| connection.dll | Used by Deploy Server to communicate with Deploy Client. | Build DeployServer solution |
| deploy.log | Log file of Deploys | (create empty text file) |
| DeployServer.exe | Main Deploy Server executable | Build DeployServer solution |
| DeployServer.pdb | Debug symbols for DeployServer. | Build DeployServer solution |
| PurgeInstallImages.exe | Utility to purge old Install Images. It keeps 10 versions of each deploy. | Build PurgeInstallImages solution |
| PurgeInstallImages.pdb | Debug symbols for PurgeInstallImages.exe | Build PurgeInstallImages solution |
| PurgeSymbolStore.exe | Utility to purge old data from the symbol store. It keeps 10 versions of each deploy. | Build PurgeSymbolStore solution |
| PurgeSymbolStore.pdb | Debug symbols for PurgeSymbolStore.exe | Build PurgeSymbolStore solution |
| server.cfg | The config file for Deploy Server. | DeployServer solution(run directory) * |
| SimuBugCatcher.exe | Used by Deploy Server to submit it's own crash reports. | Build SimuBugCatcher solution |
| symsrv.dll | Used to access the symbol server. (Version 6.5.3.8) | DeployServer solution(run directory) |
| symstore.exe | Used to access the symbol server. (Version 6.4.7.0) | DeployServer solution(run directory) |
Talk about setting up the Linux RPM builder
NOTE: You'll create the server.cfg by taking the server-template.cfg and modifing it for your needs.
- (Optional) Add shortcut on the desktop to DeployServer.exe
- (Optional) Add shortcut in startup to DeployServer.exe
- Build the Deploy client
- Create a Deploy.cfg file in the bin\run directory of the deploy client. It will look like this:
GROUP=DEPLOY PORT=13410 HOST=(DEPLOY SERVER ADDRESS) END_GROUP
- Create C:\Install Images
- Add the following files
| File Name | Description | Origin |
| base\base.wse | Wise script for full installs | $P4\tools\deployment |
| base\basePatch.wse | Wise script for patch installs | $P4\tools\deployment |
| Includes\CheckDirectX.wse | Wise script to check if the user has the correct version of DirectX | $P4\tools\deployment |
| Includes\InstallDirectX.wse | Wise script to install DirectX. | $P4\tools\deployment |
| Includes\LNCH32.wse | Wise script to install the Launcher | $P4\tools\deployment |
| Includes\msvcr71.dll | Microsoft Visual C runtime library | Microsoft |
| SIMUAL\v21\Launcher.exe | Main Launcher executable | Build Launcher solution |
| SIMUAL\v21\lnchupdr.exe | Tool used in the process of updating the Launcher | Build Launcher solution |
| SIMUAL\v21\updreg.dll | Registry editing | Build Launcher solution |
| SIMUAL\v21\launcher.cfg | Config file for the launcher. Used to specifiy the host of the launch server, and registry location for Launcher data. | (create - see below) |
| SIMUAL\v21\help32.txt | Help file displayed to users when a problem occurs. | Build Launcher solution |
- Create launcher.cfg. It will look like this:
HOST=(Launcher Host) REGLOCATION=(Company)
- Create C:\directx_9c_redist
- Add the following files
| File Name | Description | Origin |
| dxwebsetup.exe | Direct X installer which downloads files as needed. | http://www.microsoft.com/downloads/details.aspx?FamilyId=2DA43D38-DB71-4C1B-BC6A-9B6652CD92A3&displaylang=en |
- Create C:\deploy_incoming and share it with all users that will be deploying.
- Create C:\debug_symbols and share it with all users that will be debugging.
- Create C:\DumpAnalyzer
- Add the following files
| File Name | Description | Origin |
| AnalyzerInterface.dll | C++ side of DumpAnalyzer.exe | Build DumpAnalyzerr solution |
| AnalyzerInterface.pdb | Debug symbols for AnalyzerInterface | Build DumpAnalyzerr solution |
| DumpAnalyzer.exe | C# side, analyzes crash dumps using the symbol store and returns a stack trace. | Build DumpAnalyzerr solution |
| DumpAnalyzer.pdb | Debug symbols for DumpAnalyzer.exe | Build DumpAnalyzerr solution |
| msvcr71.dll | Microsoft Visual C Runtime library. | Microsoft |
- (Optional) Create link to DumpAnalyzer.exe on desktop
- (Optional) Create link to DumpAnalyzer.exe in startup menu.
- Create C:\putty
- Add the following files
| File Name | Description | Origin |
| putty.exe | Telnet and SSH client | http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html |
| pscp.exe | SCP client, i.e. command-line secure file copy | http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html |
| plink.exe | command-line interface to the PuTTY back ends | http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html |
- Start both Deploy Server and the Deploy client.
- In the Deploy client click the Edit button.
- Select the Base product.
- Verify all Values and make any necessary changes.
- Click the Add Product button.
- Inherit from DeployBase.
- Enter the Name Deploy(Company initials). E.G. DeployABC
- Click Create then Close.
- Select Deploy(Company initials).
- Enter or select the path where you built Deploy client.
- Deploy it.
- Create a DeployABC.sal(use company specific extention to associate it with your launcher)
Example:
UPPORT=5540 GAME=DEPLOYABC FULLGAMENAME=DeployABC GAMEFILE=deploy.exe
- Run that file to install your Deploy client from the server.
- Follow the same process for any other things you want to add to the Deploy system.
