Skip to content

@indiekit/store-bitbucket

Bitbucket content store adaptor for Indiekit.

Installation

npm install @indiekit/store-bitbucket

Requirements

A Bitbucket app password.

IMPORTANT

Store your app password in an environment variable called BITBUCKET_PASSWORD so that only you and the application can see it.

Usage

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

json
{
  "plugins": ["@indiekit/store-bitbucket"],
  "@indiekit/store-bitbucket": {
    "user": "username",
    "repo": "reponame"
  }
}

Options

OptionTypeDescription
userstringYour Bitbucket username. Required.
repostringThe name of your Bitbucket repository. Required.
branchstringThe branch files will be saved to. Optional, defaults to main.
passwordstringA Bitbucket app password. Required, defaults to process.env.BITBUCKET_PASSWORD.