3 unstable releases

0.2.0	Dec 21, 2022
0.1.3	Nov 28, 2022
0.1.2	Nov 28, 2022

#7 in #iroh

Used in 2 crates

Apache-2.0/MIT

635KB
13K SLoC

iroh gateway

A Rust implementation of an IPFS gateway based on iroh. An IPFS gateway allows you to access content on the IPFS network over HTTP.

Running / Building

cargo run -- -p 10000

Options

Run with cargo run -- -h for details
-wcf Writeable, Cache, Fetch (options to toggle write enable, caching mechanics and fetching from the network); currently exists but is not implemented
-p Port the gateway should listen on

ENV Variables

IROH_INSTANCE_ID - unique instance identifier, preferably some name than hard id (default: generated lower & snake case name)
IROH_ENV - indicates the service environment (default: dev)

Endpoints

Endpoint	Flag	Description	Default
`/ipfs/:cid` & `/ipfs/:cid/:path`	`?format={"", "fs", "raw", "car"}`	Specifies the serving format & content-type	`""/fs`
	`?filename=DESIRED_FILE_NAME`	Specifies a filename for the attachment	`{cid}.bin`
	`?download={true, false}`	Sets content-disposition to attachment, browser prompts to save file instead of loading	`false`
	`?force_dir={true, false}`	Lists unixFS directories even if they contain an `index.html` file	`false`
	`?uri=ENCODED_URL`	Query parameter to handle navigator.registerProtocolHandler Web API ie. ipfs://	`""`

License

^{Licensed under either of Apache License, Version
2.0 or MIT license at your option.}
_{Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in this crate by you, as defined in the Apache-2.0 license, shall
be dual licensed as above, without any additional terms or conditions.}

Dependencies

~45–61MB
~1M SLoC