e8ff40d5a4
* feat: add remote VSCode SSH support for remote server deployments Add support for opening VSCode via SSH when Vibe Kanban is running on a remote server. This allows users accessing the web UI through a tunnel to open projects/tasks in their local VSCode which connects to the remote server via SSH. Backend changes: - Add remote_ssh_host and remote_ssh_user fields to EditorConfig (v3) - Create config v8 with migration from v7 - Modify EditorConfig.open_file() to return URL when remote mode is enabled - Update API routes to return OpenEditorResponse with optional URL - Generate vscode:// URL scheme for remote SSH connections Frontend changes: - Update API client to handle OpenEditorResponse type - Modify hooks to open URLs in new tabs when returned - Add UI fields in settings for remote SSH configuration When remote_ssh_host is configured, clicking "Open in VSCode" generates a URL like: vscode://vscode-remote/ssh-remote+user@host/path/to/project This works for both project-level and task-level editor opening. * feat: extend remote SSH support to Cursor and Windsurf editors Extend the remote SSH feature to support Cursor and Windsurf editors, which are VSCode forks that use the same remote SSH protocol. Changes: - Update EditorConfig.open_file() to generate cursor:// and windsurf:// URLs - Show SSH configuration fields in settings for all three VSCode-based editors - Use same vscode-remote SSH URL pattern for all three editors When remote_ssh_host is configured, supported editors generate URLs like: - vscode://vscode-remote/ssh-remote+user@host/path - cursor://vscode-remote/ssh-remote+user@host/path - windsurf://vscode-remote/ssh-remote+user@host/path * fix: address clippy linting issues - Fix uninlined format args in v3.rs - Add allow attributes for re-exported types in v5-v7 * docs: add remote SSH configuration documentation Add comprehensive documentation for the remote SSH editor feature: - Expand Editor Integration section in global-settings.mdx - Document when to use remote SSH (tunnels, systemctl services, remote deployments) - Explain configuration fields (remote_ssh_host, remote_ssh_user) - Detail how the feature works with protocol URLs - List prerequisites for SSH access and VSCode Remote-SSH extension - Support for VSCode, Cursor, and Windsurf editors - Add Remote Deployment section to README.md - Quick guide for setting up remote SSH access - Link to detailed documentation - Include in feature list This documentation helps users understand and configure the remote SSH feature when running Vibe Kanban on remote servers accessed via browser. * remove package-lock in favour of pnpm lock * rollback config version increment * re-impl remote URL * Update i18n for general settings (vibe-kanban 4a1a3ae1) frontend/src/pages/settings/GeneralSettings.tsx Find any strings here that haven't been i18n'd and i18n them * add line number/col to the end of vscode-remote file paths * handle response url when opening file in ide from DiffCard * update remote-ssh guidance in readme * add image to global settings docs --------- Co-authored-by: Stephan Fitzpatrick <stephan@knowsuchagency.com> Co-authored-by: Britannio Jarrett <britanniojarrett@gmail.com>
130 lines
4.9 KiB
Plaintext
130 lines
4.9 KiB
Plaintext
---
|
|
title: "Global Settings"
|
|
description: "Configure application-wide settings including themes, agents, GitHub integration, and more"
|
|
sidebarTitle: "Settings"
|
|
---
|
|
|
|
You can configure application-wide settings via the **Settings** page. To access it, click the ⚙️ icon in the sidebar or select "Settings" from the top-right menu.
|
|
|
|
<Frame>
|
|
<img src="/images/vk-settings.png" alt="Vibe Kanban global settings page showing theme options, agent configuration, and GitHub integration settings" />
|
|
</Frame>
|
|
|
|
## Themes
|
|
|
|
Switch between light and dark themes to suit your preference.
|
|
|
|
## Default Agent Configuration
|
|
|
|
Choose the default agent and variant for new task attempts. This profile is pre-selected when creating new task attempts and follow-ups.
|
|
|
|
1. **Select an agent** (e.g., Claude Code, Gemini CLI, Codex)
|
|
2. **Choose a variant** if available (e.g., Default, Plan, Router)
|
|
|
|
<Tip>
|
|
You can override the default agent configuration per attempt in the create attempt dialog.
|
|
</Tip>
|
|
|
|
## Editor Integration
|
|
|
|
Configure integration with your preferred code editor for a seamless development workflow.
|
|
|
|
### Selecting Your Editor
|
|
|
|
Choose from various supported editors:
|
|
- **VS Code** - Microsoft's popular code editor
|
|
- **Cursor** - VSCode fork with AI-native features
|
|
- **Windsurf** - VSCode fork optimized for collaborative development
|
|
- **Neovim**, **Emacs**, **Sublime Text** - Other popular editors
|
|
- **Custom** - Use a custom shell command
|
|
|
|
### Remote SSH Configuration
|
|
|
|
<Frame>
|
|
<img src="/images/vk-editor-ssh.png" alt="Vibe Kanban settings editor section showing ssh configuration options." />
|
|
</Frame>
|
|
|
|
When running Vibe Kanban on a remote server (e.g., accessed via Cloudflare tunnel, ngrok, or as a systemctl service), you can configure VSCode-based editors to open projects via SSH instead of assuming localhost.
|
|
|
|
This feature is available for **VS Code**, **Cursor**, and **Windsurf** editors.
|
|
|
|
#### When to Use Remote SSH
|
|
|
|
Enable remote SSH configuration when:
|
|
- Vibe Kanban runs on a remote server (VPS, cloud instance, etc.)
|
|
- You access the web UI through a tunnel or reverse proxy
|
|
- Your code files are on a different machine than your browser
|
|
- You want your local editor to connect to the remote server via SSH
|
|
|
|
#### Configuration Fields
|
|
|
|
1. **Remote SSH Host** (Optional)
|
|
- The hostname or IP address of your remote server
|
|
- Examples: `example.com`, `192.168.1.100`, `my-server`
|
|
- Must be accessible via SSH from your local machine
|
|
|
|
2. **Remote SSH User** (Optional)
|
|
- The SSH username for connecting to the remote server
|
|
- If not specified, SSH will use your default user or SSH config
|
|
|
|
#### How It Works
|
|
|
|
When remote SSH is configured, clicking "Open in VSCode" (or Cursor/Windsurf):
|
|
1. Generates a special protocol URL like: `vscode://vscode-remote/ssh-remote+user@host/path/to/project`
|
|
2. Opens in your default browser, which launches your local editor
|
|
3. Your editor connects to the remote server via SSH
|
|
4. The project or task worktree opens in the remote context
|
|
|
|
This works for both project-level and task worktree opening.
|
|
|
|
#### Prerequisites
|
|
|
|
- SSH access configured between your local machine and remote server
|
|
- SSH keys or credentials set up (no password prompts)
|
|
- VSCode Remote-SSH extension installed (or equivalent for Cursor/Windsurf)
|
|
- The remote server path must be accessible via SSH
|
|
|
|
<Tip>
|
|
Test your SSH connection first with `ssh user@host` to ensure it works without prompting for passwords.
|
|
</Tip>
|
|
|
|
## GitHub Integration
|
|
|
|
Link your GitHub account by providing a Personal Access Token (PAT) to enable:
|
|
|
|
- Automatic branch management
|
|
- Pull request creation and tracking
|
|
- Status synchronisation directly from Vibe Kanban
|
|
|
|
## Notifications
|
|
|
|
Toggle sound effects and push notifications to stay informed about task status changes.
|
|
|
|
## Telemetry
|
|
|
|
Enable or disable telemetry data collection to help improve Vibe Kanban.
|
|
|
|
## Task Templates
|
|
|
|
Manage global task templates to accelerate task creation across all projects. Templates allow you to define reusable titles and descriptions for common tasks.
|
|
|
|
<Card title="Learn more about task templates" icon="clone" href="/configuration-customisation/creating-task-templates">
|
|
Complete guide to creating and managing task templates
|
|
</Card>
|
|
|
|
## Agent Settings (Profiles & Variants)
|
|
|
|
Define and customise agent variants under **Settings → Agents**. Variants let you maintain multiple configurations for the same agent (for example, a Claude Code "PLAN" variant).
|
|
|
|
<Card title="Agent Profiles & Variants" icon="robot" href="/configuration-customisation/agent-configurations">
|
|
Detailed guide with examples for configuring agent variants
|
|
</Card>
|
|
|
|
## Safety & Disclaimers
|
|
|
|
Manage acknowledgments and reset options for onboarding, safety disclaimers, and telemetry notices.
|
|
|
|
- **Onboarding**: Reset the onboarding process to rerun the initial setup.
|
|
- **Safety Disclaimer**: Reset or review the safety disclaimer prompt.
|
|
- **Telemetry Notice**: Reset or review the telemetry data collection acknowledgment.
|