Setting up your first remote-sync-config.json

Details
Category: MokoDeploy
  • Applicable Software: General
  • Min Version Number: 00.01.00
  • Max Version Number: Not Applicable

Create the config

Add remote-sync-config.json to your project root. A minimal SFTP setup:

{
  // connection
  "type": "sftp",
  "host": "example.com",
  "user": "deploy",
  "port": 22,
  "ssh_key_file": "~/.ssh/id_ed25519",
  "remote_path": "/var/www/mysite",

  // behaviour
  "upload_on_save": false,
  "ignore": ["node_modules/**", ".git/**", "*.log"],
  "ignore_regexes": ["\\.env.*"]
}

Use it

  1. Right-click a file or folder → MokoDeploy ▸ Upload.
  2. Run MokoDeploy: Diagnose to confirm the resolved host, path, key presence and ignore-rule counts before your first upload.
  3. Set "upload_on_save": true once you trust the config to deploy on every save.

Comments are allowed because the file is parsed as JSONC. Part of the Moko VS Code suite.

Hits: 7