Individual backends provide their own configuration documentation, but there are some configuration options that are common to multiple backends. A full reference is below. Note that these are properties of the
backend field, and should be nested under that field.
|The backend git provider|
|repo||string||Required for |
|branch||string||Optional. The branch where published content is stored. All CMS commits and PRs are made to this branch|
|Optional. The API endpoint. Only necessary in certain cases, like with GitHub Enterprise or self-hosted GitLab|
|Optional. Sets the |
|base_url||string||GitHub or Bitbucket|
|Optional. OAuth client hostname (just the base domain, no path). Required when using an external OAuth server or self-hosted GitLab/Gitea|
|auth_endpoint||string||GitHub or Bitbucket|
|Optional. Path to append to |
Creating a New Backend
Anyone can write a backend, but the API is not yet finalized and documented. If you would like to write your own backend for a service that does not have one currently, Static CMS recommends using the GitHub backend as a reference for API and best practices.