boinc-server-docker is the easiest way to run your own BOINC server. You can run the server on a Linux machine, in which case the requirements are,
or you can run it on Windows 7+ or Mac OSX in which case you will need,
- Docker Toolbox (>=1.11)
There are no other dependencies, as everything else is packaged inside of Docker.
For a full tutorial on setting up the server, see the project cookbook.
If you are somewhat familiar with Docker and BOINC, the following short description takes you through creating a server and running your own science application.
To check out this repository and get a test server fully up and running, simply run,
git clone https://github.com/marius311/boinc-server-docker.git cd boinc-server-docker docker-compose pull docker-compose up -d
Note: Make sure your user is added to the
docker group, otherwise the
docker commands in this guide need to be run with
On Windows, Mac, or Linux if running Docker via docker-machine instead of natively, you will also need to run
ssh docker@$(docker-machine ip) -L 80:localhost:80 -N and enter
tcuser when prompted for a password (on Mac/Linux, this command needs to be run with
You can now visit the server webpage and connect clients to the server at http://127.0.0.1/boincserver.
The server comes pre-configured to immediately run Docker-based science applications. To do so, first create a Docker container which runs your code. As an example, we will use a
python:alpine image. Suppose your calculation is run with the following command,
docker run python:alpine python -c "print('Hello BOINC')"
To submit a job on the server which runs this as a BOINC job you would first get a shell inside the server,
docker-compose exec apache bash
Then submit the job by running
bin/boinc2docker_create_work.py python:alpine python -c "print('Hello BOINC')"
Now you can connect a BOINC client the server and run this job. Note that to run these types of Docker-based jobs, the client computer will need 64bit Virtualbox installed and "virtualization" enabled in the BIOS.
If your job has output files, have the container write them in
/root/shared/results and they are automatically returned to the server when the job is done.
This is a simple example, but any Docker containers with arbitrary code installed inside of them will work!
To stop the server and delete all server and database files (for example, if you want to start over with a fresh copy), run,
docker-compose down -v
boinc-server-docker is not just useful to get a simple test server running, its actually meant to run your real server. To learn how to, read the project cookbook, or look at the Cosmology@Home source code as an example (
boinc-server-docker was in fact originally developed for Cosmology@Home).
- Version 1.4.1 - July 26, 2017
- The default server URL is now
http://127.0.0.1/boincserverrather than previously when it was
http://boincserver.com/boincserver. This removes the need to edit your
/etc/hostsfile on Linux, and on Windows/Mac/docker-machine replaces having to edit
/etc/hostswith the SSH tunnel command above. Related warning: the boincserver.com domain is currently being squatted, so if you're using the old version be careful that you do not type sensitive information into the server website thinking you're interacting with your local test server when in fact it's a remote server at the squatted domain.
- Updated docker-compose requirement from 1.6.0 to 1.7.0, and on Windows/Mac, updated Docker Toolbox requirement from 1.10.0 to 1.11.0
- A number of improvements to boinc2docker (see ccfe9a9).
- The default server URL is now
Development and Contributing
To modify and rebuild any of the
boinc-server-docker images, you will need this git repository's submodules checked out (run
git submodule update --init --recursive, or clone with
git clone --recursive in the first place). Note also that currently building the images only works on Linux.
Please don't hesitate to get in contact with the maintainers of this project or to submit pull requests!