folding-at-home-docker-gpu/README.md

# Folding@Home Docker Image Builds for Nvidia GPUs [![Build Status](https://jenkins.home.keganmyers.com/buildStatus/icon?job=folding-at-home-docker-gpu)](https://jenkins.home.keganmyers.com/job/folding-at-home-docker-gpu/)

This is a fork of [this](https://github.com/wandhydrant/folding-at-home-docker-gpu)
repo with minor modifications to make pre-built images.

## Usage

### Run it:

GPU access by containers went through several stages:
first direct export of /dev/dri and other devices; then
solutions with Docker "runtimes" (nvidia-docker v1
and v2); the current variant is the Nvidia Container
Toolkit. The latter is the only one I tested this with.

As for the BOINC Nvidia container, please:

1. Install Docker (19.03 or later);

2. Install the Nvidia drivers (so that "nvidia-smi" gives you output on the host);

3. Install the [Nvidia Container Toolkit](https://github.com/NVIDIA/nvidia-docker) (see "Usage" on the linked page to test nvidia-smi in a container).

Finally you can run this container:

```
docker run -d \
  --name folding-at-home \
  --gpus all \
  -h node \
  -e USER=Anonymous \
  -e TEAM=0 \
  -e ENABLE_GPU=true \
  -e ENABLE_SMP=true \
  --restart unless-stopped \
  terribleplan/folding-at-home-docker-gpu:latest \
  --allow 0/0 --web-allow 0/0
```

``-h node`` sets an anonymous hostname instead of copying yours.

The last line means that Folding@home's web access will let everybody in,
but as the port is not exported, you can use it only from the Docker host,
pointing your browser at the container:

```
echo http://$(docker inspect  --format "{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}" folding-at-home):7396
```

### (optional) Build the image yourself

If you do not wish to use pre-built images you can build it yourself:

```
cd <git-checkout>
docker build -t my-fah-nvidia-image .
```

## Parameters

- USER - Folding@home username (default: Anonymous)
- TEAM - Foldinghome team number (default: 0)
- PASSKEY - [optional] Folding@home [passkey](https://apps.foldingathome.org/getpasskey)
- ENABLE_GPU - Enable GPU compute (default: true)
- ENABLE_SMP - Enable auto-configuration of SMP slots (default: true)
- POWER - by default "full"; but you might want to switch to "medium" and see how hot your hardware gets (especially laptops). "light" did not use the GPU at all for me. You can always switch this in the web interface.

Additional configuration parameters can be passed as command line arguments. To get the full list of parameters run:

```
docker run terribleplan/folding-at-home-docker-gpu --help
```