git

Documentation

Overview

Package git is the middleware that pull sites from git repo

Caddyfile Syntax :

git repo path {
	repo
	path
	branch
	key
	interval
	then command args
}
repo 	- git repository
	compulsory. Both ssh (e.g. git@github.com:user/project.git)
	and https(e.g. https://github.com/user/project) are supported.
	Can be specified in either config block or top level

path 	- directory to pull into, relative to site root
	optional. Defaults to site root.

branch 	- git branch or tag
	optional. Defaults to master

key 	- path to private ssh key
	optional. Required for private repositories. e.g. /home/user/.ssh/id_rsa

interval- interval between git pulls in seconds
	optional. Defaults to 3600 (1 Hour).

then	- command to execute after successful pull
	optional. If set, will execute only when there are new changes.

Examples :

public repo pulled into site root

git github.com/user/myproject

public repo pulled into <root>/mysite

git https://github.com/user/myproject mysite

private repo pulled into <root>/mysite with tag v1.0 and interval of 1 day.

git {
	repo 	git@github.com:user/myproject
	branch 	v1.0
	path	mysite
	key 	/home/user/.ssh/id_rsa
	interval 86400 # 1 day
}

Caddyfile with private git repo and php support via fastcgi. path defaults to /var/www/html/myphpsite as specified in root config.

0.0.0.0:8080

git {
	repo 	git@github.com:user/myphpsite
	key 	/home/user/.ssh/id_rsa
	interval 86400 # 1 day
}

fastcgi / 127.0.0.1:9000 php

root /var/www/html/myphpsite

A pull is first attempted after initialization. Afterwards, a pull is attempted after request to server and if time taken since last successful pull is higher than interval.

After the first successful pull (should be during initialization except an error occurs), subsequent pulls are done in background and do not impact request time.

Note: private repositories are currently only supported and tested on Linux and OSX

Index

• Constants
• Variables
• func Init() error
• func SetOS(os gitos.OS)
• func Start(repo *Repo)
• type Repo
  • func (r *Repo) Prepare() error
  • func (r *Repo) Pull() error

Constants

const DefaultInterval time.Duration = time.Hour * 1

DefaultInterval is the minimum interval to delay before requesting another git pull

Variables

var Logger *log.Logger

Logger is used to log errors; if nil, the default log.Logger is used.

var Services = &services{}

Services holds all git pulling services and provides the function to stop them.

Functions

func Init

func Init() error

Init validates git installation, locates the git executable binary in PATH and check for available shell to use.

func SetOS

func SetOS(os gitos.OS)

SetOS sets the OS to be used. Intended to be used for tests to abstract OS level git actions.

func Start

func Start(repo *Repo)

Start starts a new background service to pull periodically.

Types

type Repo

type Repo struct {
	URL      string        // Repository URL
	Path     string        // Directory to pull to
	Host     string        // Git domain host e.g. github.com
	Branch   string        // Git branch
	KeyPath  string        // Path to private ssh key
	Interval time.Duration // Interval between pulls
	Then     string        // Command to execute after successful git pull

	sync.Mutex
	// contains filtered or unexported fields
}

Repo is the structure that holds required information of a git repository.

func (*Repo) Prepare

func (r *Repo) Prepare() error

Prepare prepares for a git pull and validates the configured directory

func (*Repo) Pull

func (r *Repo) Pull() error

Pull attempts a git clone. It retries at most numRetries times if error occurs