Invites

SparkleShare can open invites issued by servers. When the user accepts an invite, SparkleShare is automatically configured to use a repository, and the user's public key is automatically uploaded.

<?xml version="1.0" encoding="UTF-8"?>
<sparkleshare>
  <invite>
    <address>ssh://[email protected]/</address>
    <remote_path>/hbons/Stuff</remote_path>
    <accept_url>https://www.sparkleshare.org/accept.php</accept_url> // Optional
    <announcements_url>tcp://notifications.sparkleshare.org:1986</announcements_url> // Optional
  </invite>
</sparkleshare>

Invite file names must end with the ".xml" extension. address and remote_path are the values you would normally fill in into the "Add Remote Project" window. accept_url is the url SparkleShare sends the user's public key to using HTTP POST (var named "pubkey"). You want to make sure this url is only valid for a short period of time and uses HTTP Secure.

Systems that have SparkleShare installed listen to the sparkleshare:// protocol handler. This way you can simply point to your invite file on the web, and the SparkleShare client will handle the rest. For example:

<a href="sparkleshare://path/to/the/invite.xml">Click here to add this project to SparkleShare</a>

Where sparkleshare:// will be replaced by https://.

In 0.9.0 it is also possible to use the sparkleshare-unsafe:// protocol handler this will get the invite file over http. This should only be used for development purposes, since this will reveal the whole URL to someone in between you and the server.