jsharmony-cms/doc/deployment_target.json

jsHarmony CMS

//Deployment Target Publish Path

  //SFTP
  sftp://username:password@host:port/path
  //* Note - if password is not set, the Public Key defined in the Deployment Target will be used for authentication
  //* Note - be sure to review the "ftp_config.delete_excess_files" option

  //FTPS
  ftps://username:password@ftp.domain.com:port/path
  //* Note - be sure to review the "ftp_config.delete_excess_files" option

  //FTP
  ftp://username:password@ftp.domain.com:port/path
  //* Note - be sure to review the "ftp_config.delete_excess_files" option

  //Local Filesystem
  file://c:/path/to/folder/
  //* Note - be sure to review the "fs_config.delete_excess_files" option

  //CMS Deployment Host
  cmshost://hostid
  //Connect as a remote host using the jsharmony-cms-host program
  //  https://github.com/apHarmony/jsharmony-cms-host

  //Amazon S3
  s3://path/to/bucket/
  //Set access key and secret key in s3_config parameter below
  
  //GIT HTTPS
  git_https://username:password@host/path
  //* Note - set the git branch in the git_config.branch parameter

  //GIT SSH
  git_ssh://username@host/path
  //* Note - git_ssh will use the Public / Private Key defined in the Deployment Target as its identity
  //* Note - set the git branch in the git_config.branch parameter



//Deployment Target Publish Config
{
  "page_subfolder": "",   //Store CMS page files in a subfolder of the publish directory, ex. 'pages/'
  "media_subfolder": "",  //Store CMS media files in a subfolder of the publish directory, ex. 'media/'
  "url_prefix": "/",                 //Prefix for URLs on publish, ex. '/content/'.  Can be used in page templates as %%%url_prefix%%%
  "url_prefix_page_override": null,  //Override URL prefix for CMS page URLs, ex. '/pages/'
  "url_prefix_media_override": null, //Override URL prefix for CMS media URLs, ex. '/media/'
  "published_url": null,  //(Optional) URL of published site, ex. https://example.com
  "exec_pre_deployment": null,     //Execute shell command after populating publish folder, before deployment
                                   //Ex. { cmd: 'cmd', params: ['/c', 'echo abc > c:\\a.a'] }
  "exec_post_deployment": null,    //Execute shell command after deployment
                                   //Ex. { cmd: 'cmd', params: ['/c', 'echo abc > c:\\a.a'] }
  "git_branch": "site_%%%SITE_ID%%%",    //Git branch used for deployment.  The %%%SITE_ID%%% parameter is replaced with the site id.
  "copy_folders": [/* "dir1","dir2" */], //Copy contents from the source folders into the publish folder
  "publish_local_templates": false,      //Whether to include the site's "templates" folder in the published files
  "ignore_remote_template_certificate": false,  //When downloading remote templates, ignore self-signed certificate errors

  //FTP/FTPS/SFTP publish settings
  "ftp_config": {
    "overwrite_all": false,         //For FTP / FTPS / SFTP, if true, always upload all files, instead of comparing size and MD5
    "delete_excess_files": false,   //For FTP / FTPS / SFTP, if true, delete excess files in destination that weren't in the publish build

    "ignore_certificate_errors": false,    //For FTPS, ignore self-signed certificate errors
    "compression": false,                  //For FTP / FTPS, whether to enable compression
  },

  //Local Filesystem deployment settings
  "fs_config": {
    "delete_excess_files": false,   //If true, delete excess files in destination that weren't in the publish build
  }

  //CMS Deployment Host settings
  "cmshost_config": {
    "download_remote_templates": false,   //Download remote templates via Deployment Host
    "remote_timeout": 60,                 //Timeout (seconds) for downloading remote templates
  },

  //Amazon S3 deployment settings
  "s3_config": {
    "accessKeyId": "",
    "secretAccessKey": "",
    "upload_params": { //Add parameters to the S3.upload request
      //"ACL": "public-read",
      //More parameters can be found at:
      //https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#putObject-property
    },
  },

  //Git deployment settings
  "git_config": {
    "branch": "master",  //Branch where the files will be uploaded
    "options": {         //Any additional git config options can be used
      "user.email": "cms@localhost",
      "user.name": "CMS",
    }
  },

  //Advanced options
  //----------------
  "generate": { //Items to generate on publish
    "onBeforeDeploy": true,      //true (all), false (none), or array of items, ex: ["page","media"]
    "onDeploy": true,            //true (all), false (none), or array of items, ex: ["page","media"] 
    "onDeploy_PostBuild": true,  //true (all), false (none), or array of items, ex: ["page","media"]
  },
  //Remote folders or files to ignore when deleting excess files on publish
  //Use with FTP, FTPS, SFTP, S3, and Local File System deployments
  "ignore_remote": [
    "path/to/folder",
    "path/to/file"
  ]
}

//Template Variables
//  Template Variables can be used in Page Template HTML and Component Template HTML as: %%%key%%%
//  Template Variables can also be used in Remote Template URLs as: %%%key%%%
{
  "key": "value",   //Basic Param

  "key": {          //Separate values for editor and publish templates
    "editor": "value_1",
    "publish": "value_2"
  },

  "key": {          //Value for publish, and blank (no value) for editor
    "publish": "value_2"
  },
}