client

Documentation

Overview

Package client contains helper function to deal with the different client protocols.

Index

• Variables
• func InstallProtocol(scheme string, c transport.Transport)
• func NewClient(endpoint *transport.Endpoint) (transport.Transport, error)

Examples

• InstallProtocol

Variables

var Protocols = map[string]transport.Transport{
	"http":  http.DefaultClient,
	"https": http.DefaultClient,
	"ssh":   ssh.DefaultClient,
	"git":   git.DefaultClient,
	"file":  file.DefaultClient,
}

Protocols are the protocols supported by default.

Functions

func InstallProtocol

func InstallProtocol(scheme string, c transport.Transport)

InstallProtocol adds or modifies an existing protocol.

Example

package main

import (
	"crypto/tls"
	"net/http"

	"github.com/mojotx/go-git/v5/plumbing/transport/client"
	githttp "github.com/mojotx/go-git/v5/plumbing/transport/http"
)

func main() {
	// Create custom net/http client that.
	httpClient := &http.Client{
		Transport: &http.Transport{
			TLSClientConfig: &tls.Config{InsecureSkipVerify: true},
		},
	}

	// Install it as default client for https URLs.
	client.InstallProtocol("https", githttp.NewClient(httpClient))
}

func NewClient

func NewClient(endpoint *transport.Endpoint) (transport.Transport, error)

NewClient returns the appropriate client among of the set of known protocols: http://, https://, ssh:// and file://. See `InstallProtocol` to add or modify protocols.