Skip to content

@indiekit/store-gitea

Gitea (or Forgejo-based) content store adaptor for Indiekit.

Installation

npm install @indiekit/store-gitea

Requirements

A Gitea access token with read and write permissions to a repository.

IMPORTANT

Store your access token in an environment variable called GITEA_TOKEN so that only you and the application can see it.

Usage

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

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

Options

OptionTypeDescription
instancestringGitea instance URL. Optional, defaults to https://gitea.com.
userstringYour Gitea username. Required.
repostringThe name of your Gitea repository. Required.
branchstringThe branch files will be saved to. Optional, defaults to main.
tokenstringA Gitea access token. Required, defaults to process.env.GITEA_TOKEN.