wikijs-fork/server/modules/storage/git/definition.yml

key: git
title: Git
description: Git is a version control system for tracking changes in computer files and coordinating work on those files among multiple people.
author: requarks.io
logo: https://static.requarks.io/logo/git-alt.svg
website: https://git-scm.com/
isAvailable: true
supportedModes:
  - sync
  - push
  - pull
defaultMode: sync
schedule: PT5M
props:
  authType:
    type: String
    default: 'ssh'
    title: Authentication Type
    hint: Use SSH for maximum security.
    enum:
      - 'basic'
      - 'ssh'
    order: 1
  repoUrl:
    type: String
    title: Repository URI
    hint: Git-compliant URI (e.g. git@github.com:org/repo.git for ssh, https://github.com/org/repo.git for basic)
    order: 2
  branch:
    type: String
    default: 'master'
    order: 3
  verifySSL:
    type: Boolean
    default: true
    title: Verify SSL Certificate
    hint: Some hosts requires SSL certificate checking to be disabled. Leave enabled for proper security.
    order: 31
  sshPrivateKeyPath:
    type: String
    title: SSH Private Key Path
    hint: SSH Authentication Only - Absolute path to the key. The key must NOT be passphrase-protected.
    order: 10
  basicUsername:
    type: String
    title: Username
    hint: Basic Authentication Only
    order: 11
  basicPassword:
    type: String
    title: Password / PAT
    hint: Basic Authentication Only
    order: 12
  localRepoPath:
    type: String
    title: Local Repository Path
    default: './data/repo'
    hint: 'Path where the local git repository will be created.'
    order: 30
  defaultEmail:
    type: String
    title: Default Author Email
    default: 'name@company.com'
    hint: 'Used as fallback in case the author of the change is not present.'
    order: 20
  defaultName:
    type: String
    title: Default Author Name
    default: 'John Smith'
    hint: 'Used as fallback in case the author of the change is not present.'
    order: 21
  gitBinaryPath:
    type: String
    title: Git Binary Path
    default: ''
    hint: Optional - Absolute path to the Git binary, when not available in PATH. Leave empty to use the default PATH location (recommended).
actions:
  - handler: syncUntracked
    label: Add Untracked Changes
    hint: Output all content from the DB to the Git repo to ensure all untracked content is saved. If you enabled Git after content was created or you temporarily disabled Git, you'll want to execute this action to add the missing untracked changes.