Configuration options

Ian Channing edited this page Nov 8, 2018 · 27 revisions

There are a few default configuration options you can override by putting them in the config.xml found in:

  • Mac - ~/.config/sparkleshare/
  • Linux (default package manager) - ~/.config/sparkleshare/
  • Linux (flatpak) - ~/.config/org.sparkleshare.SparkleShare/
  • Windows - %APPDATA%\sparkleshare\

These may change or may be removed at any time, so be careful if you plan to make any manual changes.

<?xml version="1.0" encoding="UTF-8"?>
<sparkleshare>
  <user>
    <name>Hylke Bons</name>
    <email>hylkebons@gmail.com</email>
  </user>
  <folders_path>/Users/hbons/SparkleShare</folders_path> // Optional
  <fetch_avatars>False</fetch_avatars> // Optional
  <notifications>True</notifications> // Optional
  <folder>
    <path>/Users/hbons/Desktop</path> // Optional
    <name>SparkleShare-Design-Corner</name>
    <identifier>f8f7d0976075daf78ed9f456976fae33e3b9bd18</identifier>
    <url>ssh://git@github.com/hbons/SparkleShare-Design-Corner</url>
    <backend>Git</backend>
  </folder>
  <folder>
    <name>gnome-emoji</name>
    <identifier>f851e0a5d3ad20d345d3eae86ec5ed1eae998405</identifier>
    <url>ssh://git@github.com/hbons/gnome-emoji</url>
    <backend>Git</backend>
    <announcements_url>tcp://server:80</announcements_url> // Optional
  </folder>
</sparkleshare>

To change a project's path

  1. Add the project
  2. Stop SparkleShare
  3. Move the project
  4. Edit the config folder section for the project
    1. Set path to the new parent folder
    2. Change name if you rename the folder as well
  5. Start SparkleShare

To use your avatar

  1. Add an avatar at http://gravatar.com for the email config value
  2. Add in the <fetch_avatars>True</fetch_avatars> config option
  3. Restart SparkleShare
  4. SparkleShare will then pull down the avatar from there into ~/.config/sparkleshare/avatars/ folder (%APPDATA%\sparkleshare\avatars\ on Windows)
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.