# README
IPFS Gateway
A reference implementation of HTTP Gateway Specifications.
Documentation
- Go Documentation: https://pkg.go.dev/github.com/ipfs/go-libipfs/gateway
- Gateway Specification: https://github.com/ipfs/specs/tree/main/http-gateways#readme
- Types of HTTP Gateways: https://docs.ipfs.tech/how-to/address-ipfs-on-web/#http-gateways
Example
// Initialize your headers and apply the default headers.
headers := map[string][]string{}
gateway.AddAccessControlHeaders(headers)
conf := gateway.Config{
Headers: headers,
}
// Initialize a NodeAPI interface for both an online and offline versions.
// The offline version should not make any network request for missing content.
ipfs := ...
// Create http mux and setup path gateway handler.
mux := http.NewServeMux()
gwHandler := gateway.NewHandler(conf, ipfs)
mux.Handle("/ipfs/", gwHandler)
mux.Handle("/ipns/", gwHandler)
// Start the server on :8080 and voilá! You have a basic IPFS gateway running
// in http://localhost:8080.
_ = http.ListenAndServe(":8080", mux)
# Packages
go:generate ./build.sh.
# Functions
AddAccessControlHeaders adds default headers used for controlling cross-origin requests.
NewHandler returns an http.Handler that can act as a gateway to IPFS content offlineApi is a version of the API that should not make network requests for missing data.
ServeContent replies to the request using the content in the provided ReadSeeker and returns the status code written and any error encountered during a write.
WithHostname is a middleware that can wrap an http.Handler in order to parse the Host header and translating it to the content path.
# Constants
No description provided by the author
No description provided by the author
# Structs
Config is the configuration used when creating a new gateway handler.
Specification is the specification of an IPFS Public Gateway.
# Interfaces
API defines the minimal set of API services required for a gateway handler.
# Type aliases
No description provided by the author