Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add production deployment address #33

Merged
merged 1 commit into from
Sep 16, 2024
Merged

docs: add production deployment address #33

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,23 @@ An [IPFS Bitswap] Peer Cloudflare Worker

![hoverboard overview diagram](./docs/hoverboard.png)

## Usage

You can connect to hoverboard from any compatible libp2p node that supports the (secure) websocket transport.

### Peer Address

The libp2p multiaddr of the production hoverboard deployment run by the Storacha Network is:

```
/dns4/elastic.dag.house/tcp/443/wss/p2p/bafzbeibhqavlasjc7dvbiopygwncnrtvjd2xmryk5laib7zyjor6kf3avm
```

## Getting started

Install `node` >= 18, and `wrangler` >= 3

Copy `.example.dev.vars` to `.dev.vars` and set the AWS access keys vars.
Copy `.example.dev.vars` to `.dev.vars` and set the required environment variables.

Run `npm install` to install package dependencies.

Expand Down
Loading