Wondering what’s next for npm?Check out our public roadmap! »

    gatsby-plugin-sftp-cache

    0.2.0 • Public • Published

    gatsby-plugin-sftp-cache

    npm npm

    Maintainability Contributor Covenant

    Cache directories in your gatsby project to a remote server to preserve files and speed up deployments via https://github.com/axe312ger/sftp-cache

    Works well with https://github.com/axe312ger/gatsby-plugin-netlify-cache, make sure to enable the netlify-cache plugin before the sftp-cache plugin.

    Features

    • Download from cache directory and refill it again
    • Compare file by missing on other end, modification date, file size and md5 hash
    • Keeps file modification date
    • Client: Windows, Linux, OSX
    • Server: Any host supporting sftp. MD5 hash comparision also needs md5 or md5sum installed on the server.

    Installation

    npm i gatsby-plugin-sftp-cache

    Usage

    Pass your server connection credentials, the remote cache directory and the directories you want to cache to the plugin options in your gatsby-config.js:

    const { join } = require('path')
    
    require('dotenv').config({
      path: `.env.${process.env.NODE_ENV}`
    })
    
    module.exports = {
      plugins: [
        {
          resolve: `gatsby-plugin-sftp-cache`,
          options: {
            connection: {
              // All options: https://github.com/mscdex/ssh2#client-methods
              host: 'your.host.io',
              username: 'your-sft-user',
              password: process.env.SFTP_CACHE_PW
            },
            remoteDir: '/home/your-sftp-user/sftp-cache-storage/assets',
            dirsToCache: [
              // Relative to your gatsby root directory
              join('.cache'),
              join('public', 'assets'),
              join('node_modules', '.cache', 'gatsby-transformer-video')
            ],
            concurrency: 5 // Optional, defaults to 2.
          }
        }
      ]
    }

    Install

    npm i gatsby-plugin-sftp-cache

    DownloadsWeekly Downloads

    15

    Version

    0.2.0

    License

    MIT

    Unpacked Size

    4.73 kB

    Total Files

    4

    Last publish

    Collaborators

    • avatar