Getting HomeRun

HomeRun is FOSS (Free and Open Source Software), meaning both that it is distributed at no cost, and that the source code is published and available. But you don't need the source code to try it out or use it, since HomeRun is distributed in binary as well as source form. Also, HomeRun bundles everything it needs to operate with it: you don't need to install a database, etc In fact, you only need to make sure that you have a recent (1.5) version of Java (the computer language HomeRun is written in) installed on each computer. If it isn't already installed, don't worry: Java is also available for free for all major computing platforms (Windows, Linux, Mac OSX, etc). It's very easy to get started with HomeRun - read on!

Installation the Easy Way: Latest Binary Release

HomeRun has a client-server architecture, which in non-technical terms just means it is composed of two independent but cooperating parts. The part known as the server is intended to run on a single computer in a home network, which should always stay on, and be connected to the local network. Client software, by contrast, can run anywhere on the network (including the server computer), can run on multiple machines at the same time, and client computers do not have to stay running when they aren't needed. So to install HomeRun, simply select a computer you want to be the server, and complete the following simple steps:

• Download the 'Server' file (from table below) to the server computer.
• Unzip the file, and navigate to the fwork directory.
• Start the server by running the hrserver.bat batch file.
• For each client computer you want to use, download a copy of the 'Client' file.
• Unzip the Client file, and fire up a client by running the hrclient.bat batch file.
• See the Next Steps section below on how to configure your new system.

Additional notes about these instructions:

• It is not necessary to install all clients initially: one will do to configure the system.
• You may freely combine different operating systems: Windows server, Mac client, etc
• On non-Windows systems, the batch files are scripts: hrserver.sh and hrclient.sh.
• Zip archives can mess with file permissions on non-Windows systems: you may have to make the script files executable - viz chmod u+x hrserver.sh.
• Consult Readme files and other documentation included with Server or Client files for further instructions.

Current Release

Installation the Hard Way: Building from Source Releases

One great adavantage of FOSS software is the ability to alter or extend it to suit your purposes. This can only meaningfully be done if you possess the source code (and have some knowlege of programming). HomeRun allows and encourages this practice by offering a source release at SourceForge - look for the downloads with src as part of the file name. Here you may also find binary releases, as well as all previous releases. There are two additional software requirements to build from source: first, you need a Java 1.5 SDK, rather than just the so-called 'runtime' mentioned above. Second, you need to install a Java-based build tool available from the Apache Software Foundation called Ant. To install from source, follow these steps:

• Download and unzip the source distribution file to any computer with above-mentioned build tools installed.
• Build HomeRun by invoking the tool at the top directory: ant
• Server distribution files are generated in the server\target directory.
• Client distribution files are generated in the client\target directory.
• Follow binary installation instructions above using these files.

Installation on the Bleeding Edge: Building from the Code Repository

Finally, following the spirit of many open source projects, you may even obtain the source code as it is being worked on, and before it is ready for a release. Be warned: the code in this state may not be stable or even usable. But for the intrepid, visit GoogleCode for instructions about obtaining the latest source code. Note that you will need a client program for subversion, the source code repository management system, if you wish to build and install using the repository files. But if you merely want to look at the code, you may browse without any tool other than a web browser.

Next Steps - Configuration

You now should have a complete installation: one server and at least one client. However, HomeRun has a thouroughly modular design, which means that you only need to install the parts that you intend to use. Because of this, the server initially has very little in it. Your next job will be to select and install the capabilities that make sense for you and your home. Capabilites are organized into packages, and you install packages from the Setup program in the client user interface. But to assist you, we provide here an interactive package browser to make it easy for you to find what's available.