Version 1 (modified by sander, 10 years ago) (diff)


Factory Manual: Using the standard factory

This chapter details the installation and configuration of the standard factory that is distributed by If you are implementing your own factory from scratch you can skip this chapter, but if you want to develop a factory builds on the standard factory then you want to read this so you understand how configuration works.

Downloading and installing the standard factory

You can download the standard factory from our Subversion repository at You can also download a tar.gz package but it is easier to keep up-to-date when you download it from Subversion. Use the following command to download the latest version of the factory from Subversion:

$> svn checkout

To update your factory to the latest version, go to the directory where the factory is and run:

$> svn update

Next, copy conf/config.default.ini to conf/config.ini and open it in a text editor. Change the settings in the global section according to your preferences.

The name of your factory. This must match the name of the factory that you created on the website. You can pick any name you like but all your factories must have a different name.
Which SSL transport you want to use. Not all transports work on all platforms. Currently supported are m2crypto which requires the Python M2Crypto library, and pyssl which uses Python's built-in HTTPS connection. The default is currently mycrypto because it allows the use of PEM encrypted SSL client certificates.
The logfile that you want to log to.

By default log_file is set to /var/log/ On most Unix/Linux? systems you are not allowed to write to this directory with your normal account. You are strongly suggested to change this parameter.

Determines the verbosity of the log. Can be set to one of debug, info, warning, error or critical.
Determines the format of the log entries. Please see the Python documentation on logging for more detail.
The XML-RPC endpoint. This should normally be
A full path pointing to the file containing your PEM-encoded SSL/TLS certificate.
Full path pointing to the file containing your PEM-encoded SSL/TLS private key. This can be the same file as your certificate.
The maximum system load. If the system load is greater than this value then the factory will sleep instead of poll for new jobs. This has currently no effect on Windows.
Path to a directory that will be used to store temporary files.
A comma separated list of backends (applications) that are enabled. For every worker that you added to your factory on the server you should have a backend in your configuration file. See below for more information about backends.

Configuring backends

For every worker that you added to your factory on the Officeshots website you should have a backend in your configuration file. You can name the backends any way you like. Add them all to the backends in a comma separated list. Then, for all the backends in that list you need to have a separate configuration section. For example, if you added AbiWord? and Gnumeric as workers on the Officeshots website then you need two backends in your configuration file.

Example configuration

backends = my_abiword, some_old_gnumeric

# Configuration options for AbiWord

# Configuration options for Gnumeric

If you do not want to use certain backends/sections then you only need to remove them from the backends line. You do not need to remove the entire sections. All the backends have at least a few configuration options in common.