Skip to content

Latest commit

 

History

History
58 lines (37 loc) · 1.62 KB

README.md

File metadata and controls

58 lines (37 loc) · 1.62 KB

boinc-monitor

boinc-monitor is a simple web service that allowes checking on you boinc clients

Installation

boinc-monitor was written using Python 3.9, but can probably support earlier versions (3.6+).

Python dependencies

You can install python dependencies with pip or pipenv:

> # Using pip
> pip install -r requirements.txt

> # Using pipenv
> pipenv install

Building web interface

First of all, grab yarn. Install requirements and build static files:

> yarn --cwd gui install
> yarn --cwd gui build

Configuring listen port and boinc-clients

Configuration is handled by environs. This means that you can either pass options through environment variables, or define them in your .env file in project directory.

Boinc client connection parameters are passed in CLIENTS variable, described as boinc:// URI:

# Passing single client connection
CLIENTS=boinc://:[email protected]?name=homepc
# Or multiple, comma-separated
CLIENTS=boinc://:[email protected]?name=homepc,boinc://:[email protected]?name=paragon

Running in Docker

You can use provided Dockerfile and docker-compose.yml to build boinc-monitor image and run it with Docker. One day i'll publish image on Docker Hub :)

Screenshot

web gui screenshot

Future plans?

  1. Improving web interface
  2. Statistics page?

I don't currently see this project as a way to control your boinc clients, so starting/stopping jobs and adding projects is probably out of scope.