peerfinder/templates/participate.html

{% extends "base.html" %}

{% block content %}

<h2>I want to participate!</h2>

<p>This tool relies on a pool of workers, all over dn42, that process
requests, perform ping measurements, and report back the results.  You're
welcome to add your own machines to the pool!</p>

<h3>Registering a worker</h3>

<p>You need to separately register each computer that will provide
measurements.  Manual validation is performed for each registration.</p>

<p>The contact information is free-form, and will be shown to users when
they launch measurements.  This allows users to contact you if they want
to peer.</p>

<form class="participant_form" action="/create/participant" method="POST">
  <label for="name">Machine name (required)</label>
  <input type="text" name="name" id="name" /><br />

  <label for="contact">Mean of contacting you, like IRC nick, mail address, ... (optional)</label>
  <input type="text" name="contact" id="contact" /><br />

  <label for="country">Country code where this machine is located (optional)</label>
  <input type="text" name="country" id="country" /><br />

  <label for="comment">Free-form comment, like tunnel technology (GRE, OpenVPN, ...), or things like &quot;very shitty DSL&quot; (optional)</label>
  <input type="text" name="comment" id="comment" /><br />

  <input type="submit" value="Register" />
</form>

<h3>Measurement scripts</h3>

<p>Currently, two measurement scripts are available, depending on your needs:
  <ul>
    <li><a href="/script.sh">shell script implemented as a self-contained loop</a></li>
    <li><a href="/cron.sh">shell script that you can run in cron</a></li>
  </ul>
  For both scripts, you need to edit the UUID variable to put your own UUID.
</p>

<p>Of course, you can write your own measurement scripts, using the
still-undocumented API.  Please make sure that your scripts are not too
aggressive: you should not fetch jobs more often than 30 seconds, while 1
minute is a good value.  Please include a fairly large amount of jitter (a
random sleep of at most 30 seconds, for instance).  This avoids
synchronisation between participants.</p>

{% endblock %}