The ipfs-cluster website

Official website for ipfs-cluster http://cluster.ipfs.io

This repository contains the source code for the ipfs-cluster website available at http://cluster.ipfs.io. If you're looking for the open-source IPFS Cluster project itself, head to https://github.com/ipfs/ipfs-cluster.

This project builds out a static site to explain ipfs-cluster, ready for deployment on ipfs. It uses hugo to glue the html together. It provides an informative, public-facing website. The most important things are the words, concepts and links it presents.

Install

git clone https://github.com/ipfs/ipfs-cluster-website

Usage

To deploy the site cluster.ipfs.io, run:

# Build out the optimised site to ./public, where you can check it locally.
make

# Add the site to your local ipfs, you can check it via /ipfs/<hash>
make deploy

# Save your dnsimple api token as auth.token
cat "<api token here>" > auth.token

# Update the dns record for cluster.ipfs.io to point to the new ipfs hash.
make publish-to-domain

The following commands are available:

make

Build the optimised site to the ./public dir

make serve

Preview the production ready site at http://localhost:1313 (requires hugo on your PATH)

make dev

Start a hot-reloading dev server on http://localhost:1313 (requires hugo on your PATH)

make deploy

Build the site in the public dir and add to ipfs (requires hugo & ipfs on your PATH)

make publish-to-domain 🚀

Update the DNS record for cluster.ipfs.io. (requires an auto.token file to be saved in the project root.)

If you'd like to update the dnslink TXT record for another domain, pass DOMAIN=<your domain here> like so:

make publish-to-domain DOMAIN=tableflip.io

See the Makefile for the full list or run make help in the project root. You can pass the env var DEBUG=true to increase the verbosity of your chosen command.

Maintainers

The ipfs-cluster team.

Contribute

Please do! Check out the issues, or open a PR!

Check out our contributing document for more information on how we work, and about contributing in general.

Small note: If editing the README, please conform to the standard-readme specification.

License

MIT © 2018 Protocol Labs Inc.