FAHCLIENT(8)

NAME
fahclient - service daemon for the Folding@home Client

SYNOPSIS
fahclient command [args ...]
fahclient log
fahclient showconfig

DESCRIPTION
fahclient is an rc(8) daemon for the Folding@home Client.

Configure fahclient with the following rc.conf(5) variables:

fahclient_enable
    Toggle to enable fahclient. Default: “NO”.

fahclient_chdir
    Working directory of fahclient. Default: “%%FAHCLIENT_WORK_DIR%%”.

fahclient_config
    Configuration file. Default: “%%ETCDIR%%/config.xml”.

fahclient_donor
    Donor to attribute work units to. Settings in the configuration file take precedence. Default: “Anonymous”.

fahclient_extra_flags
    Extra flags passed to the Folding@home Client after other flags. Default: empty.

fahclient_flags
    Extra flags passed to daemon(8) before any other flags. Default: empty.

fahclient_logfile
    Log file. Takes precedence over settings in the configuration file. Default: “%%FAHCLIENT_WORK_DIR%%/log.txt”.

fahclient_team
    Folding@home team to join and attribute work units to. Settings in the configuration file take precedence. Default: ‘11743’, Team FreeBSD.

fahclient_pidfile
    PID file. Default: “%%FAHCLIENT_WORK_DIR%%/fahclient.pid”.

fahclient_user
    System user to run fahclient as. Default: ‘fahclient’.

fahclient supports the following extra commands:

log View fahclient's folding logs.

showconfig
    Show the final configuration of fahclient after all configuration files and command-line flags are processed.

The Web Dashboard is available at https://v8-4.foldingathome.org/ and http://localhost:7396/ when fahclient is running. Visit the Web Dashboard to connect fahclient to a Folding@home Account and manage folding work.

Link fahclient to an existing account with an Account Token. Generate it on the Web Dashboard. Add the Account Token to either the configuration file or specify it a command-line argument to fahclient:
    sysrc fahclient_extra_flags+=" --account-token=<Account-Token>"

Refer to the Folding@home Client's help message for more usage information:
    %%FAHCLIENT_PROGRAM%% --help

FILES

%%FAHCLIENT_PROGRAM%%
    Folding@home Client program invoked by the fahclient daemon.

EXAMPLES

  Example 1: Quick Start
Start fahclient by executing the following steps:

    # Mount linprocfs(5) at /compat/linux/proc:
    mount -t linprocfs linprocfs /compat/linux/proc
    # Mount linsysfs(5) at /compat/linux/proc:
    mount -t linsysfs linsysfs /compat/linux/sys
    # Enable fahclient:
    service fahclient enable
    # Optionally, set the desired donor name:
    sysrc fahclient_donor="Anonymous"
    # Start fahclient:
    service fahclient start

Open the Folding@home Web Dashboard to finish the setup.

Add linprocfs(5) and linsysfs(5) entries to fstab(5) to make the setup persistent across reboots.

SEE ALSO
Folding@home v8.4 Client Guide: https://foldingathome.org/guides/v8-4-client-guide/

Folding@home FAQ: https://foldingathome.org/faq/

Folding Forum: https://foldingforum.org/

Team FreeBSD Statistics: https://stats.foldingathome.org/team/11743

HISTORY
Team FreeBSD was founded by Frank Mayhar.

AUTHORS
The fahclient manual page was written by Mateusz Piotrowski <0mp@FreeBSD.org>.

CAVEATS
The working directory of fahclient must have the execute permissions enabled to function properly. For example, on a zfs(4) dataset where %%FAHCLIENT_WORK_DIR%% is located the ‘exec’ property must be set to ‘on’.