ElectricCommander Installation Guide

Transcription

1 ElectricCmmander Installatin Guide fr versin Electric Clud, Inc. 676 W. Maude Avenue Sunnyvale, CA Dcument Rev. 1

2 Cpyright Electric Clud, Inc. All rights reserved. Published 3/8/2013 Electric Clud believes the infrmatin in this publicatin is accurate as f its publicatin date. The infrmatin is subject t change withut ntice and des nt represent a cmmitment frm the vendr. THE INFORMATION IN THIS PUBLICATION IS PROVIDED AS IS. ELECTRIC CLOUD, INCORPORATED MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND WITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLY DISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Use, cpying, and distributin f any ELECTRIC CLOUD sftware described in this publicatin requires an applicable sftware license. Cpyright prtectin includes all frms and matters f cpyrightable material and infrmatin nw allwed by statutry r judicial law r hereinafter granted, including withut limitatin, material generated frm sftware prgrams displayed n the screen such as icns, screen display appearance, and s n. The sftware and/r databases described in this dcument are furnished under a license agreement r nndisclsure agreement. The sftware and/r databases may be used r cpied nly in accrdance with terms f the agreement. It is against the law t cpy the sftware n any medium except as specifically allwed in the license r nndisclsure agreement. Trademarks Electric Clud, ElectricAcceleratr, ElectricCmmander, ElectricDeply, ElectricInsight, and Electric Make are registered trademarks r trademarks f Electric Clud, Incrprated. Electric Clud prducts ElectricAcceleratr, ElectricCmmander, ElectricDeply, ElectricInsight, and Electric Make are cmmnly referred t by their shrt names Acceleratr, Cmmander, Deply, Insight, and emake thrughut varius types f Electric Clud prduct-specific dcumentatin. Other prduct names mentined in this guide may be trademarks r registered trademarks f their respective wners and are hereby acknwledged.

3 Cntents Chapter 1: ElectricCmmander Intrductin 1-1 What is ElectricCmmander? 1-1 What Makes ElectricCmmander Unique? 1-1 Architecture 1-3 Chapter 2: System Requirements and Supprted Platfrms 2-1 System Requirements and Supprted Platfrms 2-1 Server, web server, r repsitry server platfrms 2-1 Agent platfrms 2-3 Hardware Requirements 2-3 Sftware Requirements 2-4 Prt Usage 2-4 Database Infrmatin 2-4 Default Installatin Directries 2-5 Lg File Lcatins 2-5 Disk Usage 2-7 Memry Usage 2-7 Server/Agent Cmpatibility 2-8 The "checksum" utility 2-8 Chapter 3: Installing ElectricCmmander 3-1 General Infrmatin 3-1 User Interface Installatin Methd 3-2 Express Server Installatin 3-2 Express Agent Installatin 3-6 Advanced Installatin 3-10 Interactive Cmmand-line Installatin Methd 3-38 Silent Unattended Installatin Methd 3-44 Linux Silent Installatin Examples 3-47 Windws Silent Installatin Examples 3-48 Why Cmmander installs/requires agents n remte web servers and repsitry servers 3-49 Installing Agents n Nn-Server-Supprted Platfrms 3-50 UNIX Agent Cmmand-line Installatin 3-50 UNIX Agent Silent Installatin 3-51 Chapter 4: Upgrading ElectricCmmander 4-1 ElectricCmmander Upgrade Prcess 4-1 Befre yu begin the upgrade prcess Imprtant Nte fr Upgrading a Stand-alne Repsitry Server r Web Server 4-2 i

4 Imprtant MySQL Upgrade Nte 4-2 Perfrming a Clean Installatin 4-2 Upgrading Cmmander and Adding an Artifact Repsitry Server 4-3 Linux Upgrade Nte 4-3 User Interface Upgrade Methd 4-3 Interactive Cmmand-line Upgrade Methd 4-6 Silent Unattended Upgrade Methd 4-6 Upgrading Agents n Nn-Server-Supprted Platfrms 4-6 Chapter 5: Remte Agent Installatin and Upgrade 5-1 Prerequisites 5-1 Publish an Installer t the Artifact Repsitry 5-1 Upgrading trust n a remte agent 5-2 Chapter 6: Initial Cnfiguratin Tasks 6-1 External Database Cnfiguratin 6-1 Cnfiguring Cmmander t Use an Alternate Database 6-2 Using the Web Interface t Set the Database Cnfiguratin 6-2 Using ectl t Set the Database Cnfiguratin 6-3 Switching t an Alternate Database 6-4 Lgging in and Licensing 6-5 Abut Licenses 6-5 Applying the License Key 6-5 Making the Plugins Directry Universally Accessible 6-6 Cnfigure Cmmander server, agents, and web servers t pint t a universally accessible netwrk lcatin 6-7 Keep the plugins directry in its default server lcatin and replicate the cntents t remte agents and web servers 6-9 If yu have a prxy server in yur envirnment Trubleshting 6-9 Web Interface Online Help System 6-10 Chapter 7: Uninstalling ElectricCmmander 7-1 Uninstalling ElectricCmmander 7-1 Windws Uninstall 7-1 UNIX Uninstall 7-1 Chapter 8: Other Related Tpics 8-1 Backing up Yur Cmmander Server 8-1 Recmmendatins 8-1 Prerequisites 8-1 Backup steps 8-1 Restring Yur Cmmander Server 8-2 Prerequisites 8-3 Apache Web Server r Agent Certificates 8-8 Descriptin 8-8 Generating a signed certificate fr the ElectricCmmander web server r agent: 8-8 Send the request t the CA 8-8 Install the signed certificate 8-8 ii

5 Alternate: Generating a new self-signed certificate t update a hstname 8-8 Alternate: Restring the default cnfiguratin 8-9 Cmmander Server Certificates 8-9 Using chkcnfig 8-10 Manual Server/Agent Stp and Start 8-11 Slutin fr Stp 8-11 Slutin fr Start 8-12 Chapter 9: Trubleshting 9-1 iii

6 iv

7 Chapter 1: ElectricCmmander Intrductin What is ElectricCmmander? ElectricCmmander is an enterprise-class slutin fr autmating the sftware build and release prcess. Cmmander helps teams make sftware build, package, test, and deplyment tasks mre repeatable, mre visible, and mre efficient. At its cre, ElectricCmmander is a web-based system fr autmating and managing the build and release prcess. It prvides a scalable slutin, slving sme f the biggest challenges f managing these back-end sftware develpment tasks. Challenges slved by ElectricCmmander Time wasted n script-intensive, manual, hme-grwn systems that are errr prne and d nt scale well, with little r n management visibility r reprting Multiple, discnnected build and test systems acrss lcatins, resulting in redundant wrk, the inability t share/reuse cde files acrss teams, making it painful t manage build and test data Slw verall build and release cycles that directly impact release predictability and time-t-market Cmmander tackles these prblems with a three-tier architecture, AJAX-pwered web interface, and first-f-itskind build and release analytic capabilities fr reprting and cmpliance. With this slutin, yur develpers, release engineers, build managers, QA teams, and managers gain: Shared platfrm fr disseminating best practices and reusing cmmn prcedures Ability t supprt gegraphically distributed teams Cntinuus integratin and greater agility Faster thrughput and mre efficient hardware utilizatin Visibility/reprting fr better prject predictability Better sftware quality by integrating and validating against all target platfrms and cnfiguratins What Makes ElectricCmmander Unique? ElectricCmmander is the mst scalable slutin n the market, and nly ElectricCmmander prvides enterprise-class scalability fr build and release management. It is easy t install and use n a simple build, yet scales t supprt the largest and mst cmplex build and test prcesses. Only ElectricCmmander s multithreaded Java server prvides efficient synchrnizatin even under high jb vlume. Overview Here are sme f the facilities ElectricCmmander prvides: 1-1

8 ElectricCmmander Wrkflw functinality - Use a Wrkflw t design and manage prcesses at a higher level than individual jbs. Wrkflws allw yu t cmbine prcedures int prcesses t create build-test-deply lifecycles (fr example). A wrkflw cntains states and transitins yu define t prvide cmplete cntrl ver yur wrkflw prcess. The Cmmander Wrkflw feature allws yu t define an unlimited range f large r small lifecycle cmbinatins t meet yur needs. Cntinuus Integratin Manager (CI Manager) - This feature prvides a frnt-end user interface fr creating, managing, and mnitring cntinuus integratin builds. The Cntinuus Integratin Dashbard prvides: Visually see yur running builds, build prgress, build status, and histrical build utcmes. Easily accessed Actins t cnfigure a cntinuus integratin build. Quick cnfiguratin f yur preferred SCM system. A prject can cntain any number f cntinuus integratin builds, depending n the wrk yu have already set up fr yur prcedures/steps t perfrm. Handles resurce management - If a resurce is vercmmitted, ElectricCmmander delays sme jbs until thers have finished with the resurce. Yu can define pls f equivalent resurces and ElectricCmmander balances the lad acrss the pl. Access cntrl - users lg in t the system and ElectricCmmander uses their infrmatin t cntrl their activities. Privileges can be set fr individuals r grups t ensure the security yu need. Preflight Build functinality - used by develpers t build and test cde changes in islatin n their lcal machines befre thse changes are cmmitted t a prductin build. Search, srt, and filter functins t minimize viewing r wading thrugh infrmatin that is f n interest t yu, giving yu quick access t the infrmatin yu need. Recrds a variety f infrmatin abut each jb, such as the running time and success r failure f each step. A set f reprts is available t prvide even mre infrmatin. ntificatins t get imprtant infrmatin r data t individuals r grups immediately and n a regular basis fr a particular jb r a specific jb aspect. Pwerful and flexible reprting facilities - Varius statistics such as the number f cmpiles r test errrs are cllected after each step and recrded in the ElectricCmmander database. A variety f reprts can be generated frm this infrmatin. Artifact Management - Use artifacts t imprve perfrmance acrss builds, prvide better reusability f cmpnents, and imprve crss-team cllabratin with greater traceability. Fr example, instead f each develper repeatedly dwnlading third-party packages frm external surce, these cmpnents can be published and versined as an artifact. A develper then simply retrieves a specific artifact versin frm a lcal repsitry, guaranteeing a cnsistent package frm build t build. All ElectricCmmander features are available frm a cmmand-line tl (ectl), a Perl API, as well as a web interface. Plugin capability - Cmmander is built with an extensible UI, enabling easy develpment f plugins, including integratins with ther tls, custm dashbards, and unique user experiences based n rles. Allws yu t bserve jbs as they run and t cancel jbs. A wrkspace fr each jb - a disk area jbs can use fr strage. Pwerful data mdel based n prperties - Prperties are used t stre jb input data such as the surce cde branch t use fr the build, t cllect data during a jb (such as number f errrs r warnings), and t anntate the jb after it cmpletes (fr example, a build has passed QA). 1-2

9 Chapter 1: ElectricCmmander Intrductin Znes and Gateways - A zne (r tp-level netwrk) yu create, is a way t partitin a cllectin f agents t secure them frm use by ther grups. A gateway is a secured cnnectin between tw znes when yu want t share r transfer infrmatin t anther zne. Fr example, yu might want a develpers zne and a test zne. The Cmmander server is a member f the default zne, created during Cmmander installatin. Architecture ElectricCmmander was architected frm the grund up t supprt enterprise scale sftware prductin. Based n a three-tier architecture, Cmmander scales t handle large, cmplex envirnments. Cmmander s multithreaded Java server prvides efficient synchrnizatin even under high jb vlume. The Cmmander server manages resurces, issues cmmands, generates reprts. An underlying database stres cmmands, metadata, and lg files. Agents execute cmmands, mnitr status, and cllect results, in parallel acrss a cluster f servers fr rapid thrughput. See the fllwing illustrated architecture verview. Cmmander simple architectural verview 1-3

10 ElectricCmmander Other cnfiguratins Remte web servers r multiple web servers at yur current site Remte repsitry servers r multiple repsitry servers at yur current site Remte database Prxy resurces The next illustratin is an example fr hw yu might set up a remte web server installatin. This remte web server cnfiguratin helps prevent netwrk latency. If yu have multiple sites, ElectricCmmander can be cnfigured in numerus ways t help yu wrk mre efficiently. 1-4

11 Chapter 2: System Requirements and Supprted Platfrms This chapter describes hardware and sftware requirements, disk space usage, file lcatins, database infrmatin, and mre fr installing and running ElectricCmmander n Windws r UNIX systems. Nte: All versin requirements fr perating systems and databases listed in this chapter are rutinely tested and fully supprted by Electric Clud. Newer versins may wrk r be supprted als. Cntact Electric Clud Custmer Supprt if yu have any questins. System Requirements and Supprted Platfrms Server, web server, r repsitry server platfrms Micrsft Windws Windws 7, SP1 recmmended Windws Server 2008 and Windws 2008 R2 Windws Server SP2 recmmended but nt required Windws XP - SP2 r later required fr hsts running Windws XP Ntes: Linux Windws Server 2008 and Windws 7 Nte: An administratr may need t disable User Accunt Cntrl (UAC). If the installer runs under accunt X, but services will run under accunt Y, installatin directries (bth prgram and data) will prbably have permissins that prevent Y s access. This applies particularly t data directries. Fr all Windws versins, 32 and 64-bit are supprted. Red Hat Enterprise Linux 6, 32 and 64-bit Red Hat Enterprise Linux 5, 32 and 64-bit Red Hat Enterprise Linux 4, 32-bit nly SUSE Linux Enterprise Server 12.1, 32 and 64-bit SUSE Linux Enterprise Server 11.4, 32 and 64-bit 2-1

12 ElectricCmmander SUSE Linux Enterprise Server 10.3 and 10.4, 32 and 64-bit Ubuntu , 32 and 64-bit Ntes: D nt chse nbdy fr the RHEL user. RHEL des nt allw a su - nbdy -c f.sh because it is nt a shell accunt. Using nbdy prevents the SQL server frm starting, which means the default ElectricCmmander database is inaccessible. RHEL 6 Nte: If yu plan t use Cmmander n RHEL 6.x, 64-bit, yu need t run ne r all f the fllwing cmmands befre installing Cmmander: yum install libstdc++.i686 - Yu must run this cmmand. If yu d nt run this cmmand, the Cmmander Apache server will nt start and the installer silently fails fr any type f Cmmander installatin. yum install libuuid.i686 - Run this cmmand if perfrming a Cmmander installatin that includes an Apache server. Fr example, if yu are installing Cmmander agents nly, withut a web server, yu d nt need t run this cmmand n each agent machine. yum install nss-pam-ldapd*.i686 - Yu must run this cmmand (t install 32-bit NSS packages) if using an LDAP accunt fr wnership f the server/web/repsitry services. If yu d nt run this cmmand, the Cmmander Apache server fails t start. Nte: Befre attempting any Cmmander installatin, Electric Clud recmmends running all f these cmmands n yur RHEL 6, 64-bit machines. These cmmands install 32-bit libraries, mitted by Red Hat, but required fr the Cmmander installatin executable file t wrk. RHEL 5 Nte: If yu plan t use ElectricCmmander n RHEL5.x, the supprted installatin methd requires the SeLinux cnfiguratin t be less restrictive set the SeLinux perating mde t Permissive. T d this, issue the fllwing cmmand as the rt user: # setenfrce 0 Alternatively, the mde can be changed by editing the file /etc/selinux/cnfig and changing the line "SELINUX=enfrcing" t "SELINUX=permissive". Either change requires rebting the Linux server t have the changes take effect. RHEL 4 64-bit Nte: Red Hat Linux 4 64-bit is NOT supprted as a Cmmander server r web server machine, but yu may cntinue t use this platfrm fr agents. SUSE Linux Enterprise Server Nte: After installing Cmmander, run the fllwing cmmand as rt: /usr/lib/lsb/install_initd /etc/init.d/cmmander* This cmmand ensures the Cmmander daemns are started in the apprpriate sequence after any system restart. Ubuntu bit Nte: Befre installing ElectricCmmander, yu must install Ubuntu s 32-bit cmpatibility layer by running the fllwing cmmand: sud apt-get install ia32-libs 2-2

13 Chapter 2: System Requirements and Supprted Platfrms Nte: Steps running with impersnatin n Ubuntu run with a PATH envirnment variable set in /etc/envirnment. As a side-effect, the ElectricCmmander bin directry is nt in the PATH in the impersnatin cntext, s calls t tls like ectl and pstp fail with a nt fund errr. T fix: Update /etc/envirnment t include the ElectricCmmander bin directry in PATH. Fr Ubuntu bit nly - Befre installing ElectricCmmander, yu must run the fllwing cmmand (t install 32-bit NSS packages) if using an LDAP accunt fr wnership f the server/web/repsitry services: apt-get install libnss-ldap:i386 If yu d nt run this cmmand, the Cmmander Apache server fails t start. Agent platfrms All server machines specified fr the ElectricCmmander server See RHEL 6 Nte abve fr 64-bit installatins. See RHEL 5 Nte fr Cmmander server abve. See Ubuntu bit nte fr Cmmander server abve. Red Hat Enterprise Linux 4 (64-bit) Micrsft Windws 2000 Sun Slaris 9 (Architecture: Sparc nly) Sun Slaris 10 (Architecture: Sparc and Intel x86) HP-UX 11i v1 (11.11) r later (Architecture: PA-RISC 2.0) Make sure the fllwing patches (r patches superceding these patches) are installed: PHKL_29243, PHSS_39077 HP-UX Secure Shell Nte: HP-UX Secure Shell requires that a randm number generatr be lcated n the system. It searches fr /dev/urandm and /dev/randm (in that sequence) n the system and uses the first device it finds. If it fails t lcate these tw devices, HP-UX Secure Shell uses its wn internal randm number generatr prgram. By default, HP-UX 11i v2 systems includes these randm number devices. These devices can als be btained fr HP-UX 11i v1 by dwnlading and installing the HP-UX Strng Randm Number Generatr frm HP recmmends that Secure Shell users n HP-UX 11i v1 systems install the Strng Randm Number Generatr prduct as it significantly speeds up prgram initializatin and executin time fr sme cmmands. Mac OS X 10.4 (Tiger) r later (Architecture: Intel) Prxy Agent ntes When using a prxy agent, the prxy target must run an SSH v2 server. Fr mre infrmatin n prxy target agents, see the Cnfiguratin and Resurce nline help tpics. Running certain cmmands requiring administratr privileges (fr example, net stp xxx) using cygwin 1.7 sshd can fail with access denied errrs. These errrs did nt ccur in cygwin 1.5. The Cmmander prxy agent relies n sshd being privileged. T set this privilege n cygwin 1.7, yu need t run an additinal setup script (in additin t ssh-hst-cnfig): cyglsa-cnfig rebt Hardware Requirements Minimum requirements fr either the Windws r Linux machine where the ElectricCmmander server is installed: 2-3

14 ElectricCmmander Prcessr clck rate: 1.5 GHz r higher Memry: 2 GB RAM r mre (8 GB recmmended fr small t medium deplyments) Cres: 2 r mre (4 cres recmmended fr small t medium deplyments) Sftware Requirements T cnnect t ElectricCmmander, yur web brwser must be ne f the fllwing: Micrsft Internet Explrer 7.0 r later Mzilla Firefx 10.0 r later (Firefx versins earlier than v10.0 are nt supprted.) Chrme 13 r later Nte: Web brwser extensins such as AdBlckPlus fr Ggle Chrme can interfere with the display f Cmmander web pages. Electric Clud recmmends disabling any ad blcking brwser extensins r add an exclusin fr Cmmander web pages. If yu are installing an ElectricCmmander server and yu have a web server (fr example, Apache, IIS) r ther applicatin using prt 80 and/r 443 n the ElectricCmmander hst, yu have 4 ptins: Prt Usage Chse different web server prts. Uninstall the existing web server. Disable the existing web server. Recnfigure the existing web server t use anther prt. By default, ElectricCmmander uses the fllwing prts: ElectricCmmander Server ElectricCmmander Server (SSL prt) 80 - ElectricCmmander Web Server ElectricCmmander Web Server (SSL prt) Prt used by the ElectricCmmander agent fr HTTP cmmunicatin n the lcalhst netwrk interface ElectricCmmander Agents (by default, this is an HTTPS prt) Preflight file transfer prt, ther file transfer, event ntificatins, r ther messaging Artifact repsitry server (by default, this is an HTTPS prt) Other database prts: Oracle 11g Release 1, and R Micrsft SQL Server Tip: Make sure yur firewall is pen fr the prts Cmmander needs. Database Infrmatin During ElectricCmmander server installatin, yu can chse NOT t install the built-in [default] database n the server machine. If yu did nt install the built-in database, after ElectricCmmander server installatin is cmplete, yu must chse an alternate database befre yu can begin using Cmmander (enterprise license required). ElectricCmmander supprts the fllwing alternate databases: 2-4

15 Chapter 2: System Requirements and Supprted Platfrms MySQL 5.0, 5.1, r r later ( r later is recmmended) MS SQL Server 2005 with Service Pack 2 r later, r MS SQL Server 2008, 2008 R2 Oracle 10g R2 (including RAC) Oracle 11g Release 2, R2 IMPORTANT: If yu install Cmmander v4.2.x r later using the built-in Cmmander database, be advised that this database is nt recmmended fr prductin systems. Electric Clud highly recmmends using an alternate database in yur prductin Cmmander envirnment. Yu may switch t an alternate database at anytime in the future. Using an alternate database requires a Cmmander enterprise license. See Chapter 5, "Initial Cnfiguratin Tasks" n page 6-1 fr mre infrmatin. Ntes: 1. Yu will nt be able t lg in until a database is set up. 2. If yu are using tw different Cmmander servers, they cannt pint t the same database. Database grwth Expected database grwth ver time can be crrelated with the number f jb steps created, using an estimate f 10K per jb step. Nte: Database grwth is NOT crrelated with build lgs r build artifacts size. T create a reasnable database grwth estimate per perid: Estimate the number f jbs per perid, multiply the jb number estimate by the number f steps estimated per jb, then multiply that number by 10Kbytes t determine the disk size required fr that perid f study. Fr example: If yu run 500 jbs per day with an average f 200 steps per jb, r 100K steps per day, yur database wuld grw abut 1 GB per day r 90 GB per quarter. Using this example, if yu prune jbs lder than 30 days, database size culd be maintained at abut 30 GB. Default Installatin Directries Yu can change the installatin directries if yu need t d s. Default fr Windws prgram files: C:\Prgram Files\Electric Clud\ElectricCmmander Defaults fr Windws data (database, lgs, cnfiguratin files): Fr Windws 2008 r Windws 7 - C:\PrgramData\Electric Clud\ElectricCmmander Fr Windws XP r C:\Dcuments and Settings\All Users\Applicatin Data\Electric Clud\ElectricCmmander UNIX/Mac: /pt/electricclud/electriccmmander Lg File Lcatins The fllwing infrmatin is fr default run time lg lcatins. 2-5

16 ElectricCmmander Fr Windws Agent Default fr Windws XP, C:\Dcuments and Settings\All Users\Applicatin Data\Electric Clud\ElectricCmmander\lgs\agent Default fr Windws 2008, Windws 7 - C:\PrgramData\Electric Clud\ElectricCmmander\lgs\agent Server Default fr Windws XP, C:\Dcuments and Settings\All Users\Applicatin Data\Electric Clud\ElectricCmmander\lgs Default fr Windws 2008, Windws 7 - C:\PrgramData\Electric Clud\ElectricCmmander\lgs Web server Default fr Windws XP, C:\Dcuments and Settings\All Users\Applicatin Data\Electric Clud\ElectricCmmander\apache\lgs Default fr Windws 2008, Windws 7 - C:\PrgramData\Electric Clud\ElectricCmmander\apache\lgs Repsitry server Default fr Windws XP, C:\Dcuments and Settings\All Users\Applicatin Data\Electric Clud\ElectricCmmander\lgs\repsitry Default fr Windws 2008, Windws 7 - C:\PrgramData\Electric Clud\ElectricCmmander\lgs\repsitry Installer Fr UNIX Default fr Windws XP, C:\Dcuments and Settings\All Users\Applicatin Data\Electric Clud\ElectricCmmander\lgs Default fr Windws 2008, Windws 7 - C:\PrgramData\Electric Clud\ElectricCmmander\lgs Agent /pt/electricclud/electriccmmander/lgs/agent Server /pt/electricclud/electriccmmander/lgs Web server /pt/electricclud/electriccmmander/apache/lgs Repsitry server /pt/electricclud/electriccmmander/lgs/repsitry Installer /pt/electricclud/electriccmmander/lgs 2-6

17 Chapter 2: System Requirements and Supprted Platfrms Nte: Server lgs and agent lgs rll ver peridically s individual lgs d nt grw t large and lder lgs are deleted. Rll-ver parameters are cnfigurable in cnf/lgback.xml and cnf/agent.cnf. Disk Usage Disk space usage varies and depends n the quantity and size f the jbs yu run. Electric Clud recmmends starting with the fllwing free space recmmendatins: Server - 10 GB Agents - 5 GB each Sizing artifact cache directry space n resurces By default, artifacts are retrieved int the <data-dir>/artifact-cache directry f the agent installatin. Yu can mdify the agent.cnf file t change the lcatin, r yu can specify the cache directry lcatin n each resurce knwn t Cmmander. Determining hw much free space the cache partitin needs t accmmdate all f yur artifact versins can be difficult. Here is ne apprach t apprximate the disk/partitin size yu need: Fr each artifact, estimate hw large yu think each versin will be and hw many versins yu plan t keep. Cmpute the ttal required space t be the sum f versin-size * numversins fr each artifact. Add a buffer f 50%. Using yur end result, allcate a disk/partitin that size and cnfigure the cache as a directry n that disk/partitin. Repsitry server - If using Artifact Management functinality, yu culd need GB, r mre disk space fr yur repsitry server. Althugh a server install includes an artifact repsitry, Electric Clud recmmends that prductin repsitry server(s) be installed n different machines than the Cmmander server. The repsitry server may d a very large amunt f disk and netwrk I/O when transferring artifact versins t and frm requesters and this may adversely affect Cmmander server perfrmance. Sizing the repsitry backingstre Fr a repsitry installatin, by default, the repsitry backingstre is the <datadir>/repsitry-data directry. Yu can mdify the <datadir>/cnf/repsitry/server.prperties file r use eccnfigure t update the backingstre lcatin. Determining exactly hw much free space the backingstre disk/partitin needs t accmmdate yur artifact versins can be difficult. Here is ne apprach t apprximate the disk size yu need: Memry Usage Fr each artifact, estimate hw large yu think each versin will be and hw many versins yu plan t keep. Cmpute the ttal required space t be the sum f versin-size * numversins fr each artifact. Add a buffer f 50%. Using yur end result, allcate a disk/partitin that size and cnfigure the repsitry backingstre as a directry n that disk/partitin. Memry usage varies depending n whether r nt the ElectricCmmander server is a dedicated machine. By default, minimum memry usage is 20% f free memry n a 32 r 64-bit system, assuming the ElectricCmmander server is running n a dedicated machine. By default, fr a Cmmander repsitry server, minimum memry usage is 10% f free memry. By default, fr a Cmmander agent, minimum memry usage is 256 MB. T adjust the memry level, g t the ElectricCmmander directry t mdify the wrapper.java.initmemry.percent and wrapper.java.maxmemry.percent lines in wrapper.cnf: 2-7

18 ElectricCmmander Fr Windws XP r Windws 2003: c:\dcuments and Settings\All Users\Applicatin Data\Electric Clud\ ElectricCmmander\cnf\wrapper.cnf Fr Windws 2008 r Windws 7 c:\prgramdata\electric Clud\ElectricCmmander\cnf\wrapper.cnf Fr Linux: /pt/electricclud/electriccmmander/cnf/wrapper.cnf Fr a repsitry server: Windws: c:\dcuments and Settings\All Users\Applicatin Data\Electric Clud\ ElectricCmmander\cnf\repsitry\wrapper.cnf r c:\prgramdata\electric Clud\ElectricCmmander\cnf\repsitry\wrapper.cnf Linux: /pt/electricclud/electriccmmander/cnf/repsitry/wrapper.cnf Nte: Alternately, using eccnfigure, yu can set the initial and maximum memry settings. Fr example, t set the CmmanderServer initial memry percentage t 21% and the maximum memry percentage t 31%, specify: eccnfigure --serverinitmemry 21 --servermaxmemry 31 Server/Agent Cmpatibility All supprted ElectricCmmander Agent versins are frward and backward cmpatible with all supprted ElectricCmmander Server versins. Fr example, an ElectricCmmander v3.10 Agent is cmpatible with an ElectricCmmander v4.2 Server; and cnversely, an ElectricCmmander v3.10 Server is cmpatible with an ElectricCmmander v4.2 Agent. Nte: ElectricCmmander pre-v3.10 cmpnents are n lnger supprted. If yur current Cmmander installatin is a versin prir t 3.10, cntact Electric Clud Custmer Supprt fr manual instructins t upgrade yur installatin. The "checksum" utility An MD5 checksum file is available n the Electric Clud FTP site. If yu chse t verify that ElectricCmmander files are intact and unaltered frm their riginal frm and cntent after yu dwnlad them, dwnlad the crrespnding MD5 checksum file als. MD5 utilities are available fr Windws, Linux, and Mac perating systems. On Linux, verify with md5sum --check ElectricCmmander-xx.md5 Mst Linux installatins prvide an md5sum cmmand fr calculating MD5 message digests. An MD5 utility fr Windws can be dwnladed at T use the MD5 checksum utility n a Mac: 1. In Finder, brwse t /Applicatins/Utilities. 2. Duble-click the Terminal icn. A Terminal windw appears. 3. In the Terminal windw, type: md5 (fllwed by a space). 4. Drag the dwnladed file frm the Finder int the Terminal windw. 2-8

19 Chapter 2: System Requirements and Supprted Platfrms 5. Click in the Terminal windw, press the Return key, and cmpare the checksum displayed n the screen t the ne n the dwnlad page. 2-9

20 2-10

21 Chapter 3: Installing ElectricCmmander General Infrmatin This chapter describes all versins f the ElectricCmmander installatin prcess. If yu are upgrading a previusly installed Cmmander versin, fllw the instructins in "Upgrading ElectricCmmander" n page 4-1. Nte: Yu must install Cmmander n a lcal drive. Electric Clud des nt supprt installing the Cmmander server n a netwrk vlume. The graphical user interface fr installatin wrks fr bth Windws and Linux platfrms supprting the Cmmander server install. See chapter 2, "System Requirements and Supprted Platfrms", fr a list f supprted Cmmander server platfrms. If X is nt running r nt available, the Linux user interface installer will run in interactive cmmand-line mde. Fr new installs, three ptins are available: Express Server install, Express Agent install, r Advanced install. The express installs use default values fr all settings except service accunts. The advanced install allws yu t specify cmpnents, directries, prts, and s n. When installing r upgrading a 64-bit machine, the 64-bit versin f the Java Runtime Envirnment is installed autmatically. If yu chse t install the Cmmander-prvided built-in database, be advised that this database is nt recmmended fr prductin systems. Electric Clud highly recmmends using an alternate database in yur prductin Cmmander envirnment (Cmmander enterprise license required). See "Database Infrmatin" n page 2-4 fr alternate databases supprted by Cmmander. When installing an agent, repsitry server, and/r web server, yu can enter infrmatin fr a remte Cmmander server. That infrmatin can then be used t discver the server s plugins directry and set it accrdingly s the lcal install is in sync with the remte Cmmander server. During an agent installatin, yu can create a resurce bject n the server autmatically. Similarly, during a repsitry installatin, yu can create a repsitry bject n the server autmatically. This chapter cntains three sectins, ne fr each installatin methd. The three methds fr installing Cmmander are: User Interface - this is a set f installatin screens that prvides click-thrugh autmatin and prmpts fr infrmatin yu need t supply. Cmmand-line - use this methd if yu prefer using an interactive cmmand-line fr the installatin prcess. This methd is available nly n Linux machines. 3-1

22 ElectricCmmander Silent - this is a nn-interactive cmmand-line installatin. Yu may find this installatin methd preferable fr installing multiple remte agents. User Interface Installatin Methd Begin each graphical user interface installatin by duble-clicking the ElectricCmmander-<versin> file. The first screen, Welcme t the ElectricCmmander Installer, appears with three ptins as fllws: Express Server Select this ptin t install the ElectricCmmander server, including the web and repsitry servers, built-in database, ne agent t run jbs frm this machine, and Cmmander tls. Express Agent Select this ptin t install a Cmmander agent this installatin als includes Cmmander tls. Use this ptin fr managed hsts where yu intend t run jb steps. Advanced This ptin allws yu t select individual cmpnents, directries, r prts. Fr example, yu can use this ptin t install a remte web server nly, r yu may want t install tls nly n develper machines. Multiple installatin cmbinatins are available. See "Advanced Installatin" n page 3-10 fr mre infrmatin. Nte: Electric Clud recmmends installing the ElectricCmmander server first, befre installing remte agents r web servers. Express Server Installatin This installatin type installs the ElectricCmmander server, including the web server, built-in database, ne agent t run jbs frm this machine, and Cmmander tls. Duble-click the ElectricCmmander-<versin> file t begin installatin. Nte: The built-in database included with this installatin type is nt recmmended fr prductin systems. Electric Clud highly recmmends using an alternate database in yur prductin Cmmander envirnment. Yu can upgrade t an alternate database at a later time (Cmmander enterprise license required). Select the Express Server installatin type. 3-2

23 Chapter 3: Installing ElectricCmmander Click Next t cntinue. Nte: The fllwing screen example is fr Windws nly. If yu are installing n a Linux machine, see the additinal Linux field descriptins belw. Type-in the accunt User Name and Passwrd. This accunt is the ne used t run the Cmmander server, web server, and repsitry server services. Dmain - If the user belngs t a dmain, enter the dmain name in this field. If this is a lcal user, leave this field blank. Use the lcal system accunt checkbx - Check this bx if yu want the Cmmander server, repsitry server, and web server services t run as the lcal Windws system accunt. Nte: The lcal system accunt des nt have access t netwrk shares. Use the same accunt fr the agent service checkbx - Check this bx if yu want the agent n the Cmmander server machine t run as the same accunt. IMPORTANT: Fr security reasns in prductin envirnments, yu may want t use a separate accunt fr the agent service because the server accunt has permissin t read the key file (cnf\passkey). The key file is used t decrypt passwrds stred in Cmmander. Using a different accunt fr the agent service ensures that a prcess running n the agent cannt gain access t the key file. Nte: If yu select this checkbx, yu will nt see the fllwing screen with fields t supply yur agent service accunt infrmatin. On Linux machines: If yu are installing Cmmander n a Linux server, the infrmatin yu need t supply is slightly different as fllws: User Name - This is the user wh wns the Cmmander server, repsitry server, and web server prcesses. Grup Name - This is the grup that wns the Cmmander server, repsitry server, and web server prcesses. 3-3

24 ElectricCmmander Use the same accunt fr the agent service checkbx - Check this bx if yu want the same user and grup t wn the agent prcess n the Cmmander server machine. IMPORTANT: Fr security reasns in prductin envirnments, yu may want t use a separate user and grup fr the agent service because the server service has permissin t read the key file (cnf\passkey). The key file is used t decrypt passwrds stred in Cmmander. Using a different user and grup fr the agent service ensures that a prcess running n the agent cannt gain access t the key file. Nte: If yu select this checkbx, yu will nt see the fllwing screen with fields t supply yur agent service accunt infrmatin. Click Next t cntinue. Nte: The fllwing screen example is fr Windws nly. If yu are installing n a Linux machine, see the additinal Linux field descriptins belw. Type-in the accunt User Name and Passwrd. This accunt is the ne used t run the Cmmander agent service. Dmain - If the user belngs t a dmain, enter the dmain name in this field. If this is a lcal user, leave this field blank. Use the lcal system accunt checkbx - Check this bx if yu want the Cmmander agent service t run as the lcal Windws system accunt. Nte: The lcal system accunt des nt have access t netwrk shares. On Linux machines: If yu are installing Cmmander n a Linux server, the infrmatin yu need t supply is slightly different as fllws: User Name - This is the user wh wns the Cmmander agent prcess. Grup Name - This is the grup that wns the Cmmander agent prcess. Click Next t cntinue. 3-4

25 Chapter 3: Installing ElectricCmmander Review the default settings and yur service accunt selectins. Use the Back buttn t change yur service accunt selectins if necessary. Click Next t cntinue. Please wait while ElectricCmmander is installing all cmpnents this prcess may take fifteen minutes. The Cmmander server will start when installatin is cmplete. 3-5

26 ElectricCmmander Launch a web brwser t lgin t ElectricCmmander checkbx - Check this bx if yu want Cmmander t pen t the lgin screen nw. Click Finish t cmplete the installatin. Express Agent Installatin ElectricCmmander sftware must be installed n each agent machine yu intend ElectricCmmander t use. Duble-click the ElectricCmmander-<versin> file t begin installatin. Nte: Yu may install ElectricCmmander agent sftware n Windws r Linux with this installatin methd. Fr Slaris, HP-UX, Mac, r ther supprted UNIX agent machines, see "Installing Agents n Nn-Server- Supprted Platfrms" n page Select Express Agent t begin this installatin als installs Tls. Click Next t cntinue. 3-6

27 Chapter 3: Installing ElectricCmmander Server Hst Name - Type-in the name f the ElectricCmmander server that will cmmunicate with this agent. If the remte server is using a nn-default HTTP prt, yu must specify the Server Hst Name as hst:prt. Cmmander User Name - Specify the name f a user n the Cmmander server wh has sufficient privileges t create a resurce. Defaults t the Cmmander-supplied admin user. Passwrd - Specify the passwrd fr the Cmmander user. The default passwrd fr the admin user is changeme. Discver the plugins directry checkbx - If yu wuld like the agent machine t have access t the plugins directry (recmmended), check this bx. The plugins directry n the Cmmander server must be shared befre the agent machine can use discver t find the directry. Fr mre infrmatin, see "Making the Plugins Directry Universally Accessible" n page 6-6. Create a resurce checkbx - Check this bx t create a resurce n the remte Cmmander server fr the agent yu are installing. Trusted checkbx - Check this bx t restrict this agent t ne Cmmander server. Resurce Name - Supply the name yu wuld like t use fr this resurce. Create in default zne checkbx - Check this bx if yu want t create the agent in the default zne. Agent Gateway URL - Supply the URL f the gateway used t cmmunicate with the Cmmander server. Zne Name - Supply the zne name used during remte agent and/r remte repsitry creatin. Click Next t cntinue. Nte: The fllwing screen example is fr Windws nly. If yu are installing n a Linux machine, see the additinal Linux field descriptins belw. 3-7

28 ElectricCmmander Type-in the accunt User Name and Passwrd. This accunt is the ne used t run the Cmmander agent service. Dmain - If the user belngs t a dmain, enter the dmain name in this field. If this is a lcal user, leave this field blank. Use the lcal system accunt checkbx - Check this bx if yu want the Cmmander agent service t run as the lcal Windws system accunt. Nte: The lcal system accunt des nt have access t netwrk shares. On Linux machines: If yu are installing Cmmander n a Linux server, the infrmatin yu need t supply is slightly different as fllws: User Name - This is the user wh wns the Cmmander agent prcess. Grup Name - This is the grup that wns the Cmmander agent prcess. Click Next t cntinue. 3-8

29 Chapter 3: Installing ElectricCmmander Review this screen t verify yur selectins. Use the Back buttn t change any f yur settings if necessary. Click Next t cntinue. Please wait while the agent and tls are installed this will take just a few minutes. Click Next t cntinue. 3-9

30 ElectricCmmander Click Finish t cmplete the agent installatin. Advanced Installatin This installatin type prvides the flexibility t accept sme r all default installatin specificatins r change them t accmmdate yur envirnment. Duble-click the ElectricCmmander-<versin> file t begin installatin. When the Cmmander Welcme t the ElectricCmmander Installer screen appears, select Advanced t begin. Click Next t cntinue. The next screen displays individual cmpnents t install. Ntes: 1. Cmmander tls are autmatically installed with each installatin type. 2. An agent is autmatically installed with a web server r repsitry server. 3-10

31 Chapter 3: Installing ElectricCmmander 3. The built-in database that yu can chse t install is nt recmmended fr prductin systems. Electric Clud highly recmmends using an alternate database in yur prductin Cmmander envirnment. If yu chse t install the built-in database, yu can upgrade t an alternate database at a later time. If yu d nt install the built-in database, yu must cnfigure Cmmander t use an alternate database befre using Cmmander. Using an alternate database requires a Cmmander enterprise license. Yu can select ne r mre ptins t install at the same time. Hwever, this guide prvides examples fr the mst cmmn ways yu might use the Advanced ptin. The fllwing examples are prvided: Installing the ElectricCmmander server and all cmpnents Installing a Cmmander agent Installing a remte Cmmander web server, including an agent Installing a remte Cmmander repsitry server, including an agent Installing Cmmander tls Example 1 - cmplete ElectricCmmander installatin This installatin example installs the ElectricCmmander server, including the web, repsitry, and database servers, ne agent t run jbs frm this machine, and Cmmander tls. Duble-click the ElectricCmmander-<versin> file t begin installatin. Select all checkbxes and click Next t cntinue. 3-11

32 ElectricCmmander Cmmander uses these default directries t install files and cmpnents. Click Brwse t specify ther directry lcatins if yu prefer t d s. Click Next t accept the default lcatins r the directry lcatins yu specified. Cmmander uses the default prts displayed n this screen. Yu can accept these default prt specificatins r type-in alternate prt numbers. Click Next t cntinue. 3-12

33 Chapter 3: Installing ElectricCmmander Supply the hst name users need t type int their brwser t access the Cmmander web server. Click Next t cntinue. Nte: The fllwing screen example is fr Windws nly. If yu are installing n a Linux machine, see the additinal Linux field descriptins belw. Type-in the accunt User Name and Passwrd. This accunt is the ne used t run the Cmmander server, web server, and repsitry server services. Dmain - If the user belngs t a dmain, enter the dmain name in this field. If this is a lcal user, leave this field blank. 3-13

34 ElectricCmmander Use the lcal system accunt checkbx - Check this bx if yu want the Cmmander server, web server, and repsitry server services t run as the lcal Windws system accunt. Nte: The lcal system accunt des nt have access t netwrk shares. Use the same accunt fr the agent service checkbx - Check this bx if yu want the agent n the Cmmander server machine t run as the same accunt. IMPORTANT: Fr security reasns in prductin envirnments, yu may want t use a separate accunt fr the agent service because the server accunt has permissin t read the key file (cnf\passkey). The key file is used t decrypt passwrds stred in Cmmander. Using a different accunt fr the agent service ensures that a prcess running n the agent cannt gain access t the key file. Nte: If yu select this checkbx, yu will nt see the fllwing screen with fields t supply yur agent service accunt infrmatin. On Linux machines: If yu are installing Cmmander n a Linux server, the infrmatin yu need t supply is slightly different as fllws: User Name - This is the user wh wns the Cmmander server, web server, and repsitry server prcesses. Grup Name - This is the grup that wns the Cmmander server, web server, and repsitry server prcesses. Use the same accunt fr the agent service checkbx - Check this bx if yu want the same user and grup t wn the agent prcess n the Cmmander server machine. IMPORTANT: Fr security reasns in prductin envirnments, yu may want t use a separate user and grup fr the agent service because the server service has permissin t read the key file (cnf\passkey). The key file is used t decrypt passwrds stred in Cmmander. Using a different user and grup fr the agent service ensures that a prcess running n the agent cannt gain access t the key file. Nte: If yu select this checkbx, yu will nt see the fllwing screen with fields t supply yur agent service accunt infrmatin. Click Next t cntinue. Nte: The fllwing screen example is fr Windws nly. If yu are installing n a Linux machine, see the additinal Linux field descriptins belw. 3-14

35 Chapter 3: Installing ElectricCmmander Type-in the accunt User Name and Passwrd. This accunt is the ne used t run the Cmmander agent service. Dmain - If the user belngs t a dmain, enter the dmain name in this field. If this is a lcal user, leave this field blank. Use the lcal system accunt checkbx - Check this bx if yu want the Cmmander agent service t run as the lcal Windws system accunt. Nte: The lcal system accunt des nt have access t netwrk shares. On Linux machines: If yu are installing Cmmander n a Linux server, the infrmatin yu need t supply is slightly different as fllws: User Name - This is the user wh wns the Cmmander agent prcess. Grup Name - This is the grup that wns the Cmmander agent prcess. Click Next t cntinue. 3-15

36 ElectricCmmander Review default settings and any custm specificatins. Use the Back buttn t mdify any infrmatin if necessary. Click Next t cntinue. Please wait while ElectricCmmander installs all cmpnents and files this prcess may take fifteen minutes. The Cmmander server will start when installatin is cmplete. 3-16

37 Chapter 3: Installing ElectricCmmander Launch a web brwser t lgin t ElectricCmmander checkbx - Check this bx if yu want Cmmander t pen t the lgin screen nw. Click Finish t cmplete the installatin. Example 2 - installing a Cmmander agent ElectricCmmander sftware must be installed n each agent machine yu intend ElectricCmmander t use. Duble-click the ElectricCmmander-<versin> file t begin installatin. Nte: Yu may install ElectricCmmander agent sftware n Windws r Linux with this installatin methd. Fr Slaris, HP-UX, Mac, r ther supprted UNIX agent machines, see "Installing Agents n Nn-Server- Supprted Platfrms" n page Select Agent t begin this installatin als installs Tls. 3-17

38 ElectricCmmander Click Next t cntinue. Cmmander uses these default directries fr installatin. Click Brwse t specify ther directry lcatins if yu prefer t d s. Click Next t accept the default lcatins r the directry lcatins yu specified. Cmmander uses the default prts displayed n this screen. Yu can accept these default prt specificatins r type-in alternate prt numbers. Click Next t cntinue. 3-18

39 Chapter 3: Installing ElectricCmmander Server Hst Name - Type-in the name f the ElectricCmmander server that will cmmunicate with this agent. If the remte Cmmander server is using nn-default prts, yu must specify the Server Hst Name as hst:prt. Cmmander User Name - Specify the name f a user n the Cmmander server wh has sufficient privileges t create a resurce. Defaults t the Cmmander-supplied admin user. Passwrd - Specify the passwrd fr the Cmmander user. The default passwrd fr the admin user is changeme. Discver the plugins directry checkbx - If yu wuld like the agent machine t have access t the plugins directry (recmmended), check this bx. The plugins directry n the Cmmander server must be shared befre the agent machine can use discver t find the directry. Fr mre infrmatin, see "Making the Plugins Directry Universally Accessible" n page 6-6. Create a resurce checkbx - Check this bx t create a resurce n the remte Cmmander server fr the agent yu are installing. Trusted checkbx - Check this bx t restrict this agent t ne Cmmander server. Resurce Name - Supply the name yu wuld like t use fr this resurce. Create in default zne checkbx - Check this bx if yu want t create the agent in the default zne. Agent Gateway URL - Supply the URL f the gateway used t cmmunicate with the Cmmander server. Zne Name - Supply the zne name used during remte agent and/r remte repsitry creatin. Click Next t cntinue. Nte: The fllwing screen example is fr Windws nly. If yu are installing n a Linux machine, see the additinal Linux field descriptins belw. 3-19

40 ElectricCmmander Type-in the accunt User Name and Passwrd. This accunt is the ne used t run the Cmmander agent service. Dmain - If the user belngs t a dmain, enter the dmain name in this field. If this is a lcal user, leave this field blank. Use the lcal system accunt checkbx - Check this bx if yu want the Cmmander agent service t run as the lcal Windws system accunt. Nte: The lcal system accunt des nt have access t netwrk shares. On Linux machines: If yu are installing Cmmander n a Linux server, the infrmatin yu need t supply is slightly different as fllws: User Name - This is the user wh wns the Cmmander agent prcess. Grup Name - This is the grup that wns the Cmmander agent prcess. Click Next t cntinue. 3-20

41 Chapter 3: Installing ElectricCmmander Review the default and yur custm specificatins. Use the Back buttn t mdify any infrmatin if necessary. Click Next t cntinue. Please wait while ElectricCmmander installs the agent, tls, and assciated files. 3-21

42 ElectricCmmander Click Finish t cmplete the Cmmander agent installatin. Example 3 - installing a remte Cmmander web server, including an agent ElectricCmmander supprts multiple wrkspaces, including thse c-lcated n agents that use them. In this architecture, step lg files are created lcally s even the largest lg files can be captured withut a perfrmance penalty. Step lg files can be viewed frm the web UI, but with a perfrmance penalty if retrieving thse files acrss the WAN. Remte users, wh want t view thse particular lgs, pay a perfrmance penalty twice nce fr the web server t retrieve the file cntents and nce fr the web t send the cntents back acrss the WAN t the brwser. The slutin: Install ne central Cmmander server, then install a Cmmander web server at each remte site, c-lcated with remte agents and wrkspaces, allwing remte users t lg in thrugh their lcal web server. Any peratins initiated frm the remte lcatin, including running a jb, are cmpleted by the central Cmmander server. When a remte user views the Jb Details page, jb data is retrieved frm the central server. Assuming the jb is using a wrkspace at the remte user s site, links t all lg files effectively refer t lcal paths. Because lg files are accessed by the remte web server s agent nly, and nt the Cmmander server, bth trips acrss the WAN are eliminated. The Cmmander web server reads the lg file lcally (via its agent), then serves the page t the user whse brwser is als n the same side f the WAN. Ntes: 1. Yu can install Cmmander web servers n any Windws r Linux platfrm suitable fr installing the Cmmander server. 2. Fr infrmatin abut why Cmmander autmatically installs an agent with each remte repsitry server, see "Why Cmmander installs/requires agents n remte web servers and repsitry servers" n page Duble-click the ElectricCmmander-<versin> file t begin installatin. On the Advanced installatin screen, select Web server t begin. 3-22

43 Chapter 3: Installing ElectricCmmander Click Next t cntinue. Cmmander uses these default directries fr installatin. Click Brwse t specify ther directry lcatins if yu prefer t d s. Click Next t accept the default lcatins r the directry lcatins yu specified. 3-23

44 ElectricCmmander Cmmander uses the default prts displayed n this screen. Yu can accept these default prt specificatins r type-in alternate prt numbers. Click Next t cntinue. This is the name f web server hst that users will type int their brwser t access ElectricCmmander. 3-24

45 Chapter 3: Installing ElectricCmmander Server Hst Name - Type-in the name f the ElectricCmmander server that this web server will cmmunicate with. If the remte Cmmander server is using nn-default prts, yu must specify the Server Hst Name as hst:prt. Cmmander User Name - Specify the name f a user n the Cmmander server. Defaults t the Cmmander-supplied admin user. Passwrd - Specify the passwrd fr the Cmmander user. The default passwrd fr the admin user is changeme. Discver the plugins directry checkbx - If yu wuld like the web server t have access t the plugins directry (recmmended), check this bx. The plugins directry n the Cmmander server must be shared befre the web server can use discver t find the directry. Fr mre infrmatin, see "Making the Plugins Directry Universally Accessible" n page 6-6. Trusted checkbx - Check this bx t restrict this agent t ne Cmmander server. Resurce Name - Supply the name yu wuld like t use fr this resurce. Create in default zne checkbx - Check this bx if yu want t create the agent in the default zne. Agent Gateway URL - Supply the URL f the gateway used t cmmunicate with the Cmmander server. Zne Name - Supply the zne name used during remte agent and/r remte repsitry creatin. Click Next t cntinue. Nte: The fllwing screen example is fr Windws nly. If yu are installing n a Linux machine, see the additinal Linux field descriptins belw. 3-25

46 ElectricCmmander Type-in the accunt User Name and Passwrd. This accunt is the ne used t run the web server service. Dmain - If the user belngs t a dmain, enter the dmain name in this field. If this is a lcal user, leave this field blank. Use the lcal system accunt checkbx - Check this bx if yu want the web server service t run as the lcal Windws system accunt. Nte: The lcal system accunt des nt have access t netwrk shares. On Linux machines: If yu are installing Cmmander n a Linux server, the infrmatin yu need t supply is slightly different as fllws: User Name - This is the user wh wns the web server prcess. Grup Name - This is the grup that wns the web server prcess. Click Next t cntinue. Nte: The fllwing screen example is fr Windws nly. If yu are installing n a Linux machine, see the additinal Linux field descriptins belw. 3-26

47 Chapter 3: Installing ElectricCmmander Type-in the accunt User Name and Passwrd. This accunt is the ne used t run the Cmmander agent service. Dmain - If the user belngs t a dmain, enter the dmain name in this field. If this is a lcal user, leave this field blank. Use the lcal system accunt checkbx - Check this bx if yu want the Cmmander agent service t run as the lcal Windws system accunt. Nte: The lcal system accunt des nt have access t netwrk shares. On Linux machines: If yu are installing Cmmander n a Linux server, the infrmatin yu need t supply is slightly different as fllws: User Name - This is the user wh wns the Cmmander agent prcess. Grup Name - This is the grup that wns the Cmmander agent prcess. Click Next t cntinue. 3-27

48 ElectricCmmander Verify that all specified infrmatin is what yu intended r use the Back buttn t mdify a setting. Click Next t cntinue. Please wait while ElectricCmmander installs a remte web server. 3-28

49 Chapter 3: Installing ElectricCmmander Launch a web brwser t lgin t ElectricCmmander checkbx - Check this bx if yu want Cmmander t pen t the lgin screen nw. Click Finish t cmplete the Cmmander remte web server installatin. Example 4 - Installing a remte repsitry server, including an agent This installatin example installs a remte ElectricCmmander repsitry server, an agent t run jbs frm this machine, and Cmmander tls. Duble-click the ElectricCmmander-<versin> file t begin installatin. On the Advanced installatin screen, select Repsitry t begin. Nte: Installing an agent n the same machine as a repsitry server enables the repsitry server s backingstre t be cleaned up by running a jb n this agent rather than lgging int each remte repsitry server and running the cmmand manually. Fr infrmatin abut why Cmmander autmatically installs an agent with each remte web server, see "Why Cmmander installs/requires agents n remte web servers and repsitry servers" n page

50 ElectricCmmander Click Next t cntinue. Cmmander uses these default directries t install files and cmpnents. Click Brwse t specify ther directry lcatins if yu prefer t d s. Click Next t accept the default lcatins r the directry lcatins yu specified. 3-30

51 Chapter 3: Installing ElectricCmmander Cmmander uses the default prts displayed n this screen. Yu can accept these default prt specificatins r type-in alternate prt numbers. Click Next t cntinue. Server Hst Name - Type-in the name f the ElectricCmmander server that will cmmunicate with this agent. If the remte Cmmander server is using nn-default prts, yu must specify the Server Hst 3-31

52 ElectricCmmander Name as hst:prt. Cmmander User Name - Specify the name f a user n the Cmmander server wh has sufficient privileges t create a resurce. Defaults t the Cmmander-supplied admin user. Passwrd - Specify the passwrd fr the Cmmander user. The default passwrd fr the admin user is changeme. Discver the plugins directry checkbx - If yu wuld like the agent machine t have access t the plugins directry (recmmended), check this bx. The plugins directry n the Cmmander server must be shared befre the agent machine can use discver t find the directry. Fr mre infrmatin, see "Making the Plugins Directry Universally Accessible" n page 6-6. Create a resurce checkbx - Check this bx t create a resurce n the remte Cmmander server fr the agent yu are installing. Trusted checkbx - Check this bx t restrict this agent t ne Cmmander server. Resurce Name - Supply the name yu wuld like t use fr this resurce. Create a repsitry - Check this bx t create a repsitry bject n the remte Cmmander server fr the repsitry server yu are installing. Repsitry Name - Supply the name yu wuld like t use fr this repsitry bject. Create in default zne checkbx - Check this bx if yu want t create the agent in the default zne. Agent Gateway URL - Supply the URL f the gateway used t cmmunicate with the Cmmander server. Zne Name - Supply the zne name used during remte agent and/r remte repsitry creatin. Click Next t cntinue. Nte: The fllwing screen example is fr Windws nly. If yu are installing n a Linux machine, see the additinal Linux field descriptins belw. Type-in the accunt User Name and Passwrd. This accunt is the ne used t run the Cmmander repsitry server service. 3-32

53 Chapter 3: Installing ElectricCmmander Dmain - If the user belngs t a dmain, enter the dmain name in this field. If this is a lcal user, leave this field blank. Use the lcal system accunt checkbx - Check this bx if yu want the repsitry server service t run as the lcal Windws system accunt. Nte: The lcal system accunt des nt have access t netwrk shares. Use the same accunt fr the agent service checkbx - Check this bx if yu want the agent n the Cmmander server machine t run as the same accunt. Nte: If yu select this checkbx, yu will nt see the fllwing screen with fields t supply yur agent service accunt infrmatin. On Linux machines: If yu are installing Cmmander n a Linux server, the infrmatin yu need t supply is slightly different as fllws: User Name - This is the user wh wns the Cmmander repsitry server prcess. Grup Name - This is the grup that wns the Cmmander repsitry server prcess. Use the same accunt fr the agent service checkbx - Check this bx if yu want the same user and grup t wn the agent prcess n the Cmmander server machine. Nte: If yu select this checkbx, yu will nt see the fllwing screen with fields t supply yur agent service accunt infrmatin. Click Next t cntinue. Nte: The fllwing screen example is fr Windws nly. If yu are installing n a Linux machine, see the additinal Linux field descriptins belw. Type-in the accunt User Name and Passwrd. This accunt is the ne used t run the Cmmander agent service. Dmain - If the user belngs t a dmain, enter the dmain name in this field. If this is a lcal user, leave this field blank. 3-33

54 ElectricCmmander Use the lcal system accunt checkbx - Check this bx if yu want the Cmmander agent service t run as the lcal Windws system accunt. Nte: The lcal system accunt des nt have access t netwrk shares. On Linux machines: If yu are installing Cmmander n a Linux server, the infrmatin yu need t supply is slightly different as fllws: User Name - This is the user wh wns the Cmmander agent prcess. Grup Name - This is the grup that wns the Cmmander agent prcess. Click Next t cntinue. Review default settings and any custm specificatins. Use the Back buttn t mdify any infrmatin if necessary. Click Next t cntinue. 3-34

55 Chapter 3: Installing ElectricCmmander Please wait while ElectricCmmander installs all cmpnents and files this prcess may take fifteen minutes. The Cmmander server will start when installatin is cmplete. Click Finish t cmplete the installatin. Example 5 - installing Cmmander tls nly If yu need t install Cmmander tls nly n develper r ther machines, use this installatin methd. Open the installer executable file n each machine where yu need t install Cmmander tls. Duble-click the ElectricCmmander-<versin> file t begin installatin. Select Advanced t see the fllwing screen and then make sure n checkbxes are selected. Ntice the Tls checkbx remains selected by default. 3-35

56 ElectricCmmander Click Next t cntinue. Accept the default installatin directry r click Brwse t select the directry yu prefer. Click Next t cntinue. 3-36

57 Chapter 3: Installing ElectricCmmander Verify that the settings are crrect r use the Back buttn t make a change. Click Next t cntinue. Please wait while Cmmander installs Tls files n this machine. 3-37

58 ElectricCmmander Click Finish t cmplete the Cmmander Tls installatin. Interactive Cmmand-line Installatin Methd Nte: A Windws cmmand-line installatin is nt supprted. Yu can use the interactive cmmand-line installatin methd fr Linux-nly installs. If yu have X installed, running the installer will bring up the graphical user interface autmatically. Hwever, yu can use the cmmand-line installatin methd if yu specify./electriccmmander-<versin> --mde cnsle. Install Cmmander n a lcal Linux vlume. Electric Clud des nt supprt installing the Cmmander server n a netwrk vlume. Nte: Yu may install ElectricCmmander agent sftware n Linux with this installatin methd. Fr Slaris, HP-UX, Mac, r ther supprted UNIX agent machines, see "Installing Agents n Nn-Server-Supprted Platfrms" n page Additinal infrmatin abut installatin: Cmmander tls are autmatically installed with each installatin type. An agent is autmatically installed with a web server r repsitry server. The built-in database that yu can chse t install is nt recmmended fr prductin systems. Electric Clud highly recmmends using an alternate database in yur prductin Cmmander envirnment. If yu chse t install the built-in database, yu can upgrade t an alternate database at a later time. If yu d nt install the built-in database, yu must cnfigure Cmmander t use an alternate database befre using Cmmander. Using an alternate database requires a Cmmander enterprise license. Express Server./ElectricCmmander-<versin> Cpyright (c) , Electric Clud, Inc. All rights reserved. This will install ElectricCmmander n yur cmputer. Cntinue? [n/y] y Specify the type f setup yu wuld like t perfrm: expressserver, expressagent, r advanced. [expressserver] 3-38

59 Chapter 3: Installing ElectricCmmander Specify the user the server, web, and/r repsitry will run as. [] <user> Specify the grup the server, web, and/r repsitry will run as. [] <grup> Use the same service accunt fr the agent (nt recmmended fr prductin systems)? [y/n] n Specify the user the agent will run as. [] <user> Specify the grup the agent will run as. [] <grup> Installing ElectricCmmander... Installing agent... Installing server... Installing tls... Installing web... Installing database Installing jre Installing repsitry... Cpied lg file t "/pt/electricclud/electriccmmander/lgs" ElectricCmmander <versin> was successfully installed! Installer lg file: /pt/electricclud/electriccmmander/lgs/installer.lg. Express Agent./ElectricCmmander-<versin> Cpyright (c) , Electric Clud, Inc. All rights reserved. This will install ElectricCmmander n yur cmputer. Cntinue? [n/y] y Specify the type f setup yu wuld like t perfrm: expressserver, expressagent, r advanced. [expressserver] expressagent Discver the plugins directry frm a remte Cmmander server? [y/n] y Create a resurce fr the installed agent n a remte Cmmander server? [y/n] y Register as trusted agent (required fr gateway)? [y/n] y Create repsitry and/r agent in the default zne? [y/n] n Specify the hst:prt f a remte Cmmander server the agent, repsitry server and/r web server being installed can link t. The prt is nly required if it is nt the default. [] <hstname:prt> Specify the user name with which t lgin t <hstname:prt>. [admin] Specify the passwrd fr "admin" n <hstname:prt>. [] <changeme> Specify the name f the resurce t create n <resurcename> <hstname:prt>. [myhst] Specify the agent gateway URL in the frm f iporhstname:prt [] Specify the zne name fr the agent and/r repsitry [] Specify the user the agent will run as. [] <user> Specify the grup the agent will run as. [] <grup> Installing ElectricCmmander... Installing agent... Installing tls... Installing jre Cpied lg file t "/pt/electricclud/electriccmmander/lgs" 3-39

60 ElectricCmmander ElectricCmmander <versin> was successfully installed! Installer lg file: /pt/electricclud/electriccmmander/lgs/installer.lg. Advanced - All cmpnents./electriccmmander-<versin> Cpyright (c) , Electric Clud, Inc. All rights reserved. This will install ElectricCmmander n yur cmputer. Cntinue? [n/y] y Specify the type f setup yu wuld like t perfrm: expressserver, expressagent, r advanced. [expressserver] advanced Install a Cmmander server? [n/y] y Install a built-in database? [n/y] y Install an Apache web server? [n/y] y Install a Cmmander agent? [n/y] y Install a Cmmander repsitry server? [n/y] y Specify the install directry (fr prgram files and binaries). [/pt/electricclud/electriccmmander] Specify the data directry (fr cnfiguratin files and lgs). [/pt/electricclud/electriccmmander] Specify the server HTTP prt. [8000] Specify the server HTTPS prt. [8443] Specify the server file transfer prt. [61613] Specify the web HTTP prt. [80] Specify the web HTTPS prt. [443] Specify the agent prt. [7800] Specify the agent lcal prt. [6800] Specify the repsitry prt. [8200] Specify the hst name that users will type in their brwser t access the web server. [hstname] Specify the user the server, web, and/r repsitry will run as. [] <user> Specify the grup the server, web, and/r web repsitry will run as. [] <grup> Use the same service accunt fr the agent (nt recmmended fr prductin systems)? [y/n] n Specify the user the agent will run as. [] <user> Specify the grup the agent will run as. [] <grup> Installing ElectricCmmander... Installing agent... Installing server... Installing tls... Installing web... Installing database

61 Chapter 3: Installing ElectricCmmander Installing jre Installing repsitry... Cpied lg file t "/pt/electricclud/electriccmmander/lgs" ElectricCmmander <versin> was successfully installed! Installer lg file: /pt/electricclud/electriccmmander/lgs/installer.lg. Advanced - Agent nly./electriccmmander-<versin> Cpyright (c) , Electric Clud, Inc. All rights reserved. This will install ElectricCmmander n yur cmputer. Cntinue? [n/y] y Specify the type f setup yu wuld like t perfrm: expressserver, expressagent, r advanced. [expressserver] advanced Install a Cmmander server? [n/y] n Install an Apache web server? [n/y] n Install a Cmmander repsitry server? [n/y] n Install a Cmmander agent? [n/y] y Specify the install directry (fr prgram files and binaries). [/pt/electricclud/electriccmmander] Specify the data directry (fr cnfiguratin files and lgs). [/pt/electricclud/electriccmmander] Specify the agent prt. [7800] Specify the agent lcal prt. [6800] Discver the plugins directry frm a remte Cmmander server? [y/n] y Create a resurce fr the installed agent n a remte Cmmander server? [y/n] y Register as trusted agent (required fr gateway)? [y/n] n Create repsitry and/r agent in the default zne? [y/n] y Specify the hst:prt f a remte Cmmander server the agent, repsitry server and/r web server being installed can link t. The prt is nly required if it is nt the default. [] <hstname:prt> Specify the user name with which t lgin t <hstname:prt>. [admin] Specify the passwrd fr "admin" n <hstname:prt>. [] <changeme> Specify the name f the resurce t create n <hstname:prt>. [myhst] <resurcename> Specify the user the agent will run as. [] <user> Specify the grup the agent will run as. [] <grup> Installing ElectricCmmander... Installing agent... Installing tls... Installing jre Cpied lg file t "/pt/electricclud/electriccmmander/lgs" ElectricCmmander <versin> was successfully installed! Installer lg file: /pt/electricclud/electriccmmander/lgs/installer.lg. 3-41

62 ElectricCmmander Advanced - Repsitry Server, including an agent./electriccmmander-<versin> Cpyright (c) , Electric Clud, Inc. All rights reserved. This will install ElectricCmmander n yur cmputer. Cntinue? [n/y] y Specify the type f setup yu wuld like t perfrm: expressserver, expressagent, r advanced. [expressserver] advanced Install a Cmmander server? [n/y] n Install an Apache web server? [n/y] n Install a Cmmander repsitry server? [n/y] y Specify the install directry (fr prgram files and binaries). [/pt/electricclud/electriccmmander] Specify the data directry (fr cnfiguratin files and lgs). [/pt/electricclud/electriccmmander] Specify the agent prt. [7800] Specify the agent lcal prt [6800] Specify the repsitry server prt. [8200] Discver the plugins directry frm a remte Cmmander server? [n/y] y Create a resurce fr the installed agent n a remte Cmmander server? [n/y] y Create a repsitry bject n a remte Cmmander server? [n/y] y Register as trusted agent (required fr gateway)? [y/n] n Create repsitry and/r agent in the default zne? [y/n] y Specify the hst:prt f a remte Cmmander server, the agent, repsitry server, and/r web server being installed can link t. The prt is nly required if it is nt the default. [] <hstname:prt> Specify the user name with which t lgin t <hstname:prt>. [admin] Specify the passwrd fr "admin" n <hstname:prt>. [] <changeme> Specify the name f the resurce t create n <hstname:prt>. [upgrade-linux] <resurcename> Specify the name f the repsitry t create n <hstname:prt>. <repsitryname> Specify the user the server, web, and/r repsitry will run as. [] <user> Specify the grup the server, web, and/r repsitry will run as. [] <grup> Use the same service accunt fr the agent (nt recmmended fr prductin systems)? [n/y] n Specify the user the agent will run as. [] <user> Specify the grup the agent will run as. [] <grup> Installing ElectricCmmander... Installing tls... Installing jre

63 Chapter 3: Installing ElectricCmmander Installing agent... Installing repsitry... Cpied lg file t "/pt/electricclud/electriccmmander/lgs" ElectricCmmander <versin> was successfully installed! Installer lg file: /pt/electricclud/electriccmmander/lgs/installer.lg. Advanced - Web Server, including an agent./electriccmmander-<versin> Cpyright (c) , Electric Clud, Inc. All rights reserved. This will install ElectricCmmander n yur cmputer. Cntinue? [n/y] y Specify the type f setup yu wuld like t perfrm: expressserver, expressagent, r advanced. [expressserver] advanced Install a Cmmander server? [n/y] n Install an Apache web server? [n/y] y Install a Cmmander repsitry server? [n/y] n Specify the install directry (fr prgram files and binaries). [/pt/electricclud/electriccmmander] Specify the data directry (fr cnfiguratin files and lgs). [/pt/electricclud/electriccmmander] Specify the web HTTP prt. [80] Specify the web HTTPS prt. [443] Specify the agent prt. [7800] Specify the agent lcal prt. [6800] Specify the hst name that users will type in their brwser t access the web server. <hstname> Discver the plugins directry frm a remte Cmmander server? [y/n] y Register as trusted agent (required fr gateway)? [y/n] y Specify the hst:prt f a remte Cmmander server the agent and/r web server being installed can link t. The prt is nly required if it is nt the default. [] <hstname> Specify the user name with which t lgin t <hstname:prt>. [admin] Specify the passwrd fr "admin" n <hstname:prt>. [] <changeme> Specify the user the server, web, and/r repsitry will run as. [] <user> Specify the grup the server, web, and/r repsitry will run as. [] <grup> Installing ElectricCmmander... Installing tls... Installing web... Cpied lg file t "/pt/electricclud/electriccmmander/lgs" ElectricCmmander <versin> was successfully installed! Installer lg file: /pt/electricclud/electriccmmander/lgs/installer.lg. 3-43

64 ElectricCmmander Advanced - Tls nly./electriccmmander-<versin> Cpyright (c) , Electric Clud, Inc. All rights reserved. This will install ElectricCmmander n yur cmputer. Cntinue? [n/y] y Specify the type f setup yu wuld like t perfrm: expressserver, expressagent, r advanced. [expressserver] advanced Install a Cmmander server? [n/y] n Install an Apache web server? [n/y] n Install a Cmmander agent? [n/y] n Specify the install directry (fr prgram files and binaries). [/pt/electricclud/electriccmmander] Installing tls... Cpied lg file t "/pt/electricclud/electriccmmander/lgs" ElectricCmmander <versin> was successfully installed! Installer lg file: /pt/electricclud/electriccmmander/lgs/installer.lg. Silent Unattended Installatin Methd Yu can run the ElectricCmmander installer in unattended (silent) mde with n user interface fr either Windws r Linux. Use the arguments in the fllwing list t cnstruct the cmmands yu need fr the particular installatin yu need t perfrm. Fr example: server, agent, web server, and s n. See examples fr typical installatin types fllwing the argument list. This argument list is an excerpt frm the installer help text and can be fund by running the fllwing cmmand: ElectricCmmander-<versin> --help Frm a cmmand line, invke the fllwing cmmand t begin a silent install: ElectricCmmander-<versin> --mde silent... IMPORTANT: Only limited validity checking is perfrmed n these values during an unattended installatin, which means typing errrs r ther mistakes may manifest themselves in strange ways. ElectricCmmander-<versin> --help Usage: ElectricCmmander-<versin> [ptins...] Available Optins: --agentgatewayurl [ARG] --agentlcalprt [ARG] The URL f the gateway used t cmmunicate with the Cmmander server. Prt used by the Cmmander agent fr HTTP cmmunicatin n the lcalhst netwrk interface. 3-44

65 Chapter 3: Installing ElectricCmmander ElectricCmmander-<versin> --help Usage: ElectricCmmander-<versin> [ptins...] Available Optins: --agentprt [ARG] --datadirectry [ARG] --frce32bit --help --installagent --installdatabase --installdirectry [ARG] --installrepsitry --installserver --installweb --mde [ARG] --remteserver [ARG] --remteservercreaterepsitry --remteservercreateresurce --remteserverdiscverplugins --remteserverpasswrd [ARG] --remteserverrepsitry [ARG] Prt used by the installed Cmmander agent fr HTTPS cmmunicatin n any netwrk interface. Directry used t stre cnfiguratin files, lgs, and database artifacts. Frce a 32-bit install, even if the machine is 64-bit. Display this infrmatin. Install the Cmmander agent. Install a lcal built-in database t use with the main Cmmander server. This database is nt recmmended fr prductin systems. Directry used t stre prgram files and binaries. Install a Cmmander artifact repsitry server. Install the main Cmmander server. Install the lcal web server and Cmmander web interface. The mde in which the installer will run. Available values: cnsle, silent, r standard The hst:prt fr the remte Cmmander server. The prt is ptinal and can be mitted if the server is using the default HTTP prt. Create a repsitry bject n the remte Cmmander server. Create a resurce fr the installed agent n the remte Cmmander server. Set the plugins directry fr the installed agent and/r web server t the shared plugins directry defined n the remte Cmmander server. The passwrd t use when lgging in t the remte Cmmander server. The name f the repsitry t create n the remte Cmmander server. 3-45

66 ElectricCmmander ElectricCmmander-<versin> --help Usage: ElectricCmmander-<versin> [ptins...] Available Optins: --remteserverresurce [ARG] --remteserveruser [ARG] --repsitryprt [ARG] --respnse-file [ARG] --save-respnse-file [ARG] --serverfiletransferprt [ARG] --serverhttpprt [ARG] --serverhttpsprt [ARG] --temp [ARG] --trustedagent --unixagentgrup [ARG] --unixagentuser [ARG] --unixservergrup [ARG] --unixserveruser [ARG] --usesameserviceaccunt --versin The name f the resurce t create n the remte Cmmander server. The username t use when lgging in t the remte Cmmander server. Prt used by the Cmmander artifact repsitry server (default is 8200). A file cntaining installer respnses. ARG is a file with r withut a path. The file cntains name/value pairs separated by = (an equal sign) representing cmmand line argument values. Any value n the cmmand line supersedes the value in the respnse-file. The respnse-file can be autmatically created during the install using the save-respnse-file cmmandline argument. A file fr writing installer respnses t when the installer exists. File transfer prt used by the installed Cmmander server. HTTP prt used by the installed Cmmander server. HTTPS prt used by the installed Cmmander server. Directry used t stre temprary files used by the installer. Restrict the agent t ne Cmmander server. The grup the installed Cmmander agent runs as. The user the installed Cmmander agent runs as. The grup the installed Cmmander/web/repsitry server runs as. The user the installed Cmmander/web/repsitry server runs as. Use the same accunt fr server and agent services. Nt recmmended fr prductin systems. Display installer versin infrmatin. 3-46

67 Chapter 3: Installing ElectricCmmander ElectricCmmander-<versin> --help Usage: ElectricCmmander-<versin> [ptins...] Available Optins: --webhstname [ARG] --webhttpprt [ARG] --webhttpsprt [ARG] --windwsagentdmain [ARG] --windwsagentlcalsystem --windwsagentpasswrd [ARG] --windwsagentuser [ARG] --windwsserverdmain [ARG] --windwsserverlcalsystem --windwsserverpasswrd [ARG] --windwsserveruser [ARG] --windwsskipadmincheck --znename [ARG] The name users need t type in their brwser t access the web server. HTTP prt used by the installed web server. HTTPS prt used by the installed web server. The dmain f the accunt the installed Cmmander agent runs as. Run the Cmmander agent as the lcal system accunt. The passwrd f the accunt the installed Cmmander agent runs as. The user name f the accunt the installed Cmmander agent runs as. The dmain f the accunt the installed Cmmander/web/repsitry server runs as. Run the Cmmander/web/repsitry server as the lcal system accunt. The passwrd f the accunt the installed Cmmander/web/repsitry server runs as. The user name f the accunt the installed Cmmander/web/repsitry server runs as. D nt check that the user running the installer is a direct member f grup Administratrs. The zne name used during remte agent and/r remte repsitry creatin. Linux Silent Installatin Examples The fllwing examples are cmmand strings t use fr unattended (silent) installatins. The examples are shwn with ptins, each n a separate line fr viewing ease. Hwever, yu must enter all values n a single line. All cmpnents with default ptins./electriccmmander-<versin> --mde silent --installserver --installagent --installdatabase 3-47

68 ElectricCmmander --installweb --installrepsitry --unixserveruser <user> --unixservergrup <grup> --unixagentuser <user> --unixagentgrup <grup> Nte: Electric Cluds recmmends installing an agent alng with a repsitry server. Repsitry Server, including an agent, with default ptins./electriccmmander-<versin> --mde silent --installrepsitry --installagent --unixagentuser <user> --unixagentgrup <grup> --unixserveruser <user> --unixservergrup <grup> --unixagentuser <user> --remteserver <yur existing Cmmander server> Agent nly with default ptins./electriccmmander-<versin> --mde silent --installagent --unixagentuser <user> --unixagentgrup <grup> Web Server, including an agent, with default ptins./electriccmmander-<versin> --mde silent --installweb --unixagentuser <user> --unixagentgrup <grup> --remteserver <yur existing Cmmander server> --unixserveruser <user> --unixservergrup <grup> Tls nly with default ptins./electriccmmander-<versin> --mde silent Windws Silent Installatin Examples The fllwing examples are cmmand strings t use fr unattended (silent) installatins. The examples are shwn with ptins, each n a separate line fr viewing ease. Hwever, yu must enter all values n a single line. All cmpnents with default ptins ElectricCmmander-<versin>.exe --mde silent --installserver --installagent --installdatabase --installweb --installrepsitry 3-48

69 Chapter 3: Installing ElectricCmmander --windwsserveruser <user> --windwsserverdmain <dmain> --windwsserverpasswrd <passwrd> --windwsagentuser <user> --windwsagentdmain <dmain> --windwsagentpasswrd <passwrd> Repsitry Server, including an agent ElectricCmmander-<versin>.exe --mde silent --installrepsitry --installagent --windwsagentuser <user> --windwsagentdmain <dmain> --windwsagentpasswrd <passwrd> --windwsserveruser <user> --windwsserverdmain <dmain> --windwsserverpasswrd <passwrd> --remteserver <yur existing Cmmander server> Agent nly with default ptins ElectricCmmander-<versin>.exe --mde silent --installagent --windwsagentuser <user> --windwsagentdmain <dmain> --windwsagentpasswrd <passwrd> Web Server, including an agent ElectricCmmander-<versin>.exe --mde silent --installweb --windwsagentuser <user> --windwsagentdmain <dmain> --windwsagentpasswrd <passwrd> --remteserver <yur existing Cmmander server> --windwsserveruser <user> --windwsserverdmain <dmain> --windwsserverpasswrd <passwrd> Tls nly with default ptins ElectricCmmander-<versin>.exe --mde silent Why Cmmander installs/requires agents n remte web servers and repsitry servers Beginning with Cmmander v4.2, the web server n lnger reads wrkspace files frm the file system directly. Instead, the web server issues a request t the agent installed n the web server machine. That agent then validates the request with the Cmmander server and then either: 3-49

70 ElectricCmmander serves the desired file (if the file resides in a lcal wrkspace n that machine, r if the file is in a shared r wrkspace that this agent can access) frwards the request t anther agent (if the file resides in a lcal wrkspace n that agent, r if the file is in a wrkspace in a different zne). This change was made t supprt the discnnected wrkspaces feature in v4.2. Similarly, the repsitry server n lnger talks directly t the Cmmander server when issuing server requests. The repsitry server talks t the agent installed n the repsitry server machine. That agent either talks directly t the Cmmander server r frwards the request t a gateway agent (if the repsitry server is in a zne ther than the default zne). This allws repsitry servers in ther znes t talk t the Cmmander server. Installing Agents n Nn-Server-Supprted Platfrms Currently, the graphical user interface installer fr ElectricCmmander des nt supprt installing agent platfrms that are nt supprted Cmmander server platfrms als. Hwever, yu can install all UNIXsupprted agent platfrms using the interactive cmmand-line installer r the silent install methds until these ther UNIX platfrms are part f the new installer. Use the fllwing examples fr UNIX agent installatins: UNIX Agent Cmmand-line Installatin Nte: The fllwing infrmatin is fr nn-linux UNIX installatins. 1. Obtain a cpy f cmmander_<ostype>.bin 2. Lg in as rt. 3. Run chmd +x./cmmander_<ostype>.bin t ensure the installer is executable. 4. Run./cmmander_<OStype>.bint begin the ElectricCmmander agent installatin n a UNIX machine. Nte: Yu may install ElectricCmmander agent sftware n a Linux, Slaris, HP-UX, r Mac OS agent machines, regardless f where the ElectricCmmander server is installed (Windws r Linux machine). The fllwing is an example (with anntatins) f the infrmatin yu need t install ElectricCmmander agents n UNIX machines: Checking install integrity, please wait... ElectricCmmander fr Linux Installer Cpyright ElectricClud, Inc. All rights reserved. Press CTRL-C t exit the installatin at any time. Press Enter t accept default settings. lg file: /tmp/cmmander_install_ _ lg This suite installer can install several different prduct ptins. NOTE: The default is t install everything. Which prducts wuld yu like t install (server, web server, agent, tls): When yu type-in the agent ptin, an agent and tls will be installed. Here are the prmpts related t UNIX agent installatin: Press Enter t begin the Cmmander UNIX agent installatin and yu shuld see the fllwing respnse: 3-50

71 Chapter 3: Installing ElectricCmmander OK, installing agent. Where wuld yu like the sftware t be installed? Nte: The destinatin shuld nt be an NFS filesystem. If n directry is specified, by default an electricclud directry is created in /pt. Enter destinatin directry (default is /pt): <directry path> Enter a pre-existing user t wn installed agent files and run agent prcesses: Enter a pre-existing grup t wn installed agent files and run agent prcesses: Enter the agent prt (default is 7800): Accept the default prt r specify a different prt t eliminate any cntentin, depending n yur existing system cnfiguratin. Press Enter after supplying yur infrmatin and/r accepting ElectricCmmander defaults. When the installatin is cmplete, yu will see the fllwing message. OK: Installatin successful! UNIX Agent Silent Installatin The UNIX installers (nn-linux) als have a cmmand-line interface yu can use fr unattended (silent) installatins. The interface allws yu t specify cnfiguratin ptins n the cmmand line r in a cnfig file. The Linux installer has mre ptins than the installers fr platfrms that supprt agent and tls installatins nly. A few ntes befre yu begin: Specifying the -q ptin causes the installer t perate in silent mde. Nte: Defaults will be used unless verridden in the cnfig file r n the cmmand line. The -f ptin frces the installer t remve and replace any existing files in the destinatin directry. Nte: This ptin des nt uninstall the previus versin, it cmpletely remves the directry and writes a new ne. Fr upgrades, see "Upgrading ElectricCmmander" n page 4-1 The --cnfig ptin can be used t specify a file cntaining cnfiguratin variables and values. The fllwing cmmand-line string uses the cnfig file t verride default values n a silent install: cmmander_sun4u_sunos.bin -q -f --cnfig mycnfig Silent Installatin Cnfiguratin Parameters by Install Type The fllwing examples are cmmand strings t use fr an unattended (silent) installatins. Agent install EC_INSTALL_TYPE=agent DESTINATION_DIR="/pt" AGENT_USER_TO_RUN_AS=(user fr agent files and prcesses) AGENT_GROUP_TO_RUN_AS=(grup fr agent) EC_AGENT_PORT=(agent prt number) 3-51

72 ElectricCmmander Tls install EC_INSTALL_TYPE=tls DESTINATION_DIR="/pt" USER_TO_RUN_AS="user" GROUP_TO_RUN_AS="grup" 3-52

73 Chapter 4: Upgrading ElectricCmmander ElectricCmmander Upgrade Prcess Yu can upgrade ElectricCmmander frm any 3.10.x versin and later. Nte: This upgrade prcess des nt supprt ElectricCmmander versins prir t If yu wish t upgrade frm ElectricCmmander versins prir t 3.10, cntact Electric Clud Custmer Supprt fr assistance with upgrading the Cmmander server. Befre yu begin the upgrade prcess... The fllwing checklist lists pre-upgrade tasks: IMPORTANT: In mst implementatins, ElectricCmmander is a prduct that will be utilized acrss many users within a crpratin. As such, a best-practice f testing yur upgrade n a separate test server is highly recmmended t ensure that all aspects f the upgrade prcess are fully understd befre ptentially impacting dwnstream users. If yu are upgrading a Cmmander server, back up yur existing Cmmander data befre upgrading. Electric Clud recmmends using yur database-specific backup tl t perfrm the backup. Alternatively, yu can use the Cmmander-prvided tl (ectl exprt) t create a cmplete XML backup f yur database. If yu chse t use ectl exprt, Electric Clud recmmends ding jbless exprts if the system is active (running jbs). Jb-less exprts back up yur critical business lgic such as build prcedures, wrkflw definitins, and s n. Nte: During an upgrade, certain catastrphic events (like a pwer failure) may leave the database in an unusable state. Fr this reasn, it is extremely imprtant that yu back up yur database befre prceeding with the upgrade. If yu are upgrading a Cmmander server, perfrm maintenance such as, but nt limited t, deleting r cmpressing Cmmander lg files, pruning Cmmander wrkspaces, and deleting unused Prjects and/r Prcedures. Back up the Plugins Directry. The default lcatin is the plugins subdirectry within the data directry. Back up files cntaining yur cnfiguratin and custm settings t ensure all imprtant settings are preserved. Specifically, within the data directry, back up: Cmmander server and agent cnfiguratin files in the cnf subdirectry Apache web server cnfiguratin files in the apache/cnf subdirectry The lcal MySQL database cnfiguratin file, my.ini, in the mysql subdirectry (if applicable) 4-1

74 ElectricCmmander If yu use an artifact repsitry, back up yur Cmmander repsitry cnfiguratin files in the cnf/repsitry subdirectry. If any changes were made t the custm editr r preflight driver script prperties (installed by default), yu need t back up thse files. These prperties are stred in the server-level prperty sheet, which can be viewed in the web UI by accessing the Administratin tab/ Server subtab. Custm editrs are stred in the nested sheet named ec_custmeditrs. Preflight driver scripts are stred in the nested sheet named ec_preflight. The upgrade prcess verwrites default custm editr and preflight driver scripts with current versins. Electric Clud recmmends backing up any custm prperties yu created by renaming the prperty. Fr example, change ec_preflight/clientdrivers/perfrce t ec_ preflight/clientdrivers/perfrce_mdified. Back up any ther files where yu have created custm cnfiguratins, specified ther custm infrmatin, r created any type f mdificatin. The number f Cmmander files yu may have mdified is t numerus t list, s yu might want t back up the entire Cmmander data directry and any ther miscellaneus files yu are unsure whether r nt yu have changed. Fr mre infrmatin abut backing up yur Cmmander server, see "Backing up Yur Cmmander Server" n page 8-1 Imprtant Nte fr Upgrading a Stand-alne Repsitry Server r Web Server If yu are upgrading a stand-alne repsitry server r stand-alne remte web server, yu must uninstall and then reinstall these servers using the Cmmander installer n thse machines; yu cannt just upgrade the repsitry r web server. The uninstall/reinstall prcess is required t install an agent n the server machine. Fr infrmatin abut why Cmmander autmatically installs an agent with each repsitry server r web server, see "Why Cmmander installs/requires agents n remte web servers and repsitry servers" n page Imprtant MySQL Upgrade Nte IMPORTANT: If yu are upgrading a MySQL database, it may take several hurs if yu have a significant dataset. DO NOT INTERRUPT THE UPGRADE PROCESS if yu d, yu can crrupt yur database, which means yu will need t d a restre frm a previus database backup. As an alternative, yu can view Upgrade Prcess status by using ectl frm a cmmand line: ectl getserverstatus Nte: Upgrading t Cmmander v4.2 r later preserves the existing lcal MySQL database, if applicable. Perfrming a Clean Installatin If ElectricCmmander v3.10 r later is currently installed n yur machine, the installer prvides an ptin t upgrade the existing installatin r perfrm a clean installatin, which will allw yu t specify a different installatin directry fr the new versin. Nte: If yur current Cmmander installatin is a versin prir t 3.10, cntact Electric Clud Custmer Supprt fr manual instructins t upgrade yur installatin. A clean installatin allws yu t begin the nrmal installatin prcess described in "Installing ElectricCmmander" n page 3-1 in a different directry. Current services remain running until yu click Next n the Ready t Install screen, s prts and directries being used by the existing installatin are nt usable by the new installatin. If yu wuld like t use the same prts, manually stp the existing services t free the prts. After yu click Next n the Ready t Install screen t begin the installatin prcess, existing services are stpped and deleted, the riginal installatin is unregistered, and the new Cmmander versin is installed. 4-2

75 Chapter 4: Upgrading ElectricCmmander Nte: Files frm yur previus Cmmander versin will nt be remved r mdified and will remain in their riginal directries. Upgrading Cmmander and Adding an Artifact Repsitry Server If upgrading frm 3.x t 4.x, using the installer s GUI r interactive cnsle ptins, yu will be prmpted whether r nt t add a repsitry server t yur installatin. Silent installs will nt install a repsitry server n upgrade frm 3.x t 4.x. Linux Upgrade Nte When using the Linux installer t perfrm an upgrade, yu may encunter prblems mving brken symblic links. Yu may see errrs that begin with a line such as: culd nt read "/pt/electricclud/electriccmmander/wrkspace/fileoperatinslinux-lcalmve- 7689/fileSymLink": n such file r directry If yu encunter such errrs, manually remve the file and run the installer again. User Interface Upgrade Methd Yu will be running the installer, ElectricCmmander-<versin> [GUI], which cllects the Cmmander service accunt credentials, uninstalls yur current release, installs the latest Cmmander release, cnfigures the system with all prperty values mined, and restres custm files and data. Nte: Upgrading t Cmmander v4.2 preserves the existing lcal MySQL database, if applicable. An install/upgrade lg file named installer.lg is created in the lgs subdirectry in the data directry. After backing up yur existing ElectricCmmander server, create a flder where yu can dwnlad the ElectricCmmander-<versin> installatin file. Nte: If yur current Cmmander installatin is a versin prir t 3.10, cntact Electric Clud Custmer Supprt fr manual instructins t upgrade yur installatin. Duble-click the ElectricCmmander-<versin> file t begin installatin yu will see the Welcme t the ElectricCmmander Installer screen. 4-3

76 ElectricCmmander Click Next t upgrade the existing installatin. If yu chse t perfrm a clean install, see "Perfrming a Clean Installatin" n page 4-2. Review the upgrade settings. Click Next t cntinue. Please wait while yur ld Cmmander versin is uninstalled. Depending n the installatin type and yur amunt f data, this prcess may take ten r mre minutes. After the ld Cmmander versin is uninstalled, ElectricCmmander installs the necessary cmpnents this prcess may take fifteen minutes r mre depending n the installatin type. 4-4

77 Chapter 4: Upgrading ElectricCmmander Launch a web brwser t lgin t ElectricCmmander checkbx - check this bx if yu want Cmmander t pen t the lgin screen nw. (This checkbx appears nly when a Cmmander web server is being upgraded.) Click Finish t cmplete the upgrade. If a Cmmander server is being upgraded, when the installatin is cmplete the server will cntinue t upgrade the database (if applicable). Yu will nt be able t lg in t the Cmmander server until the database upgrade is cmplete. Yu can view the upgrade status by using ectl frm a cmmand line: ectl getserverstatus After clicking Finish, yu may see a web page similar t the fllwing screen if the upgrade is still in prgress. 4-5

78 ElectricCmmander Interactive Cmmand-line Upgrade Methd A Windws cmmand-line upgrade is nt supprted. Yu can use the interactive cmmand-line upgrade methd fr Linux-nly installs. If yu have X installed, running the installer brings up the graphical user interface autmatically. Hwever, yu can use the cmmand-line upgrade methd if yu specify:./electriccmmander-<versin> --mde cnsle Nte: Yu may upgrade ElectricCmmander agent sftware n Linux with this methd. Fr Slaris, HP-UX, Mac, r ther supprted UNIX agent machines, see "Upgrading Agents n Nn-Server-Supprted Platfrms" n page 4-6. The fllwing example illustrates a Linux cmmand-line upgrade:./electriccmmander-<versin> Cpyright (c) , Electric Clud, Inc. All rights reserved. This will install ElectricCmmander n yur cmputer. Cntinue? [n/y] y Upgrade the existing <versin> installatin t versin <versin>? [n/y] y Installing agent... Installing server... Cpied lg file t "/pt/electricclud/electriccmmander/lgs" ElectricCmmander <versin> was successfully installed! Installer lg file: /pt/electricclud/electriccmmander/lgs/installer.lg. Nte: Upgrading t Cmmander v4.2 preserves the existing lcal MySQL database, if applicable. If yu wuld prefer perfrm a clean install, answer n t the abve prmpt fr upgrading the existing installatin and then specify arguments described in "Interactive Cmmand-line Installatin Methd" n page Fr mre infrmatin abut a clean install, see "Perfrming a Clean Installatin" n page 4-2. Nte: Different ptins are required n remte agents, see "Remte Agent Installatin and Upgrade" n page 5-1. Silent Unattended Upgrade Methd Yu can run the ElectricCmmander upgrade in unattended (silent) mde with n user interface fr either Windws r Linux. Frm a cmmand line, invke the fllwing cmmand t begin a silent upgrade:./electriccmmander-<versin> --mde silent "Installing ElectricCmmander" n page 3-1 Upgrading Agents n Nn-Server-Supprted Platfrms Nte: The infrmatin in this sectin is specifically fr nn-linux UNIX agents. Currently, the graphical user interface installer fr ElectricCmmander des nt supprt upgrading agent platfrms that are nt supprted Cmmander server platfrms als. Hwever, yu can upgrade all UNIXsupprted agent platfrms using the interactive cmmand-line installer r the silent install methds until these ther UNIX platfrms are part f the new installer. T upgrade a UNIX agent, yu must uninstall and re-install the agent sftware. Fr uninstall instructins, see "Uninstalling ElectricCmmander" n page 7-1. Fr installatin instructins, see "Installing Agents n Nn-Server-Supprted Platfrms" n page

79 Chapter 5: Remte Agent Installatin and Upgrade Yu can use the methd discussed in this chapter t install r upgrade remte ElectricCmmander Agents n the fllwing hsts nly: Linux Slaris r Slaris x86 HP-UX Mac OS Nte: Remte install/upgrade fr Windws hsts is nt available at this time. Prerequisites Yu must have an artifact repsitry server installed. "The target machines must be running the SSH daemn. "The user yu select must be set up fr passwrdless sud privileges. Fr example, in the /etc/suders file, yu must add <username> ALL=(ALL) NOPASSWD:ALL IMPORTANT: If the EC-AgentManagement plugin is nt installed, the remte install/upgrade ptin will nt be available and yu cannt install/upgrade agents remtely frm the Cmmander user interface. During a new Cmmander v4.2 installatin, this plugin is installed autmatically. Fr each remte agent machine yu want t upgrade, make sure PasswrdAuthenticatin=yes in /etc/ssh/sshd_cnfig. Example: # T disable tunneled clear text passwrds, change t n here! PasswrdAuthenticatin yes PasswrdAuthenticatin=n is the default n SUSE platfrms, s yu must edit /etc/ssh/sshd_ cnfig. Restart the sshd service after changing the value. Publish an Installer t the Artifact Repsitry Yu can publish an installer t the artifact repsitry by: 5-1

80 ElectricCmmander Fllwing the nline help instructins abut using the Publish Installer prcedure r Issuing the fllwing cmmand: ectl publishartifactversin --versin <versin>-<platfrm> -- artifactname cm.electricclud:installer --cmpress 0 --frmdirectry '/tmp' --includepatterns 'cmmander_*.bin;electriccmmander-*' Replace <versin> and <platfrm> with the apprpriate values. Fr example, versin shuld resemble this frmat: Linux Valid values fr <platfrm> are: Linux, Darwin, HP-UX, SunOS, and SunOSx86 Additinal infrmatin is included in the nline help system s Resurces tpic. Upgrading trust n a remte agent T upgrade trust n a remte agent, yu can use these cmmands: ectl --server <yur_servername> lgin admin <yur_admin_passwrd> eccert --server <yur_servername> initagent --frce --remte Using the abve cmmands will make yur agent trustable; yu must then edit the agent n the Resurces page t make it trusted. 5-2

81 Chapter 6: Initial Cnfiguratin Tasks External Database Cnfiguratin During ElectricCmmander server installatin, if yu elected nt t install the built-in [default] database, yu need t cnfigure ElectricCmmander t recgnize yur alternate database chice (a Cmmander enterprise license is required). Currently, yu can chse frm: MySQL 5.0, 5.1, r r later ( r later is recmmended) MS SQL Server 2005 with Service Pack 2 r later, r MS SQL Server 2008, 2008 R2 Oracle 10g R2 (including RAC) Oracle 11g Release 2, R2 Nte: Any database yu chse t use must be UTF-8 cmpliant. When the database first starts up, ElectricCmmander creates a schema in that database s the database user shuld be the wner f the ElectricCmmander database, allwing it t make such changes. Yur database administratr (DBA) must create a database user and database fr use specifically by ElectricCmmander that includes schema bjects like tables, indices, and cnstraints, all with mdify and delete capabilities. Database user The ElectricCmmander server interacts with the database using a JDBC driver fr each f the databases Cmmander supprts. The first step in any interactin is t present user credentials t the database. This infrmatin is stred in the Cmmander database.prperties file as a user name plus a passwrd. The passwrd is stred as an encrypted string, using the passkey generated by the server. Database user privileges The database user that Cmmander uses must have rights t add r delete rws frm the database at all times. At certain defined times, the database user must have rights t create r delete tables, and add r remve a clumn/indices/cnstraints t a table. Supprted cnfiguratins T prevent prblems during upgrades and cmpatibility with future versins, Electric Clud supprts installatins nly where the database user has rights t create and delete tables at all times. The database must be cnfigured t allw up t 200 pen cnnectins. 6-1

82 ElectricCmmander MS SQL Server-specific infrmatin SQL Server supprts tw types f user authenticatin: SQL Server Authenticatin and Windws Authenticatin. Because the authenticatin type influences hw infrmatin is prvided in the ectl cmmand setdatabasecnfiguratin, yu must find ut frm yur DBA which authenticatin type is required fr the user prvided. Tip: This infrmatin may be particularly imprtant if yu are using SQL Server The cmmands and ptins referenced in this sectin are used with ectl, the ElectricCmmander cmmandline tl. See "Using ectl t Set the Database Cnfiguratin" n page 6-3 fr additinal infrmatin abut using ectl fr database cnfiguratin. Fr SQL Server Authenticatin, specify the --username and --passwrd ptins t setdatabasecnfiguratin. Fr Windws Authenticatin, there are tw ptins: NTLM lgin - The user name must include the dmain name, fr example, user@dmain.cm r dmain\user. SSO (single sign n) lgin - The cmmander service must be run as the dmain user, and the user name must be set t blank (fr example, --username ""). D nt specify a passwrd if using SSO; the server will frward credentials frm the service itself. After changing the ElectricCmmander database cnfiguratin, the server attempts t cnnect t the database t d the initial schema setup. While the server is attempting t cnnect and d the initial schema setup, yu can use ectl getserverstatus t see if there are prblems lgging int the database r creating the schema. This cmmand shws lg messages frm the server btstrap prcess. Nte: Befre the server is cmpletely up, getserverstatus des nt require a lgin sessin, but after the server is up, it des. Thus, if yu issue a getserverstatus call and get a sessin expired errr, the server is up. Cnfiguring Cmmander t Use an Alternate Database If yu deselected the database checkbx during installatin, yu will NOT be able t lg in t ElectricCmmander until yu set up a database cnfiguratin pinting t an external database (Cmmander enterprise license required). Use ne f the fllwing tw methds: Using the web interface Using ectl Using the Web Interface t Set the Database Cnfiguratin 6-2

83 Chapter 6: Initial Cnfiguratin Tasks 1. Select yur Database Type frm the drp-dwn menu. 2. Fill-in yur Database Name. 3. Fill-in the Hst Name fr yur database server. 4. Accept the default Prt r supply the prt number yu need fr yur database. 5. Supply the database User Name the Cmmander server will use t access yur database. 6. Fill-in and cnfirm the Passwrd fr the database user yu specified. 7. Click Save and Restart Server after supplying infrmatin in all fields. Nte: Yu may need t cnsult with yur Database Administratr if yu d nt have all f the infrmatin required n this web page. T access the Database Cnfiguratin web page at a later time t make mdificatins, click the Administratin > Database Cnfiguratin tabs. Using ectl t Set the Database Cnfiguratin If yu prefer t use the ElectricCmmander cmmand-line tl, use the ectl cmmand, setdatabasecnfiguratin t change the database cnfiguratin. The usage is: setdatabasecnfiguratin Fr example: [--databasetype <mysql sqlserver Oracle builtin>] [--databasename <database name>] [--hstname <hst name>] [--ignrepasskeymismatch <Blean flag>] [--ignreservermismatch <Blean flag>] [--passwrd <passwrd>] [--prt <prt number>] [--preservesessins <Blean flag>] [--username <user name>] [--custmdatabasedialect <custm database dialect>] [--custmdatabasedriver <custm database driver>] [--custmdatabaseurl <custm database URL>] ectl setdatabasecnfiguratin --databasetype sqlserver --databasename cmmander --hstname lcalhst --prt username cmmander --passwrd cmmander The ptins are: Optin databasetype Descriptin Selects the database type supprted ptins are mysql sqlserver Oracle builtin 6-3

84 ElectricCmmander Optin databasename hstname ignrepasskeymismatch ignreservermismatch prt preservesessins username passwrd custmdatabasedialect custmdatabasedriver custmdatabaseurl Descriptin The name f yur alternate database this is nt the hst name, but the name the DBA gave the database bject. The hst name where yur database is running <Blean flag true false> - If the server is started with a different passkey, ignre the mismatch if true. Nte: This actin discards all saved passwrds. <Blean flag true false> - If the server is started n a different hst than where the server previusly started, ignre the mismatch if true. The prt number used by the database Server if mitted, prt 1433 is used <Blean flag true false> - If ignring a server mismatch, default behavir invalidates all sessins. Setting this flag t true preserves all sessins, allwing the server t recnnect t running jbs. This ptin is used in cmbinatin with ignreservermismatch. The user name t use when cnnecting t the database Fr MS SQL Server, see the infrmatin n the next page regarding supprt fr SQL Server Authenticatin and Windws Authenticatin The passwrd t use t cnnect t the database Fr MS SQL Server, see the infrmatin n the next page regarding supprt fr SQL Server Authenticatin and Windws Authenticatin Internal ptin - use nly at the request f Electric Clud supprt Internal ptin - use nly at the request f Electric Clud supprt Internal ptin - use nly at the request f Electric Clud supprt Switching t an Alternate Database If yu did nt deselect the database checkbx during installatin and yu want t switch t anther database nw [next mnth r any time in the future], yu can. T cnfigure anther database and migrate the existing data t the new database: 6-4

85 Chapter 6: Initial Cnfiguratin Tasks 1. Exprt yur data by issuing the fllwing cmmand: ectl exprt <filename> --cmpress 1 Nte: If running the exprt n an active system, d nt include jbs in the exprt. 2. Set the database cnfiguratin using the web interface r ectl as described abve. 3. Restart the Cmmander server by issuing the fllwing cmmand: ectl shutdwnserver --restart 1 4. Imprt yur data by issuing the fllwing cmmand: ectl imprt <filename> --frce 1 Ntes: 1. This prcess is the same whether r nt yu are switching frm the built-in database r changing frm ne alternate database t a different alternate database. 2. If yu are using tw different Cmmander servers, they cannt pint t the same database. Lgging in and Licensing Fr a new installatin, the default admin accunt user name is admin and the passwrd is changeme. Type these values in the apprpriate fields and click Lgin. Abut Licenses In Cmmander v4.2 and later, a standard license is packaged with the server and is autmatically installed if n ther license is present. The standard license allws yu t use the built-in database nly. Prir t Cmmander v4.2, all licenses were enterprise licenses. If yu are a legacy custmer, and yu perfrm a clean server installatin, yu can install yur riginal (pre-v4.2) license (which is an enterprise license) n the new server and cnfigure the server t talk t the prductin database. This apprach is pssible nly when n ther server is running and cnnected t the prductin database. Nte: If yu want t install a new server (fr example, fr test purpses), d nt install yur riginal license n the new server. Instead, allw the test server t use the standard license. This allws yu t experiment with test servers withut having t cntact Electric Clud Technical Supprt if yur needs fit within the cnstraints f the standard license. Applying the License Key A standard license is autmatically included with the Cmmander installatin. 6-5