Technical documentation

These documents describe how to create and operate a BOINC project. Don't be scared by the amount of information; most of it is for advanced features that you probably won't need.

Quick start

• ​Create a BOINC project in 1 hour or less

BOINC concepts and features

• Computing model
  • Basic concepts
  • Platforms
  • Applications and versions
  • Jobs
  • Jobs and data
  • Redundancy and errors
  • Work distribution
  • Locality scheduling
  • Trickle messages
• Data management
  • Files and file references
  • File compression
  • Explicit client file management

Developing BOINC applications

• Overview
  • The BOINC wrapper
  • Apps that run in VirtualBox virtual machines
  • Apps that run in Docker containers
  • Example applications
• Basic APIs
  • API for native apps
  • Cross-platform utility functions
• Special types of applications
  • Multicore applications
    • OpenCL CPU applications
  • Applications that use GPUs
    • CUDA applications
    • OpenCL applications
  • Non-CPU-intensive applications
  • MPI applications
• Specialized APIs
  • Startup and status data
  • Diagnostics
  • Trickle messages
  • Intermediate upload
  • Apps that do network communication
  • API for wrappers
• Adding graphics
  • Graphics apps
  • Using OpenGL
  • Using HTML
• Customized scheduling
  • Plan classes
    • Specifying plan classes in XML
    • Specifying plan classes in C++
  • Job-level scheduler customization
• Languages other than C/C++
  • FORTRAN
  • Java
  • Python
  • PyMW: Python master/worker system
• Dynamic library naming issues
• Building applications
  • Windows
  • Mac OS X
  • Linux
  • Android
  • CUDA and OpenCL
• Debugging applications
  • Windows
  • Android
• Testing applications

Creating a BOINC project

• What is a project?
  • The project URL
  • Directory structure
• Setting up a BOINC server
  • The make_project script
• The project configuration file
  • Project options
  • Daemons
  • Periodic tasks
• Adding applications/platforms
• Adding application versions
• Administrative web interface
• Project control
• Security issues
  • Server security
  • Encryption utility program
  • Code signing
• Launching your project
• Using Secure Socket Layer (SSL)
• Internals
  • The BOINC database
  • Other job-processing daemons
  • Server-side file deletion
  • Database purging utility

Submitting and handling jobs

• Introduction
• Input and output templates
• Local job submission
  • Staging input files
  • Submitting jobs locally
  • Work generators
• Local web-based job submission
  • Per-user file sandbox
  • Example: LAMMPS
• Remote job submission
  • Job-based input file management
  • Remote access to output files
  • Job submission, monitoring, and control
• Job keywords
• Managing multiple job submitters
  • Access control and quotas
  • Prioritizing jobs
• Validation
  • Standard validators
  • Custom validators
  • Homogeneous redundancy
  • Homogeneous App Version
  • Adaptive replication
• Handling completed jobs
• Canceling jobs
• APIs for job-processing programs
• Broadcast and targeted jobs
• The status of completed jobs
• Single job submission
• Multi-size applications
• Condor/BOINC integration
• Pinning jobs to app version numbers
• Assigning credit to jobs

Maintaining a BOINC project

• Trouble-shooting server components
• Upgrading a project's server software
  • Server software change log
• Increasing server capacity
• Log rotation
• Watchdogs
• Stripcharts

Project web site

• Customize web site content
• Customize web site appearance with CSS
• Project-specific preferences
• Dealing with spam
• Creating and managing message boards
• Project news
• Web site translation
• Badges
• Server status page
• Profile screening
• Caching
• Adding a wiki
• Integration with WordPress
• Integration with Drupal

Communicating with volunteers

• Recruiting and retaining volunteers
• GUI URLs
• Notices
• Requiring that volunteers accept Terms of Use
• Adding project graphics to the manager's simple view

Miscellaneous

• Accepting donations through PayPal
• Blacklisting hosts
• Campus-level BOINC projects
• Code signing using X509 certificates
• Combining BOINC with Grids and clusters
• Configuring MySQL for BOINC
• Controlling account creation
• Export credit data as XML
• Importing BOINC-wide teams
• Including opaque data in scheduler request messages
• LDAP authentication
• Per-app credit
• User app selection
• Volunteer storage
• Volunteer data archival
• What to do when you run out of database IDs
• How to be compliant with GDPR

Unsupported software

• RBoinc remote job submission