-
Notifications
You must be signed in to change notification settings - Fork 122
/
about.json
502 lines (502 loc) · 18.2 KB
/
about.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
{
"seo": {
"title": "",
"description": ""
},
"og": {
"site_name": "",
"url": "",
"type": "website",
"image": ""
},
"page_content": [
[
{
"type": "section-data",
"gradient": true,
"variant": "light"
},
{
"id": "about_hero-header",
"columns": [
{
"type": "hero",
"page": "about",
"cols": {
"num": "col-6_sm-7_mi-10_ti-12",
"push_left": "off-6_sm-5_mi-1_ti-0"
},
"format": "header",
"heading": "What is Web3.Storage?",
"subheading": "Web3.Storage is a service to make building on top of Filecoin as simple as possible - giving developers the power of distributed storage and content addressing via simple client libraries or an HTTP API."
}
]
}
],
[
{
"id": "section_architecture-1",
"columns": [
{
"type": "custom",
"cols": {
"num": "col-11"
},
"customizations": [
{
"type": "corkscrew",
"id": "architecture-blurred-background"
},
{
"type": "text_block",
"format": "small",
"description": [
"Content uploaded to Web3.Storage is pinned redundantly three times to an IPFS Cluster of 6+ geographically distributed nodes. Before uploading, our client side libraries convert data into a CAR file (that includes the CID of the file), which keeps things trustless: the client can cryptographically verify that the CID corresponds to their file when storing and retrieving.",
"Once this 31GiB CAR file is uploaded, a queue of geographically distributed storage providers - selected for performance and availability - bid for the right to store these deals, with the Web3.Storage service making a minimum of 5 deals with the various storage providers.",
"This data is made available to the public IPFS network, meaning you or anyone can access the data from anyone broadcasting the data via its CID.",
"Please <a href='/docs' alt='Web3.Storage Documentation'>see the documentation</a> for how one can use the Status API to query for information regarding pin status and deal status for your uploaded content."
]
},
{
"type": "image_block",
"src": "/images/about/placeholder_image.png"
}
]
},
{
"type": "corkscrew",
"id": "about_section_architecture-corkscrew",
"cols": {
"num": "col-1"
}
}
]
},
{
"id": "section_architecture-2",
"columns": [
{
"type": "custom",
"cols": {
"num": "col-5_md-4"
},
"customizations": [
{
"type": "helix",
"id": "section_architecture-2-helix"
},
{
"type": "image_block",
"id": "section_architecture-image-storage",
"src": "/images/index/app-ui-screenshot-storage-manager.png"
},
{
"type": "image_block",
"id": "section_architecture-image-files",
"src": "/images/index/app-ui-screenshot-file-manager.png"
},
{
"type": "image_block",
"id": "section_architecture-image-upload",
"src": "/images/index/app-ui-screenshot-file-upload.png"
}
]
},
{
"type": "custom",
"cols": {
"num": "col-6_md-7_sm-12",
"push_left": "off-1_sm-0"
},
"customizations": [
{
"type": "cross",
"id": "section_architecture-2-cross"
},
{
"type": "text_block",
"format": "small",
"heading": "Once the deals are active, the Web3.Storage client polls to ensure that the relevant sectors are still available.",
"description": [
"If the Filecoin network finds that a copy of your data is no longer proven to be stored, e.g., a storage deal expires or a miner goes offline, the Web3.Storage client will automatically add the relevant data into the queue of upcoming deals to ensure at all times there are always a minimum of 5 copies of data being stored with Filecoin Storage Providers.",
"In the future, we hope to expand this service to offer a variety of options for storing data - including purely protocol-based approaches (e.g. via smart contracts) as well as other hosted options (e.g. HTTP endpoints). We also aim to provide more native tooling for automated deal management via tools like smart contracts - which may augment the offerings of this service in the future.",
"Our aim today is to provide a user-friendly experience that massively reduces the burden for onboarding new use cases into the web3 ecosystem today - while providing an upgrade path for the future."
]
}
]
},
{
"type": "custom",
"cols": {
"num": "col-5_md-4_sm-8_mi-10_ti-12",
"push_left": "off-0_sm-2_mi-1_ti-0"
},
"customizations": [
{
"type": "helix",
"id": "section_architecture-2-helix-small"
},
{
"type": "image_block",
"id": "section_architecture-image-storage",
"src": "/images/index/app-ui-screenshot-storage-manager.png"
},
{
"type": "image_block",
"id": "section_architecture-image-files",
"src": "/images/index/app-ui-screenshot-file-manager.png"
},
{
"type": "image_block",
"id": "section_architecture-image-upload",
"src": "/images/index/app-ui-screenshot-file-upload.png"
}
]
}
]
}
],
[
{
"id": "section_how-it-works",
"columns": [
{
"type": "text_block",
"cols": {
"num": "col-5_sm-10_ti-12",
"push_left": "off-0_sm-1_ti-0"
},
"format": "medium",
"heading": "How Does Web3.Storage work?",
"description": [
"<a href='/docs/#quickstart' class='how-it-works-highlight' target='_blank'>Developers can start building in a matter of minutes</a> - allowing them to take advantage of all the power and openness of the decentralized web with none of the infrastructure complexity.",
"Behind the scenes, Web3.Storage is backed by Filecoin and makes content available via IPFS leveraging the unique properties of each network."
]
},
{
"type": "custom",
"cols": {
"num": "col-6_sm-10_ti-12",
"push_left": "off-1_sm-1_ti-0"
},
"customizations": [
{
"type": "text_block",
"format": "small",
"heading": "About Filecoin",
"description": "Filecoin offers persistent, decentralized storage - guaranteeing the integrity of the underlying data through a robust economic model while also providing cryptographic proofs for verifiability."
},
{
"type": "text_block",
"format": "small",
"heading": "About IPFS",
"description": "IPFS offers content addressing - enabling developers to create immutable links to their content, and flexibility for developers in how they’d like to retrieve their data (whether it be running personal nodes, relying on public infrastructure, or paying for hosted options)."
}
]
}
]
},
{
"id": "how-it-works-accordion",
"columns": [
{
"type": "accordion_block",
"cols": {
"num": "col-12_sm-10_ti-12",
"push_left": "off-0_sm-1_ti-0"
},
"multiple": true,
"toggleOnLoad": true,
"sections": [
{
"heading": "Storage Term",
"content": "All data uploaded to Web3.Storage is available to anyone who requests it using the correct CID. Users should not store any private or sensitive information in an unencrypted form using Web3.Storage. Further, deleting files from Web3.Storage via the site’s Files page or API will remove them from the file listing for a user’s account, but nodes on the IPFS network may retain copies of the data indefinitely. Users should not use Web3.Storage for data that may need to be permanently deleted in the future."
},
{
"heading": "Data Limits",
"content": "Web3.Storage supports uploads up to 32GiB in size per request, and currently has a cap of 1TiB of storage per account. Data limits can be increased at not cost by submitting a request via your Account page when logged in."
},
{
"heading": "Filecoin Deals",
"content": "Data stored via the website is guaranteed to be available in IPFS upon completion of a successful upload. Please note that once replication in IPFS is complete (at a minimum of 3 copies being stored), data is also pushed to be stored on Filecoin. Content is batched into deals on Filecoin and it is expected that there may be a delay between the content being uploaded to the website and being stored on Filecoin through a deal. You may query the status of any CID uploaded through Web3.Storage using the Status API (updated every five minutes) for the latest information regarding an individual CID’s pin status or deal status.<br><br>For reference, the following parameters and strategies are used to ensure highly redundant storage on the Filecoin network:<ul><li>Deals with storage providers are set to last 18 months with automatic deal renewals, managed by Web3.Storage.</li><li>Each piece of content is stored with a minimum of 5 storage providers, typically exceeding this minimum (the specific list of storage providers being provided via the Status API). In the event of a terminated sector, Web3.Storage will automatically store an additional copy to meet the minimum of 5 copies being stored on the Filecoin network.</li><li>It is recommended that you do not rely on Filecoin deals directly for performant retrieval, and instead retrieve the data via IPFS (where Web3.Storage will be dual pinning the content). Retrieving data over the IPFS network is the recommended means of accessing Web3.Storage data.</li><ul>"
}
]
}
]
}
],
[
{
"id": "section_explore-docs",
"grid": ["noGutter"],
"columns": [
{
"type": "text_block",
"cols": {
"num": "col-3_md-7_ti-8",
"push_left": "off-0_md-1_sm-0"
},
"format": "medium",
"heading": "Open product. Open book.",
"cta": {
"url": "/docs",
"text": "EXPLORE DOCS",
"theme": "dark",
"event": "",
"ui": "",
"action": ""
}
},
{
"type": "card_list_block",
"cols": {
"num": "col-8_md-10_sm-12_mi-10",
"push_left": "off-1_md-1_sm-0_mi-1"
},
"cards": [
{
"type": "D",
"categories": [
{
"heading": "Welcome",
"links": [
{
"url": "/docs/#quickstart",
"text": "Quickstart"
},
{
"url": "/docs/#create-an-account",
"text": "Create an Account"
},
{
"url": "/docs/#get-an-api-token",
"text": "Get an API token"
},
{
"url": "/docs/#create-the-upload-script",
"text": "Create the Upload Script"
},
{
"url": "/docs/#run-the-script",
"text": "Run the Script"
},
{
"url": "/docs/#get-your-file",
"text": "Get your file"
},
{
"url": "/docs/#next-steps",
"text": "Next Steps"
}
]
},
{
"heading": "Concepts",
"links": [
{
"url": "/docs/concepts/content-addressing",
"text": "Content Addressing"
},
{
"url": "/docs/concepts/decentralized-storage",
"text": "Decentralized Storage"
}
]
}
]
},
{
"type": "D",
"categories": [
{
"heading": "How-tos",
"links": [
{
"url": "/docs/how-tos/store/",
"text": "Store"
},
{
"url": "/docs/how-tos/retrieve",
"text": "Retrieve"
},
{
"url": "/docs/how-tos/query",
"text": "Query"
},
{
"url": "/docs/how-tos/list",
"text": "List"
},
{
"url": "/docs/how-tos/work-with-car-files",
"text": "Work with Content"
},
{
"url": "/docs/how-tos/generate-api-token",
"text": "Generate an API Token"
},
{
"url": "/docs/how-tos/troubleshooting",
"text": "Troubleshooting"
}
]
},
{
"heading": "Reference",
"links": [
{
"url": "/docs/reference/http-api/",
"text": "HTTP API Reference"
},
{
"url": "/docs/reference/js-client-library",
"text": "Javascript Client Library"
}
]
}
]
}
]
},
{
"type": "text_block",
"cols": {
"num": "col-3"
},
"format": "medium",
"heading": "Open product. Open book.",
"cta": {
"url": "/docs/",
"text": "EXPLORE DOCS",
"theme": "dark",
"event": "",
"ui": "",
"action": ""
}
}
]
}
]
],
"floater_animations": [
{
"trigger": "about_hero-header",
"duration": 1000,
"offset": 700,
"floaters": [
{
"id": "about_hero-ring",
"start": {
"scale": 0.8,
"rotate": 35
},
"end": {
"scale": 1,
"rotate": 55
}
},
{
"id": "about_hero-helix",
"start": {
"scale": 1,
"rotate": 20,
"x": 1,
"y": -1
},
"end": {
"scale": 1.2,
"rotate": -20,
"x": 80,
"y": -40
}
},
{
"id": "about_hero-spring",
"start": {
"rotate": 45
},
"end": {
"rotate": 70
}
},
{
"id": "about_hero-cone",
"start": {
"scale": 1,
"rotate": 1
},
"end": {
"scale": 1.1,
"rotate": 15
}
},
{
"id": "about_section_architecture-corkscrew",
"start": {
"rotate": 29,
"scale": 1,
"x": 1,
"y": 1
},
"end": {
"rotate": 40,
"scale": 1.15,
"x": 60,
"y": 80
}
}
]
},
{
"trigger": "section_architecture-2",
"duration": 1200,
"floaters": [
{
"id": "section_architecture-2-helix",
"start": {
"rotate": -79,
"scale": 1,
"x": -1,
"y": 1
},
"end": {
"rotate": -129,
"scale": 1.2,
"x": -140,
"y": 20
}
},
{
"id": "section_architecture-2-helix-small",
"start": {
"rotate": -79,
"scale": 1,
"x": -1,
"y": 1
},
"end": {
"rotate": -129,
"scale": 1.2,
"x": -140,
"y": 20
}
},
{
"id": "section_architecture-2-cross",
"start": {
"rotate": 1,
"scale": 1,
"x": 1,
"y": 1
},
"end": {
"rotate": 40,
"scale": 1.3,
"x": 70,
"y": 70
}
}
]
}
]
}