Installing The BOINC Client Software on Linux

From Unofficial BOINC Wiki

Jump to: navigation, search

Contents

[edit] General

You install the BOINC Client Software by running the Linux "Installer Program". This will guide you through the install just like any other

program that you have installed in the past.

Note:
I wrote the article using the Debian/GNU distro of Linux. Since every distro has its own variants, there may be some differences between my explainations and what you actually see on your screen.
I also don't have my monitor properly configured, so my screen shots are a little less than ideal.

More information about the Debian installer package for BOINC.

This "BOINC "How-To" Guide only covers the physical installation of the BOINC Client Software and does not cover other activities related to the installation and set-up of the BOINC Client Software which are covered in other guides. Use the

"Also See" section for a list of those guides.

[edit] Preconditions

In order to complete the procedure outlined in this guide, you must meet the following preconditions:

It works very similar to a different but more popular Graphical User Interface Operating System.

  • You must have Internet Access from this computer.
  • You must be able to operate the computer and access the Internet.

[edit] Installing The BOINC Client Software

[edit] Stage #1 - Prepare to Install

[edit] Explanation

In this stage we will do all of the prepatory work to get us ready to install the BOINC Client Software.

First you should plan to stop all running programs, and ensure that all of your unsaved work has been saved before continuing. This means that if you are working on your 2,000 page thesis and have not saved it yet ... well, now is the time ...

Though there are almost never any problems with the installation of the BOINC Client Software, you don't want to be the first to lose all their

work.

[edit] Step #1a - Stop All Other Programs

Stop all programs that you are currently running. Make sure you save your work.

[edit] Step #1b - Enable Your Internet Access

Enable access to the Internet for your computer.

[edit] Stage #2 - Download the BOINC Client Software

[edit] Explanation

Download Page for the BOINC Client Software
Download Page for the BOINC Client Software

Now we need to download the BOINC Client Software. Make sure that you select the correct version to down load from this list based on your Operating System.

Note:
Download the ONLY the Recommended Version! Unless you really know what you are doing with the BOINC Client Software, only use the "Recommended Version!"
Note:
Apple OS-X has two different types of Graphical User Interfaces (GUI) available for use. If you are just starting out, my advice is to use the standard GUI version. Later, when you know what you are doing, you can try the other version with the "Simple GUI".

I usually download the software to the desktop so it will be easier for me to find. From there, I do the next steps to install the BOINC Client Software.

If you look at the example, you will see that the version we want is the one that is in the third set of boxes on the first line below the bar indicating Linux/x86. Click on the link "Download". In this example we will get the BOINC Client Software of Version 4.43, which was the latest when this image was taken (unless some sneak changed my example. Curses!).

[edit] Step #2a - Download Page

Right-Click on this link and open it in a new window.

[edit] Step #2b - Download File

Click on the "Download" link in the line "Recommended Version" directly under the "Linux" line.


[edit] Step #2c - Save As Dialog

Security Warning Dialog
Security Warning Dialog

Right after clicking the link to download the software, you will most likely get a "Security Warning". Since you need to download this software, click the "Save to Disk" radio button and click Ok. This will save the file to your home directory.


[edit] Step #2d - Download In Progress

When I did my download I did not see a progress meter. At this point I'm not sure how to tell if the file download is complete, other than to check the file size.


[edit] Step #2e - Finishing Up Downloading the BOINC Client Software

"Users Home Directory" Icon on the Desktop
"Users Home Directory" Icon on the Desktop

Now, double click on the folder that says <username's> home. In my case I was logged in as root therefore the directory for which I am looking is "root's home". If, however, I was logged in as my regular user it would say "jim's home". In this directory you should see a file with a name similar to "boinc-4.43_i686-pc-linux-gnu.sh"

At this point we are ready for the next stage!


[edit] Stage #3 - Installing the BOINC Client Software

[edit] Explanation

The Installer Program has been downloaded an at this point we are going to install the BOINC Client Software on your computer. We are going to be presented with some options, and in most cases the default settings are good for almost all installations.

First, we must determine what type of user is going to be installing the BOINC Client Software. If you logged into Linux as root then you will have free reign as to where to install the BOINC Client Software. There are standards as to where the BOINC Client Software should be installed to be completely compatible with the Linux system hierarchy. I personally suggest installing the BOINC Client Software in /usr/boinc. Also as root, you will have the option of making the BOINC Client Software run as a Daemon, start in a login script, or as a standalone application.

If, on the other hand, you logged in under a standard user name (ie: not as root) then your choices are limited. In this case, I would suggest saving the file in your home directory. As a standard user, you will have the option of running the BOINC Client Software from your login script or as a standalong application.

Installing the program will be the same in all the above examples, with the exception of location. To get the BOINC Client Software to run from a startup script or as a Daemon we will have to take a couple of extra steps after it has been installed.


[edit] Step #3a - Decide Where BOINC Will Be Installed

The Linux Installer Program will create a subdirectory, from where it was executed. If you want the BOINC Client Software to be installed in your home directory, then place the Installer Program in your home directory and execute it there. If, however, you prefer it to be installed in usr/boinc then run the Installer Program from the /usr subdirectory.


[edit] Step #3b - Make the Installer Program Executable

"Installer Program" in User's Home Directory
"Installer Program" in User's Home Directory

Right click on the Installer Program and down to Properties.


"Installer Program" Properties Dialog Box
"Installer Program" Properties Dialog Box

On the new window, goto the Permissions tab. You should see three sets of check boxes, labeled Owner:, Group, and Others. For our purposes, we need to give Owner (that is you) the capability of executing this Installer Program.

Click the "Execute" check-box on the line for "Owner".

Now, at the bottom, click Close.


[edit] Step #3c - Start the Installer Program

"Run or Display" Dialog Box
"Run or Display" Dialog Box
Now that we have the Installer Program in the desired location, and has been made executable, we are ready to "Git'er Done!"

Locate the Installer Program and double click on its icon. You will have a dialog box similar to this one appear. You will want to click Run to execute the Installer Program.


[edit] Stage #4 - Initial Launch of the BOINC Client Software

[edit] Explanation

After the BOINC Client Software launches for the first time it will perform some configuration steps and run an initial Benchmark of your computer. This test is used to evaluate how "fast" your computer is so that the Project can assign you work that can be finished by the Result Deadline. For example, if your computer can only process four Work Units into Results, we had better not issue you 4,000 Work Units to process. If that occurred, you would get a large lump of stuff that your computer could not finish in time.

The Benchmark will make is seem like your computer, and the BOINC Client Software are not working correctly. This "freezing" effect is normal and expected.

While the Benchmark is running, you want to do as little as possible to get a "good" reading. You can look at the numbers in the Messages Tab of the BOINC Manager which should have opened on your desktop when you pressed the "Finish" button.

During the initial start up and running of the Benchmark the BOINC Client Software should produce Messages in the Messages Tab that will look something like the following: 

2005-07-12 12:17:37 [---] Starting BOINC client version 4.43 for linux_intelx86
2005-07-12 12:17:37 [---] Executing as a daemon
2005-07-12 12:17:37 [---] Data directory: \usr\BOINC (x86)\BOINC
2005-07-12 12:17:37 [---] BOINC is running as a service and as a non-system user.
2005-07-12 12:17:37 [---] No application graphics will be available.
2005-07-12 12:17:37 [---] No general preferences found - using BOINC defaults
2005-07-12 12:17:37 [---] Remote control not allowed; using loopback address
2005-07-12 12:17:39 [---] Running CPU benchmarks
2005-07-12 12:18:37 [---] Benchmark results:
2005-07-12 12:18:37 [---]    Number of CPUs: 4
2005-07-12 12:18:37 [---]    1467 double precision MIPS (Whetstone) per CPU
2005-07-12 12:18:37 [---]    1418 integer MIPS (Dhrystone) per CPU
2005-07-12 12:18:37 [---] Finished CPU benchmarks
2005-07-12 12:18:37 [---] Resuming computation and network activity
2005-07-12 12:18:37 [---] request_reschedule_cpus: Resuming activities
2005-07-12 12:18:37 [---] Insufficient work; requesting more
Note:
The BOINC Client Software may appear to "freeze" or "lock-up" while the Benchmark is running; this is normal and an expected behavior. To get the most accurate Benchmark scores I recommend that you do not have any other programs running.

You can get the full explanation of the Benchmark messages by looking at "Running CPU benchmarks". You can also see these, and many other messages at BOINC Messages which is also accessible from the Wiki's first page. The whole point to all these Messages is to keep you informed as to how the BOINC Client Software is operating on your computer.

[edit] Step #4a - BOINC's Maiden Voyage

Now that we have BOINC installed, getting it to run for the first time is easy. Double click on the run_client icon. The run_client script will start the BOINC program and put it in the background as a Daemon. Using this method you will not see any output on the screen. This method will also not restart BOINC after a reboot. I ran this script as root on my computer and the BOINC Client Software continued to run even after I logged out. I cannot say for sure if this will be the case for a regular user or not.



[edit] Step #4b - Allow The Benchmark Process Complete

In the time it takes to read the above section, the Benchmark process should run through to completion.



[edit] Step #4c - Let's See What Is Happening

After sufficient time has elapsed for the Benchmark process to complete, you can now click on the boincmgr icon. This will start the world famous Boinc Manager. From here you can manipulate the Projects as needed.



[edit] Stage #5 - Clean-Up Your Computer

[edit] Explanation

In this stage we do those activities to finish the installation and clean-up your computer.

[edit] Step #5a - Delete/Save Installer Program

If you only have one computer that you are going to use with the BOINC Client Software, and you do not want to save the Installer Program; select the icon on the desktop (or wherever you downloaded it to) and drag it to the "Trash".

If, however, you want to be able to install the BOINC Client Software on another computer, or, you want to preserve the Installer Program move it to a shared folder for local access or to a "save" directory.

[edit] Summary

We downloaded and installed the BOINC Client Software and started it up for its initial run and obtained a Benchmark score.

If you came here from the BOINC "How-To" Guide "Installing the BOINC Client Software And Participating In A BOINC Powered Project", then click the "Back" button on your Web Browser.


[edit] BOINC "How-To" Guides Related To Installation

The list that follows contains the BOINC "How-To" Guides, in rough order of use, that are used in the installation and set-up of the BOINC Client Software.

Note:
Don't panic! I have pictures and everything!
Retrieved from "http://www.boinc-wiki.info/Installing_The_BOINC_Client_Software_on_Linux"
Personal tools