Deploy Scripts

Scripts in api/deploy/ upload repository source files to remote web servers via SFTP.

deploy-sftp.php

Path: api/deploy/deploy-sftp.php Base class: MokoEnterprise\CliFramework

Reads connection details from a sftp-config.json file and recursively uploads a repository's src/ directory to the configured remote path. Supports PuTTY .ppk keys and OpenSSH PEM keys via phpseclib. Strips // line comments from the config file so the Sublime Text SFTP plugin format works without modification.

Usage

php api/deploy/deploy-sftp.php [OPTIONS]

Option	Default	Description
`--path <dir>`	`.`	Repository root to deploy
`--src-dir <dir>`	`src`	Sub-directory inside the repo to upload
`--env <dev\|demo>`	—	Target environment; selects named config file (see below)
`--config <file>`	—	Explicit config path — overrides `--env` and auto-lookup
`--key-passphrase <pw>`	(none)	Passphrase for encrypted SSH key
`--dry-run`	off	Preview uploads without connecting
`--verbose` / `-v`	off	Show per-file transfer details
`--quiet` / `-q`	off	Suppress all output except errors
`--help` / `-h`	—	Show help and exit

Config File Resolution

--env controls which config file is loaded from {path}/scripts/sftp-config/:

`--env`	Config file
`dev`	`scripts/sftp-config/sftp-config.dev.json`
`demo`	`scripts/sftp-config/sftp-config.demo.json`
(none)	`scripts/sftp-config/sftp-config.json` (generic fallback)

Note: The rs environment has been retired. RS deployment is via the release pipeline only.

--config <file> always takes precedence over --env.

Directory Layout

Both directories are gitignored — create them locally and never commit their contents:

{repo_root}/
  scripts/
    sftp-config/            ← gitignored; copy templates from templates/scripts/deploy/
      sftp-config.dev.json  ← copy of sftp-config.dev.json.example, filled in
      sftp-config.demo.json ← copy of sftp-config.demo.json.example, filled in
    keys/                   ← gitignored; place your .ppk / PEM key file here

IMPORTANT: sftp-config.json files are for local development only. In CI/CD, all credentials must come from GitHub variables and secrets. Never commit sftp-config files.

See templates/scripts/sftp-config/README.md for step-by-step setup instructions.

Key Resolution

ssh_key_file in sftp-config.json may be an absolute path or a bare filename. When not absolute, the script looks for the key under {path}/scripts/keys/ first, then falls back to the value as a path relative to CWD.

Examples

# Preview what would be uploaded (no connection)
php api/deploy/deploy-sftp.php --env dev --dry-run --verbose

# Deploy src/ to dev server
php api/deploy/deploy-sftp.php --path /repos/mymodule --env dev

# Deploy src/ to demo server
php api/deploy/deploy-sftp.php --path /repos/mymodule --env demo

# Use a different source directory
php api/deploy/deploy-sftp.php --path /repos/mymodule --env dev --src-dir htdocs

# Deploy with explicit config and encrypted key
php api/deploy/deploy-sftp.php \
  --path /repos/mymodule \
  --config /repos/mymodule/scripts/sftp-config/sftp-config.demo.json \
  --key-passphrase "my passphrase"

Config Format

Copy a template from templates/scripts/deploy/ to scripts/sftp-config/ and fill in your values:

{
  "type": "sftp",
  "host": "iad1-shared-b7-01.dreamhost.com",
  "user": "mokoconsulting_dev",
  "ssh_key_file": "jmiller_private.ppk",
  "port": "22",
  "remote_path": "/home/mokoconsulting_dev/crm.dev.mokoconsulting.tech/htdocs/custom/mymodule/",
  "ignore_regexes": [
    "\\.git*",
    "sftp-config(-alt\\d?)?\\.json",
    "\\.DS_Store",
    "Thumbs\\.db"
  ]
}

ssh_key_file may be a bare filename (resolved from scripts/keys/) or an absolute path (e.g. J:/My Drive/Keys/jmiller_private.ppk).

Exit Codes

Code	Meaning
`0`	All files uploaded successfully
`1`	Connection failed or one or more files could not be uploaded
`2`	Invalid arguments or config file error

Called by Workflows

Workflow	Trigger	Target	Secrets prefix
`deploy-dev.yml`	`workflow_call`, `workflow_dispatch`	Dev server	`DEV_FTP_`
`deploy-demo.yml`	`workflow_call`, `workflow_dispatch`	Demo server	`DEMO_FTP_`

Note: The former deploy-rs.yml workflow (RS server, RS_FTP_ prefix) has been retired. RS deployment is now handled via the release pipeline (auto-release.yml).

See Deploy Workflows for workflow usage.

GitHub Secrets and Variables Reference

When called from CI, the script reads credentials from environment variables set by the workflow. See the SFTP Deployment Guide for the full secrets/variables tables for `DEV_FTP_` and `DEMO_FTP_` environments, including types (Secret vs. Variable) and scopes (Org vs. Repo).

Repo: moko-platform · moko-platform wiki

Field	Value
Minimum Version	04.07.00
Platform	all
Applies To	All repositories

Revision	Date	Author	Description
1.0	2026-05-08	Moko Consulting	Initial version