This Installation page works on the assumption that you have already submitted your [Exim BuildFarm Application](http://eximbuild.mrball.net/cgi-bin/register-form.pl) and the BuildFarm administration has sent you an email with your machine alias (aka _animal_) and secret password, which you will enter in step 9 below. If you just want to run the build farm client and never submit the results, you call simply run everything with the --test option and it will still work. If you ever run it without --test, it will still work, but the server will reject the feedback because it's from an unknown _animal_.
+If you want to run more than one instance of the build farm to test multiple different configurations, such as one with OpenSSL and one with GnuTLS, simply start at step 9. More details on the extra configuration required to keep it separate from the main build are at the end of this page.
+
## Install Steps
1. Make sure that all required packages for Exim to build successfully are installed. The minimal package requirements are the basic suite of compiler tools and basic libraries. You will also need to install the ccache package.
2. Create the master exim user (i.e. the user that Exim changes uid to when it runs in normal operation). I suggest the user **exim**. If you already have the Exim package provided by your distro installed, chances are good that you already have a user named **exim** or **exim4**. That user is fine. This howto also assumes you use the groupname **exim**.
-3. Create a user that will run the Build Farm. I suggest the user **farm**. Due to some assumptions that are made in the test suite, the group name must also be **farm**. It is ok if you make it a secondary group or the primary group.
+3. Create a user that will run the Build Farm. I suggest the user **farm**. Due to some assumptions that are made in the test suite, the group name must also be **farm**. It is ok if you make it a secondary group or the primary group. You also must assign a geckos name, or some tests will fail. I suggest "Exim BuildFarm". An example command that should work for most distributions:
+`useradd -m -c 'Exim BuildFarm' farm`
4. Add **exim** as a secondary group to the **farm** user. (You should **NOT** add **farm** as a secondary group to the exim user; this will cause test errors.)
5. Configure sudo to allow user **farm** to elevate to root without a password. Run `visudo` and add:
`farm ALL=(ALL) NOPASSWD: ALL`
12. Test the configure process by running `./run_build.pl --test --verbose=2 --only-steps=configure`. If there are errors, you'll need to correct them until the process succeeds (ends with OK). You can repeat this as many times as necessary because test mode does not store the status of the git repo or the status of each stage of the build.
13. Test the build process by running `./run_build.pl --test --verbose=2 --only-steps=configure,make`. If there are build errors, make adjustments, install additional packages, etc, and repeat the test.
14. Test the test suite by running `./run_build.pl --test --verbose=2 --only-steps=configure,make,test --override range_num_tests='1 2'`. If there are build errors when building the test suite, or runtime errors trying to run the test suite, you may need to install additional packages (you shouldn't though).
-15. If you enabled the documentation building process in the *build-farm.conf*, then you can try to build it with `./run_build.pl --test --verbose=2 --only-steps=configure,build_docs`. For documentation generation to succeed, it will require extra packages to be installed to support xml, xslt, pdf, and a few other things.
+15. If you enabled the documentation building process in the *build-farm.conf*, then you can try to build it with `./run_build.pl --test --verbose=2 --only-steps=configure,make-doc`. For documentation generation to succeed, it will require extra packages to be installed to support xml, xslt, pdf, and a few other things.
16. If you can get past each of these steps, then your build farm system meets the minimum requirements.
17. The official process can be kicked off by running `/home/farm/code/run_cron.sh --run-all`. This will run the default build configuration, keep track of the git repository status, and upload the build results to the server.
18. Once that command runs with no complaints, add it to the **farm** user crontab. You can run it at whatever frequency you choose, I suggest 1 hour. If a previous instantiation is still running, the script will detect the lockfile and exit so as not to step on each other.
+## Multiple build clients on one machine
+As mentioned above, you can start at step 9. A second application must be filled out to put the appropriate data in the database because this is treated a separate BuildFarm client:
+
+1. Make a second copy of the *build-farm.conf* with a different name, such as *build-farm-alias2.conf*.
+2. Set the path for build_root and the CCACHE_DIR environment settings, each to a new subdirectory from the first configuration.
+3. Create the new build_root directory.
+4. When testing, pass this additional parameter to any build script you run: `--config /path/to/build-farm-machine2.conf`.
+5. Add a new cron job for this second build farm client in the same way you chose to do the first one, just make sure to specify the --config option with it.
+
## Further documentation
* Details of options in [build-farm.conf](https://github.com/mrballcb/exim-build-farm-client/wiki/BuildConfigConf)
* Details of [potential testing commandlines](https://github.com/mrballcb/exim-build-farm-client/wiki/TestingBuilds)
+* Details of [building documentation](https://github.com/mrballcb/exim-build-farm-client/wiki/BuildingDocs)
git://git.exim.org / buildfarm-client-wiki.git / blobdiff