These pages are historical. There is a new manual

Synchronizing configurations | Pluckeye

Synchronizing your configurations using the Pluckeye users site allows you to:

  1. Use a common configuration on different devices.
  2. Make your configuration changes visible to others for accountability.
  3. Restore your local configuration from the online backup if your local configuration is lost.

    On Android, synchronization occurs automatically, so if you’re only using Android you can stop reading here. But be aware that Pluckeye on Android currently only handles general configurations..

    For desktop Pluckeye, synchronization can be initiated in one of two ways:

  4. Uploading a configuration.
  5. Assigning a remote configuration to your device.

Uploading a configuration

Warning: This won’t work correctly on Pluckeye before version 1.0. If you’re using Pluckeye 0.99.x, skip down to manual upload below.

By default, the desktop version of Pluckeye stores configuration only on your local computer and does not copy it to the users site.

If you would like to share the configuration from your local computer with another device, you first need to upload it. To do this open a console and in it type:

pluck upload

After that, the configuration should automatically synchronize to and from the users site. It can then be shared with another device by assigning the configuration to another device, or by importing it in another configuration.

Manually uploading a configuration

Another way to “upload” your configuration is to simply export it to a file, then the copy the contents into a new configuration on, and then assign that configuration to your device. Step by step:

  1. Export your configuration to a file by running cd Destkop && pluck export >settings.txt in a console. This should create a file named settings.txt on your desktop.
  2. Open settings.txt in an editor such as notepad.
  3. Copy the contents by hitting Ctrl-A Ctrl-C.
  4. Create a new configuration, with any name you like.
  5. Paste the configuration contents (Ctrl-V) into the textarea under the edit tab.
  6. Click “Save”.
  7. Assign the remote configuration to your device.

Assigning a remote configuration

You can create a general configuration on the users site and assign it to your device. Doing so will cause your device to use the newly created configuration rather than the configuration that already exists on the device. Only a general configuration may be assigned to a device.

If you have a substantial local configuration, you may want to upload it before assigning another configuration to your device.

Synchronizing local configuration with remote

After you have assigned a remote configuration (i.e., one on the users site) to your device, you can synchronize your local version with the remote one by running:

pluck sync

However, changes made remotely may still take some time to come into effect on your devices. Hence, if you need to make an immediate change that will not be subject to your delay (e.g., adding a block rule), you should make the change on the device (i.e., by interacting with the browser extension or by typing pluck commands in a console) and then use pluck sync.