You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[](https://circleci.com/gh/ipfs/ipfs-docs)
3
-
[](https://protocol.ai/)
This repository organizes overall documentation issues across the IPFS project.
7
-
8
-
**If you'd just like to read the IPFS docs, we recommend the website version of the info contained in this repo! https://docs.ipfs.tech**
9
-
10
-
## Get involved
11
-
12
-
We would **love ❤️ your help** to improve existing items or make new ones even better! [We also have bounties available](https://github.com/ipfs/devgrants/projects/1)!
13
-
14
-
### Issues
15
-
16
-
If you find something wrong within this repository, please raise an [issue here →](https://github.com/ipfs/ipfs-docs/issues). Unless the issue is urgent, updates will be batch-merged into `main` on Tuesdays or Thursdays.
17
-
18
-
### Bounties
19
-
20
-
You can earn the undying love of the IPFS community _and_ make some money by closing an issue with the [`bounty` tag](https://github.com/ipfs/ipfs-docs/issues?q=is%3Aopen+is%3Aissue+label%3Abounty)! Submissions must be production-ready and meet all the specifications listed on the issue page. Check out the [current list of open bounties →](https://github.com/ipfs/devgrants/projects/1)
21
-
22
-
If you are attempting to close an issue, great! Thanks for the help! Please leave a comment within the issue requesting to be assigned to that issue **before** submitting a pull request. This minimizes the chance of multiple different contributors duplicating work by submitting pull requests for the same issue. If you submit a pull request to an issue _without_ first being assigned to it, that pull request may not be accepted.
23
-
24
-
### Suggestions
25
-
26
-
Everyone has an opinion when it comes to docs, and **that's a good thing**! Having folks from different backgrounds add to a discussion empowers everyone within that discussion. So if you've got something to add or would like to bring up a topic for discussion about the IPFS Docs project, please do so! [Just create an issue using the `kind/question` tag!](https://github.com/ipfs/ipfs-docs/issues?q=is%3Aopen+is%3Aissue+label%3Akind%2Fquestion).
Feel free to submit pull requests with any changes you'd like to see! If you're simply changing a typo or editing out a styling bug, you can add `ciskip` to the title of your pull request to stop Filecorgi from running. Once merged, the website is updated automatically within 5-10 minutes.
9
+
[](https://protocol.ai/)
[](https://circleci.com/gh/ipfs/ipfs-docs)
-[Contribute to documentation](#contribute-to-documentation)
21
+
-[Issues](#issues)
22
+
-[Bounties](#bounties)
23
+
-[Suggestions](#suggestions)
24
+
-[Pull requests welcome](#pull-requests-welcome)
25
+
-[Style and configuration guide](#style-and-configuration-guide)
26
+
-[Static-site generator](#static-site-generator)
27
+
-[Automated deployments](#automated-deployments)
28
+
-[Translation](#translation)
29
+
-[Core members](#core-members)
30
+
-[License](#license)
31
+
<!-- /TOC -->
32
+
33
+
---
34
+
35
+
Welcome to the official IPFS documentation. The Interplanetary File System (IPFS) is a distributed, peer-to-peer network for storing and accessing files, websites, applications, and data. Protocol Labs is the primary maintainer of the IPFS documentation and will review all issues and pull requests created in this repository.
36
+
37
+
**If you'd just like to read the IPFS documentation, we recommend the [website version](https://docs.ipfs.tech).**
31
38
32
39
## Project set up
33
40
34
-
If you want to build this site locally, run the following:
41
+
### Run locally
42
+
43
+
To build the site locally, follow the steps below.
35
44
36
45
1. Clone this repository:
37
46
38
47
```bash
39
48
git clone https://github.com/ipfs/ipfs-docs.git
40
49
```
41
50
42
-
1. Move into the `ipfs-docs` folder and install the NPM dependencies:
51
+
2. Move into the `ipfs-docs` folder and install the NPM dependencies:
43
52
44
53
```bash
45
54
cd ipfs-docs
46
55
npm install
47
56
```
48
57
49
-
1. Boot up the application in _dev mode_:
58
+
3. Boot up the application in _dev mode_:
50
59
51
60
```bash
52
61
npm start
53
62
```
54
63
55
-
1. Open [localhost:8080](http://localhost:8080) in your browser.
56
-
1. Close the local server with `CTRL` + `c`.
57
-
1. To restart the local server, run `npm start` from within the `ipfs-docs` folder.
64
+
4. Open [localhost:8080](http://localhost:8080) in your browser.
65
+
5. Close the local server with `CTRL` + `c`.
66
+
6. To restart the local server, run `npm start` from within the `ipfs-docs` folder.
58
67
59
-
## Troubleshooting
68
+
###Troubleshooting
60
69
61
-
If you're having trouble setting up the site locally, check here for solutions to some common problems.
70
+
If you're having trouble setting up the site locally, check this section for solutions to common issues.
62
71
63
-
### Digital envelope routines initialization error
@@ -75,7 +84,7 @@ To solve this error, perform the following steps:
75
84
76
85
1. Open a terminal.
77
86
2. Navigate into the `ipfs-docs` folder:
78
-
87
+
79
88
```bash
80
89
cd ipfs-docs
81
90
```
@@ -92,7 +101,47 @@ To solve this error, perform the following steps:
92
101
npm start
93
102
```
94
103
95
-
You can now return to the [Project set-up](#project-set-up) section above and continue on with the steps. You can also check [this issue in the Webpack GitHub repository](https://github.com/webpack/webpack/issues/14532) for more information about this error.
104
+
You can return to the [Project set-up](#project-set-up) section above and continue with the steps. You can also check [this issue in the Webpack GitHub repository](https://github.com/webpack/webpack/issues/14532) for more information about this error.
105
+
106
+
## Contribute to documentation
107
+
108
+
We would **love ❤️ your help** to improve existing items or make new ones even better! [We also have bounties available](https://github.com/ipfs/devgrants/projects/1)!
109
+
110
+
### Issues
111
+
112
+
If you find something wrong within this repository, please raise an issue [here →](https://github.com/ipfs/ipfs-docs/issues). Unless the issue is urgent, updates will be batch-merged into `main` on Tuesdays or Thursdays.
113
+
114
+
### Bounties
115
+
116
+
You can earn the undying love of the IPFS community, _and_ get rewarded by closing an issue containing the [`bounty` tag](https://github.com/ipfs/ipfs-docs/issues?q=is%3Aopen+is%3Aissue+label%3Abounty). Submissions must be production-ready and meet all the specifications listed on the issue page. To get started, check out the [current list of open bounties →](https://github.com/ipfs/devgrants/projects/1).
117
+
118
+
If you are attempting to close an issue, great! Thanks for the help! Please leave a comment within the issue requesting to be assigned to that issue **before** submitting a pull request. This minimizes the chance of multiple contributors duplicating work by submitting pull requests for the same issue. If you submit a pull request to an issue _without_ first being assigned to it, your pull request may not be accepted.
119
+
120
+
### Suggestions
121
+
122
+
Everyone has an opinion when it comes to documentation, and **that's a good thing**! Having folks from different backgrounds add to a discussion empowers everyone within that discussion, so if you've got something to add or would like to bring up a topic for discussion about the documentation, please do so! Create an issue using the [`kind/question` tag](https://github.com/ipfs/ipfs-docs/issues?q=is%3Aopen+is%3Aissue+label%3Akind%2Fquestion).
123
+
124
+
### Pull requests welcome
125
+
126
+
Feel free to submit pull requests with any changes you'd like to see. If you're simply changing a typo or editing a styling bug, you can add `ciskip` to the title of your pull request to stop Filecorgi from running. Once merged, the website is updated automatically within 5-10 minutes.
127
+
128
+
## Style and configuration guide
129
+
130
+
A writing style and template guide is in the process of being written that contributors can use as a guideline.
131
+
132
+
### Static-site generator
133
+
134
+
The IPFS documentation site uses the [VuePress static website generator](https://vuepress.vuejs.org/) to convert the Markdown guides into a documentation website. All the documentation is written in Markdown; follow the [VuePress Markdown documentation](https://vuepress.github.io/guide/markdown.html) for information on how to write markdown files for VuePress.
135
+
136
+
### Automated deployments
137
+
138
+
When opening a pull request, CI scripts will run against your feature branch to test your changes.
139
+
140
+
The CI/CD production workflow builds on the `main` branch and deploys the documentation site on [fleek](https://fleek.co/). The site reflects the latest commit on `main`.
141
+
142
+
### Translation
143
+
144
+
Please stay tuned on the steps to translate the documentation.
96
145
97
146
## Core members
98
147
@@ -101,4 +150,4 @@ You can now return to the [Project set-up](#project-set-up) section above and co
101
150
102
151
## License
103
152
104
-
All software code is copyright (c) Protocol Labs, Inc. under the **MIT license**. Other written documentation and content is copyright (c) Protocol Labs, Inc. under the [**Creative Commons Attribution-Share-Alike License**](https://creativecommons.org/licenses/by/4.0/).
153
+
All software code is copyright (c) Protocol Labs, Inc. under the **MIT license**. Other written documentation and content are copyright (c) Protocol Labs, Inc. under the [**Creative Commons Attribution-Share-Alike License**](https://creativecommons.org/licenses/by/4.0/).
Copy file name to clipboardExpand all lines: docs/basics/command-line.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ description: "A simple walkthrough of how to perform basic IPFS operations using
5
5
6
6
# Basic CLI Operations
7
7
8
-
This short guide aims to walk you through the basics of using IPFS with the Kubo CLI. Kubo is [one of multiple IPFS implementations](.ipfs-implementations.md). It is the oldest IPFS implementation and exposes a CLI (among other things).
8
+
This short guide aims to walk you through the basics of using IPFS with the Kubo CLI. Kubo is [one of multiple IPFS implementations](ipfs-implementations.md). It is the oldest IPFS implementation and exposes a CLI (among other things).
9
9
10
10
You will learn how to add, retrieve, read, and remove files within the CLI. If you are unsure about the meaning of some terms, you can check out the [glossary](../concepts/glossary.md).
Copy file name to clipboardExpand all lines: docs/concepts/bitswap.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -43,7 +43,7 @@ Bitswap sends _want-block_ to peers that have the block, and they respond with t
43
43
44
44
### Additional references
45
45
46
-
-[February 2020: New improvements to IPFS Bitswap](https://blog.ipfs.io/2020-02-14-improved-bitswap-for-container-distribution/)
46
+
-[February 2020: New improvements to IPFS Bitswap](https://blog.ipfs.tech/2020-02-14-improved-bitswap-for-container-distribution/)
47
47
-[Technical overview of the Go implementation of Bitswap](https://docs.google.com/presentation/d/1mbFFGIIKNvboHyLn-k26egOSWkt9nXjlNbxpmCEQfqQ/edit#slide=id.p)
48
48
-[Article: Swapping bits and distributing hashes on the decentralized web (Textile)](https://medium.com/textileio/swapping-bits-and-distributing-hashes-on-the-decentralized-web-5da98a3507)
49
49
- "About Bitswap" Go implementation poster from the IPFS developer summit in Berlin in July 2018:
Copy file name to clipboardExpand all lines: docs/concepts/glossary.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -372,7 +372,7 @@ Protocol Buffers (Protobuf) is a free and open-source cross-platform data format
372
372
373
373
### Pubsub
374
374
375
-
Publish-subscribe (Pubsub) is an experimental feature in IPFS. Publishers send messages classified by topic or content, and subscribers receive only the messages they are interested in. [More about Pubsub](https://blog.ipfs.io/25-pubsub/)
375
+
Publish-subscribe (Pubsub) is an experimental feature in IPFS. Publishers send messages classified by topic or content, and subscribers receive only the messages they are interested in. [More about Pubsub](https://blog.ipfs.tech/25-pubsub/)
Libp2p supports upgrading a transport connection into a securely encrypted channel. You can then trust the identity of the peer you're communicating with and that no third-party can read the conversation or alter it in-flight. The current default is [TLS 1.3](https://www.ietf.org/blog/tls13/) as of IPFS 0.7. The previous default of [SECIO](https://docs.libp2p.io/concepts/secure-comms/) is now deprecated and disabled by default (see [this blog post](https://blog.ipfs.io/2020-08-07-deprecating-secio/) for more information).
38
+
Libp2p supports upgrading a transport connection into a securely encrypted channel. You can then trust the identity of the peer you're communicating with and that no third-party can read the conversation or alter it in-flight. The current default is [TLS 1.3](https://www.ietf.org/blog/tls13/) as of IPFS 0.7. The previous default of [SECIO](https://docs.libp2p.io/concepts/secure-comms/) is now deprecated and disabled by default (see [this blog post](https://blog.ipfs.tech/2020-08-07-deprecating-secio/) for more information).
Copy file name to clipboardExpand all lines: docs/concepts/usage-ideas-examples.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -204,7 +204,7 @@ Thanks to de-duplication, IPFS is a powerful tool for archiving the web. The [In
204
204
205
205
### Fight censorship
206
206
207
-
Wikipedia has not been accessible in Turkey for a few years. The company behind IPFS, Protocol Labs, is hosting a mirror of Wikipedia on IPFS. See the original [blog post](https://blog.ipfs.io/24-uncensorable-wikipedia/) and the [project code](https://github.com/ipfs/distributed-wikipedia-mirror) for more information.
207
+
Wikipedia has not been accessible in Turkey for a few years. The company behind IPFS, Protocol Labs, is hosting a mirror of Wikipedia on IPFS. See the original [blog post](https://blog.ipfs.tech/24-uncensorable-wikipedia/) and the [project code](https://github.com/ipfs/distributed-wikipedia-mirror) for more information.
[Kubo](https://dist.ipfs.io/#kubo) provides native support for subdomain gateways on hostnames defined in the [`Gateway.PublicGateways`](https://github.com/ipfs/kubo/blob/master/docs/config.md#gatewaypublicgateways) configuration map.
99
+
[Kubo](https://dist.ipfs.tech/#kubo) provides native support for subdomain gateways on hostnames defined in the [`Gateway.PublicGateways`](https://github.com/ipfs/kubo/blob/master/docs/config.md#gatewaypublicgateways) configuration map.
100
100
101
101
Learn more about daemon configuration for hosting a public gateway:
0 commit comments