@indiekit/syndicator-internet-archive

Internet Archive syndicator for Indiekit.

Installation

npm install @indiekit/syndicator-internet-archive

Requirements

A pair of Internet Archive API access and secret keys.

IMPORTANT

Store your API access and secret keys in environment variables called INTERNET_ARCHIVE_ACCESS_KEY and INTERNET_ARCHIVE_SECRET_KEY so that only you and the application can see them.

Usage

Add @indiekit/syndicator-internet-archive to your list of plug-ins, specifying options as required:

json

{
  "plugins": ["@indiekit/syndicator-internet-archive"],
  "@indiekit/syndicator-internet-archive": {
    "checked": true
  }
}

Options

Option	Type	Description
`accessKey`	`string`	Your S3 access key. Required, defaults to `process.env.INTERNET_ARCHIVE_ACCESS_KEY`.
`secretKey`	`string`	Your S3 secret key. Required, defaults to `process.env.INTERNET_ARCHIVE_SECRET_KEY`.
`checked`	`boolean`	Tell a Micropub client whether this syndicator should be enabled by default. Optional, defaults to `false`.
`name`	`string`	Name for this syndicator that may appear in a Micropub client’s publishing interface. Optional, defaults to `Internet Archive`.
`uid`	`string`	Value Micropub client will include when publishing a post to indicate that it should be sent to this syndicator. Optional, defaults to `https://web.archive.org/`.