@indiekit/store-ftp
v1.0.0-beta.15
Published
FTP content store adaptor for Indiekit
Downloads
239
Maintainers
Readme
@indiekit/store-ftp
FTP content store adaptor for Indiekit.
Installation
npm i @indiekit/store-ftp
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. |