Skip to content
Get packs

Guide · Open source

How to use IPFS: getting started with the official docs

Updated · written with AI from the project's own documentation and checked against our catalogue data

IPFS is an open set of protocols for storing and sharing data across many computers instead of a single central server. This guide explains what the ipfs/ipfs repository is, where the official install and documentation pages are, and how to clone the repo. By the end you will know which resources to read first and whether IPFS fits what you are building.

IPFSipfs/ipfs · ★ 23.1k · MIT

Quick start

  1. 1Open the official website. Start at ipfs.tech to see what the project is and how it is organised.
  2. 2Read the install guide. Go to docs.ipfs.tech/install/ and choose how you want to run IPFS.
  3. 3Clone the repository. Run git clone https://github.com/ipfs/ipfs in a terminal to get a local copy of the project files.
  4. 4Read the specifications. Use specs.ipfs.tech to understand the protocols in detail.
  5. 5Ask questions in the forums. Post to discuss.ipfs.tech if you get stuck or want to learn from other users.

What IPFS is and how it stores data

IPFS manages data without a central server. Content is addressed by what it contains, so anyone who has a copy can serve it to whoever asks for it.

The ipfs/ipfs repository is the top-level home for the project. Its README is short and mainly points to the official website, documentation, specifications and discussion forums rather than containing a program you run directly.

  • Website: ipfs.tech
  • Documentation: docs.ipfs.tech
  • Specifications: specs.ipfs.tech
  • Community discussion: discuss.ipfs.tech

Find the right starting point in the docs

The README suggests the install page at docs.ipfs.tech/install/ if you are not sure where to start. That page is the place to pick a way to run IPFS on your own machine.

If you want background reading, the README links to a list of academic papers on IPFS in the Further Reading section of the IPFS Docs.

https://docs.ipfs.tech/install/

Clone the ipfs/ipfs repository

The README lists one install command: cloning the repository from GitHub. Run it in a terminal to get a local copy of the README and project files for reading or exploring.

git clone https://github.com/ipfs/ipfs

Decide whether this repo is what you need

This repository is a good fit for developers who want to learn how peer-to-peer content addressing works, and for anyone looking for the official entry point to IPFS documentation and specs.

It is not a ready-made app with a click-to-install interface. Also note that peers may go offline, so if you need guaranteed availability you will need to run or pay for a pinning or hosting service.

  • Good fit: learning content addressing, reading specs, finding official docs
  • Not a fit: a one-click desktop app, or guaranteed availability without a pinning or hosting service

Know the related projects

The README does not describe these in detail, but the projects commonly compared with IPFS are Kubo, Filecoin and Hypercore. Check each project's own documentation before relying on it.

  • Kubo
  • Filecoin
  • Hypercore

What people use it for

  • Learning how content addressing lets data be fetched from any peer that holds a copy
  • Reading the IPFS specifications before building a peer-to-peer application
  • Finding the official install and documentation pages
  • Reading the academic papers on IPFS for research

Frequently asked questions

Is IPFS free to use?

The ipfs/ipfs repository is licensed under MIT, as stated in its LICENSE file. The README does not list prices for any service, so check the official docs before assuming costs.

What are the requirements for IPFS?

The source does not list prerequisites for this repository. See the install page at docs.ipfs.tech/install/ for how to run IPFS on your system.

How do I install IPFS?

The README points to docs.ipfs.tech/install/ for installation. The only command it gives is cloning the repository with git clone https://github.com/ipfs/ipfs.

Is there a click-to-install IPFS app?

No. This README points to other projects and docs rather than a single program with a click-to-install interface.

Will my files always be available on IPFS?

Not on their own. Data is served by peers, and peers can go offline, so guaranteed availability generally requires a pinning or hosting service.

How does IPFS compare to Filecoin or Hypercore?

The source only names Kubo, Filecoin and Hypercore as comparable projects. It does not compare them, so read each project's documentation to see how they differ.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

IPFS suits developers and researchers who want to understand peer-to-peer content addressing, and this repo is the official entry point to its docs and specs. It is not suited to anyone who wants a ready-made app or guaranteed data availability without running or paying for a pinning or hosting service.

Install options & downloads