Client configuration (advanced)

The BOINC core client can be controlled by command-line options, configuration files, and environment variables.

These features are generally useful only for advanced users.

Configuration files

BOINC uses the following configuration files. They are located in the BOINC data folder. You can edit one or more of these files before launching the client to control BOINC in various ways.

Account files: Each one describes an attached project.
global_prefs_override.xml: Override global preferences.
cc_config.xml: Turn log messages on/off by category, and other core client configuration options.
remote_hosts.cfg: Hosts from which remote GUI RPCs is allowed
gui_rpc_auth.cfg: GUI RPC password
project_init.xml: Startup project
acct_mgr_url.xml: Account manager URL
acct_mgr_login.xml: Account manager login

Command-line options

The core client has command-line options that provide minimal control (e.g. the ability attach and detach projects).

More detailed control, and the ability to interact with a running client, is provided by the boinccmd tool.

--help: Show client options.
--version: Show client version.
--attach_project URL account_key: Attach this computer to a new project.
--show_projects: Print a list of projects to which this computer is attached.
--detach_project URL: Detach this computer from a project.
--reset_project URL: Clear pending work for a project. Use this if there is a problem that is preventing your computer from working.
--update_prefs URL: Contact a project's server to obtain new preferences. This will also report completed results and get new work if needed.
--run_cpu_benchmarks: Run CPU benchmarks. Do this if you have modified your computer's hardware.
--check_all_logins: (Unix) If 'run if user active' preference is off, check for input activity on all current logins; default is to check only local mouse/keyboard
--gui_rpc_port N: Specify port for GUI RPCs
--allow_remote_gui_rpc: Allow GUI RPCs from remote hosts
--dir abs_path: Use the given directory as BOINC home
--detach: Detach from console (Windows only; Linux equivalent is --daemon, see below)
--no_gui_rpc: Don't allow GUI RPCs.
--daemon: Linux: detach from controlling terminal; Windows: run as service
--start_delay N: Specify a number of seconds to delay running apps after client startup **New in 6.1**.
--allow_multiple_clients: Allow multiple BOINC clients to run concurrently on a single host. If set, you must run each BOINC client in a separate BOINC data directory (if you run multiple clients in the same directory, this will not be detected, and mayhem will ensue). **New in 6.2.2**

Environment variables

HTTP_PROXY: URL of HTTP proxy
HTTP_USER_NAME: User name for proxy authentication
HTTP_USER_PASSWD: Password for proxy authentication
SOCKS4_SERVER: URL of SOCKS 4 server
SOCKS5_SERVER: URL of SOCKS 5 server
SOCKS5_USER: User name for SOCKS authentication
SOCKS5_PASSWD: Password for SOCKS authentication

Implementation and debugging command-line options

--exit_when_idle: Exit when 1) at least one scheduler request has been made, and 2) there are no more jobs, i.e. when all jobs have been completed, reported, and acknowledged. **New in 6.1** Also causes results to be reported immediately after completion.
--exit_before_start: Exit just before starting any job (use this to check the contents of slot directories).
--exit_after_finish: Exit just after finishing any job (use this to check the contents of slot directories).
--no_time_test: Don't run performance benchmarks; used fixed numbers instead.
--exit_after_app_start N: Exit about N seconds after first application starts
--min: Put client in the background after starting up
--skip_cpu_benchmarks: Don't run CPU benchmarks
--file_xfer_giveup_period N: Specify giveup period for file transfers
--started_by_screensaver: Passed by screensaver when it launches client