@indiekit/store-ftp

1.0.0-beta.23 • Public • Published

@indiekit/store-ftp

FTP content store adaptor for Indiekit.

Installation

npm install @indiekit/store-ftp

Requirements

A FTP server you can access with a username and password.

[!IMPORTANT] Store your username and password in environment variables called FTP_USER and FTP_PASSWORD so that only you and the application can see them.

Usage

Add @indiekit/store-ftp to your list of plug-ins, specifying options as required:

{
  "plugins": ["@indiekit/store-ftp"],
  "@indiekit/store-ftp": {
    "host": "ftp.server.example",
    "user": "username",
    "directory": "project/www"
  }
}

Options

Option Type Description
host string Your FTP hostname, for example ftp.server.example. Required.
port number Your FTP port. Optional, defaults to 22.
user string Your FTP username. Required, defaults to process.env.FTP_USER.
password string Your FTP password. Required, defaults to process.env.FTP_PASSWORD.
directory string Directory to save files to. Optional.

Package Sidebar

Install

npm i @indiekit/store-ftp

Weekly Downloads

6

Version

1.0.0-beta.23

License

MIT

Unpacked Size

9.69 kB

Total Files

5

Last publish

Collaborators

  • paulrobertlloyd