Closed srirambv closed 1 year ago
Verification passed on
Brave | 1.53.92 Chromium: 114.0.5735.110 (Official Build) beta (64-bit) |
---|---|
Revision | 1c828682b85bbc70230a48f5e345489ec447373e-refs/branch-heads/5735_90@{#13} |
OS | Windows 11 Version 22H2 (Build 22621.1778) |
IPFS on Desktop
Installation & Setup
IPFS installation
[x] Verify going to
brave://ipfs
and clicking onInstall and start
installs and shows the latestgo-ipfs
release, via theVersion:
section underNode info
.Seed profile
ipns://en.wikipedia-on-ipfs.org
.Use a Brave local IPFS node
.IPNS Keys
(add/rotate) section.Import and Sharing
(page, image, text, video) section.go-updater node update
--use-dev-goupdater-url
, and clicking onRestart
viabrave://ipfs
downloads and installs the latest in-development (release) candidate.Method to resolve IPFS resources
isBrave local IPFS node
inbrave://settings/ipfs
.brave://ipfs-internals
showsNode is not running
underIPFS node status
, with aStart
button.Start
.Config
Maximum IPFS cache size (GB)
on thebrave://settings/ipfs
page (setMethod to resolve IPFS resources
toBrave local IPFS node
onbrave://settings/ipfs
), the new value is reflected on the diagnostic page (brave://ipfs
) in theRepo Stats -> Size
section.Diagnostic page (
brave://ipfs
)brave://ipfs
redirects tobrave://ipfs-internals
.brave://ipfs
will present you with anInstall and start
button, which will install and start an IPFS local node. Confirm you seeNode is running
underIPFS node status
,Stop
,Restart
, andMy Node
buttons, and a dynamically updatingConnected peers:
count.Stop
temporarily clears all statistics, paths, and config information.Start
populates all statistics, paths, and config information, and you seeStop
,Restart
, andMy Node
buttons, along with a dynamically updatingConnected peers:
count.Restart
clears and then repopulates all stats, paths, and config information, and you seeStop
,Restart
, andMy Node
buttons, along with a dynamically updatingConnected peers:
count.(details)
to the right ofConnected peers:
takes you to thePEERS
pane of127.0.0.1:45002/ipfs/bafy..../#/
and you see a global map with a dynamically updating peer count and listing, below.Perform a garbage collection sweep
resets and repopulates theObjects:
andSize:
stats beneathRepo Stats
.My Node
takes you to theStatus
pane of the IPFS dashboard, with a URL similar to127.0.0.1:45002/ipfs/bafy..../#/
, where you seeConnected to IPFS
, MB count of files shared, and dynamically updating peers count, as well as yourPEER ID
andAGENT
.Import and Sharing
[x] Prerequisites: Brave local IPFS node launched and local gateway configured. On a new profile, loading
ipns://en.wikipedia-on-ipfs.org
and clickingUse a Brave local IPFS node
on the interstitial page will set you up.Importing a page via IPFS
wikipedia.org
. Context-click the page and selectImport to IPFS > This page
.Importing linked content
https://search.brave.com/search?q=hiddenmickeys&source=desktop
. Context-click the first link there and selectImport to IPFS > Linked content
.Importing selected audio
https://samplelib.com/sample-mp3.html
. Context-click any audio file and selectImport to IPFS > Selected audio
.Importing selected image
search.brave.com
, right-clicking on the logo, and choosingImport to IPFS > Selected image.
Importing selected text
https://lipsum.com/
and make a text selection. Context-click and chooseImport Selected Text to IPFS
.file_1
and the imported text is readable inside the file.Importing selected video
Import to IPFS > Selected video
.Note: For the other types, downloading from the IPFS webui (My Node) and ensuring they still play in a media player, is enough.
Sharing a local file using IPFS (without IPNS keys)
IPFS -> Share Local File Using IPFS
select and import any local file.https://dweb.link/ipfs/
is copied to the clipboard, and opens when pasting into a new tab.Sharing a local folder using IPFS (without IPNS keys)
IPFS -> share Local Folder Using IPFS
, and select and import any local folder.Address bar
Badge shown only when IPFS support is enabled
https://en.wikipedia-on-ipfs.org
, switchMethod to resolve IPFS resources
to eitherGateway
orBrave local IPFS node
inbrave://settings/ipfs
, and then see anIPFS
badge/icon in the URL bar.Badge on a public gateway
https://dweb.link/ipfs/QmT5NvUtoM5nWFfrQdVrFtvGfKFmG7AHE8P34isapyhCxX/wiki/Mars.html
redirects you seamlessly tohttps://bafybeicgmdpvw4duutrmdxl4a7gc52sxyuk7nz5gby77afwdteh3jc5bqa.ipfs.dweb.link/wiki/Mars.html
, and there's anIPFS
badge/button in the URL bar. Confirm that clickingIPFS
goes toipfs://bafybeicgmdpvw4duutrmdxl4a7gc52sxyuk7nz5gby77afwdteh3jc5bqa/wiki/Mars.html
.https://ipfs.io/ipns/libp2p.io/
shows anIPFS
button in the URL bar, and clicking it redirects toipns://libp2p.io/
. Confirm it resolves and loads.Badge on DNSlink websites
IPFS
badge/button onhttps://en.wikipedia-on-ipfs.org/wiki/Asia/#Economy
loadsipns://en.wikipedia-on-ipfs.org/wiki/Asia/#Economy
in a new tab.IPFS
badge/button onhttps://blog.ipfs.io/24-uncensorable-wikipedia
loadsipns://blog.ipfs.io/24-uncensorable-wikipedia/
in a new tab.Protocol info popup
ipns://brantly.eth
while usingBrave local IPFS node
for the resolver, and confirm there's a clickable info badge "IPFS" to the left of the URL, with on click pop-up that saysThis content was loaded over the IPFS protocol.
Automatic redirects to IPFS
brave://settings/ipfs
, setRedirect IPFS resources to the configured IPFS gateway
toOn
.https://ipfs.io/ipfs/QmbWqxBEKC3P8tqsKc98xmWNzrzDtRLMiMPL8wBuTGsMnR
and confirm it redirects toipfs://bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdi
.https://en.wikipedia-on-ipfs.org/wiki/
and confirm it redirects toipns://en.wikipedia-on-ipfs.org/wiki/
.IPFS Companion
IPFS Companion
toOn
viabrave://settings/ipfs
prompts you to install the extension. After clickingAdd extension
, confirm you get a notification that IPFS Companion was added to Brave, and are then taken to theSet your IPFS preference
interstitial page.IPFS Companion
, will load a popup.Companion Preferences
page.My Node
and confirm it opens the same ipfs-webui interface asMy Node
atbrave://ipfs-internals
IPFS URLs
Gateway
andBrave local IPFS node
modes:ipfs://bafybeiemxf5abjwjbikoz4mc3a3dla6ual3jsgpdr4cjr3oz3evfyavhwq/wiki/Vincent_van_Gogh.html#Life
ipfs://bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdi/
ipfs://QmXoypizjW3WknFiJnKLwHCnL72vedxjQkDDP1mXWo6uco/wiki/Tokyo_National_Museum.html
ipfs:QmYwAPJzv5CZsnA625s3Xf2nemtYgPpHdWEz79ojWnPbdG/readme
IPNS URLs
Gateway
andBrave local IPFS node
modes:ipns://en.wikipedia-on-ipfs.org
ipns://en.wikipedia-on-ipfs.org/wiki/Tokyo#Islands
ipns://docs.ipfs.io
ipns://brantly.eth
(ENS)ipns://vitalik.eth
(ENS)ipns://brad.crypto
(Unstoppable Domains)Gateway choice
The interstitial page
Method to resolve IPFS resources
set toAsk
inbrave://settings/ipfs
.ipfs://bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdi
loads the interstitial page.ipns://en.wikipedia-on-ipfs.org
in a new tab loads the same interstitial page.Use a public gateway
loadshttps://dweb.link/ipns/en.wikipedia-on-ipfs.org/wiki/
which then redirect to unique Origin athttps://en-wikipedia--on--ipfs-org.ipns.dweb.link/wiki/
.Use a Brave local IPFS node
loadsipns://en.wikipedia-on-ipfs.org/wiki/
.Public Path gateway
https://cloudflare-ipfs.com/
viaSettings -> IPFS -> IPFS public gateway address -> Change
.Only a valid IPFS gateway with Origin isolation enabled can be used in Brave
is displayed (example).Public Subdomain Gateway
https://{YOUR-PUBLIC-GATEWAY}
viaSettings -> IPFS -> IPFS public gateway address -> Change
. Refer to the IPFS public-gateway list.ipns://en.wikipedia-on-ipfs.org/wiki/
and selectingUse a public gateway
loadshttps://{YOUR-PUBLIC-GATEWAY}/ipns/en.wikipedia-on-ipfs.org/wiki/
which then redirect to unique Origin athttps://en-wikipedia--on--ipfs-org.ipns.{YOUR-PUBLIC-GATEWAY}/wiki/
Verify loadshttps://cf-ipfs.com/ipns/en.wikipedia-on-ipfs.org/wiki/
which then redirect to unique Origin athttps://en-wikipedia--on--ipfs-org.ipns.{YOUR-PUBLIC-GATEWAY}/wiki/
.Protocol system handler/OS integration
ipfs://
Windows
) that pressingWin+R
, typingopen ipfs://bafkreigcnxudvpojjfwncmauociy5q46zsq46oe66cxbyzie3imabuoege
, and pressingEnter
opens Brave and loads an HTML page with the wordPASS
.macOS
): opening Terminal, and typingopen ipfs://bafkreigcnxudvpojjfwncmauociy5q46zsq46oe66cxbyzie3imabuoege
, and pressingEnter
opens Brave and loads an HTML page with the wordPASS
.Linux
) that opening a shell and typingxdg-open ipfs://bafkreigcnxudvpojjfwncmauociy5q46zsq46oe66cxbyzie3imabuoege
and pressingEnter
opens Brave and loads an HTML page with the wordPASS
.ipns://
Windows
) that pressingWin+R
, typingopen ipns://en.wikipedia-on-ipfs.org/wiki/Tokyo#Islands
, and pressingEnter
opens Brave and loads an HTML page scrolled to the headerIslands
.macOS
): opening Terminal, and typingopen ipns://en.wikipedia-on-ipfs.org/wiki/Tokyo#Islands
, and pressingEnter
opens Brave and loads an HTML page scrolled to the headerIslands
.Linux
) that opening a shell and typingxdg-open ipns://en.wikipedia-on-ipfs.org/wiki/Tokyo#Islands
, and pressingEnter
opens Brave and loads an HTML page scrolled to the headerIslands
.Peers
[x] Prerequisites: Brave local IPFS node launched and local gateway configured on two machines, locally networked (LAN, can be over Wi-Fi).
Adding
; see issue 15567 for full setup stepsbrave://settings/ipfs/peers
and click on theAdd
button, it prompts you to enter a new peer-connection string. Confirm that entering an incorrect string yieldsThis name is not valid
upon clickingSubmit
. (Acceptable ones are only CIDs or something like**/p2p/**
format.)Restart
button; happen it shows error message and suggests to see more on diagnostic page.Peering.Peers
section of IPFS node config file got updated (either viaMy Node → Settings → IPFS Config
or by manually inspectingbrave_ipfs/config
file).Removing
IPNS Keys
[x] Prerequisites: Brave local IPFS node launched and local gateway configured. Go to
Settings -> IPFS
, there should be an availableSet up your IPNS keys
option, which opensbrave://settings/ipfs/keys
Publishing a local file using an IPNS key
IPFS -> Share local file using IPNS -> self
.https://dweb.link/ipns/
is copied to the clipboard by opening a new tab and pasting from the context menu orCTRL+V
.k51q...
) before the?filename=filename.ext
from the copied text.Publishing a local folder using an IPNS key
IPFS > Share local folder using IPNS -> self
.https://dweb.link/ipns/
is copied to clipboard by opening a new tab and pasting from context menu orCTRL+V
.k51q...
) before the?filename=filename.ext
from the copied text.Importing keys
Import
button and choosing an existing key file to import.self
will yieldThis name cannot be used
.Publishing content with IPNS key
Add/Remove/Rotate keys
Add
, it prompts for a key name and generates a new key.Add
and entering an existing key name shows aThis name cannot be used
error message.self
key prompts for a key name. Enter a valid, unique name and clickRotate
. Confirm the key is created with your entered name, original hash, and a newself
key (with a new hash value) is generated.Export key
andRemove key
. ChooseExport key
and confirm you get prompted to save the key. ClickSave
and ensure the key is saved to disk. Delete the key frombrave://settings/ipfs/keys
and now clickAdd
to confirm the same key as the original is added from disk.Remove key
removes the key from the UI.IPFS on Android
Public Gateway Setting
IPFS Gateway
option is available underBrave Shields & Privacy
.IPFS/IPNS URI
ipfs://bafybeiemxf5abjwjbikoz4mc3a3dla6ual3jsgpdr4cjr3oz3evfyavhwq/wiki/Vincent_van_Gogh.html
for the first time triggers IPFS interstitial page to select public gateway to load the URI.Use a public gateway
loadshttps://bafybeiemxf5abjwjbikoz4mc3a3dla6ual3jsgpdr4cjr3oz3evfyavhwq.ipfs.dweb.link/wiki/Vincent_van_Gogh.html
via public gateway.ipns://brad.crypto
brings up IPFS interstitial page (ipfs://QmTiqc12wo2pBsGa9XsbpavkhrjFiyuSWsKyffvZqVGtut
)Use a public gateway
loadshttps://bafybeicp7gd7s4oljtcesmd7e6vypunw26mv3f5ass5ud7b6jrfebc4ux4.ipfs.dweb.link/
via public gateway.ipfs://
URI oripns://
URI doesn't show any interstitial page.ipfs://
URI oripns://
URI doesn't load on a private tab even when the setting is enabled.