iroh gateway

crates.io Released API docs MIT/Apache-2.0 licensed CI

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

ENV Variables

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.