corehttp

Documentation

Overview

Package corehttp provides utilities for the webui, gateways, and other high-level HTTP interfaces to IPFS.

Index

• Constants
• Variables
• func ListenAndServe(n *core.IpfsNode, listeningMultiAddr string, options ...ServeOption) error
• func Serve(node *core.IpfsNode, lis net.Listener, options ...ServeOption) error
• type BlockList
  • func (b *BlockList) SetDecider(d Decider)
  • func (b *BlockList) ShouldAllow(s string) bool
  • func (b *BlockList) ShouldBlock(s string) bool
• type Decider
• type Gateway
  • func NewGateway(conf GatewayConfig) *Gateway
  • func (g *Gateway) ServeOption() ServeOption
• type GatewayConfig
• type ServeOption
  • func CommandsOption(cctx commands.Context) ServeOption
  • func CommandsROOption(cctx commands.Context) ServeOption
  • func GatewayOption(writable bool) ServeOption
  • func IPNSHostnameOption() ServeOption
  • func LogOption() ServeOption
  • func PrometheusCollectorOption(handlerName string) ServeOption
  • func PrometheusOption(path string) ServeOption
  • func RedirectOption(path string, redirect string) ServeOption
  • func VersionOption() ServeOption

Constants

const WebUIPath = "/ipfs/QmR9MzChjp1MdFWik7NjEjqKQMzVmBkdK3dz14A6B5Cupm"

TODO: move to IPNS

Variables

var WebUIOption = RedirectOption("webui", WebUIPath)

var WebUIPaths = []string{
	WebUIPath,
	"/ipfs/QmXX7YRpU7nNBKfw75VG7Y1c3GwpSAGHRev67XVPgZFv9R",
	"/ipfs/QmXdu7HWdV6CUaUabd9q2ZeA4iHZLVyDRj3Gi4dsJsWjbr",
	"/ipfs/QmaaqrHyAQm7gALkRW8DcfGX3u8q9rWKnxEMmf7m9z515w",
	"/ipfs/QmSHDxWsMPuJQKWmVA1rB5a3NX2Eme5fPqNb63qwaqiqSp",
	"/ipfs/QmctngrQAt9fjpQUZr7Bx3BsXUcif52eZGTizWhvcShsjz",
	"/ipfs/QmS2HL9v5YeKgQkkWMvs1EMnFtUowTEdFfSSeMT4pos1e6",
}

this is a list of all past webUI paths.

Functions

func ListenAndServe

func ListenAndServe(n *core.IpfsNode, listeningMultiAddr string, options ...ServeOption) error

ListenAndServe runs an HTTP server listening at |listeningMultiAddr| with the given serve options. The address must be provided in multiaddr format.

TODO intelligently parse address strings in other formats so long as they unambiguously map to a valid multiaddr. e.g. for convenience, ":8080" should map to "/ip4/0.0.0.0/tcp/8080".

func Serve

func Serve(node *core.IpfsNode, lis net.Listener, options ...ServeOption) error

Types

type BlockList

type BlockList struct {
	Decider Decider
	// contains filtered or unexported fields
}

func (*BlockList) SetDecider

func (b *BlockList) SetDecider(d Decider)

SetDecider atomically swaps the blocklist's decider. This method is thread-safe.

func (*BlockList) ShouldAllow

func (b *BlockList) ShouldAllow(s string) bool

func (*BlockList) ShouldBlock

func (b *BlockList) ShouldBlock(s string) bool

type Decider

type Decider func(string) bool

Decider decides whether to Allow string

type Gateway

type Gateway struct {
	Config GatewayConfig
}

Gateway should be instantiated using NewGateway

func NewGateway

func NewGateway(conf GatewayConfig) *Gateway

func (*Gateway) ServeOption

func (g *Gateway) ServeOption() ServeOption

type GatewayConfig

type GatewayConfig struct {
	Headers   map[string][]string
	BlockList *BlockList
	Writable  bool
}

type ServeOption

type ServeOption func(*core.IpfsNode, net.Listener, *http.ServeMux) (*http.ServeMux, error)

ServeOption registers any HTTP handlers it provides on the given mux. It returns the mux to expose to future options, which may be a new mux if it is interested in mediating requests to future options, or the same mux initially passed in if not.

func CommandsOption

func CommandsOption(cctx commands.Context) ServeOption

func CommandsROOption

func CommandsROOption(cctx commands.Context) ServeOption

func GatewayOption

func GatewayOption(writable bool) ServeOption

func IPNSHostnameOption

func IPNSHostnameOption() ServeOption

IPNSHostnameOption rewrites an incoming request if its Host: header contains an IPNS name. The rewritten request points at the resolved name on the gateway handler.

func LogOption

func LogOption() ServeOption

func PrometheusCollectorOption

func PrometheusCollectorOption(handlerName string) ServeOption

func PrometheusOption

func PrometheusOption(path string) ServeOption

func RedirectOption

func RedirectOption(path string, redirect string) ServeOption

func VersionOption

func VersionOption() ServeOption