Skip to content

Commit 47e3196

Browse files
committed
docs(readme): repo paths, updated links
1 parent cf43a89 commit 47e3196

File tree

1 file changed

+50
-31
lines changed

1 file changed

+50
-31
lines changed

README.md

Lines changed: 50 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,31 @@
1-
# IPFS Desktop
2-
3-
[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](https://protocol.ai/)
4-
[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech/)
5-
[![total download count](https://img.shields.io/github/downloads/ipfs/ipfs-desktop/total.svg?style=flat-square&label=all%20downloads)](https://github.com/ipfs/ipfs-desktop/releases)
6-
[![latest release download count](https://img.shields.io/github/downloads/ipfs/ipfs-desktop/v0.42.0/total.svg?style=flat-square)](https://github.com/ipfs/ipfs-desktop/releases/tag/v0.42.0)
1+
<h1 align="center">
2+
IPFS Desktop
3+
</h1>
4+
5+
<p align="center">
6+
<a href="https://ipfs.tech"><img src="https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square" alt="Official Part of IPFS Project"></a>
7+
<a href="https://discuss.ipfs.tech"><img alt="Discourse Forum" src="https://img.shields.io/discourse/posts?server=https%3A%2F%2Fdiscuss.ipfs.tech"></a>
8+
<a href="https://matrix.to/#/#ipfs-space:ipfs.io"><img alt="Matrix" src="https://img.shields.io/matrix/ipfs-space%3Aipfs.io?server_fqdn=matrix.org"></a>
9+
<a href="https://github.com/ipfs/ipfs-desktop/actions?query=branch%3Amain"><img src="https://img.shields.io/github/actions/workflow/status/ipfs/ipfs-desktop/ci.yml?branch=main"></a>
10+
<a href="https://github.com/ipfs/ipfs-desktop/releases"><img alt="GitHub release" src="https://img.shields.io/github/v/release/ipfs/ipfs-desktop?filter=!*rc*"></a>
11+
</p>
712

813
**IPFS Desktop gives you all the power of [IPFS](https://ipfs.tech) in a convenient desktop app: a complete IPFS node, plus handy OS menubar/taskbar shortcuts and an all-in-one file manager, peer map, and content explorer.**
914

1015
Use IPFS Desktop to get acquainted with IPFS without needing to touch the terminal — or, if you're already experienced, use the powerful menubar/taskbar shortcuts alongside the command line to make your IPFS workflow faster.
1116

12-
![Status screen of IPFS Desktop](https://gateway.ipfs.io/ipfs/QmYHuXitXMf5xTjiQXmXdqszvMTADvrM5zA7EqoDj3d3RH)
17+
![Status screen of IPFS Desktop](https://ipfs.io/ipfs/QmYHuXitXMf5xTjiQXmXdqszvMTADvrM5zA7EqoDj3d3RH)
1318

1419
| Files screen | Explore screen | Peers screen | Settings screen | Menubar/taskbar |
1520
|-------|---------|-------|----------|------|
16-
| ![Screenshot of the Files screen](https://gateway.ipfs.io/ipfs/QmRN82RPWHKuSuBadijTQuaCjFKAGaymt3aFBoG6Du9Vi3) | ![Screenshot of the Explore screen](https://gateway.ipfs.io/ipfs/Qmaerxh9UKf9F3YPKnV2cBEnPQoJdVmkswFdz7kNQGncKt) | ![Screenshot of the Peers screen](https://gateway.ipfs.io/ipfs/QmaVbBYsEBb34HMP1YWeErrS7X3TB6Y9t1iQ4sBRnTvSwa) | ![Screenshot of the Settings screen](https://gateway.ipfs.io/ipfs/Qmby5RuN7K9s5W9RVLdrQSE8gRKQ66EX8c39iC31DLAxN6) | ![Screenshot of Mac/Windows menus](https://gateway.ipfs.io/ipfs/QmbT2YtuNo17Qaq31FJWRZgRMY4E6N9cdfBwzZTFSHUoBP) |
21+
| ![Screenshot of the Files screen](https://ipfs.io/ipfs/QmRN82RPWHKuSuBadijTQuaCjFKAGaymt3aFBoG6Du9Vi3) | ![Screenshot of the Explore screen](https://ipfs.io/ipfs/Qmaerxh9UKf9F3YPKnV2cBEnPQoJdVmkswFdz7kNQGncKt) | ![Screenshot of the Peers screen](https://ipfs.io/ipfs/QmaVbBYsEBb34HMP1YWeErrS7X3TB6Y9t1iQ4sBRnTvSwa) | ![Screenshot of the Settings screen](https://ipfs.io/ipfs/Qmby5RuN7K9s5W9RVLdrQSE8gRKQ66EX8c39iC31DLAxN6) | ![Screenshot of Mac/Windows menus](https://ipfs.io/ipfs/QmbT2YtuNo17Qaq31FJWRZgRMY4E6N9cdfBwzZTFSHUoBP) |
1722

1823
### Quick-install shortcuts
1924

2025
When in doubt, pick one of package formats with built-in automatic update mechanism:
2126

22-
- **Mac:** [ipfs-desktop-0.42.0-mac.dmg](https://github.com/ipfs/ipfs-desktop/releases/download/v0.42.0/ipfs-desktop-0.42.0-mac.dmg)
2327
- **Windows:** [ipfs-desktop-setup-0.42.0-win-x64.exe](https://github.com/ipfs/ipfs-desktop/releases/download/v0.42.0/ipfs-desktop-setup-0.42.0-win-x64.exe)
28+
- **Mac:** [ipfs-desktop-0.42.0-mac.dmg](https://github.com/ipfs/ipfs-desktop/releases/download/v0.42.0/ipfs-desktop-0.42.0-mac.dmg)
2429
- **Linux:** [ipfs-desktop-0.42.0-linux-x86_64.AppImage](https://github.com/ipfs/ipfs-desktop/releases/download/v0.42.0/ipfs-desktop-0.42.0-linux-x86_64.AppImage)
2530
- If you prefer to manage updates on your own, see [other package formats](#install) below.
2631

@@ -60,7 +65,7 @@ When in doubt, pick one of package formats with built-in automatic update mechan
6065

6166
## Features
6267

63-
IPFS Desktop combines a complete IPFS node (running [kubo](https://github.com/ipfs/kubo)) and the [IPFS Web UI](https://github.com/ipfs-shipyard/ipfs-webui) into a single, convenient desktop app — plus adds a menu to your OS menubar/system tray for easy access to a variety of common IPFS tasks.
68+
IPFS Desktop combines a complete IPFS node (running [kubo](https://github.com/ipfs/kubo)) and the [IPFS Web UI](https://github.com/ipfs/ipfs-webui) into a single, convenient desktop app — plus adds a menu to your OS menubar/system tray for easy access to a variety of common IPFS tasks.
6469

6570
If you already have an IPFS node on your computer, IPFS Desktop will act as a control panel and file browser for that node. If you don't have a node, it'll install one for you. And either way, IPFS Desktop will automatically check for updates.
6671

@@ -98,7 +103,7 @@ Use the `Explore` screen to explore some example datasets — or your own files
98103

99104
IPFS Desktop enables most operating systems (Mac, Windows and some Linux flavors) to support protocols including `ipfs://` and `ipns://`. This means that if an app on your computer tries to open a link starting with one of those protocol identifiers (for example, if your web browser encounters a link to `ipns://en.wikipedia-on-ipfs.org`), it'll automatically open in IPFS Desktop.
100105

101-
For an even better experience with `ipfs://`, and `ipns://` addresses, we also recommend installing [IPFS Companion](https://github.com/ipfs-shipyard/ipfs-companion) to add support in your favorite browser!
106+
For an even better experience with `ipfs://`, and `ipns://` addresses, we also recommend installing [IPFS Companion](https://github.com/ipfs/ipfs-companion) to add support in your favorite browser!
102107

103108
### Learn IPFS commands as you go
104109

@@ -110,13 +115,6 @@ Release notes and older versions of IPFS Desktop can be found on the [releases p
110115

111116
Don't see your favorite package manager? Visit our [package managers page](https://github.com/ipfs/ipfs-desktop/issues/691) and help us add support for it!
112117

113-
### Mac
114-
- **Installer:** [ipfs-desktop-0.42.0-mac.dmg](https://github.com/ipfs/ipfs-desktop/releases/download/v0.42.0/ipfs-desktop-0.42.0-mac.dmg)\
115-
[![](https://img.shields.io/github/downloads/ipfs/ipfs-desktop/v0.42.0/ipfs-desktop-0.42.0-mac.dmg.svg?style=flat-square&label=downloads)<br/>
116-
![](https://img.shields.io/github/downloads/ipfs/ipfs-desktop/v0.42.0/ipfs-desktop-0.42.0-squirrel.zip.svg?style=flat-square&label=update)](https://github.com/ipfs/ipfs-desktop/releases/download/v0.42.0/ipfs-desktop-0.42.0-mac.dmg)
117-
- **Homebrew** (community-maintained): `brew install --cask ipfs`
118-
- ℹ️ update checks from existing users: [![](https://img.shields.io/github/downloads/ipfs/ipfs-desktop/v0.42.0/latest-mac.yml.svg?style=flat-square&label=autoupdate)](https://github.com/ipfs/kubo/releases/latest)
119-
120118
### Windows
121119
- **Installer:** [ipfs-desktop-setup-0.42.0-win-x64.exe](https://github.com/ipfs/ipfs-desktop/releases/download/v0.42.0/ipfs-desktop-setup-0.42.0-win-x64.exe)\
122120
[![](https://img.shields.io/github/downloads/ipfs/ipfs-desktop/v0.42.0/ipfs-desktop-setup-0.42.0-win-x64.exe.svg?style=flat-square&label=downloads)](https://github.com/ipfs/ipfs-desktop/releases/download/v0.42.0/ipfs-desktop-setup-0.42.0-win-x64.exe)
@@ -125,6 +123,13 @@ Don't see your favorite package manager? Visit our [package managers page](https
125123
- **WinGet** (community-maintained): `winget install IPFS.IPFS-Desktop`
126124
- ℹ️ update checks from existing users: [![](https://img.shields.io/github/downloads/ipfs/ipfs-desktop/v0.42.0/latest.yml.svg?style=flat-square&label=autoupdate)](https://github.com/ipfs/kubo/releases/latest)
127125

126+
### Mac
127+
- **Installer:** [ipfs-desktop-0.42.0-mac.dmg](https://github.com/ipfs/ipfs-desktop/releases/download/v0.42.0/ipfs-desktop-0.42.0-mac.dmg)\
128+
[![](https://img.shields.io/github/downloads/ipfs/ipfs-desktop/v0.42.0/ipfs-desktop-0.42.0-mac.dmg.svg?style=flat-square&label=downloads)<br/>
129+
![](https://img.shields.io/github/downloads/ipfs/ipfs-desktop/v0.42.0/ipfs-desktop-0.42.0-squirrel.zip.svg?style=flat-square&label=update)](https://github.com/ipfs/ipfs-desktop/releases/download/v0.42.0/ipfs-desktop-0.42.0-mac.dmg)
130+
- **Homebrew** (community-maintained): `brew install --cask ipfs`
131+
- ℹ️ update checks from existing users: [![](https://img.shields.io/github/downloads/ipfs/ipfs-desktop/v0.42.0/latest-mac.yml.svg?style=flat-square&label=autoupdate)](https://github.com/ipfs/kubo/releases/latest)
132+
128133
### Linux/FreeBSD
129134
- **AppImage**: [ipfs-desktop-0.42.0-linux-x86_64.AppImage](https://github.com/ipfs/ipfs-desktop/releases/download/v0.42.0/ipfs-desktop-0.42.0-linux-x86_64.AppImage)\
130135
[![](https://img.shields.io/github/downloads/ipfs/ipfs-desktop/v0.42.0/ipfs-desktop-0.42.0-linux-x86_64.AppImage.svg?style=flat-square&label=downloads)](https://github.com/ipfs/ipfs-desktop/releases/download/v0.42.0/ipfs-desktop-0.42.0-linux-x86_64.AppImage)
@@ -181,7 +186,7 @@ No matter how you contribute, please be sure you read and follow the [IPFS Contr
181186

182187
Contributing translations in your language is particularly valuable! We use Transifex to manage internationalization, which means you don't need to change a single line of code to add your translations — just sign up for a Transifex account.
183188

184-
Because IPFS Desktop app includes text from [IPFS Web UI](https://github.com/ipfs-shipyard/ipfs-webui) and [IPLD Explorer](https://github.com/ipfs-shipyard/ipld-explorer), you'll want to join all three Transifex projects in order to see all the text:
189+
Because IPFS Desktop app includes text from [IPFS Web UI](https://github.com/ipfs/ipfs-webui) and [IPLD Explorer Components](https://github.com/ipfs/ipld-explorer-components/), you'll want to join all three Transifex projects in order to see all the text:
185190
- https://www.transifex.com/ipfs/ipfs-desktop/
186191
- https://www.transifex.com/ipfs/ipfs-webui/
187192
- https://www.transifex.com/ipfs/ipld-explorer/
@@ -231,25 +236,39 @@ This is a known issue with Electron/Chrome and some hardened kernels. More detai
231236
$ ipfs-desktop --no-sandbox
232237
```
233238

234-
### Where are my IPFS configuration and log files?
239+
### Where are my configuration and log files?
235240

236241
> [!IMPORTANT]
237-
> IPFS Desktop app configuration is separate from the configuration and repository of Kubo IPFS node.
242+
> IPFS Desktop uses [Kubo](https://github.com/ipfs/kubo) implementation of IPFS node, which has its own configuration and repository, separate from the Desktop app.
243+
244+
#### IPFS Desktop configuration
245+
246+
You can open Desktop app and log files from the IPFS logo menu by selecting `Open Logs Directory` or `Open Configuration File` from the `Advanced` submenu.
247+
248+
Or, find them in your OS as follows:
238249

239-
You can open Desktop app and log files from the IPFS logo menu by selecting `Open Logs Directory` or `Open Configuration File` from the `Advanced` submenu. Or, find them in your OS as follows:
240250
- **Mac:** `~/Library/Application Support/IPFS Desktop/`
241-
- **Windows:** `%appdata%/IPFS Desktop/`
251+
- **Windows:** `%APPDATA%\IPFS Desktop\`
242252
- **Linux:** `~/.config/IPFS Desktop/`
243253

244-
### How does IPFS Desktop select the IPFS repo location?
254+
#### Kubo repository and configuration
245255

246-
> [!IMPORTANT]
247-
> IPFS Desktop uses [Kubo](https://github.com/ipfs/kubo) implementation of IPFS node, which has its own configuration and repository, separate from the Desktop app.
256+
To open your Kubo repo directory from the IPFS logo menu, select `Open Repository Directory` from the `Advanced` submenu.
257+
258+
Or, find them in your OS as follows (assuming no custom `$IPFS_PATH` was set):
259+
260+
- **Mac:** `$HOME/.ipfs/`
261+
- **Windows:** `%USERPROFILE%\.ipfs\` (`C:\Users\Username\.ipfs\`)
262+
- **Linux:** `$HOME/.ipfs/`
263+
264+
Configuration file is named `.ipfs/config`
265+
266+
##### How does IPFS Desktop select the IPFS repo location?
248267

249268
IPFS Desktop uses [ipfsd-ctl](https://github.com/ipfs/js-ipfsd-ctl) to locate Kubo repository.
250269

251270
1. First, it checks the `IPFS_PATH` environment variable.
252-
2. If that isn't set, it falls back to `$HOME/.ipfs`. As soon as the first run has succeeded, repository location info is saved in the configuration file, which becomes the source of truth.
271+
2. If that isn't set, it falls back to `$HOME/.ipfs` (`%USERPROFILE%/.ipfs/` on Windows). As soon as the first run has succeeded, repository location info is saved in the configuration file, which becomes the source of truth.
253272

254273
To open your Kubo repo directory from the IPFS logo menu, select `Open Repository Directory` from the `Advanced` submenu.
255274

@@ -325,14 +344,14 @@ You can update your Kubo config to try different sources of the migration files.
325344
##### With IPFS-Desktop
326345

327346
1. Go to the Settings tab
328-
2. Find "Migrations" in the config, and update the `DownloadSources` array to be `["IPFS", "https://dweb.link", "https://cloudflare-ipfs.com", "HTTP"]`
347+
2. Find "Migrations" in the config, and update the `DownloadSources` array to be `["IPFS", "https://trustless-gateway.link", "HTTP"]`
329348

330349
##### From the terminal
331350

332351
For this method, you have to have the `ipfs` binary available on your command line:
333352

334353
```bash
335-
ipfs config --json Migration.DownloadSources '["IPFS", "https://dweb.link", "https://cloudflare-ipfs.com", "HTTP"]'
354+
ipfs config --json Migration.DownloadSources '["IPFS", "https://trustless-gateway.link", "HTTP"]'
336355
```
337356

338357
##### Manually in an editor (not recommended)
@@ -341,10 +360,10 @@ You can also edit the config file (`~/.ipfs/config` or `C:\Users\Username\.ipfs\
341360

342361
### I need more help!
343362

344-
If you need help with using IPFS Desktop, the quickest way to get answers is to post them in the [official IPFS forums](https://discuss.ipfs.tech).
363+
If you need help with using IPFS Desktop, the quickest way to get answers is to post them in the [official IPFS forums](https://discuss.ipfs.tech/c/help/13).
345364

346365
If you think you've found a bug or other issue with IPFS Desktop itself, please [open an issue](https://github.com/ipfs/ipfs-desktop/issues/new/choose).
347366

348367
## License
349368

350-
[MIT — Protocol Labs, Inc.](./LICENSE)
369+
[MIT](./LICENSE)

0 commit comments

Comments
 (0)