@indiekit/store-gitlab

GitLab content store adaptor for Indiekit.

Installation

npm install @indiekit/store-gitlab

Requirements

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

IMPORTANT

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

Usage

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

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

Options

Option	Type	Description
instance	string	GitLab instance URL. Optional, defaults to https://gitlab.com.
projectId	string	GitLab project ID. Required (if user and repo not provided).
user	string	Your GitLab username. Required (if projectId not provided).
repo	string	The name of your GitLab repository. Required (if projectId not provided).
branch	string	The branch files will be saved to. Optional, defaults to main.
token	string	A GitLab access token. Required, defaults to process.env.GITLAB_TOKEN.