-
Notifications
You must be signed in to change notification settings - Fork 428
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Cleanup js-ipfs mentions #1620
Merged
Merged
Cleanup js-ipfs mentions #1620
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
d142555
Cleanup js-ipfs mentions
ElPaisano e7a71d4
remove chatapp link, update unixfs page
ElPaisano 815a780
Update faq, glossary
ElPaisano ae09b87
update mention in ipns concept page
ElPaisano 8dceac7
Remove js-ipfs ipns publish example
ElPaisano 721df2e
cleanup, deletes
ElPaisano 18e8d00
feat: update /concepts/nodes page (#1624)
SgtPooki e924363
fix: :wastebasket: Deprecation notice for js-ipfs (#1628)
whizzzkid 2a4ccca
Update companion-node-types.md (#1631)
BigLep 35b12d6
address bad links
ElPaisano 07bb7b6
spelling, bad link
ElPaisano File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -7,9 +7,10 @@ description: Explore frequently asked questions about IPFS, the InterPlanetary F | |
|
||
## What is IPFS? | ||
|
||
IPFS stands for the InterPlanetary File System — a peer-to-peer network for storing and accessing files, websites, applications, and data in a distributed file system. | ||
The InterPlanetary File System (IPFS) is a set of composable, peer-to-peer protocols for addressing, routing, and transferring [content-addressed](../concepts/glossary.md#content-addressing) data in a decentralized file system. Many popular Web3 projects are built on IPFS - see the [ecosystem directory](https://ecosystem.ipfs.tech) for a list of some of these projects. | ||
|
||
To learn more, see the ["What is IPFS?"](what-is-ipfs.md) guide. | ||
New to IPFS? Start with | ||
[the 3-page Basic Concepts](../concepts/README.md#learn-the-basics). | ||
|
||
## IPFS in action | ||
|
||
|
@@ -34,6 +35,20 @@ When you add a file to IPFS, IPFS splits it into smaller blocks. IPFS hashes eac | |
|
||
There are a lot of ways you can contribute to IPFS, whether you're interested in helping with either of the core implementations, applications like IPFS Desktop, writing or editing documentation, doing UX, or whatever you enjoy working on. [Get all the details on where to get started here.](../community/contribute/ways-to-contribute.md) | ||
|
||
### What is an implementation | ||
|
||
An IPFS implementation is any software with basic functionality for interaction with other IPFS implementations. An implementation: | ||
|
||
- Supports addressability using CIDs. | ||
|
||
- Exposes operations like retrieval, provisioning and indexing on resources using CIDs. The operations that an implementation may support are open-ended, but this requirement should cover any interaction which the implementation exposes to other IPFS implementations. | ||
|
||
- Verifies that the CIDs it resolves match the resources they address, at least when it has access to the resources bytes. However, implementations may relax this requirement in controlled environments in which it is possible to ascertain that verification has happened elsewhere in a trusted part of the system. | ||
|
||
There are already many IPFS implementations, including [Kubo](../install/command-line.md), [Helia](../install/js-ipfs.md), and [more](../concepts/ipfs-implementations.md). | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think better to link to the Kubo and Helia project pages. Also is js-ipfs.md still a thing? |
||
|
||
You can also create your own IPFS implementation. | ||
|
||
## IPFS and Filecoin | ||
|
||
### What is the connection between IPFS and Filecoin? | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -228,6 +228,10 @@ The sharding technique used for [sharding](#sharding) big UnixFS directories. It | |
|
||
A Cryptographic Hash is a function that takes some arbitrary input (content) and returns a fixed-length value. The exact same input data will always generate the same hash as output. There are numerous hash algorithms. [More about Hash](hashing.md) | ||
|
||
### Helia | ||
|
||
A lean, modular, and modern implementation of IPFS for the JS and browser environments. Superseded [js-ipfs](#js-ipfs). Learn more at [https://github.com/ipfs/helia](https://github.com/ipfs/helia). | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. "It supersedes js-ipfs." (so we have a complete sentence) |
||
|
||
### Hole punching | ||
|
||
A technique for [NAT](#nat) or firewall traversal that relies on coordinated simultaneous connections. Used when port forwarding is not possible. [See DCUtR](#dcutr) | ||
|
@@ -250,7 +254,7 @@ The InterPlanetary Name System (IPNS) is a system for creating and updating muta | |
|
||
### JS-IPFS | ||
|
||
An implementation of IPFS written entirely in JavaScript. It runs in a Browser, a Service Worker, Electron and Node.js. See [Nodes > JS-IPFS](../concepts/nodes.md#js-ipfs) | ||
An [implementation of IPFS written entirely in JavaScript](https://github.com/ipfs/js-ipfs). It runs in a browser, a service worker, Electron and Node.js. Deprecated and superseded by [Helia](#helia). | ||
|
||
### JSON | ||
|
||
|
@@ -316,11 +320,11 @@ Multicodec is an identifier indicating the format of the target content. It help | |
|
||
### Multihash | ||
|
||
Multihash is a protocol for differentiating outputs from various well-established hash functions, addressing size and encoding considerations. It is useful to write applications that future-proof their use of hashes, and it allows multiple hash functions to coexist. [More about Multihash](https://multiformats.io/multihash/). | ||
Multihash is a protocol for differentiating outputs from various well-established hash functions, addressing size and encoding considerations. It is useful to write applications that future-proof their use of hashes, and it allows multiple hash functions to coexist. [More about Multihash](https://github.com/multiformats/multihash). | ||
|
||
### Multiformats | ||
|
||
The Multiformats project is a collection of protocols that aim to future-proof systems today. A key element is enhancing format values with self-description. This allows for interoperability, protocol agility, and promotes extensibility. [More about Multiformats](https://multiformats.io/) and [Multihash](https://multiformats.io/multihash/) | ||
The Multiformats project is a collection of protocols that aim to future-proof systems today. A key element is enhancing format values with self-description. This allows for interoperability, protocol agility, and promotes extensibility. [More about Multiformats](https://multiformats.io/) and [Multihash](https://github.com/multiformats/multihash) | ||
|
||
## N | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should really be driving people towards https://specs.ipfs.tech in this section and particularly https://specs.ipfs.tech/architecture/