You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-2Lines changed: 6 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -72,8 +72,8 @@ There are a couple of minor issues with the webgui:
72
72
### Nvidia
73
73
74
74
Hardware acceleration users for Nvidia will need to install the container runtime provided by Nvidia on their host, instructions can be found here:
75
-
https://github.com/NVIDIA/nvidia-docker
76
-
We automatically add the necessary environment variable that will utilise all the features available on a GPU on the host. Once nvidia-docker is installed on your host you will need to re/create the docker container with the nvidia container runtime `--runtime=nvidia` and add an environment variable `-e NVIDIA_VISIBLE_DEVICES=all` (can also be set to a specific gpu's UUID, this can be discovered by running `nvidia-smi --query-gpu=gpu_name,gpu_uuid --format=csv` ). NVIDIA automatically mounts the GPU and drivers from your host into the foldingathome docker container.
We automatically add the necessary environment variable that will utilise all the features available on a GPU on the host. Once nvidia container toolkit is installed on your host you will need to re/create the docker container with the nvidia container runtime `--runtime=nvidia` and add an environment variable `-e NVIDIA_VISIBLE_DEVICES=all` (can also be set to a specific gpu's UUID, this can be discovered by running `nvidia-smi --query-gpu=gpu_name,gpu_uuid --format=csv` ). NVIDIA automatically mounts the GPU and drivers from your host into the foldingathome docker container.
77
77
78
78
## Usage
79
79
@@ -91,6 +91,7 @@ services:
91
91
- PUID=1000
92
92
- PGID=1000
93
93
- TZ=Etc/UTC
94
+
- CLI_ARGS= #optional
94
95
volumes:
95
96
- /path/to/data:/config
96
97
ports:
@@ -107,6 +108,7 @@ docker run -d \
107
108
-e PUID=1000 \
108
109
-e PGID=1000 \
109
110
-e TZ=Etc/UTC \
111
+
-e CLI_ARGS= `#optional` \
110
112
-p 7396:7396 \
111
113
-p 36330:36330 `#optional` \
112
114
-v /path/to/data:/config \
@@ -125,6 +127,7 @@ Containers are configured using parameters passed at runtime (such as those abov
125
127
|`-e PUID=1000`| for UserID - see below for explanation |
126
128
|`-e PGID=1000`| for GroupID - see below for explanation |
127
129
|`-e TZ=Etc/UTC`| specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
130
+
|`-e CLI_ARGS=`| Optionally pass additional cli arguments to `FAHClient` on container start. |
128
131
|`-v /config`| Where Folding@home should store its database and config. |
129
132
130
133
## Environment variables from files (Docker secrets)
@@ -288,6 +291,7 @@ Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64
288
291
289
292
## Versions
290
293
294
+
***15.06.24:** - Rebase to Ubuntu Noble, add optional cli args.
291
295
***14.12.22:** - Rebase to Ubuntu Jammy, migrate to s6v3.
292
296
***15.01.22:** - Rebase to Ubuntu Focal. Add arm64v8 builds (cpu only). Increase verbosity about gpu driver permission settings.
- { env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London." }
26
24
param_usage_include_vols: true
27
25
param_volumes:
28
26
- { vol_path: "/config", vol_host_path: "/path/to/data", desc: "Where Folding@home should store its database and config." }
@@ -34,17 +32,16 @@ cap_add_param: false
34
32
cap_add_param_vars: ''
35
33
36
34
# optional container parameters
37
-
opt_param_usage_include_env: false
35
+
opt_param_usage_include_env: true
38
36
opt_param_env_vars:
37
+
- { env_var: "CLI_ARGS", env_value: "", desc: "Optionally pass additional cli arguments to `FAHClient` on container start." }
39
38
opt_param_usage_include_vols: false
40
39
opt_param_usage_include_ports: true
41
40
opt_param_ports:
42
41
- { external_port: "36330", internal_port: "36330", port_desc: "Optional port for connecting remotely via FAHControl app (no password)." }
43
42
opt_param_device_map: false
44
43
opt_param_devices:
45
44
- { device_path: "/dev/dri", device_host_path: "/dev/dri", desc: "Only needed if you want to use your Intel GPU (vaapi)." }
46
-
opt_cap_add_param: false
47
-
optional_block_1: false
48
45
49
46
# application setup block
50
47
app_setup_block_enabled: true
@@ -62,11 +59,12 @@ app_setup_block: |
62
59
### Nvidia
63
60
64
61
Hardware acceleration users for Nvidia will need to install the container runtime provided by Nvidia on their host, instructions can be found here:
65
-
https://github.com/NVIDIA/nvidia-docker
66
-
We automatically add the necessary environment variable that will utilise all the features available on a GPU on the host. Once nvidia-docker is installed on your host you will need to re/create the docker container with the nvidia container runtime `--runtime=nvidia` and add an environment variable `-e NVIDIA_VISIBLE_DEVICES=all` (can also be set to a specific gpu's UUID, this can be discovered by running `nvidia-smi --query-gpu=gpu_name,gpu_uuid --format=csv` ). NVIDIA automatically mounts the GPU and drivers from your host into the foldingathome docker container.
We automatically add the necessary environment variable that will utilise all the features available on a GPU on the host. Once nvidia container toolkit is installed on your host you will need to re/create the docker container with the nvidia container runtime `--runtime=nvidia` and add an environment variable `-e NVIDIA_VISIBLE_DEVICES=all` (can also be set to a specific gpu's UUID, this can be discovered by running `nvidia-smi --query-gpu=gpu_name,gpu_uuid --format=csv` ). NVIDIA automatically mounts the GPU and drivers from your host into the foldingathome docker container.
0 commit comments