Windows Setup

Windows Service Definition

The installation of Zed on a Windows machine will include a Service definition called "Zed Builds And Bugs". You will want to review the settings of this service, and in particular you will need to ensure that the account for this service is set correctly.

By default, the installation will set this service up to run as the "Local System" account. This is often not optimal, however, as the Local System account may not have write access to the directories where builds will be hosted, and where the database files will be stored.

It is recommended, therefore, that you create a dedicated user account on your Windows machine to run the Zed service, and you ensure that this user can write to all of the directories where you will store build results and working sets.

e.g. if you create a "build" local user, you will update the service definition by selecting the "Log On" tab of the service, and entering the build user and password information:

Once you have saved this, then follow the steps below to ensure that the build user will have write access to the folders required for build results storage and working sets.

Firewalls

The Zed server will listen on port 8081 by default. This prevents it from interrupting any existing web server that you may already have running on your machine. If you would like to change this, you will need to edit the main Zed configuration file called zed.xml in the main Zed installation directory. Find the section called IOAdapters, and change the listen_port to the port number you want.

Ensure that any firewall software that you have installed will allow the Zed server to listen on the port number that you have configured. If you can access the Zed server via a web browser from the machine which it is installed but not from other machines on your network, then the likely cause is that you have firewall software blocking the port you are trying to listen on.

Registration

Once your Zed server is installed and running you will need to register the software in order to activate all of it's capabilities. To do this, switch to the Administration workspace by selecting the Administration button at the top of the screen.

Then select New->License Status and you will see the License Status screen display:

On this screen enter your License Token, Company Name, Contact Name, e-mail address and phone number. This information will be used by Hericus support to contact you if necessary.

Once you have entered your information, press the save button, and your registration request will be sent to the main Zed home-base server at Hericus. You will receive a response and your License Status screen will update to display your configured license information.

Administration Parameters

When you first configure your server, there are a few Administration Parameters that you will want to setup right away so that everything will be consistent on your machine.

E-Mail Parameters

The Zed server has the capability to both send and receive e-mail. It uses this capability to send out build notification failures, task updates, and to create tasks from e-mails. In order for this to work smoothly, you'll need to set up a few parameters.

Go to the Administration workspace and choose View->Server Settings. To edit a server setting simply double-click on the parameter and edit it's value in the dialog displayed.

Configure the following settings for e-mail:

• server.email.address This parameter defines the e-mail address of your server. It is used in the "From" field whenever an e-mail is sent.
• server.email.receiving These parameters all control how the server receives e-mail.
  • server.email.receiving.host This is the mail server that this Zed server will connect to in order to download e-mail. This is typically the name of your POP or IMAP server.
  • server.email.receiving.protocol This is the e-mail protocol that will be used to communicate with your mail server. Valid values are pop3 and imap.
  • server.email.receiving.secure This indicates whether an SSL connection is allowed/required when communicating with your mail server. Valid values are true or false.
  • server.email.receiving.username This is the username that the Zed server will use when logging in to retrieve mail. If you set this value to be empty, then the Zed server will not try to download e-mail, and the rest of the server.email.receiving options will be ignored.
  • server.email.receiving.password This is the password that will be used by the Zed server to authenticate the user when downloading e-mail. If you set this value to be empty, then the Zed server will not try to download e-mail.
• server.email.sending These parameters control how the server will send e-mail.
  • server.email.sending.host This is the mail server that this Zed server will connect to in order to send e-mail. This is typically the name of your SMTP server.
  • server.email.sending.secure This indicates whether an SSL connection is allowed/required when communicating with your mail server. Valid values are true or false.
  • server.email.sending.username This is the username that the Zed server will use when logging in to send mail. If you set this value to be empty, then a warning message will be logged whenever the server needs to send an e-mail, indicating that the server could not send the e-mail.
  • server.email.sending.password This is the password that will be used by the Zed server to authenticate the user when sending e-mail.

Build Parameters

The build parameters that should be configured initially are as follows:

• builder.workdir.default When a new build is created, it will pick up this setting as it's working directory. The user may change this working directory for each build, but the default comes from this setting. It's a good idea to use the same root working directory for all of your builds so that you know where on your machine all of your builds can be found.
• builder.statusdir.default When a new build is created, it will pick up this setting as it's status directory. The user may change this status directory for each build, but the default comes from this setting. It is fine to use the same status directory for all builds, as there will be a subdirectory automatically created for each run of a build.
• builder.remotebuild These settings control remote or satellite build connections. If you are not going to use multiple build machines, then you won't have to worry about this setting.
  • builder.remotebuild.username This is the Zed username that will be used to connect to the satellite Zed server in order to run build steps. It is recommended that this be the user "build".
  • builder.remotebuild.userpass This is the password for the Zed username that will be used to connect to satellite build servers.
  • builder.remotebuild.userdb This is the "Database" name that will be used when connecting to satellite build servers. The default of "Main" should be appropriate unless you change the name of your database during the satellite installations.
  • builder.remotebuild.ssl This indicates whether an SSL connection will be used between the main Zed build server and the satellite Zed build servers when executing remote build steps. Valid values are true and false

Attachments

document-save.png		898 bytes
license1.png		13139 bytes
services1.png		8735 bytes