Tabby WebDAV Sync Plugin

A WebDAV-based configuration synchronization plugin for Tabby terminal. Sync your Tabby configuration file (config.yaml) across devices using Nextcloud WebDAV or any other WebDAV server.

Features

• Automatic Sync - Automatically uploads config changes to WebDAV server when Tabby settings change
• Manual Sync - Manual upload/download buttons for on-demand synchronization
• Flexible TLS Configuration - Three modes for HTTPS connections:
  • System CA (default) - Use system certificate authorities
  • Skip verification - For self-signed certificates (not recommended for public networks)
  • Custom certificate - Use your own CA certificate file
• HTTP Support - Works with both HTTP and HTTPS WebDAV servers
• User-Configurable Path - Customize the remote file path on your WebDAV server
• Version Compatibility Check - Warns when downloading config from different Tabby versions
• Metadata Annotations - Uploaded files include generation time, Tabby version, and encryption mode

Installation

Build from Source

# Clone the repository
git clone <repository-url>
cd tabby-webdav-sync

# Install dependencies
npm install

# Build the plugin
npm run build

Install in Tabby

Tabby loads plugins as npm packages from plugins/node_modules/. The plugin directory must be named tabby-webdav-sync and contain both package.json and the built dist/ folder:

plugins/
└── node_modules/
    └── tabby-webdav-sync/
        ├── package.json          # from the repo root (keywords: ["tabby-plugin"], main: dist/index.js)
        └── dist/                 # the whole built folder (index.js + 460.index.js)

Windows:

C:\Users\<username>\AppData\Roaming\tabby\plugins\node_modules\tabby-webdav-sync\

Linux:

~/.config/tabby/plugins/node_modules/tabby-webdav-sync/

macOS:

~/Library/Application Support/tabby/plugins/node_modules/tabby-webdav-sync/

Restart Tabby after copying the files.

Usage

1. Open Tabby Settings (Ctrl+, or Cmd+,)
2. Navigate to WebDAV Sync tab
3. Configure your WebDAV server:

| Setting | Description | |---------|-------------| | Enable automatic sync | Toggle auto-sync on config changes | | Server URL | Your WebDAV server URL (e.g., https://nextcloud.example.com/remote.php/dav/files/username) | | Username | WebDAV authentication username | | Password | WebDAV authentication password | | Remote Path | Path for config file on server (default: /tabby-sync/config.yaml) | | TLS Verification | Certificate verification mode for HTTPS | | Encryption | None or Vault (Tabby's built-in encryption) |

4. Click Test Connection to verify settings
5. Click Save Settings to save configuration

Manual Sync

• Upload Now - Upload current Tabby config to WebDAV server
• Download Now - Download config from WebDAV server and apply

Automatic Sync

When enabled, the plugin automatically uploads your config to the WebDAV server whenever Tabby settings change.

WebDAV Server Configuration

Nextcloud

Use the following URL format:

https://<nextcloud-server>/remote.php/dav/files/<username>

Other WebDAV Servers

Ensure your WebDAV server supports:

• Basic authentication (username/password)
• File creation and modification
• Directory creation (for initial setup)

Development

Project Structure

src/
├── index.ts                          # Module entry point with auto-sync logic
├── declarations.d.ts                 # Type declarations for Tabby APIs
└── components/
    └── webdav-sync-settings.component.ts  # Settings UI component

Build Commands

npm run build    # Production build
npm run watch    # Watch mode for development
npm run lint     # Run linting

Test in Tabby

TABBY_PLUGINS=$(pwd) tabby --debug

Technical Details

Config File Storage

• Plugin settings are stored in webdav-sync-settings.json alongside Tabby's config
• Synced config is stored as config.yaml on the WebDAV server with metadata header

Metadata Format

Uploaded config files include a header:

# --- Tabby WebDAV Sync Plugin ---
# Generated: 2024-01-15T10:30:00.000Z
# Tabby version: 1.0.215
# Encryption: none
# ---

API Dependencies

• webdav npm package for WebDAV client functionality
• Tabby Core APIs: ConfigService, PlatformService
• Tabby Settings API: SettingsTabProvider

License

MIT

Acknowledgments

• Reference implementation from tabby-cloud-sync-settings
• Tabby terminal emulator