chore: revised and updated the commands, added specifics to connect to remote clients

This commit is contained in:
Michele Cereda
2024-01-14 12:48:35 +01:00
parent 9aa414e323
commit 146fa725f1

View File

@@ -9,7 +9,12 @@
## TL;DR ## TL;DR
```sh ```sh
# Use a project manager. # Connect to specific clients.
# Default hostname: 'localhost'.
# Default password: contents of './gui_rpc_auth.cfg'.
boinccmd --host 'client.fqdn' --passwd 'password'
# Use project managers.
boinccmd --acct_mgr attach 'http://bam.boincstats.com' 'username' 'password' boinccmd --acct_mgr attach 'http://bam.boincstats.com' 'username' 'password'
boinccmd --acct_mgr info boinccmd --acct_mgr info
boinccmd --acct_mgr sync boinccmd --acct_mgr sync
@@ -21,15 +26,19 @@ boinccmd --acct_mgr detach
boinccmd --read_cc_config boinccmd --read_cc_config
boinccmd --read_global_prefs_override boinccmd --read_global_prefs_override
# Get the host's status. # Get the clients' status.
boinccmd --get_simple_gui_info boinccmd --get_simple_gui_info
boinccmd --get_state boinccmd --get_state
# Get the clients' messages.
# A.K.A. logs.
boinccmd --get_messages
# List the current tasks. # List the current tasks.
boinccmd --get_tasks boinccmd --get_tasks
boinccmd --get_tasks | grep -i -C 8 'executing' boinccmd --get_tasks | grep -i -C 8 'executing'
# Request projects' update. # Request projects' updates.
boinccmd --project http://www.worldcommunitygrid.org/ update boinccmd --project http://www.worldcommunitygrid.org/ update
# Get file transfers. # Get file transfers.
@@ -41,10 +50,10 @@ boinccmd --file_transfer \
'corona_RdRp_v2_sidock_00475839_r2_s-20_0_r356677380_0' \ 'corona_RdRp_v2_sidock_00475839_r2_s-20_0_r356677380_0' \
retry retry
# Retry deferred network communication. # Retry deferred network communications.
boinccmd --network_available boinccmd --network_available
# Toggle getting work units from a project. # Toggle getting work units from projects.
boinccmd --project http://www.worldcommunitygrid.org/ allowmorework boinccmd --project http://www.worldcommunitygrid.org/ allowmorework
boinccmd --get_project_status \ boinccmd --get_project_status \
| grep "master URL" \ | grep "master URL" \
@@ -59,11 +68,15 @@ boinccmd --get_project_status \
boinccmd --set_run_mode 'always' boinccmd --set_run_mode 'always'
boinccmd --set_gpu_mode 'auto' '10' boinccmd --set_gpu_mode 'auto' '10'
boinccmd --set_network_mode 'never' '600' boinccmd --set_network_mode 'never' '600'
# Run from containers.
docker run --rm --name 'boinc' 'boinc/client' \
boinccmd --host 'client.fqdn' --passwd '123' --get_messages
``` ```
## Gotchas ## Gotchas
- `boinccmd` looks for the `gui_rpc_auth.cfg` file in the same directory it is launched from. - If not given explicitly, `boinccmd` looks for the password in the `gui_rpc_auth.cfg` file in the same directory it is launched from.
## Further readings ## Further readings
@@ -74,8 +87,8 @@ boinccmd --set_network_mode 'never' '600'
References References
--> -->
<!-- Upstream -->
[boinccmd tool]: https://boinc.berkeley.edu/wiki/Boinccmd_tool
<!-- Knowledge base --> <!-- Knowledge base -->
[boinc]: boinc.md [boinc]: boinc.md
<!-- Upstream -->
[boinccmd tool]: https://boinc.berkeley.edu/wiki/Boinccmd_tool