TamperDAV

To use the full TamperDAV feature set, ensure the TamperDAV server is running before starting Tampermonkey.

Tampermonkey syncs scripts into a subfolder of your configured path (e.g., Tampermonkey/sync) using internally generated UUIDs for filenames.

To locate a specific script file:

1. Via CLI: Run node find_script_in_meta.js --name="My Script Name".
2. Via UI: Navigate to the script in the Tampermonkey UI and retrieve the UUID from the browser's address bar.

TamperDAV is a WebDAV-like server used to sync Tampermonkey scripts and edit them with an external editor. It requires Node.js version 4.9 or greater.

Windows

Execute the batch file:

TamperDAV.bat

Linux

Execute the shell script:

./tamperdav.sh

To set up a development environment:

1. Install dependencies:

   npm install

2. Run the server:

   mkdir dav
   node server.js --path=dav/

# Install dependencies
$ npm install

# run
$ mkdir dav
$ node server.js --path=dav/

TamperDAV can be configured using a config.json file, command line arguments, or environment variables.

Environment Variables

Use TD_USERNAME and TD_PASSWORD to set authentication credentials via the environment.

Command Line Example

TD_USERNAME=derjanb TD_PASSWORD=secret node server.js --path=dav/ --port=6000

Config File Example (config.json)

{
    "path": "dav",
    "no-auth-warning": false,
    "username": "derjanb",
    "password": "secret",
    "port": "7000",
    "host": "localhost",
    "max-cursors": 512,
    "open-in-editor": "sublime_text",
    "meta-touch": true,
    "debug": true
}

TamperDAV implements a subset of the WebDAV protocol to allow clients (like Tampermonkey) to manage scripts.

Key Features

• Authentication: Supports Basic Authentication via --username and --password.
• Real-time Syncing: Uses a SUBSCRIBE method and a cursor system to notify clients of file changes immediately. When a file is changed, the server uses chokidar to watch the directory and pushes updates to active subscribers.
• Cloud Editor: Supports an EDITOR method. When triggered, the server uses the configured --open-in-editor to open the file locally on the host machine, allowing for a seamless transition from browser to local IDE.
• Meta-touching: When --meta-touch is enabled, changing a .user.js file will trigger a write to its corresponding .meta.json file. This ensures that connected browsers detect the change via file timestamp updates.

TamperDAV is a WebDAV server that can be started via a shell script (./tamperdav.sh) or a batch file (TamperDAV.bat) on Windows. It serves files from a specified directory and supports authentication and real-time file watching.

Configuration Precedence

Options are applied in the following order of priority (highest to lowest):

1. Command line parameters
2. Environment variables (TD_USERNAME, TD_PASSWORD)
3. Configuration file (config.json by default)

Basic Usage

To start the server with default settings (listening on localhost:7000):

./tamperdav.sh --path=./my-scripts

To use a custom configuration file:

./tamperdav.sh --config=my-config.json

#!/usr/bin/env nodejs
# (Example of how the entrypoint is invoked via shell/bat)

You can mount the TamperDAV server as a local directory using davfs.

sudo mount -t davfs http://localhost:7000 /mnt

To access the server via the Nautilus file manager, use the following URI:

dav://localhost:7000/

For security or automated environments, you can set credentials using environment variables. These take precedence over the config.json file but are overridden by command-line arguments.

• TD_USERNAME: The username for client authentication.
• TD_PASSWORD: The password for client authentication.

You can define server settings in a JSON file named config.json located in the same directory as server.js.

Example config.json:

{
    "path": "dav",
    "meta-touch": true,
    "username": "foo",
    "password": "bar",
    "port": 1234
}