kopia lustrzana https://github.com/linuxserver/docker-documentation
Bot Updating Documentation
LinuxServer-CI
rodzic
d9340116ca
commit
73138c281f
|
|
@ -1,8 +1,16 @@
|
||||||
# linuxserver/boinc
|
# [linuxserver/boinc](https://github.com/linuxserver/docker-boinc)
|
||||||
|
|
||||||
[](https://github.com/linuxserver/docker-boinc) [](https://github.com/linuxserver/docker-boinc/releases) [](https://github.com/linuxserver/docker-boinc/packages) [](https://gitlab.com/Linuxserver.io/docker-boinc/container_registry) [](https://microbadger.com/images/linuxserver/boinc) [](https://hub.docker.com/r/linuxserver/boinc) [](https://hub.docker.com/r/linuxserver/boinc) [](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-boinc/job/master/) [](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/boinc/latest/index.html)
|
[](https://github.com/linuxserver/docker-boinc)
|
||||||
|
[](https://github.com/linuxserver/docker-boinc/releases)
|
||||||
|
[](https://github.com/linuxserver/docker-boinc/packages)
|
||||||
|
[](https://gitlab.com/Linuxserver.io/docker-boinc/container_registry)
|
||||||
|
[](https://microbadger.com/images/linuxserver/boinc "Get your own version badge on microbadger.com")
|
||||||
|
[](https://hub.docker.com/r/linuxserver/boinc)
|
||||||
|
[](https://hub.docker.com/r/linuxserver/boinc)
|
||||||
|
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-boinc/job/master/)
|
||||||
|
[](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/boinc/latest/index.html)
|
||||||
|
|
||||||
[BOINC](https://boinc.berkeley.edu/) is a platform for high-throughput computing on a large scale \(thousands or millions of computers\). It can be used for volunteer computing \(using consumer devices\) or grid computing \(using organizational resources\). It supports virtualized, parallel, and GPU-based applications.
|
[BOINC](https://boinc.berkeley.edu/) is a platform for high-throughput computing on a large scale (thousands or millions of computers). It can be used for volunteer computing (using consumer devices) or grid computing (using organizational resources). It supports virtualized, parallel, and GPU-based applications.
|
||||||
|
|
||||||
## Supported Architectures
|
## Supported Architectures
|
||||||
|
|
||||||
|
|
@ -13,18 +21,19 @@ Simply pulling `linuxserver/boinc` should retrieve the correct image for your ar
|
||||||
The architectures supported by this image are:
|
The architectures supported by this image are:
|
||||||
|
|
||||||
| Architecture | Tag |
|
| Architecture | Tag |
|
||||||
| :---: | :--- |
|
| :----: | --- |
|
||||||
| x86-64 | latest |
|
| x86-64 | latest |
|
||||||
| arm64 | arm64v8-latest |
|
| arm64 | arm64v8-latest |
|
||||||
| armhf | arm32v7-latest |
|
| armhf | arm32v7-latest |
|
||||||
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
Here are some example snippets to help you get started creating a container from this image.
|
Here are some example snippets to help you get started creating a container from this image.
|
||||||
|
|
||||||
### docker
|
### docker
|
||||||
|
|
||||||
```text
|
```
|
||||||
docker create \
|
docker create \
|
||||||
--name=boinc \
|
--name=boinc \
|
||||||
-e PUID=1000 \
|
-e PUID=1000 \
|
||||||
|
|
@ -39,6 +48,7 @@ docker create \
|
||||||
linuxserver/boinc
|
linuxserver/boinc
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
### docker-compose
|
### docker-compose
|
||||||
|
|
||||||
Compatible with docker-compose v2 schemas.
|
Compatible with docker-compose v2 schemas.
|
||||||
|
|
@ -67,43 +77,44 @@ services:
|
||||||
|
|
||||||
## Parameters
|
## Parameters
|
||||||
|
|
||||||
Docker images are configured using parameters passed at runtime \(such as those above\). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
||||||
|
|
||||||
### Ports \(`-p`\)
|
### Ports (`-p`)
|
||||||
|
|
||||||
| Parameter | Function |
|
| Parameter | Function |
|
||||||
| :---: | :--- |
|
| :----: | --- |
|
||||||
| `8080` | Boinc desktop gui. |
|
| `8080` | Boinc desktop gui. |
|
||||||
|
|
||||||
### Environment Variables \(`-e`\)
|
|
||||||
|
### Environment Variables (`-e`)
|
||||||
|
|
||||||
| Env | Function |
|
| Env | Function |
|
||||||
| :---: | :--- |
|
| :----: | --- |
|
||||||
| `PUID=1000` | for UserID - see below for explanation |
|
| `PUID=1000` | for UserID - see below for explanation |
|
||||||
| `PGID=1000` | for GroupID - see below for explanation |
|
| `PGID=1000` | for GroupID - see below for explanation |
|
||||||
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
|
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
|
||||||
| `GUAC_USER=abc` | Username for the BOINC desktop gui. |
|
| `GUAC_USER=abc` | Username for the BOINC desktop gui. |
|
||||||
| `GUAC_PASS=900150983cd24fb0d6963f7d28e17f72` | Password's md5 hash for the BOINC desktop gui. |
|
| `GUAC_PASS=900150983cd24fb0d6963f7d28e17f72` | Password's md5 hash for the BOINC desktop gui. |
|
||||||
|
|
||||||
### Volume Mappings \(`-v`\)
|
### Volume Mappings (`-v`)
|
||||||
|
|
||||||
| Volume | Function |
|
| Volume | Function |
|
||||||
| :---: | :--- |
|
| :----: | --- |
|
||||||
| `/config` | Where BOINC should store its database and config. |
|
| `/config` | Where BOINC should store its database and config. |
|
||||||
|
|
||||||
#### Device Mappings \(`--device`\)
|
#### Device Mappings (`--device`)
|
||||||
|
|
||||||
| Parameter | Function |
|
| Parameter | Function |
|
||||||
| :---: | :--- |
|
| :-----: | --- |
|
||||||
| `/dev/dri` | Only needed if you want to use your Intel GPU \(vaapi\). |
|
| `/dev/dri` | Only needed if you want to use your Intel GPU (vaapi). |
|
||||||
|
|
||||||
## Environment variables from files \(Docker secrets\)
|
|
||||||
|
## Environment variables from files (Docker secrets)
|
||||||
|
|
||||||
You can set any environment variable from a file by using a special prepend `FILE__`.
|
You can set any environment variable from a file by using a special prepend `FILE__`.
|
||||||
|
|
||||||
As an example:
|
As an example:
|
||||||
|
|
||||||
```text
|
```
|
||||||
-e FILE__PASSWORD=/run/secrets/mysecretpassword
|
-e FILE__PASSWORD=/run/secrets/mysecretpassword
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
@ -111,17 +122,19 @@ Will set the environment variable `PASSWORD` based on the contents of the `/run/
|
||||||
|
|
||||||
## Umask for running applications
|
## Umask for running applications
|
||||||
|
|
||||||
For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional `-e UMASK=022` setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up [here](https://en.wikipedia.org/wiki/Umask) before asking for support.
|
For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional `-e UMASK=022` setting.
|
||||||
|
Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up [here](https://en.wikipedia.org/wiki/Umask) before asking for support.
|
||||||
|
|
||||||
|
|
||||||
## User / Group Identifiers
|
## User / Group Identifiers
|
||||||
|
|
||||||
When using volumes \(`-v` flags\), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`.
|
When using volumes (`-v` flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`.
|
||||||
|
|
||||||
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
|
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
|
||||||
|
|
||||||
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
|
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
|
||||||
|
|
||||||
```text
|
```
|
||||||
$ id username
|
$ id username
|
||||||
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
||||||
```
|
```
|
||||||
|
|
@ -130,13 +143,13 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel
|
||||||
|
|
||||||
This image sets up the BOINC client and manager and makes its interface available via Guacamole server in the browser. The interface is available at `http://your-ip:8080`.
|
This image sets up the BOINC client and manager and makes its interface available via Guacamole server in the browser. The interface is available at `http://your-ip:8080`.
|
||||||
|
|
||||||
By default, there is no username or password set. Custom usernames and passwords can be set via optional docker environment variables. Keep in mind that the `GUACPASS` variable accepts the `md5 hash` of the desired password \(the sample above is the hash for `abc`\). The md5 hash can be generated by either of the following commands:
|
By default, there is no username or password set. Custom usernames and passwords can be set via optional docker environment variables. Keep in mind that the `GUACPASS` variable accepts the `md5 hash` of the desired password (the sample above is the hash for `abc`). The md5 hash can be generated by either of the following commands:
|
||||||
|
|
||||||
```text
|
```
|
||||||
echo -n password | openssl md5
|
echo -n password | openssl md5
|
||||||
```
|
```
|
||||||
|
|
||||||
```text
|
```
|
||||||
printf '%s' password | md5sum
|
printf '%s' password | md5sum
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
@ -151,18 +164,21 @@ Sometimes, the pop-up windows may open in a tiny box in the upper left corner of
|
||||||
### Intel
|
### Intel
|
||||||
|
|
||||||
Hardware acceleration users for Intel Quicksync will need to mount their /dev/dri video device inside of the container by passing the following command when running or creating the container:
|
Hardware acceleration users for Intel Quicksync will need to mount their /dev/dri video device inside of the container by passing the following command when running or creating the container:
|
||||||
|
```--device=/dev/dri:/dev/dri```
|
||||||
`--device=/dev/dri:/dev/dri` We will automatically ensure the abc user inside of the container has the proper permissions to access this device.
|
We will automatically ensure the abc user inside of the container has the proper permissions to access this device.
|
||||||
|
|
||||||
### Nvidia
|
### Nvidia
|
||||||
|
|
||||||
Hardware acceleration users for Nvidia will need to install the container runtime provided by Nvidia on their host, instructions can be found here: [https://github.com/NVIDIA/nvidia-docker](https://github.com/NVIDIA/nvidia-docker) 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 BOINC docker container.
|
Hardware acceleration users for Nvidia will need to install the container runtime provided by Nvidia on their host, instructions can be found here:
|
||||||
|
https://github.com/NVIDIA/nvidia-docker
|
||||||
|
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 BOINC docker container.
|
||||||
|
|
||||||
|
|
||||||
## Docker Mods
|
## Docker Mods
|
||||||
|
[](https://mods.linuxserver.io/?mod=boinc "view available mods for this container.")
|
||||||
|
|
||||||
[](https://mods.linuxserver.io/?mod=boinc)
|
We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image (if any) can be accessed via the dynamic badge above.
|
||||||
|
|
||||||
We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image \(if any\) can be accessed via the dynamic badge above.
|
|
||||||
|
|
||||||
## Support Info
|
## Support Info
|
||||||
|
|
||||||
|
|
@ -181,4 +197,3 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to
|
||||||
* **17.03.20:** - Add armhf and aarch64 builds and switch to multi-arch image.
|
* **17.03.20:** - Add armhf and aarch64 builds and switch to multi-arch image.
|
||||||
* **16.03.20:** - Clean up old pid files.
|
* **16.03.20:** - Clean up old pid files.
|
||||||
* **15.03.20:** - Initial release.
|
* **15.03.20:** - Initial release.
|
||||||
|
|
||||||
|
|
|
||||||
Ładowanie…
Reference in New Issue