Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
alexfreska committed Oct 9, 2023
1 parent aab678a commit 999e7a4
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 9 deletions.
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
filestore
config.yml
config.yml
data
bin
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
[![ipfsd](https://sia.tech/assets/banners/sia-banner-ipfsd.png)](http://sia.tech)
[![ipfsd](https://sia.tech/assets/banners/sia-banner-fsd.png)](http://sia.tech)

# ipfsd
# fsd
[![GoDoc](https://godoc.org/go.sia.tech/fsd?status.svg)](https://godoc.org/go.sia.tech/fsd)
<a href="https://ipfs.tech"><img src="https://img.shields.io/badge/IPFS-Compatible-blue.svg" alt="IPFS Implementation"></a>

[![GoDoc](https://godoc.org/go.sia.tech/ipfsd?status.svg)](https://godoc.org/go.sia.tech/ipfsd)

IPFS gateway backed by `renterd` storage.
> **fsd** _(interplanetary **f**ile **s**ystem **d**aemon)_ is an IPFS daemon that stores blocks on Sia via `renterd`.
## usage

```sh
# calculate the CID of the Bored Ape 0 image
curl -X POST --data-binary @api0.png http://localhost:8001/api/cid/calculate
curl -X POST --data-binary @ape0.png http://localhost:8001/api/cid/calculate
# Upload Bored Ape 0 image
curl -X POST --data-binary @ape0.png http://localhost:8001/api/upload/QmRRPWG96cmgTn2qSzjwr2qvfNEuhunv6FNeMFGa9bx6mQ
"QmRRPWG96cmgTn2qSzjwr2qvfNEuhunv6FNeMFGa9bx6mQ"
Expand All @@ -19,4 +19,4 @@ curl http://localhost:8080/ipfs/QmRRPWG96cmgTn2qSzjwr2qvfNEuhunv6FNeMFGa9bx6mQ
<image width="100px" src="https://ipfs.io/ipfs/QmRRPWG96cmgTn2qSzjwr2qvfNEuhunv6FNeMFGa9bx6mQ" />

## todo
- [ ] directory support, eg: ipfs://CID/images/cat.png, ipfs://QmeSjSinHpPnmXmspMjwiXyN6zS4E9zccariGR3jxcaWtq/0
- [ ] IPLD / directory support, eg: ipfs://CID/images/cat.png, ipfs://QmeSjSinHpPnmXmspMjwiXyN6zS4E9zccariGR3jxcaWtq/0
2 changes: 1 addition & 1 deletion example.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ ipfs:
gatewayAddress: :8080 # gateway URL
listenAddresses:
- /ip4/0.0.0.0/tcp/4001 # the listen address for bitswap. Since no announce addresses are configured, no bits will be swapped
fetchRemote: true # true if you want to download files that aren't pinned
fetchRemote: true # true if you want to download files that aren't pinned

0 comments on commit 999e7a4

Please sign in to comment.