Closed stephendonner closed 3 years ago
The Protocol system handler/OS integration
section for Win
can't be completed as there's no way to set Brave as the default application for the IPFS
protocol under Defaults
. Some more context/information via https://github.com/brave/brave-browser/issues/17300#issuecomment-898715004.
Also created https://github.com/brave/brave-browser/issues/17484 re: not being able to remove keys.
IPFS on Desktop
Installation & Setup
go-updater node update
brave://ipfs
and clicking onInstall and start
installs and shows the latestgo-ipfs
release, via theVersion:
section underNode info
.[x] Verify, using the above profile, that restarting Brave with
--use-dev-goupdater-url
, and clicking onRestart
viabrave://ipfs
downloads and installs the latest in-development (release) candidate.Config
Maximum IPFS cache size (GB)
on thebrave://settings/ipfs
page (setMethod to resolve IPFS resources
toLocal 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: local node launched and local gateway configured. On a new profile, loading
ipns://en.wikipedia-on-ipfs.org
and clickingUse a local 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 keys)
IPFS -> Share Local File Using IPFS
select and import any local file.Sharing a local folder using IPFS (without keys)
IPFS -> share Local Folder Using IPFS
, and select and import any local folder.Automatic redirects to IPFS
Redirect via configured IPFS gateway
brave://settings/ipfs
, setRedirect IPFS resources to the configured IPFS gateway
toOn
. Loadhttps://en.wikipedia-on-ipfs.org/
and confirm it redirects tohttp://en.wikipedia-on-ipfs.org.ipns.localhost:48081/wiki/
.Redirect via DNSLink
Automatically redirect to IPFS pages via DNSLink when possible
set toOn
, visitinghttps://en.wikipedia-on-ipfs.org/wiki
redirects toipns://en.wikipedia-on-ipfs.org/wiki
.Interstitial page (
Ask
mode inbrave://settings/ipfs
)ipns://brantly.eth
while usingLocal node
for the resolver, and confirm there's a clickable info badge to the left of the URL, which saysThis content was loaded over the IPFS protocol.
DNSLink
https://dweb.link/ipfs/QmT5NvUtoM5nWFfrQdVrFtvGfKFmG7AHE8P34isapyhCxX/wiki/Mars.html
redirects you seamlessly tohttps://bafybeicgmdpvw4duutrmdxl4a7gc52sxyuk7nz5gby77afwdteh3jc5bqa.ipfs.dweb.link/wiki/Mars.html
, and there's anOpen using IPFS
badge/button in the URL bar. Confirm that clickingOpen using IPFS
goes toipfs://bafybeicgmdpvw4duutrmdxl4a7gc52sxyuk7nz5gby77afwdteh3jc5bqa/wiki/Mars.html
.https://ipfs.io/ipns/libp2p.io/
shows anOpen using IPFS
button in the URL bar, and clicking it redirects toipns://libp2p.io/
. Confirm it resolves and loads.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. Click on the gears (settings) icon and confirm it loads theCompanion Preferences
page.IPFS URLs
Gateway
andLocal node
modes:ipfs://bafybeiemxf5abjwjbikoz4mc3a3dla6ual3jsgpdr4cjr3oz3evfyavhwq/wiki/Vincent_van_Gogh.html
ipfs://bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdi/
ipfs://QmXoypizjW3WknFiJnKLwHCnL72vedxjQkDDP1mXWo6uco/wiki/Tokyo_National_Museum.html
ipfs:QmYwAPJzv5CZsnA625s3Xf2nemtYgPpHdWEz79ojWnPbdG/readme
IPNS URLs
Gateway
andLocal node
modes:ipns://brantly.eth
ipns://en.wikipedia-on-ipfs.org
ipns://libp2p.io/
ipns://en.wikipedia-on-ipfs.org/wiki/Tokyo
ipns://ipfs.io
Gateway
https://cloudflare-ipfs.com/
viaSettings -> IPFS -> Change
.ipns://en.wikipedia-on-ipfs
loads the interstitial page.Use a public gateway
loadshttps://cloudflare-ipfs.com/ipns/en.wikipedia-on-ipfs.org/wiki/
.https://en.wikipedia-on-ipfs.org
, switchMethod to resolve IPFS resources
to eitherGateway
orLocal node
inbrave://settings/ipfs
, and then see anOpen using IPFS
badge/icon in the URL bar.Open using IPFS
onhttps://blog.ipfs.io/24-uncensorable-wikipedia
loadsipfs://bafybeiaieqdmhtnehaau7kqoj2lmdfqc7juk34cjyb7dxr35vahp22bquu/24-uncensorable-wikipedia/
.Protocol system handler/OS integration
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
.Peers
[x] Prerequisites: local 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.Removing
IPNS Keys
[x] Prerequisites: local 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
Sharing a local file using an IPFS key
IPFS > Share local file using IPFS
.CTRL+V
.k51qzi5uqu5dgxhiv8w8cdvmgdhbvy3t9gn4jwpwwro18fots0xtdabpcxxzwc
) before the?filename=filename.ext
from the copied text.Sharing a local folder using an IPFS key
IPFS > Share local folder using IPFS
.CTRL+V
.k51qzi5uqu5dgxhiv8w8cdvmgdhbvy3t9gn4jwpwwro18fots0xtdabpcxxzwc
) 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
.Pinning content with IPNS key
Add/Remove/Rotate keys
Add
, it prompts for 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 name and clickRotate
. Confirm the key is created with your entered name, and 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://brave.crypto
brings up IPFS interstitial page.Use a public gate
loadshttps://brave-crypto.ipns.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.