Welcome to the IPFS documentation portal! Whether you’re just learning about IPFS or are looking for detailed reference information, this is the place to start. You might have noticed that IPFS is a project with a big scope — and a lot of different tools, sites, and code.
Here’s an overview of what you’ll find in our documentation:
Head over to the introduction section to learn about the basics of IPFS. There are also instructions on how to install IPFS, and tips on basic IPFS usage.
IPFS is a complex system that hopes to change how we use the internet, so it comes with many new concepts. The guides section has an overview of major concepts in IPFS (including terms and ideas associated with distributed file systems generally), and guides for specific IPFS use cases. The examples section is home to a number of basic examples of ways to use the IPFS ecosystem, including:
- A simple how-to on pinning
- Instructions for making your own IPFS service
- A guide to hosting your website
For detailed guidance on select topics, try out the interactive tutorials at ProtoSchool. You can learn about the decentralized web by solving code challenges.
Commands & API
Specifications & Planning
Get in touch with other members of the IPFS community who are building tools on top of IPFS or even helping to build IPFS itself! You can ask questions, discuss new ideas, or get support for problems at https://discuss.ipfs.io, but you can also hop on IRC for a quick chat.
See the other links in the community section for more information about meetings, events, apps people are building, and more.
Information about contributing to IPFS and about other software projects in the community are also hosted here.
IPFS is an open-source community project. While Protocol Labs is able to sponsor some of the work around it, much of the design, code, and effort is contributed by volunteers and community members like you. If you’re interested in helping improve IPFS, check the how to help guide to get started.
We’ve split out some of the major parts of IPFS into separate projects over time — while they’re still critical components of IPFS, they can be useful in a variety of other contexts, too. Check their individual sites for specific information and references: