Here are the steps to quickly get setup with buckets:
Download and install the
Initialize the account and login:
hub init # Follow instructions ... hub login # if you already have a username
Detailed instructions can be found in the official docs.
Initialize a new Bucket:
Buckets are mapped to local directories. In order to create a bucket from the working directory run:
cd /path/to/your/data hub bucket initBuckets are not encrypted by default. If you are going to store sensitive data, use the
hub bucket init --privateoption. Read more here.
It is also possible to retrieve existing buckets (or pull changes performed by others in the case of shared buckets) with the
hub bucket init --existingflag.
Make changes and push them:
After adding or modifying files in your bucket folder, you can publish the changes by pushing them:
hub bucket status # show changes to the bucket hub bucket push # publish changes to IPFS
Explore your content on IPFS:
Your content has been pushed and is made available on IPFS. You can display thread, IPNS and website links associated to your bucket with:
hub bucket links
The first link should take you to the Hub gateway and allow you to inspect your files as currently published. You can use the IPNS link for example, if you are hosting a website, to open it on the browser.
Archive your bucket and back it up on Filecoin:
You can archive your bucket at any point and store it on Filecoin:
# Archive hub bucket archive # Check status hub bucket archive status # Or watch status hub bucket archive status -w
Learn more about Textile buckets:
hubcommands and subcommands take a
--helpflag that displays available flags and usage instructions. These are also published here.
- The instructions here are based on the Buckets guide, which contains more details, for example about permissions, shared buckets and organizations.
- Filecoin storage in Textile buckets is a very new feature! Make sure you read the Bucket Archiving for the latest information on how it works, limits and price.
- This blog post contains explanatory videos and information about archiving and recovery. Once you have a deal CID, you can also use Lotus to retrieve the data.
Use the Buckets API directly: