SFTP uploader plugin for webpack

A webpack plugin to upload your build folder(s) to server by sftp.

NOTE: Node v12+ and webpack v4+ are supported.

Installation

npm i -D sftp-uploader-webpack-plugin

or

yarn add -D sftp-uploader-webpack-plugin

Usage

Webpack configuration webpack.config.ts

1// import SftpUploader from 'sftp-uploader-webpack-plugin';
2const SftpUploader = require('sftp-uploader-webpack-plugin');
3// ...
4
5const webpackConfig = {
6  // ...
7  plugins: [
8    // ...
9    ...(!process.env.SFTP_REMOTE_HOST
10      ? []
11      : [
12          new SftpUploader({
13            // ssh options
14            scp: {
15              host: process.env.SFTP_REMOTE_HOST,
16              ...(process.env.SFTP_REMOTE_PORT && { port: +process.env.SFTP_REMOTE_PORT }),
17              username: process.env.SFTP_REMOTE_USER,
18              password: process.env.SFTP_REMOTE_PASSWORD,
19              // ... other `ssh2` options
20            },
21            remotePath: process.env.SFTP_REMOTE_PATH/* ! */,
22            // localPath: path.resolve(__dirname, 'dist'),
23          }),
24        ]),
25  ],
26}
27module.exports = webpackConfig;

Example .env

1# SFTP
2SFTP_REMOTE_HOST=localhost
3SFTP_REMOTE_PORT=22
4SFTP_REMOTE_USER=user
5SFTP_REMOTE_PASSWORD=password
6SFTP_REMOTE_PATH=/var/www/prod