Bee Gateway

Swarm Gateway website.

Warning: This project is in alpha state. There might (and most probably will) be changes in the future to its API and working. Also, no guarantees can be made about its stability, efficiency, and security at this stage.

This project is intended to be used with Bee version 1.5.0-dda5606e. Using it with older or newer Bee versions is not recommended and may not work. Stay up to date by joining the official Discord and by keeping an eye on the releases tab.

Development
Contribute
Maintainers
License

Development

git clone git@github.com:ethersphere/gateway.git

cd  gateway

npm start

The Gateway runs in development mode on http://localhost:3030/.

:warn: Don't forget to provide postage stamp via environment variable or edit directly the postageStamp constant in .src/constants.ts..

Environment variables

REACT_APP_BEE_HOSTS - comma separated bee API URLs through which the gateway uploads and downloads. The api to upload is selected at random while on download the gateway checks all the hosts (defaults to [http://localhost:1633])
REACT_APP_BZZ_LINK_DOMAIN - specifies what domain of Bzz Link should be used (defaults to bzz.link)
REACT_APP_POSTAGE_STAMP - Postage stamp batch ID to be used for uploading (defaults to 00000...00000
REACT_APP_GATEWAY_URL - URL on which the gateway is hosted (defaults to current window location)
REACT_APP_DIRECT_DOWNLOAD_URL - URL for a direct download of asset, used for redirecting ENS requests (defaults to https://api.gateway.ethswarm.org/bzz/)

Contribute

There are some ways you can make this module better:

Consult our open issues and take on one of them
Help our tests reach 100% coverage!
Join us in our Discord chat in the #develop-on-swarm channel if you have questions or want to give feedback

Maintainers

See what "Maintainer" means here.

License

BSD-3-Clause