From 863bef51b523cc056b7bf3dd5bd1b97ffc8f25fc Mon Sep 17 00:00:00 2001 From: Jessica Schilling Date: Wed, 21 Oct 2020 10:22:02 -0600 Subject: [PATCH 01/27] Update README.md --- README.md | 27 ++++++++++++++------------- 1 file changed, 14 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index dc6a9ef1e..c02dec64f 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,5 @@ # IPFS Desktop -> A desktop client for [IPFS](https://ipfs.io). -> -> You don't need the command line to run an IPFS node. Just install IPFS Desktop and have all the power of IPFS in your hands. Powered by [Web UI](https://github.com/ipfs-shipyard/ipfs-webui). - -**Download the latest release** - -- Mac - [IPFS-Desktop-0.13.2.dmg](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-0.13.2.dmg) or `brew cask install ipfs` -- Windows - [IPFS-Desktop-Setup-0.13.2.exe](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-Setup-0.13.2.exe) or `choco install ipfs-desktop` -- Linux - see the [install](#install) section for available options - -![IPFS Desktop](https://gateway.ipfs.io/ipfs/QmbT2YtuNo17Qaq31FJWRZgRMY4E6N9cdfBwzZTFSHUoBP) - [![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](https://protocol.ai/) [![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/) [![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs) @@ -19,7 +7,16 @@ [![total download count](https://img.shields.io/github/downloads/ipfs-shipyard/ipfs-desktop/total.svg?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-desktop/releases) [![latest release download count](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/total.svg?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/tag/v0.13.2) -IPFS Desktop allows you to run your IPFS Node on your machine without having to bother with command line tools. With it, you have the power of [Web UI](https://github.com/ipfs-shipyard/ipfs-webui) on tip of your hands plus a handful of shortcuts you can find on settings. +**IPFS Desktop gives you all the power of [IPFS](https://ipfs.io) in an easy desktop app: a complete IPFS node, plus handy OS-level menubar shortcuts and an all-in-one file manager, peer map, and content explorer.** + +Great for IPFS newcomers and power users/devs alike! Use IPFS Desktop to get acquainted with IPFS without needing to touch the command line — or, if you're already experienced, use the powerful menubar/taskbar shortcuts alongside the command line to make your IPFS workflow faster. + +📥 **Download now!** 🎉 + +- **Mac:** [IPFS-Desktop-0.13.2.dmg](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-0.13.2.dmg) or `brew cask install ipfs` +- **Windows:** [IPFS-Desktop-Setup-0.13.2.exe](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-Setup-0.13.2.exe) or `choco install ipfs-desktop` +- **Linux:** See [installation options](#install) below + ## Table of Contents @@ -32,6 +29,10 @@ IPFS Desktop allows you to run your IPFS Node on your machine without having to ## Features +![IPFS Desktop](https://gateway.ipfs.io/ipfs/QmbT2YtuNo17Qaq31FJWRZgRMY4E6N9cdfBwzZTFSHUoBP) + +IPFS Desktop allows you to run your IPFS Node on your machine without having to bother with command line tools. With it, you have the power of [Web UI](https://github.com/ipfs-shipyard/ipfs-webui) on tip of your hands plus a handful of shortcuts you can find on settings. + ### IPFS daemon always running IPFS Desktop's main feature is to allow you to have the IPFS daemon always running in the background. But fear not! If you need to stop it, you can do it just by clicking on 'Stop'. From 32f79c815174e8cbf1d4233acf3e1ee44dd814e0 Mon Sep 17 00:00:00 2001 From: Jessica Schilling Date: Wed, 21 Oct 2020 10:58:18 -0600 Subject: [PATCH 02/27] Update README.md --- README.md | 76 +++++++++++++++++++++++++------------------------------ 1 file changed, 34 insertions(+), 42 deletions(-) diff --git a/README.md b/README.md index c02dec64f..36861b00d 100644 --- a/README.md +++ b/README.md @@ -7,11 +7,11 @@ [![total download count](https://img.shields.io/github/downloads/ipfs-shipyard/ipfs-desktop/total.svg?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-desktop/releases) [![latest release download count](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/total.svg?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/tag/v0.13.2) -**IPFS Desktop gives you all the power of [IPFS](https://ipfs.io) in an easy desktop app: a complete IPFS node, plus handy OS-level menubar shortcuts and an all-in-one file manager, peer map, and content explorer.** +**IPFS Desktop gives you all the power of [IPFS](https://ipfs.io) in an easy desktop app: a complete IPFS node, plus handy OS menubar/taskbar shortcuts and an all-in-one file manager, peer map, and content explorer.** -Great for IPFS newcomers and power users/devs alike! Use IPFS Desktop to get acquainted with IPFS without needing to touch the command line — or, if you're already experienced, use the powerful menubar/taskbar shortcuts alongside the command line to make your IPFS workflow faster. +Use IPFS Desktop to get acquainted with IPFS without needing to touch the command line — or, if you're already experienced, use the powerful menubar/taskbar shortcuts alongside the command line to make your IPFS workflow faster. -📥 **Download now!** 🎉 +**Download now!** 🎉 📥 - **Mac:** [IPFS-Desktop-0.13.2.dmg](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-0.13.2.dmg) or `brew cask install ipfs` - **Windows:** [IPFS-Desktop-Setup-0.13.2.exe](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-Setup-0.13.2.exe) or `choco install ipfs-desktop` @@ -20,14 +20,13 @@ Great for IPFS newcomers and power users/devs alike! Use IPFS Desktop to get acq ## Table of Contents -- [Features](#features) +- [IPFS Desktop Features](#ipfs-desktop-features) - [Install](#install) -- [Contribute](#contribute) - - [Translations](#translations) +- [Contribute](#contribute) (including [translations](#translations)) - [FAQ](#faq) - [Troubleshooting](#troubleshooting) -## Features +## IPFS Desktop Features ![IPFS Desktop](https://gateway.ipfs.io/ipfs/QmbT2YtuNo17Qaq31FJWRZgRMY4E6N9cdfBwzZTFSHUoBP) @@ -66,36 +65,29 @@ You can enable, on Settings, a shortcut to take screenshots and add them automat ## Install -Download the latest release of IPFS Desktop for your OS, below. +Release notes and older versions of IPFS Desktop can be found on the [releases page](https://github.com/ipfs-shipyard/ipfs-desktop/releases). -| Platform | Download link | Download count -|---------:|---------------|--------------- -| **Windows** | [IPFS-Desktop-Setup-0.13.2.exe](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-Setup-0.13.2.exe) | [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/IPFS-Desktop-Setup-0.13.2.exe.svg?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-Setup-0.13.2.exe) -| **Mac** | [IPFS-Desktop-0.13.2.dmg](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-0.13.2.dmg) | [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/IPFS-Desktop-0.13.2.dmg.svg?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-0.13.2.dmg) +Don't see your favorite package manager? Visit our [package managers page](https://github.com/ipfs-shipyard/ipfs-desktop/issues/691) and help us add support for it! -We provide multiple _experimental_ installers for **Linux** and **FreeBSD**: +### Mac +- **Official installer:** [IPFS-Desktop-0.13.2.dmg](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-0.13.2.dmg) [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/IPFS-Desktop-0.13.2.dmg.svg?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-0.13.2.dmg) +- **Homebrew** (community-maintained): `brew cask install ipfs` -| Package | Download link | Download count -|---------:|---------------|--------------- -| tar | [ipfs-desktop-0.13.2-linux-x64.tar.xz](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x64.tar.xz) | [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-x64.tar.xz.svg?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x64.tar.xz) -| deb | [ipfs-desktop-0.13.2-linux-amd64.deb](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-amd64.deb) | [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-amd64.deb.svg?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-amd64.deb) -| rpm | [ipfs-desktop-0.13.2-linux-x86_64.rpm](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.rpm) | [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.rpm.svg?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.rpm) -| AppImage | [ipfs-desktop-0.13.2-linux-x86_64.AppImage](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.AppImage) | [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.AppImage.svg?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.AppImage) -| freebsd | [ipfs-desktop-0.13.2-linux-x64.freebsd](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x64.freebsd) | [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-x64.freebsd.svg?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x64.freebsd) +### Windows +- **Official installer:** [IPFS-Desktop-Setup-0.13.2.exe](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-Setup-0.13.2.exe) [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/IPFS-Desktop-Setup-0.13.2.exe.svg?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-Setup-0.13.2.exe) +- **Chocolatey** (community-maintained): `choco install ipfs-desktop` +- **Scoop** (community-maintained): `scoop install ipfs-desktop` -Or you can use your favorite package manager and a third-party package maintained by the community: +### Linux and FreeBSD +- **Official tarball** (note: experimental!): [ipfs-desktop-0.13.2-linux-x64.tar.xz](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x64.tar.xz) [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-x64.tar.xz.svg?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x64.tar.xz) +- **Official Debian DEB:** (note: experimental!): [ipfs-desktop-0.13.2-linux-amd64.deb](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-amd64.deb) [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-amd64.deb.svg?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-amd64.deb) +- **Official Red Hat RPM:** (note: experimental!): [ipfs-desktop-0.13.2-linux-x86_64.rpm](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.rpm) [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.rpm.svg?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.rpm) +- **Official AppImage:** (note: experimental!): [ipfs-desktop-0.13.2-linux-x86_64.AppImage](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.AppImage) [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.AppImage.svg?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.AppImage) +- **Official FreeBSD:** (note: experimental!): [ipfs-desktop-0.13.2-linux-x64.freebsd](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x64.freebsd) [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-x64.freebsd.svg?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x64.freebsd) +- **Snapcraft** (community-maintained): `snap install ipfs-desktop` +- **AUR** (maintained by [@alexhenrie](https://github.com/alexhenrie)): [`ipfs-desktop` package](https://aur.archlinux.org/packages/ipfs-desktop/) -- **Homebrew** - `brew cask install ipfs` -- **Chocolatey** - `choco install ipfs-desktop` -- **Scoop** - `scoop install ipfs-desktop` -- **Snap** - `snap install ipfs-desktop` -- **AUR** - [`ipfs-desktop` package](https://aur.archlinux.org/packages/ipfs-desktop/) maintained by [@alexhenrie](https://github.com/alexhenrie) - -> Using package managers? Please head to [our package managers page](https://github.com/ipfs-shipyard/ipfs-desktop/issues/691) and help us add support for yours! - -You can find releases notes and older versions on the [releases](https://github.com/ipfs-shipyard/ipfs-desktop/releases) page. - -### Install from Source +### Install from source To install it from source you need [Node.js](https://nodejs.org/en/) `>=12` and need [npm](npmjs.org) `>=6.1.0` installed. This uses [`node-gyp`](https://github.com/nodejs/node-gyp) so **you must take a look** at their [platform specific dependencies](https://github.com/nodejs/node-gyp#installation). @@ -112,6 +104,16 @@ npm start The IPFS Desktop app will launch and should appear in your OS menu bar. +## Contribute + +[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/#contributing-guidelines) + +Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs-shipyard/ipfs-desktop/issues)! + +If you're interested in contributing translations, go to [project page on Transifex](https://www.transifex.com/ipfs/ipfs-desktop/), create an account, pick a language and start translating. + +This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md). + ## Translations The translations are stored on [./assets/locales](./assets/locales) and the English version is the source of truth. @@ -149,16 +151,6 @@ Other languages are periodically pulled from [Transifex](https://www.transifex.c 3. Run `node pkgs/macos/notarize-cli.js ./IPFS-Desktop-A.B.C.dmg` 4. Debug errors by calling the tool directly: `xcrun altool --notarize-app -f /path/to/IPFS-Desktop-0.X.0.dmg --primary-bundle-id io.ipfs.desktop -u XXX-from-vault-XXX -p XXX-app-specific-password-from-vault-XXX`, also see the [long list of hoops Apple might ask you to jump through](https://github.com/ipfs-shipyard/ipfs-desktop/pull/1365#issuecomment-598127684). -## Contribute - -[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/#contributing-guidelines) - -Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs-shipyard/ipfs-desktop/issues)! - -If you're interested in contributing translations, go to [project page on Transifex](https://www.transifex.com/ipfs/ipfs-desktop/), create an account, pick a language and start translating. - -This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md). - ## FAQ ### Where is the configuration and logs? From caffe13044baf7e86cbaafc299e7a4b6a511023e Mon Sep 17 00:00:00 2001 From: Jessica Schilling Date: Wed, 21 Oct 2020 11:15:11 -0600 Subject: [PATCH 03/27] Update README.md --- README.md | 40 +++++++++++++++++++--------------------- 1 file changed, 19 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 36861b00d..000235f6d 100644 --- a/README.md +++ b/README.md @@ -23,8 +23,7 @@ Use IPFS Desktop to get acquainted with IPFS without needing to touch the comman - [IPFS Desktop Features](#ipfs-desktop-features) - [Install](#install) - [Contribute](#contribute) (including [translations](#translations)) -- [FAQ](#faq) -- [Troubleshooting](#troubleshooting) +- [FAQ & Troubleshooting](#faq-troubleshooting) ## IPFS Desktop Features @@ -32,6 +31,8 @@ Use IPFS Desktop to get acquainted with IPFS without needing to touch the comman IPFS Desktop allows you to run your IPFS Node on your machine without having to bother with command line tools. With it, you have the power of [Web UI](https://github.com/ipfs-shipyard/ipfs-webui) on tip of your hands plus a handful of shortcuts you can find on settings. +It's based on Web UI running in Electron to add those extra, awesome menu commands. + ### IPFS daemon always running IPFS Desktop's main feature is to allow you to have the IPFS daemon always running in the background. But fear not! If you need to stop it, you can do it just by clicking on 'Stop'. @@ -78,7 +79,7 @@ Don't see your favorite package manager? Visit our [package managers page](https - **Chocolatey** (community-maintained): `choco install ipfs-desktop` - **Scoop** (community-maintained): `scoop install ipfs-desktop` -### Linux and FreeBSD +### Linux/FreeBSD - **Official tarball** (note: experimental!): [ipfs-desktop-0.13.2-linux-x64.tar.xz](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x64.tar.xz) [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-x64.tar.xz.svg?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x64.tar.xz) - **Official Debian DEB:** (note: experimental!): [ipfs-desktop-0.13.2-linux-amd64.deb](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-amd64.deb) [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-amd64.deb.svg?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-amd64.deb) - **Official Red Hat RPM:** (note: experimental!): [ipfs-desktop-0.13.2-linux-x86_64.rpm](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.rpm) [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.rpm.svg?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.rpm) @@ -89,10 +90,12 @@ Don't see your favorite package manager? Visit our [package managers page](https ### Install from source -To install it from source you need [Node.js](https://nodejs.org/en/) `>=12` and -need [npm](npmjs.org) `>=6.1.0` installed. This uses [`node-gyp`](https://github.com/nodejs/node-gyp) so **you must take a look** at their [platform specific dependencies](https://github.com/nodejs/node-gyp#installation). +To install and run IPFS Desktop from source, you'll also need: +- [Node.js](https://nodejs.org/en/) `>=12` +- [npm](npmjs.org) `>=6.1.0` +- Any [platform-specific dependencies](https://github.com/nodejs/node-gyp#installation) required by [`node-gyp`](https://github.com/nodejs/node-gyp) -Then follow the steps below to clone the source code, install the dependencies and run it the app: +Then, follow the steps below to clone the source code, install dependencies, and run the app. Once IPFS Desktop launches, you'll see an IPFS icon in your OS menu bar or system tray. ```bash git clone https://github.com/ipfs-shipyard/ipfs-desktop.git @@ -102,8 +105,6 @@ npm run build npm start ``` -The IPFS Desktop app will launch and should appear in your OS menu bar. - ## Contribute [![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/#contributing-guidelines) @@ -114,12 +115,12 @@ If you're interested in contributing translations, go to [project page on Transi This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md). -## Translations +### Translations The translations are stored on [./assets/locales](./assets/locales) and the English version is the source of truth. Other languages are periodically pulled from [Transifex](https://www.transifex.com/ipfs/ipfs-desktop/), a web interface to help us translate IPFS Desktop and its components to another languages. -## Releasing +### Releasing - Manually test a few things that don't transfer well to automated testing: - Mac/Win/Linux: confirm that "Take Screenshot" under menubar/system tray menu works as expected for both single- and multi-monitor setups (file(s) imported, correct link copied to clipboard) @@ -143,7 +144,7 @@ Other languages are periodically pulled from [Transifex](https://www.transifex.c - Update [Homebrew Cask](https://github.com/Homebrew/homebrew-cask/blob/master/CONTRIBUTING.md#updating-a-cask). - To start work on the next version, bump the version in the `package.json` -### Manual notarization (Fallback in-case CI is not doing it correctly) +#### Manual notarization (Fallback in-case CI is not doing it correctly) - Notarize `.dmg` at Apple (context: [#1365](https://github.com/ipfs-shipyard/ipfs-desktop/issues/1211)) 1. Download `.dmg` from `https://github.com/ipfs-shipyard/ipfs-desktop/releases/vA.B.C` @@ -151,9 +152,9 @@ Other languages are periodically pulled from [Transifex](https://www.transifex.c 3. Run `node pkgs/macos/notarize-cli.js ./IPFS-Desktop-A.B.C.dmg` 4. Debug errors by calling the tool directly: `xcrun altool --notarize-app -f /path/to/IPFS-Desktop-0.X.0.dmg --primary-bundle-id io.ipfs.desktop -u XXX-from-vault-XXX -p XXX-app-specific-password-from-vault-XXX`, also see the [long list of hoops Apple might ask you to jump through](https://github.com/ipfs-shipyard/ipfs-desktop/pull/1365#issuecomment-598127684). -## FAQ +## FAQ & Troubleshooting -### Where is the configuration and logs? +### Where are my IPFS configuration and log files? The configuration file and logs are located on: - Mac: `~/Library/Application Support/IPFS Desktop/` @@ -162,21 +163,19 @@ The configuration file and logs are located on: For quick access to this folders, just right-click on your tray icon and then 'Logs Directory' or 'Configuration File', depending on what you want. -### How do we select the IPFS repo location? +### How does IPFS Dekstop select the IPFS repo location? We use [ipfsd-ctl](https://github.com/ipfs/js-ipfsd-ctl), which, in default conditions, will check `IPFS_PATH` environment variable. If not set, we fallback to `$HOME/.ipfs`. As soon as the first run has succeded, we save the information about the repository location in the configuration file, which becomes the source of truth. -### Which version of IPFS are we running? +### Which version of IPFS does IPFS Desktop run? Since we're using [ipfsd-ctl](https://github.com/ipfs/js-ipfsd-ctl), we have our own embedded IPFS binary. We try to always have the latest version. -### Which flags do we use to boot IPFS? +### Which flags does IPFS Desktop boot with? By default we use the flags `--migrate=true --routing=dhtclient ----enable-gc=true` when running the IPFS daemon. They can be changed via the configuration file, which can be easily accessed as mentioned above. -## Troubleshooting - -### No tray icon on Linux +### I don't have a system tray icon on Linux. Why? Poor tray support is a long running problem with Electron apps: [electron/issues/21445](https://github.com/electron/electron/issues/21445). @@ -187,7 +186,7 @@ According to [electron/v9.3.0/docs/api/tray.md](https://github.com/electron/elec Why the old tray is back since v0.13? We had no control over this: Electron team [removed support for `StatusNotifier` and restored the old tray interface on Linux called `XEmbed`](https://github.com/electron/electron/issues/21445#issuecomment-634163402). -### Does not start on Linux (Debian 10) +### I can't start IPFS Desktop under Debian 10. Why? Some Linux users may see an error like this: @@ -211,7 +210,6 @@ The only reliable way to fix this at the moment is to start the app with additio $ ipfs-desktop --no-sandbox ``` - ## License [MIT Protocol Labs, Inc.](./LICENSE) From 9f66c1467572632cd0a2915677ebd7a21486be71 Mon Sep 17 00:00:00 2001 From: Jessica Schilling Date: Wed, 21 Oct 2020 11:36:50 -0600 Subject: [PATCH 04/27] Update README.md --- README.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 000235f6d..b9d6109e7 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ [![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/) [![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs) [![](https://david-dm.org/ipfs-shipyard/ipfs-desktop.svg?style=flat-square)](https://david-dm.org/ipfs-shipyard/ipfs-desktop) -[![total download count](https://img.shields.io/github/downloads/ipfs-shipyard/ipfs-desktop/total.svg?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-desktop/releases) +[![total download count](https://img.shields.io/github/downloads/ipfs-shipyard/ipfs-desktop/total.svg?style=flat-square&label=all%20downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases) [![latest release download count](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/total.svg?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/tag/v0.13.2) **IPFS Desktop gives you all the power of [IPFS](https://ipfs.io) in an easy desktop app: a complete IPFS node, plus handy OS menubar/taskbar shortcuts and an all-in-one file manager, peer map, and content explorer.** @@ -71,20 +71,20 @@ Release notes and older versions of IPFS Desktop can be found on the [releases p Don't see your favorite package manager? Visit our [package managers page](https://github.com/ipfs-shipyard/ipfs-desktop/issues/691) and help us add support for it! ### Mac -- **Official installer:** [IPFS-Desktop-0.13.2.dmg](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-0.13.2.dmg) [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/IPFS-Desktop-0.13.2.dmg.svg?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-0.13.2.dmg) +- **Official installer:** [IPFS-Desktop-0.13.2.dmg](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-0.13.2.dmg) [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/IPFS-Desktop-0.13.2.dmg.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-0.13.2.dmg) - **Homebrew** (community-maintained): `brew cask install ipfs` ### Windows -- **Official installer:** [IPFS-Desktop-Setup-0.13.2.exe](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-Setup-0.13.2.exe) [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/IPFS-Desktop-Setup-0.13.2.exe.svg?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-Setup-0.13.2.exe) +- **Official installer:** [IPFS-Desktop-Setup-0.13.2.exe](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-Setup-0.13.2.exe) [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/IPFS-Desktop-Setup-0.13.2.exe.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-Setup-0.13.2.exe) - **Chocolatey** (community-maintained): `choco install ipfs-desktop` - **Scoop** (community-maintained): `scoop install ipfs-desktop` ### Linux/FreeBSD -- **Official tarball** (note: experimental!): [ipfs-desktop-0.13.2-linux-x64.tar.xz](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x64.tar.xz) [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-x64.tar.xz.svg?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x64.tar.xz) -- **Official Debian DEB:** (note: experimental!): [ipfs-desktop-0.13.2-linux-amd64.deb](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-amd64.deb) [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-amd64.deb.svg?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-amd64.deb) -- **Official Red Hat RPM:** (note: experimental!): [ipfs-desktop-0.13.2-linux-x86_64.rpm](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.rpm) [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.rpm.svg?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.rpm) -- **Official AppImage:** (note: experimental!): [ipfs-desktop-0.13.2-linux-x86_64.AppImage](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.AppImage) [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.AppImage.svg?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.AppImage) -- **Official FreeBSD:** (note: experimental!): [ipfs-desktop-0.13.2-linux-x64.freebsd](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x64.freebsd) [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-x64.freebsd.svg?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x64.freebsd) +- **Official tarball** (experimental!): [ipfs-desktop-0.13.2-linux-x64.tar.xz](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x64.tar.xz) [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-x64.tar.xz.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x64.tar.xz) +- **Official Debian DEB** (experimental!): [ipfs-desktop-0.13.2-linux-amd64.deb](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-amd64.deb) [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-amd64.deb.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-amd64.deb) +- **Official Red Hat RPM** (experimental!): [ipfs-desktop-0.13.2-linux-x86_64.rpm](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.rpm) [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.rpm.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.rpm) +- **Official AppImage** (experimental!): [ipfs-desktop-0.13.2-linux-x86_64.AppImage](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.AppImage) [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.AppImage.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.AppImage) +- **Official FreeBSD** (experimental!): [ipfs-desktop-0.13.2-linux-x64.freebsd](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x64.freebsd) [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-x64.freebsd.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x64.freebsd) - **Snapcraft** (community-maintained): `snap install ipfs-desktop` - **AUR** (maintained by [@alexhenrie](https://github.com/alexhenrie)): [`ipfs-desktop` package](https://aur.archlinux.org/packages/ipfs-desktop/) @@ -107,19 +107,19 @@ npm start ## Contribute -[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/#contributing-guidelines) +We welcome contributions to IPFS Desktop! The best way to get started is to check out our current [open issues](https://github.com/ipfs-shipyard/ipfs-desktop/issues) (or drill down specifically for [issues labeled "help wanted"](https://github.com/ipfs-shipyard/ipfs-desktop/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)) and find something interesting. All issues are categorized by the [standard label taxonomy](https://github.com/ipfs/community/blob/master/ISSUE_LABELS.md) used across the IPFS project, so you can also drill by issue type (for example, [UX-related issues](https://github.com/ipfs-shipyard/ipfs-desktop/issues?q=is%3Aissue+is%3Aopen+label%3Atopic%2Fdesign-ux)). -Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs-shipyard/ipfs-desktop/issues)! +You may also enjoy taking part in the IPFS GUI & Web Browsers Working Group's biweekly meeting to catch up on the latest plans and developments. This meeting does shift around in the calendar, so please check the [IPFS Community Calendar](https://calendar.google.com/calendar/embed?src=ipfs.io_eal36ugu5e75s207gfjcu0ae84@group.calendar.google.com&ctz=UTC) for the latest day/time. -If you're interested in contributing translations, go to [project page on Transifex](https://www.transifex.com/ipfs/ipfs-desktop/), create an account, pick a language and start translating. - -This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md). +No matter how you contribute, please be sure you read and follow the [IPFS Contributing Guidelines](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md) and the [IPFS Community Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md). ### Translations The translations are stored on [./assets/locales](./assets/locales) and the English version is the source of truth. Other languages are periodically pulled from [Transifex](https://www.transifex.com/ipfs/ipfs-desktop/), a web interface to help us translate IPFS Desktop and its components to another languages. +If you're interested in contributing translations, go to [project page on Transifex](https://www.transifex.com/ipfs/ipfs-desktop/), create an account, pick a language and start translating. + ### Releasing - Manually test a few things that don't transfer well to automated testing: From f443bf9ecc23d80663b819257de9f2c4d40ceb0c Mon Sep 17 00:00:00 2001 From: Jessica Schilling Date: Wed, 21 Oct 2020 11:51:02 -0600 Subject: [PATCH 05/27] Update README.md --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b9d6109e7..d7c24dda3 100644 --- a/README.md +++ b/README.md @@ -115,10 +115,14 @@ No matter how you contribute, please be sure you read and follow the [IPFS Contr ### Translations -The translations are stored on [./assets/locales](./assets/locales) and the English version is the source of truth. -Other languages are periodically pulled from [Transifex](https://www.transifex.com/ipfs/ipfs-desktop/), a web interface to help us translate IPFS Desktop and its components to another languages. +Contributing translations in your language is particularly welcome! The IPFS project as a whole uses Transifex to manage internationalization, which means that you don't need to change any of the code in this repo to add your translations — you just need to sign up for a Transifex account. -If you're interested in contributing translations, go to [project page on Transifex](https://www.transifex.com/ipfs/ipfs-desktop/), create an account, pick a language and start translating. +Because the IPFS Desktop app also includes code 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 projects in order to see all the text in need of translation: +- https://www.transifex.com/ipfs/ipfs-desktop/ +- https://www.transifex.com/ipfs/ipfs-webui/ +- https://www.transifex.com/ipfs/ipld-explorer/ + +*Note for developers:* We use the English version of text as the source of truth. This means that if you add any new text that will need to be localized, make those additions in [./assets/locales/en.json](./assets/locales/en.json) and they will automatically be added to Transifex for the community to translate. ### Releasing From e62e205097cafcf36b329a15f77223a268fc8d33 Mon Sep 17 00:00:00 2001 From: Jessica Schilling Date: Wed, 21 Oct 2020 12:34:24 -0600 Subject: [PATCH 06/27] Update README.md --- README.md | 106 +++++++++++++++++++++++++++++++----------------------- 1 file changed, 62 insertions(+), 44 deletions(-) diff --git a/README.md b/README.md index d7c24dda3..8dfe1edc3 100644 --- a/README.md +++ b/README.md @@ -71,20 +71,20 @@ Release notes and older versions of IPFS Desktop can be found on the [releases p Don't see your favorite package manager? Visit our [package managers page](https://github.com/ipfs-shipyard/ipfs-desktop/issues/691) and help us add support for it! ### Mac -- **Official installer:** [IPFS-Desktop-0.13.2.dmg](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-0.13.2.dmg) [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/IPFS-Desktop-0.13.2.dmg.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-0.13.2.dmg) +- **Installer:** [IPFS-Desktop-0.13.2.dmg](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-0.13.2.dmg) [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/IPFS-Desktop-0.13.2.dmg.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-0.13.2.dmg) - **Homebrew** (community-maintained): `brew cask install ipfs` ### Windows -- **Official installer:** [IPFS-Desktop-Setup-0.13.2.exe](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-Setup-0.13.2.exe) [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/IPFS-Desktop-Setup-0.13.2.exe.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-Setup-0.13.2.exe) +- **Installer:** [IPFS-Desktop-Setup-0.13.2.exe](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-Setup-0.13.2.exe) [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/IPFS-Desktop-Setup-0.13.2.exe.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-Setup-0.13.2.exe) - **Chocolatey** (community-maintained): `choco install ipfs-desktop` - **Scoop** (community-maintained): `scoop install ipfs-desktop` ### Linux/FreeBSD -- **Official tarball** (experimental!): [ipfs-desktop-0.13.2-linux-x64.tar.xz](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x64.tar.xz) [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-x64.tar.xz.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x64.tar.xz) -- **Official Debian DEB** (experimental!): [ipfs-desktop-0.13.2-linux-amd64.deb](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-amd64.deb) [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-amd64.deb.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-amd64.deb) -- **Official Red Hat RPM** (experimental!): [ipfs-desktop-0.13.2-linux-x86_64.rpm](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.rpm) [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.rpm.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.rpm) -- **Official AppImage** (experimental!): [ipfs-desktop-0.13.2-linux-x86_64.AppImage](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.AppImage) [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.AppImage.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.AppImage) -- **Official FreeBSD** (experimental!): [ipfs-desktop-0.13.2-linux-x64.freebsd](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x64.freebsd) [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-x64.freebsd.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x64.freebsd) +- **Tarball** (experimental!): [ipfs-desktop-0.13.2-linux-x64.tar.xz](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x64.tar.xz) [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-x64.tar.xz.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x64.tar.xz) +- **Debian DEB** (experimental!): [ipfs-desktop-0.13.2-linux-amd64.deb](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-amd64.deb) [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-amd64.deb.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-amd64.deb) +- **Red Hat RPM** (experimental!): [ipfs-desktop-0.13.2-linux-x86_64.rpm](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.rpm) [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.rpm.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.rpm) +- **AppImage** (experimental!): [ipfs-desktop-0.13.2-linux-x86_64.AppImage](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.AppImage) [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.AppImage.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.AppImage) +- **FreeBSD** (experimental!): [ipfs-desktop-0.13.2-linux-x64.freebsd](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x64.freebsd) [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-x64.freebsd.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x64.freebsd) - **Snapcraft** (community-maintained): `snap install ipfs-desktop` - **AUR** (maintained by [@alexhenrie](https://github.com/alexhenrie)): [`ipfs-desktop` package](https://aur.archlinux.org/packages/ipfs-desktop/) @@ -95,7 +95,7 @@ To install and run IPFS Desktop from source, you'll also need: - [npm](npmjs.org) `>=6.1.0` - Any [platform-specific dependencies](https://github.com/nodejs/node-gyp#installation) required by [`node-gyp`](https://github.com/nodejs/node-gyp) -Then, follow the steps below to clone the source code, install dependencies, and run the app. Once IPFS Desktop launches, you'll see an IPFS icon in your OS menu bar or system tray. +Then, follow the steps below to clone the source code, install dependencies, and run the app. ```bash git clone https://github.com/ipfs-shipyard/ipfs-desktop.git @@ -107,54 +107,72 @@ npm start ## Contribute -We welcome contributions to IPFS Desktop! The best way to get started is to check out our current [open issues](https://github.com/ipfs-shipyard/ipfs-desktop/issues) (or drill down specifically for [issues labeled "help wanted"](https://github.com/ipfs-shipyard/ipfs-desktop/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)) and find something interesting. All issues are categorized by the [standard label taxonomy](https://github.com/ipfs/community/blob/master/ISSUE_LABELS.md) used across the IPFS project, so you can also drill by issue type (for example, [UX-related issues](https://github.com/ipfs-shipyard/ipfs-desktop/issues?q=is%3Aissue+is%3Aopen+label%3Atopic%2Fdesign-ux)). +We welcome all contributions to IPFS Desktop! The best way to get started is to check the current [open issues](https://github.com/ipfs-shipyard/ipfs-desktop/issues) (or drill down specifically for [issues labeled "help wanted"](https://github.com/ipfs-shipyard/ipfs-desktop/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)) and find something interesting. All issues are categorized by the [standard label taxonomy](https://github.com/ipfs/community/blob/master/ISSUE_LABELS.md) used across the IPFS project, so you can also drill by topic (for example, [UX-related issues](https://github.com/ipfs-shipyard/ipfs-desktop/issues?q=is%3Aissue+is%3Aopen+label%3Atopic%2Fdesign-ux)). -You may also enjoy taking part in the IPFS GUI & Web Browsers Working Group's biweekly meeting to catch up on the latest plans and developments. This meeting does shift around in the calendar, so please check the [IPFS Community Calendar](https://calendar.google.com/calendar/embed?src=ipfs.io_eal36ugu5e75s207gfjcu0ae84@group.calendar.google.com&ctz=UTC) for the latest day/time. +You may also enjoy taking part in the IPFS GUI & Web Browsers Working Group's biweekly meeting to catch up on the latest plans. This meeting does shift around, so please check the [IPFS Community Calendar](https://calendar.google.com/calendar/embed?src=ipfs.io_eal36ugu5e75s207gfjcu0ae84@group.calendar.google.com&ctz=UTC) for the latest day/time. No matter how you contribute, please be sure you read and follow the [IPFS Contributing Guidelines](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md) and the [IPFS Community Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md). ### Translations -Contributing translations in your language is particularly welcome! The IPFS project as a whole uses Transifex to manage internationalization, which means that you don't need to change any of the code in this repo to add your translations — you just need to sign up for a Transifex account. +Contributing translations in your language is particularly valuable! The IPFS project as a whole uses Transifex to manage internationalization, which means that you don't need to change any of the code in this repo to add your translations — you just need to sign up for a Transifex account. -Because the IPFS Desktop app also includes code 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 projects in order to see all the text in need of translation: +Because IPFS Desktop app includes code 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 in need of translation: - https://www.transifex.com/ipfs/ipfs-desktop/ - https://www.transifex.com/ipfs/ipfs-webui/ - https://www.transifex.com/ipfs/ipld-explorer/ -*Note for developers:* We use the English version of text as the source of truth. This means that if you add any new text that will need to be localized, make those additions in [./assets/locales/en.json](./assets/locales/en.json) and they will automatically be added to Transifex for the community to translate. - -### Releasing - -- Manually test a few things that don't transfer well to automated testing: - - Mac/Win/Linux: confirm that "Take Screenshot" under menubar/system tray menu works as expected for both single- and multi-monitor setups (file(s) imported, correct link copied to clipboard) - - Mac only: drag/drop onto menubar icon behaves as expected when dragging one file, several files, and a combination of files/folders (file(s) imported, correct link copied to clipboard) - - Win only: right-click on a file and "Add to IPFS" from context menu works as expected (file imported, correct link copied to clipboard) - - Mac/Win: confirm that OS-wide protocol handler got registered by opening `ipfs://bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdi` in user agent without IPFS Companion -- Fetch new translations from Transifex: `tx pull -a` -- Commit the changes -- Bump the version in `package.json` -- Commit the changes -- Create a tag with the same version: `git tag vA.B.C` -- Publish local changes and the tag to GitHub repo: `git push && git push origin vA.B.C` -- Wait for the CI to upload the binaries to the draft release (a new one will be created if you haven't drafted one). -- Publish release draft. - - Once a release is published, users should receive the app update. See: https://www.electron.build/auto-update. +*Note for developers: We use the English text as the source of truth. This means that if you add any new text, make those additions in [./assets/locales/en.json](./assets/locales/en.json) and they will automatically be added to Transifex for the community to translate.* + +### Developer notes + +For more detailed information about hacking on IPFS Desktop, including a release checklist, please see the full [DEVELOPER-NOTES.md](developer notes). + +### Release checklist + +Before cutting a new release of IPFS Desktop, please go through the following process: + +#### Manual testing + +Manually test a few things that don't transfer well to automated testing: + +1. **Mac/Windows/Linux:** Confirm that "Take Screenshot" under the menubar/system tray menu works as expected for both single- and multi-monitor setups: + - File(s) import correctly + - Correct link is copied to clipboard +2. **Mac only:** Drag/drop onto menubar icon behaves as expected when dragging one file, several files, and a combination of files/folders: + - File(s) import correctly + - Correct link is copied to clipboard +3. **Windows only:** Right-click on a file and "Add to IPFS" from context menu works as expected: + - File(s) import correctly + - Correct link is copied to clipboard +4. **Mac/Windows:** Confirm that OS-wide protocol handler was registered by opening `ipfs://bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdi` in user agent _without_ IPFS Companion + +#### Main release process +1. Fetch new translations from Transifex: `tx pull -a`. +2. Commit the changes. +3. Bump the version in `package.json`. +4. Commit the changes. +5. Create a tag with the same version as your bump: `git tag vA.B.C`. +6. Publish local changes and the tag to the GitHub repo: `git push && git push origin vA.B.C`. +7. Wait for the CI to upload the binaries to the draft release (a new one will be created if you haven't drafted one). +8. Publish a release draft. + - Once a release is published, users should receive the app update (see https://www.electron.build/auto-update for details). - The `latest.yml, latest-mac.yml, latest-linux.yml` files on the release are used by the app to determine when an app update is available. -- Update links and badges in `README.md` to point to the new version (`A.B.C`) -- Update `CHANGELOG.md` with details from release/release draft -- Update selected package managers - - Wait for CI to finish and confirm it updated [Snap](https://snapcraft.io/ipfs-desktop) and is at least pending review on [Chocolatey](https://chocolatey.org/packages/ipfs-desktop#versionhistory). - - Update [Homebrew Cask](https://github.com/Homebrew/homebrew-cask/blob/master/CONTRIBUTING.md#updating-a-cask). -- To start work on the next version, bump the version in the `package.json` - -#### Manual notarization (Fallback in-case CI is not doing it correctly) - -- Notarize `.dmg` at Apple (context: [#1365](https://github.com/ipfs-shipyard/ipfs-desktop/issues/1211)) - 1. Download `.dmg` from `https://github.com/ipfs-shipyard/ipfs-desktop/releases/vA.B.C` - 2. Ensure `APPLEID` and `APPLEIDPASS` are set either as environment variables or entries in `.env` file. Those need to belong to the same org as cert used for signing. - 3. Run `node pkgs/macos/notarize-cli.js ./IPFS-Desktop-A.B.C.dmg` - 4. Debug errors by calling the tool directly: `xcrun altool --notarize-app -f /path/to/IPFS-Desktop-0.X.0.dmg --primary-bundle-id io.ipfs.desktop -u XXX-from-vault-XXX -p XXX-app-specific-password-from-vault-XXX`, also see the [long list of hoops Apple might ask you to jump through](https://github.com/ipfs-shipyard/ipfs-desktop/pull/1365#issuecomment-598127684). +9. Update all links and badges in `README.md` to point to the new version (`A.B.C`). +10. Update `CHANGELOG.md` with details from release/release draft. +11. Update selected package managers: + - Wait for CI to finish and confirm that it updated [Snap](https://snapcraft.io/ipfs-desktop), and is at least pending review on [Chocolatey](https://chocolatey.org/packages/ipfs-desktop#versionhistory). + - Update the [Homebrew cask](https://github.com/Homebrew/homebrew-cask/blob/master/CONTRIBUTING.md#updating-a-cask). +12. To start work on the next version, bump the version in `package.json`. + +#### Manually notarize `.dmg` with Apple + +These steps are only needed as a fallback if CI is not correctly notarizing the `.dmg` file. For context, see [#1365](https://github.com/ipfs-shipyard/ipfs-desktop/issues/1211). + +1. Download the `.dmg` from `https://github.com/ipfs-shipyard/ipfs-desktop/releases/vA.B.C`. +2. Ensure `APPLEID` and `APPLEIDPASS` are set either as environment variables or entries in `.env` file. These need to belong to the same org as the certificate used for signing. +3. Run `node pkgs/macos/notarize-cli.js ./IPFS-Desktop-A.B.C.dmg`. +4. Debug errors by calling the tool directly: `xcrun altool --notarize-app -f /path/to/IPFS-Desktop-0.X.0.dmg --primary-bundle-id io.ipfs.desktop -u XXX-from-vault-XXX -p XXX-app-specific-password-from-vault-XXX`; also, see the [long list of hoops Apple may ask you to jump through](https://github.com/ipfs-shipyard/ipfs-desktop/pull/1365#issuecomment-598127684). ## FAQ & Troubleshooting From 1e6dd7380c1dc8ffef1b34e630281b1b83113d09 Mon Sep 17 00:00:00 2001 From: Jessica Schilling Date: Wed, 21 Oct 2020 12:36:07 -0600 Subject: [PATCH 07/27] Update README.md --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 8dfe1edc3..1dc819c26 100644 --- a/README.md +++ b/README.md @@ -145,7 +145,7 @@ Manually test a few things that don't transfer well to automated testing: 3. **Windows only:** Right-click on a file and "Add to IPFS" from context menu works as expected: - File(s) import correctly - Correct link is copied to clipboard -4. **Mac/Windows:** Confirm that OS-wide protocol handler was registered by opening `ipfs://bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdi` in user agent _without_ IPFS Companion +4. **Mac/Windows:** Confirm that OS-wide protocol handler was registered by opening `ipfs://bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdi` in a user agent _without_ IPFS Companion #### Main release process 1. Fetch new translations from Transifex: `tx pull -a`. @@ -156,13 +156,13 @@ Manually test a few things that don't transfer well to automated testing: 6. Publish local changes and the tag to the GitHub repo: `git push && git push origin vA.B.C`. 7. Wait for the CI to upload the binaries to the draft release (a new one will be created if you haven't drafted one). 8. Publish a release draft. - - Once a release is published, users should receive the app update (see https://www.electron.build/auto-update for details). - - The `latest.yml, latest-mac.yml, latest-linux.yml` files on the release are used by the app to determine when an app update is available. + - Once a release is published, users should receive the app update (see https://www.electron.build/auto-update for details). + - The `latest.yml, latest-mac.yml, latest-linux.yml` files on the release are used by the app to determine when an app update is available. 9. Update all links and badges in `README.md` to point to the new version (`A.B.C`). 10. Update `CHANGELOG.md` with details from release/release draft. 11. Update selected package managers: - - Wait for CI to finish and confirm that it updated [Snap](https://snapcraft.io/ipfs-desktop), and is at least pending review on [Chocolatey](https://chocolatey.org/packages/ipfs-desktop#versionhistory). - - Update the [Homebrew cask](https://github.com/Homebrew/homebrew-cask/blob/master/CONTRIBUTING.md#updating-a-cask). + - Wait for CI to finish and confirm that it updated [Snap](https://snapcraft.io/ipfs-desktop), and is at least pending review on [Chocolatey](https://chocolatey.org/packages/ipfs-desktop#versionhistory). + - Update the [Homebrew cask](https://github.com/Homebrew/homebrew-cask/blob/master/CONTRIBUTING.md#updating-a-cask). 12. To start work on the next version, bump the version in `package.json`. #### Manually notarize `.dmg` with Apple From 95613d40f5ab528ec61f151353385cf8f4d59509 Mon Sep 17 00:00:00 2001 From: Jessica Schilling Date: Wed, 21 Oct 2020 12:41:13 -0600 Subject: [PATCH 08/27] Create DEVELOPER-NOTES.md --- DEVELOPER-NOTES.md | 49 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 DEVELOPER-NOTES.md diff --git a/DEVELOPER-NOTES.md b/DEVELOPER-NOTES.md new file mode 100644 index 000000000..01528093b --- /dev/null +++ b/DEVELOPER-NOTES.md @@ -0,0 +1,49 @@ +# Developer notes + +Below are helpful notes for developers hacking on or releasing new versions of IPFS Desktop. + +## Release checklist + +Before cutting a new release of IPFS Desktop, please go through the following process: + +### Manual testing + +Manually test a few things that don't transfer well to automated testing: + +1. **Mac/Windows/Linux:** Confirm that "Take Screenshot" under the menubar/system tray menu works as expected for both single- and multi-monitor setups: + - File(s) import correctly + - Correct link is copied to clipboard +2. **Mac only:** Drag/drop onto menubar icon behaves as expected when dragging one file, several files, and a combination of files/folders: + - File(s) import correctly + - Correct link is copied to clipboard +3. **Windows only:** Right-click on a file and "Add to IPFS" from context menu works as expected: + - File(s) import correctly + - Correct link is copied to clipboard +4. **Mac/Windows:** Confirm that OS-wide protocol handler was registered by opening `ipfs://bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdi` in a user agent _without_ IPFS Companion + +### Main release process +1. Fetch new translations from Transifex: `tx pull -a`. +2. Commit the changes. +3. Bump the version in `package.json`. +4. Commit the changes. +5. Create a tag with the same version as your bump: `git tag vA.B.C`. +6. Publish local changes and the tag to the GitHub repo: `git push && git push origin vA.B.C`. +7. Wait for the CI to upload the binaries to the draft release (a new one will be created if you haven't drafted one). +8. Publish a release draft. + - Once a release is published, users should receive the app update (see https://www.electron.build/auto-update for details). + - The `latest.yml, latest-mac.yml, latest-linux.yml` files on the release are used by the app to determine when an app update is available. +9. Update all links and badges in `README.md` to point to the new version (`A.B.C`). +10. Update `CHANGELOG.md` with details from release/release draft. +11. Update selected package managers: + - Wait for CI to finish and confirm that it updated [Snap](https://snapcraft.io/ipfs-desktop), and is at least pending review on [Chocolatey](https://chocolatey.org/packages/ipfs-desktop#versionhistory). + - Update the [Homebrew cask](https://github.com/Homebrew/homebrew-cask/blob/master/CONTRIBUTING.md#updating-a-cask). +12. To start work on the next version, bump the version in `package.json`. + +### Manually notarize `.dmg` with Apple + +These steps are only needed as a fallback if CI is not correctly notarizing the `.dmg` file. For context, see [#1365](https://github.com/ipfs-shipyard/ipfs-desktop/issues/1211). + +1. Download the `.dmg` from `https://github.com/ipfs-shipyard/ipfs-desktop/releases/vA.B.C`. +2. Ensure `APPLEID` and `APPLEIDPASS` are set either as environment variables or entries in `.env` file. These need to belong to the same org as the certificate used for signing. +3. Run `node pkgs/macos/notarize-cli.js ./IPFS-Desktop-A.B.C.dmg`. +4. Debug errors by calling the tool directly: `xcrun altool --notarize-app -f /path/to/IPFS-Desktop-0.X.0.dmg --primary-bundle-id io.ipfs.desktop -u XXX-from-vault-XXX -p XXX-app-specific-password-from-vault-XXX`; also, see the [long list of hoops Apple may ask you to jump through](https://github.com/ipfs-shipyard/ipfs-desktop/pull/1365#issuecomment-598127684). From b794c910037bea6b648c0a3df395adf6a5652885 Mon Sep 17 00:00:00 2001 From: Jessica Schilling Date: Wed, 21 Oct 2020 12:42:01 -0600 Subject: [PATCH 09/27] Update README.md --- README.md | 46 ---------------------------------------------- 1 file changed, 46 deletions(-) diff --git a/README.md b/README.md index 1dc819c26..af69eaf12 100644 --- a/README.md +++ b/README.md @@ -128,52 +128,6 @@ Because IPFS Desktop app includes code from [IPFS Web UI](https://github.com/ipf For more detailed information about hacking on IPFS Desktop, including a release checklist, please see the full [DEVELOPER-NOTES.md](developer notes). -### Release checklist - -Before cutting a new release of IPFS Desktop, please go through the following process: - -#### Manual testing - -Manually test a few things that don't transfer well to automated testing: - -1. **Mac/Windows/Linux:** Confirm that "Take Screenshot" under the menubar/system tray menu works as expected for both single- and multi-monitor setups: - - File(s) import correctly - - Correct link is copied to clipboard -2. **Mac only:** Drag/drop onto menubar icon behaves as expected when dragging one file, several files, and a combination of files/folders: - - File(s) import correctly - - Correct link is copied to clipboard -3. **Windows only:** Right-click on a file and "Add to IPFS" from context menu works as expected: - - File(s) import correctly - - Correct link is copied to clipboard -4. **Mac/Windows:** Confirm that OS-wide protocol handler was registered by opening `ipfs://bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdi` in a user agent _without_ IPFS Companion - -#### Main release process -1. Fetch new translations from Transifex: `tx pull -a`. -2. Commit the changes. -3. Bump the version in `package.json`. -4. Commit the changes. -5. Create a tag with the same version as your bump: `git tag vA.B.C`. -6. Publish local changes and the tag to the GitHub repo: `git push && git push origin vA.B.C`. -7. Wait for the CI to upload the binaries to the draft release (a new one will be created if you haven't drafted one). -8. Publish a release draft. - - Once a release is published, users should receive the app update (see https://www.electron.build/auto-update for details). - - The `latest.yml, latest-mac.yml, latest-linux.yml` files on the release are used by the app to determine when an app update is available. -9. Update all links and badges in `README.md` to point to the new version (`A.B.C`). -10. Update `CHANGELOG.md` with details from release/release draft. -11. Update selected package managers: - - Wait for CI to finish and confirm that it updated [Snap](https://snapcraft.io/ipfs-desktop), and is at least pending review on [Chocolatey](https://chocolatey.org/packages/ipfs-desktop#versionhistory). - - Update the [Homebrew cask](https://github.com/Homebrew/homebrew-cask/blob/master/CONTRIBUTING.md#updating-a-cask). -12. To start work on the next version, bump the version in `package.json`. - -#### Manually notarize `.dmg` with Apple - -These steps are only needed as a fallback if CI is not correctly notarizing the `.dmg` file. For context, see [#1365](https://github.com/ipfs-shipyard/ipfs-desktop/issues/1211). - -1. Download the `.dmg` from `https://github.com/ipfs-shipyard/ipfs-desktop/releases/vA.B.C`. -2. Ensure `APPLEID` and `APPLEIDPASS` are set either as environment variables or entries in `.env` file. These need to belong to the same org as the certificate used for signing. -3. Run `node pkgs/macos/notarize-cli.js ./IPFS-Desktop-A.B.C.dmg`. -4. Debug errors by calling the tool directly: `xcrun altool --notarize-app -f /path/to/IPFS-Desktop-0.X.0.dmg --primary-bundle-id io.ipfs.desktop -u XXX-from-vault-XXX -p XXX-app-specific-password-from-vault-XXX`; also, see the [long list of hoops Apple may ask you to jump through](https://github.com/ipfs-shipyard/ipfs-desktop/pull/1365#issuecomment-598127684). - ## FAQ & Troubleshooting ### Where are my IPFS configuration and log files? From ece53aa60ee4bdbf0da342b09021a06c7fd6cb4a Mon Sep 17 00:00:00 2001 From: Jessica Schilling Date: Wed, 21 Oct 2020 12:43:08 -0600 Subject: [PATCH 10/27] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index af69eaf12..3017a5830 100644 --- a/README.md +++ b/README.md @@ -126,7 +126,7 @@ Because IPFS Desktop app includes code from [IPFS Web UI](https://github.com/ipf ### Developer notes -For more detailed information about hacking on IPFS Desktop, including a release checklist, please see the full [DEVELOPER-NOTES.md](developer notes). +For more detailed information about hacking on IPFS Desktop, including a release checklist, please see the full [developer notes](DEVELOPER-NOTES.md). ## FAQ & Troubleshooting From 0494b6f0be43a401197a481d6a5888d6f2daad79 Mon Sep 17 00:00:00 2001 From: Jessica Schilling Date: Wed, 21 Oct 2020 12:54:40 -0600 Subject: [PATCH 11/27] Update README.md --- README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 3017a5830..2e18ccab8 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ [![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs) [![](https://david-dm.org/ipfs-shipyard/ipfs-desktop.svg?style=flat-square)](https://david-dm.org/ipfs-shipyard/ipfs-desktop) [![total download count](https://img.shields.io/github/downloads/ipfs-shipyard/ipfs-desktop/total.svg?style=flat-square&label=all%20downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases) -[![latest release download count](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/total.svg?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/tag/v0.13.2) +[![latest release download count](https://img.shields.io/github/downloads/ipfs-shipyard/ipfs-desktop/v0.13.2/total.svg?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/tag/v0.13.2) **IPFS Desktop gives you all the power of [IPFS](https://ipfs.io) in an easy desktop app: a complete IPFS node, plus handy OS menubar/taskbar shortcuts and an all-in-one file manager, peer map, and content explorer.** @@ -71,20 +71,20 @@ Release notes and older versions of IPFS Desktop can be found on the [releases p Don't see your favorite package manager? Visit our [package managers page](https://github.com/ipfs-shipyard/ipfs-desktop/issues/691) and help us add support for it! ### Mac -- **Installer:** [IPFS-Desktop-0.13.2.dmg](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-0.13.2.dmg) [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/IPFS-Desktop-0.13.2.dmg.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-0.13.2.dmg) +- **Installer:** [IPFS-Desktop-0.13.2.dmg](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-0.13.2.dmg) [![](https://img.shields.io/github/downloads/ipfs-shipyard/ipfs-desktop/v0.13.2/IPFS-Desktop-0.13.2.dmg.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-0.13.2.dmg) - **Homebrew** (community-maintained): `brew cask install ipfs` ### Windows -- **Installer:** [IPFS-Desktop-Setup-0.13.2.exe](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-Setup-0.13.2.exe) [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/IPFS-Desktop-Setup-0.13.2.exe.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-Setup-0.13.2.exe) +- **Installer:** [IPFS-Desktop-Setup-0.13.2.exe](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-Setup-0.13.2.exe) [![](https://img.shields.io/github/downloads/ipfs-shipyard/ipfs-desktop/v0.13.2/IPFS-Desktop-Setup-0.13.2.exe.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-Setup-0.13.2.exe) - **Chocolatey** (community-maintained): `choco install ipfs-desktop` - **Scoop** (community-maintained): `scoop install ipfs-desktop` ### Linux/FreeBSD -- **Tarball** (experimental!): [ipfs-desktop-0.13.2-linux-x64.tar.xz](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x64.tar.xz) [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-x64.tar.xz.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x64.tar.xz) -- **Debian DEB** (experimental!): [ipfs-desktop-0.13.2-linux-amd64.deb](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-amd64.deb) [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-amd64.deb.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-amd64.deb) -- **Red Hat RPM** (experimental!): [ipfs-desktop-0.13.2-linux-x86_64.rpm](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.rpm) [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.rpm.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.rpm) -- **AppImage** (experimental!): [ipfs-desktop-0.13.2-linux-x86_64.AppImage](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.AppImage) [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.AppImage.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.AppImage) -- **FreeBSD** (experimental!): [ipfs-desktop-0.13.2-linux-x64.freebsd](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x64.freebsd) [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-x64.freebsd.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x64.freebsd) +- **Tarball** (experimental): [ipfs-desktop-0.13.2-linux-x64.tar.xz](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x64.tar.xz) [![](https://img.shields.io/github/downloads/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-x64.tar.xz.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x64.tar.xz) +- **Debian** (experimental): [ipfs-desktop-0.13.2-linux-amd64.deb](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-amd64.deb) [![](https://img.shields.io/github/downloads/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-amd64.deb.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-amd64.deb) +- **Red Hat** (experimental): [ipfs-desktop-0.13.2-linux-x86_64.rpm](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.rpm) [![](https://img.shields.io/github/downloads/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.rpm.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.rpm) +- **AppImage** (experimental): [ipfs-desktop-0.13.2-linux-x86_64.AppImage](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.AppImage) [![](https://img.shields.io/github/downloads/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.AppImage.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.AppImage) +- **FreeBSD** (experimental): [ipfs-desktop-0.13.2-linux-x64.freebsd](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x64.freebsd) [![](https://img.shields.io/github/downloads/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-x64.freebsd.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x64.freebsd) - **Snapcraft** (community-maintained): `snap install ipfs-desktop` - **AUR** (maintained by [@alexhenrie](https://github.com/alexhenrie)): [`ipfs-desktop` package](https://aur.archlinux.org/packages/ipfs-desktop/) @@ -115,14 +115,14 @@ No matter how you contribute, please be sure you read and follow the [IPFS Contr ### Translations -Contributing translations in your language is particularly valuable! The IPFS project as a whole uses Transifex to manage internationalization, which means that you don't need to change any of the code in this repo to add your translations — you just need to sign up for a Transifex account. +Contributing translations in your language is particularly valuable! We use Transifex to manage internationalization, which means you don't need to change any of the code in this repo to add your translations — just sign up for a Transifex account. -Because IPFS Desktop app includes code 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 in need of translation: +Because IPFS Desktop app includes code 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: - https://www.transifex.com/ipfs/ipfs-desktop/ - https://www.transifex.com/ipfs/ipfs-webui/ - https://www.transifex.com/ipfs/ipld-explorer/ -*Note for developers: We use the English text as the source of truth. This means that if you add any new text, make those additions in [./assets/locales/en.json](./assets/locales/en.json) and they will automatically be added to Transifex for the community to translate.* +*Note for developers: We use English as our source of truth. This means that if you add any new text, make those additions in [./assets/locales/en.json](./assets/locales/en.json) and they will automatically propagate in Transifex for other languages.* ### Developer notes From 435140a492828e61a881c16b1c9673079bfa4bde Mon Sep 17 00:00:00 2001 From: Jessica Schilling Date: Wed, 21 Oct 2020 12:58:50 -0600 Subject: [PATCH 12/27] Update README.md --- README.md | 23 +++++++++++++++-------- 1 file changed, 15 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 2e18ccab8..c9c37f8bc 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ Use IPFS Desktop to get acquainted with IPFS without needing to touch the command line — or, if you're already experienced, use the powerful menubar/taskbar shortcuts alongside the command line to make your IPFS workflow faster. -**Download now!** 🎉 📥 +**Install now!** 🎉 📥 - **Mac:** [IPFS-Desktop-0.13.2.dmg](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-0.13.2.dmg) or `brew cask install ipfs` - **Windows:** [IPFS-Desktop-Setup-0.13.2.exe](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-Setup-0.13.2.exe) or `choco install ipfs-desktop` @@ -71,20 +71,27 @@ Release notes and older versions of IPFS Desktop can be found on the [releases p Don't see your favorite package manager? Visit our [package managers page](https://github.com/ipfs-shipyard/ipfs-desktop/issues/691) and help us add support for it! ### Mac -- **Installer:** [IPFS-Desktop-0.13.2.dmg](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-0.13.2.dmg) [![](https://img.shields.io/github/downloads/ipfs-shipyard/ipfs-desktop/v0.13.2/IPFS-Desktop-0.13.2.dmg.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-0.13.2.dmg) +- **Installer:** [IPFS-Desktop-0.13.2.dmg](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-0.13.2.dmg)\ +[![](https://img.shields.io/github/downloads/ipfs-shipyard/ipfs-desktop/v0.13.2/IPFS-Desktop-0.13.2.dmg.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-0.13.2.dmg) - **Homebrew** (community-maintained): `brew cask install ipfs` ### Windows -- **Installer:** [IPFS-Desktop-Setup-0.13.2.exe](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-Setup-0.13.2.exe) [![](https://img.shields.io/github/downloads/ipfs-shipyard/ipfs-desktop/v0.13.2/IPFS-Desktop-Setup-0.13.2.exe.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-Setup-0.13.2.exe) +- **Installer:** [IPFS-Desktop-Setup-0.13.2.exe](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-Setup-0.13.2.exe)\ +[![](https://img.shields.io/github/downloads/ipfs-shipyard/ipfs-desktop/v0.13.2/IPFS-Desktop-Setup-0.13.2.exe.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-Setup-0.13.2.exe) - **Chocolatey** (community-maintained): `choco install ipfs-desktop` - **Scoop** (community-maintained): `scoop install ipfs-desktop` ### Linux/FreeBSD -- **Tarball** (experimental): [ipfs-desktop-0.13.2-linux-x64.tar.xz](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x64.tar.xz) [![](https://img.shields.io/github/downloads/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-x64.tar.xz.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x64.tar.xz) -- **Debian** (experimental): [ipfs-desktop-0.13.2-linux-amd64.deb](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-amd64.deb) [![](https://img.shields.io/github/downloads/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-amd64.deb.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-amd64.deb) -- **Red Hat** (experimental): [ipfs-desktop-0.13.2-linux-x86_64.rpm](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.rpm) [![](https://img.shields.io/github/downloads/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.rpm.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.rpm) -- **AppImage** (experimental): [ipfs-desktop-0.13.2-linux-x86_64.AppImage](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.AppImage) [![](https://img.shields.io/github/downloads/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.AppImage.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.AppImage) -- **FreeBSD** (experimental): [ipfs-desktop-0.13.2-linux-x64.freebsd](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x64.freebsd) [![](https://img.shields.io/github/downloads/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-x64.freebsd.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x64.freebsd) +- **Tarball** (experimental): [ipfs-desktop-0.13.2-linux-x64.tar.xz](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x64.tar.xz)\ +[![](https://img.shields.io/github/downloads/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-x64.tar.xz.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x64.tar.xz) +- **Debian** (experimental): [ipfs-desktop-0.13.2-linux-amd64.deb](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-amd64.deb)\ +[![](https://img.shields.io/github/downloads/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-amd64.deb.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-amd64.deb) +- **Red Hat** (experimental): [ipfs-desktop-0.13.2-linux-x86_64.rpm](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.rpm)\ +[![](https://img.shields.io/github/downloads/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.rpm.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.rpm) +- **AppImage** (experimental): [ipfs-desktop-0.13.2-linux-x86_64.AppImage](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.AppImage)\ +[![](https://img.shields.io/github/downloads/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.AppImage.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.AppImage) +- **FreeBSD** (experimental): [ipfs-desktop-0.13.2-linux-x64.freebsd](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x64.freebsd)\ +[![](https://img.shields.io/github/downloads/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-x64.freebsd.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x64.freebsd) - **Snapcraft** (community-maintained): `snap install ipfs-desktop` - **AUR** (maintained by [@alexhenrie](https://github.com/alexhenrie)): [`ipfs-desktop` package](https://aur.archlinux.org/packages/ipfs-desktop/) From 11ac15f65db1a2dd453be03f0ce1307650de8042 Mon Sep 17 00:00:00 2001 From: Jessica Schilling Date: Wed, 21 Oct 2020 13:40:21 -0600 Subject: [PATCH 13/27] Update README.md --- README.md | 78 +++++++++++++++++++++++++++++-------------------------- 1 file changed, 41 insertions(+), 37 deletions(-) diff --git a/README.md b/README.md index c9c37f8bc..443b2c8fd 100644 --- a/README.md +++ b/README.md @@ -20,12 +20,12 @@ Use IPFS Desktop to get acquainted with IPFS without needing to touch the comman ## Table of Contents -- [IPFS Desktop Features](#ipfs-desktop-features) +- [Features](#features) - [Install](#install) - [Contribute](#contribute) (including [translations](#translations)) -- [FAQ & Troubleshooting](#faq-troubleshooting) +- [FAQ & Troubleshooting](#faq--troubleshooting) -## IPFS Desktop Features +## Features ![IPFS Desktop](https://gateway.ipfs.io/ipfs/QmbT2YtuNo17Qaq31FJWRZgRMY4E6N9cdfBwzZTFSHUoBP) @@ -137,61 +137,65 @@ For more detailed information about hacking on IPFS Desktop, including a release ## FAQ & Troubleshooting -### Where are my IPFS configuration and log files? +### Why am I missing the system tray menu on Linux? -The configuration file and logs are located on: -- Mac: `~/Library/Application Support/IPFS Desktop/` -- Windows: `%appdata%/IPFS Desktop/` -- Linux: `~/.config/IPFS Desktop/` +IPFS Desktop is built using Electron, and unfortunately, poor system tray support has been a [longstanding problem with Electron apps](https://github.com/electron/electron/issues/21445). -For quick access to this folders, just right-click on your tray icon and then 'Logs Directory' or 'Configuration File', depending on what you want. +You may wish to try troubleshooting according to the [Electron v9.3.0 docs](https://github.com/electron/electron/blob/v9.3.0/docs/api/tray.md#class-tray): -### How does IPFS Dekstop select the IPFS repo location? +- On Linux, the app indicator will be used if it is supported; otherwise `GtkStatusIcon` will be used +- On Linux distributions that only have app indicator support, you must install `libappindicator1` to make the tray icon work -We use [ipfsd-ctl](https://github.com/ipfs/js-ipfsd-ctl), which, in default conditions, will check `IPFS_PATH` environment variable. If not set, we fallback to `$HOME/.ipfs`. As soon as the first run has succeded, we save the information about the repository location in the configuration file, which becomes the source of truth. +If you've noticed that the old system tray is back in IPFS Desktop v0.13, this is because the Electron team [removed support for `StatusNotifier` and restored the old tray interface on Linux called `XEmbed`](https://github.com/electron/electron/issues/21445#issuecomment-634163402). -### Which version of IPFS does IPFS Desktop run? +### Why can't I start IPFS Desktop under Debian 10? -Since we're using [ipfsd-ctl](https://github.com/ipfs/js-ipfsd-ctl), we have our own embedded IPFS binary. We try to always have the latest version. +Some Linux users may see one of the following errors when trying to launch IPFS Desktop: -### Which flags does IPFS Desktop boot with? +When launching by double-clicking the app icon: +> The SUID sandbox helper binary was found, but is not configured correctly. +Rather than run without sandboxing I'm aborting now. You need to make sure that +chrome-sandbox is owned by root and has mode 4755. -By default we use the flags `--migrate=true --routing=dhtclient ----enable-gc=true` when running the IPFS daemon. They can be changed via the configuration file, which can be easily accessed as mentioned above. +When launching from the terminal: +```console +$ ipfs-desktop +$Trace/breakpoint trap +``` -### I don't have a system tray icon on Linux. Why? +This is a known issue with Electron/Chrome and some hardened kernels. More details can be found [here](https://github.com/ipfs-shipyard/ipfs-desktop/issues/1362#issuecomment-596857282), but a fix is to start IPFS Desktop from the terminal with the following additional parameter: +```console +$ ipfs-desktop --no-sandbox +``` -Poor tray support is a long running problem with Electron apps: [electron/issues/21445](https://github.com/electron/electron/issues/21445). +### Where are my IPFS configuration and log files? -According to [electron/v9.3.0/docs/api/tray.md](https://github.com/electron/electron/blob/v9.3.0/docs/api/tray.md#class-tray): +You can open these files from the IPFS Desktop menubar/system tray menu by selecting `Open Logs Directory` or `Open Configuration File` from the `Advanced` submenu. Or, find them in your OS as follows: +- **Mac:** `~/Library/Application Support/IPFS Desktop/` +- **Windows:** `%appdata%/IPFS Desktop/` +- **Linux:** `~/.config/IPFS Desktop/` -* On Linux the app indicator will be used if it is supported, otherwise `GtkStatusIcon` will be used instead. -* On Linux distributions that only have app indicator support, you have to install `libappindicator1` to make the tray icon work. +### How does IPFS Desktop select the IPFS repo location? -Why the old tray is back since v0.13? We had no control over this: Electron team [removed support for `StatusNotifier` and restored the old tray interface on Linux called `XEmbed`](https://github.com/electron/electron/issues/21445#issuecomment-634163402). +IPFS Desktop uses [ipfsd-ctl](https://github.com/ipfs/js-ipfsd-ctl), which, by default, checks the `IPFS_PATH` environment variable. If that isn't set, it falls back to `$HOME/.ipfs`. As soon as the first run has succeded, repository location info is saved in the configuration file, which becomes the source of truth. -### I can't start IPFS Desktop under Debian 10. Why? +To open your repo directory from the IPFS Desktop menubar/system tray menu, select `Open Repository Directory` from the `Advanced` submenu. -Some Linux users may see an error like this: +### Which version of IPFS does IPFS Desktop use? -> The SUID sandbox helper binary was found, but is not configured correctly. -Rather than run without sandboxing I'm aborting now. You need to make sure that -chrome-sandbox is owned by root and has mode 4755. +Since IPFS Desktop uses [ipfsd-ctl](https://github.com/ipfs/js-ipfsd-ctl), it includes its own embedded IPFS binary, which in most circumstances is the latest version of [go-ipfs](https://github.com/ipfs/go-ipfs). -or a very short one, when starting in a terminal: +You can check which version of IPFS you're running from the IPFS Desktop menubar/system tray menu by looking in the `About` submenu. -```console -$ ipfs-desktop -$Trace/breakpoint trap -``` +### Which flags does IPFS Desktop boot with? -This is a known issue with Electron/Chrome and some hardened kernels. -If you are interested in details, read [this](https://github.com/ipfs-shipyard/ipfs-desktop/issues/1362#issuecomment-596857282). +By default, IPFS Desktop starts the IPFS daemon with the flags `--migrate=true --routing=dhtclient ----enable-gc=true`. You can change this in the config file by editing the `IPFS Config` section of IPFS Desktop's `Settings` screen. -The only reliable way to fix this at the moment is to start the app with additional parameter: +### I need more help! -```console -$ ipfs-desktop --no-sandbox -``` +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.io). + +If you think you've found a bug or other issue with IPFS Desktop itself, please [open an issue](https://github.com/ipfs-shipyard/ipfs-desktop/issues/new/choose). ## License From a6bc616f34b020a06f4127a55691e4d0ab5efc2b Mon Sep 17 00:00:00 2001 From: Jessica Schilling Date: Wed, 21 Oct 2020 13:42:15 -0600 Subject: [PATCH 14/27] Everything but Features is better now --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 443b2c8fd..33bb9e3de 100644 --- a/README.md +++ b/README.md @@ -189,7 +189,9 @@ You can check which version of IPFS you're running from the IPFS Desktop menubar ### Which flags does IPFS Desktop boot with? -By default, IPFS Desktop starts the IPFS daemon with the flags `--migrate=true --routing=dhtclient ----enable-gc=true`. You can change this in the config file by editing the `IPFS Config` section of IPFS Desktop's `Settings` screen. +By default, IPFS Desktop starts the IPFS daemon with the flags `--migrate=true --routing=dhtclient ----enable-gc=true`. + +You can change this in the config file by editing the `IPFS Config` section of IPFS Desktop's `Settings` screen. ### I need more help! From 88c43b454cfb9272455714cdc1df41d11c5aedee Mon Sep 17 00:00:00 2001 From: Jessica Schilling Date: Wed, 21 Oct 2020 13:59:31 -0600 Subject: [PATCH 15/27] Add primary screenshot --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 33bb9e3de..dd992e9f6 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,8 @@ **IPFS Desktop gives you all the power of [IPFS](https://ipfs.io) in an easy desktop app: a complete IPFS node, plus handy OS menubar/taskbar shortcuts and an all-in-one file manager, peer map, and content explorer.** +![Status screen of IPFS Desktop](https://gateway.ipfs.io/ipfs/QmYHuXitXMf5xTjiQXmXdqszvMTADvrM5zA7EqoDj3d3RH) + Use IPFS Desktop to get acquainted with IPFS without needing to touch the command line — or, if you're already experienced, use the powerful menubar/taskbar shortcuts alongside the command line to make your IPFS workflow faster. **Install now!** 🎉 📥 From 573f324d6f34d8a72cebb5a1e588bd8530467a39 Mon Sep 17 00:00:00 2001 From: Jessica Schilling Date: Wed, 21 Oct 2020 14:37:19 -0600 Subject: [PATCH 16/27] Update README.md --- README.md | 49 ++++++++++++++++++++++++++++++++----------------- 1 file changed, 32 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index dd992e9f6..3e028e5c1 100644 --- a/README.md +++ b/README.md @@ -9,17 +9,16 @@ **IPFS Desktop gives you all the power of [IPFS](https://ipfs.io) in an easy desktop app: a complete IPFS node, plus handy OS menubar/taskbar shortcuts and an all-in-one file manager, peer map, and content explorer.** -![Status screen of IPFS Desktop](https://gateway.ipfs.io/ipfs/QmYHuXitXMf5xTjiQXmXdqszvMTADvrM5zA7EqoDj3d3RH) - Use IPFS Desktop to get acquainted with IPFS without needing to touch the command line — or, if you're already experienced, use the powerful menubar/taskbar shortcuts alongside the command line to make your IPFS workflow faster. +![Status screen of IPFS Desktop](https://gateway.ipfs.io/ipfs/QmYHuXitXMf5xTjiQXmXdqszvMTADvrM5zA7EqoDj3d3RH) + **Install now!** 🎉 📥 - **Mac:** [IPFS-Desktop-0.13.2.dmg](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-0.13.2.dmg) or `brew cask install ipfs` - **Windows:** [IPFS-Desktop-Setup-0.13.2.exe](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-Setup-0.13.2.exe) or `choco install ipfs-desktop` - **Linux:** See [installation options](#install) below - ## Table of Contents - [Features](#features) @@ -29,16 +28,29 @@ Use IPFS Desktop to get acquainted with IPFS without needing to touch the comman ## Features -![IPFS Desktop](https://gateway.ipfs.io/ipfs/QmbT2YtuNo17Qaq31FJWRZgRMY4E6N9cdfBwzZTFSHUoBP) +IPFS Desktop combines a complete IPFS node (running go-ipfs) and the [IPFS Web UI](https://github.com/ipfs-shipyard/ipfs-webui) into a single, convenient desktop app — plus adds a menubar/system tray menu to your OS for easy access to a variety of common IPFS tasks. -IPFS Desktop allows you to run your IPFS Node on your machine without having to bother with command line tools. With it, you have the power of [Web UI](https://github.com/ipfs-shipyard/ipfs-webui) on tip of your hands plus a handful of shortcuts you can find on settings. +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. + +![IPFS Desktop](https://gateway.ipfs.io/ipfs/QmbT2YtuNo17Qaq31FJWRZgRMY4E6N9cdfBwzZTFSHUoBP) -It's based on Web UI running in Electron to add those extra, awesome menu commands. -### IPFS daemon always running +### Start your node at system startup and control it from your OS IPFS Desktop's main feature is to allow you to have the IPFS daemon always running in the background. But fear not! If you need to stop it, you can do it just by clicking on 'Stop'. +### File browser lets you add, move, view, share, and pin files + +foo + +### Peer visualizer gives you info on connected nodes worldwide + +foo + +#### IPLD Explorer + +foo + ### Handle `ipfs://`, `ipns://` and `dweb:` links IPFS Desktop has the capacity to handle protocols at the operating system level; i.e., if an application tries to open a link to either `ipfs://`, `ipns://` or `dweb:`, then the OS will call IPFS Desktop, which will handle the link. @@ -47,24 +59,27 @@ For example, if you come across a link on the Internet whose `href` attribute is On Windows, an easy way to open a link would be to open the Run window (Win+R), paste the link, and hit Enter. Then, IPFS Desktop handles the rest. The same happens if you try opening the same link in a browser. -### Adds `ipfs` to your system +Goes great with IPFS Companion! + -If you're using macOS or Windows and don't have `ipfs` installed on your system, IPFS Desktop will automatically install it so it is available through the command line. If you're using Linux, or already have `ipfs` installed, you can tell IPFS Desktop to take care of it (and keep it up to date!) by toggling the option on Settings. +### Easily import items to IPFS -### Easy add to IPFS +Quickly import files and folders to your IPFS node in a variety of ways: +- Drag and drop items onto IPFS Desktop's Files screen +- (Windows) Right-click a file/folder's icon to add it to IPFS from the pop-up menu +- (Mac) Drag and drop a file/folder onto the IPFS icon in your menubar -You can easily add files and folders to IPFS: +### Automagically import your screenshots -- On Windows, you can right click on files to add them to IPFS through IPFS Desktop. -- On macOS, you can drag and drop them to the tray icon. +Use `Take Screenshot` under the IPFS icon menu (in your menubar/system tray) to take a screenshot and import it to your IPFS node with one click. -### Download copied hashes +### Quick download for CIDs, IPFS paths, and IPNS paths -You can enable, on Settings, a shortcut to download an hash on the keyboard. +Just want to download an IPFS CID or IPFS/IPNS content path? Choose `Download...` from the IPFS icon menu, paste it in, and you're good to go. -### Auto-add screenshots +### Learn IPFS commands as you go -You can enable, on Settings, a shortcut to take screenshots and add them automatically to IPFS. +If you're interested in learning how to use IPFS from the command line, IPFS Desktop's CLI Tutor Mode can show you common IPFS commands as you go. Just check the `CLI Tutor Mode` box on the `Settings` screen to switch on this feature. ## Install From 8f30f06fcece6edeca0f002f168efc436ac1ff79 Mon Sep 17 00:00:00 2001 From: Jessica Schilling Date: Wed, 21 Oct 2020 15:26:07 -0600 Subject: [PATCH 17/27] Update README.md --- README.md | 61 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 31 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index 3e028e5c1..03edc4bd0 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,10 @@ Use IPFS Desktop to get acquainted with IPFS without needing to touch the comman ![Status screen of IPFS Desktop](https://gateway.ipfs.io/ipfs/QmYHuXitXMf5xTjiQXmXdqszvMTADvrM5zA7EqoDj3d3RH) +| Files | Explore | Peers | Settings | Menu | +|-------|---------|-------|----------|------| +| ![Screenshot of the file browser page](docs/screenshots/ipfs-webui-files.png) | ![Screenshot of the IPLD explorer page](docs/screenshots/ipfs-webui-explore.png) | ![Screenshot of the swarm peers map](docs/screenshots/ipfs-webui-peers.png) | ![Screenshot of the settings page](docs/screenshots/ipfs-webui-settings.png) | ![Screenshot of the settings page](docs/screenshots/ipfs-webui-settings.png) | + **Install now!** 🎉 📥 - **Mac:** [IPFS-Desktop-0.13.2.dmg](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-0.13.2.dmg) or `brew cask install ipfs` @@ -28,54 +32,51 @@ Use IPFS Desktop to get acquainted with IPFS without needing to touch the comman ## Features -IPFS Desktop combines a complete IPFS node (running go-ipfs) and the [IPFS Web UI](https://github.com/ipfs-shipyard/ipfs-webui) into a single, convenient desktop app — plus adds a menubar/system tray menu to your OS for easy access to a variety of common IPFS tasks. +IPFS Desktop combines a complete IPFS node (running [go-ipfs](https://github.com/ipfs/go-ipfs)) 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. 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. ![IPFS Desktop](https://gateway.ipfs.io/ipfs/QmbT2YtuNo17Qaq31FJWRZgRMY4E6N9cdfBwzZTFSHUoBP) - ### Start your node at system startup and control it from your OS -IPFS Desktop's main feature is to allow you to have the IPFS daemon always running in the background. But fear not! If you need to stop it, you can do it just by clicking on 'Stop'. - -### File browser lets you add, move, view, share, and pin files - -foo - -### Peer visualizer gives you info on connected nodes worldwide - -foo +IPFS Desktop can be set to launch at system startup, ensuring that your node is running whenever your computer is on. Plus, if you'd like to stop or restart your node at any point, you can do so straight from the IPFS logo menu in your OS menubar/system tray. -#### IPLD Explorer +### Easily import files, folders, and screenshots to IPFS -foo +Quickly import files and folders to your IPFS node in a variety of convenient ways: +- Drag and drop items onto IPFS Desktop's `Files` screen +- Click the `Import` button on the `Files` screen to add items from your computer or an IPFS content ID +- (Windows) Right-click a file/folder's icon to add it to IPFS from the pop-up menu +- (Mac) Drag and drop a file/folder onto the IPFS icon in your menubar -### Handle `ipfs://`, `ipns://` and `dweb:` links +Plus, you can use `Take Screenshot` under the IPFS logo menu to take a screenshot and import it to your node with one click. -IPFS Desktop has the capacity to handle protocols at the operating system level; i.e., if an application tries to open a link to either `ipfs://`, `ipns://` or `dweb:`, then the OS will call IPFS Desktop, which will handle the link. +### Use the Files screen to manage the contents of your node -For example, if you come across a link on the Internet whose `href` attribute is `ipns://ipfs.io`, then IPFS Desktop will be able to handle it. +IPFS Desktop's `Files` screen gives you an easy, familiar interface for working with files on your IPFS node: +- Easily rename, move, or remove files +- Preview most common file formats directly in IPFS Desktop +- Copy a file/folder's IPFS content ID or a shareable link to your clipboard +- ["Pin"](https://docs.ipfs.io/concepts/persistence/) files to your IPFS node or (coming soon!) to a third-party pinning service to ensure that important data is retained -On Windows, an easy way to open a link would be to open the Run window (Win+R), paste the link, and hit Enter. Then, IPFS Desktop handles the rest. The same happens if you try opening the same link in a browser. +### Quick download for CIDs, IPFS paths, and IPNS paths -Goes great with IPFS Companion! +Just want to download an IPFS content ID or IPFS/IPNS content path? Choose `Download...` from the IPFS logo menu, paste it in, and you're good to go. +### Visualize your IPFS peers worldwide -### Easily import items to IPFS +Visit the `Peers` screen to see what nodes you're connected to, where they are, the connections they're using, and more. -Quickly import files and folders to your IPFS node in a variety of ways: -- Drag and drop items onto IPFS Desktop's Files screen -- (Windows) Right-click a file/folder's icon to add it to IPFS from the pop-up menu -- (Mac) Drag and drop a file/folder onto the IPFS icon in your menubar +### Explore the "Merkle Forest" of IPFS files -### Automagically import your screenshots +Use the `Explore` screen to explore some example datasets — or your own files — and see firsthand how items stored on IPFS are broken down into content-addressed pieces. -Use `Take Screenshot` under the IPFS icon menu (in your menubar/system tray) to take a screenshot and import it to your IPFS node with one click. +### Enjoy OS-wide support for IPFS files and links -### Quick download for CIDs, IPFS paths, and IPNS paths +IPFS Desktop enables your operating system to support protocols including `ipfs://`, `ipns://` and `dweb:`. 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://ipfs.io`), it'll automatically open in IPFS Desktop. -Just want to download an IPFS CID or IPFS/IPNS content path? Choose `Download...` from the IPFS icon menu, paste it in, and you're good to go. +For an even better experience in native support for `ipfs://`, `ipns://` and `dweb:` addresses, we recommend installing [IPFS Companion](https://github.com/ipfs-shipyard/ipfs-companion) as well! ### Learn IPFS commands as you go @@ -187,7 +188,7 @@ $ ipfs-desktop --no-sandbox ### Where are my IPFS configuration and log files? -You can open these files from the IPFS Desktop menubar/system tray menu by selecting `Open Logs Directory` or `Open Configuration File` from the `Advanced` submenu. Or, find them in your OS as follows: +You can open these files from the IPFS Desktop logo menu by selecting `Open Logs Directory` or `Open Configuration File` from the `Advanced` submenu. Or, find them in your OS as follows: - **Mac:** `~/Library/Application Support/IPFS Desktop/` - **Windows:** `%appdata%/IPFS Desktop/` - **Linux:** `~/.config/IPFS Desktop/` @@ -196,13 +197,13 @@ You can open these files from the IPFS Desktop menubar/system tray menu by selec IPFS Desktop uses [ipfsd-ctl](https://github.com/ipfs/js-ipfsd-ctl), which, by default, checks the `IPFS_PATH` environment variable. If that isn't set, it falls back to `$HOME/.ipfs`. As soon as the first run has succeded, repository location info is saved in the configuration file, which becomes the source of truth. -To open your repo directory from the IPFS Desktop menubar/system tray menu, select `Open Repository Directory` from the `Advanced` submenu. +To open your repo directory from the IPFS Desktop logo menu, select `Open Repository Directory` from the `Advanced` submenu. ### Which version of IPFS does IPFS Desktop use? Since IPFS Desktop uses [ipfsd-ctl](https://github.com/ipfs/js-ipfsd-ctl), it includes its own embedded IPFS binary, which in most circumstances is the latest version of [go-ipfs](https://github.com/ipfs/go-ipfs). -You can check which version of IPFS you're running from the IPFS Desktop menubar/system tray menu by looking in the `About` submenu. +You can check which version of IPFS you're running from the IPFS Desktop logo menu by looking in the `About` submenu. ### Which flags does IPFS Desktop boot with? From dafda7974af81841c58d2e008a296eda7d22898f Mon Sep 17 00:00:00 2001 From: Jessica Schilling Date: Wed, 21 Oct 2020 15:35:52 -0600 Subject: [PATCH 18/27] Update README.md --- README.md | 26 ++++++++++++-------------- 1 file changed, 12 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 03edc4bd0..07936bf5c 100644 --- a/README.md +++ b/README.md @@ -15,9 +15,9 @@ Use IPFS Desktop to get acquainted with IPFS without needing to touch the comman | Files | Explore | Peers | Settings | Menu | |-------|---------|-------|----------|------| -| ![Screenshot of the file browser page](docs/screenshots/ipfs-webui-files.png) | ![Screenshot of the IPLD explorer page](docs/screenshots/ipfs-webui-explore.png) | ![Screenshot of the swarm peers map](docs/screenshots/ipfs-webui-peers.png) | ![Screenshot of the settings page](docs/screenshots/ipfs-webui-settings.png) | ![Screenshot of the settings page](docs/screenshots/ipfs-webui-settings.png) | +| ![Screenshot of the file browser page](docs/screenshots/ipfs-webui-files.png) | ![Screenshot of the IPLD explorer page](docs/screenshots/ipfs-webui-explore.png) | ![Screenshot of the swarm peers map](docs/screenshots/ipfs-webui-peers.png) | ![Screenshot of the settings page](docs/screenshots/ipfs-webui-settings.png) | ![Screenshot of Mac/Windows menus](https://gateway.ipfs.io/ipfs/QmbT2YtuNo17Qaq31FJWRZgRMY4E6N9cdfBwzZTFSHUoBP) | -**Install now!** 🎉 📥 +### Quick-install shortcuts - **Mac:** [IPFS-Desktop-0.13.2.dmg](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-0.13.2.dmg) or `brew cask install ipfs` - **Windows:** [IPFS-Desktop-Setup-0.13.2.exe](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-Setup-0.13.2.exe) or `choco install ipfs-desktop` @@ -27,7 +27,7 @@ Use IPFS Desktop to get acquainted with IPFS without needing to touch the comman - [Features](#features) - [Install](#install) -- [Contribute](#contribute) (including [translations](#translations)) +- [Contribute](#contribute) or [Translate](#translations) - [FAQ & Troubleshooting](#faq--troubleshooting) ## Features @@ -36,29 +36,27 @@ IPFS Desktop combines a complete IPFS node (running [go-ipfs](https://github.com 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. -![IPFS Desktop](https://gateway.ipfs.io/ipfs/QmbT2YtuNo17Qaq31FJWRZgRMY4E6N9cdfBwzZTFSHUoBP) - ### Start your node at system startup and control it from your OS IPFS Desktop can be set to launch at system startup, ensuring that your node is running whenever your computer is on. Plus, if you'd like to stop or restart your node at any point, you can do so straight from the IPFS logo menu in your OS menubar/system tray. -### Easily import files, folders, and screenshots to IPFS +### Quickly import files, folders, and screenshots to IPFS -Quickly import files and folders to your IPFS node in a variety of convenient ways: +Import files and folders to your IPFS node in a variety of convenient ways: - Drag and drop items onto IPFS Desktop's `Files` screen - Click the `Import` button on the `Files` screen to add items from your computer or an IPFS content ID - (Windows) Right-click a file/folder's icon to add it to IPFS from the pop-up menu -- (Mac) Drag and drop a file/folder onto the IPFS icon in your menubar +- (Mac) Drag and drop a file/folder onto the IPFS logo in your menubar Plus, you can use `Take Screenshot` under the IPFS logo menu to take a screenshot and import it to your node with one click. -### Use the Files screen to manage the contents of your node +### Easily manage the contents of your node -IPFS Desktop's `Files` screen gives you an easy, familiar interface for working with files on your IPFS node: +IPFS Desktop's `Files` screen gives you an easy, familiar interface for working with files on your node: - Easily rename, move, or remove files -- Preview most common file formats directly in IPFS Desktop +- Preview many common file formats directly in IPFS Desktop - Copy a file/folder's IPFS content ID or a shareable link to your clipboard -- ["Pin"](https://docs.ipfs.io/concepts/persistence/) files to your IPFS node or (coming soon!) to a third-party pinning service to ensure that important data is retained +- ["Pin"](https://docs.ipfs.io/concepts/persistence/) files to your IPFS node or (coming soon!) to a third-party pinning service ### Quick download for CIDs, IPFS paths, and IPNS paths @@ -76,7 +74,7 @@ Use the `Explore` screen to explore some example datasets — or your own files IPFS Desktop enables your operating system to support protocols including `ipfs://`, `ipns://` and `dweb:`. 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://ipfs.io`), it'll automatically open in IPFS Desktop. -For an even better experience in native support for `ipfs://`, `ipns://` and `dweb:` addresses, we recommend installing [IPFS Companion](https://github.com/ipfs-shipyard/ipfs-companion) as well! +For an even better experience with `ipfs://`, `ipns://` and `dweb:` addresses, we also recommend installing [IPFS Companion](https://github.com/ipfs-shipyard/ipfs-companion) to add support in your favorite browser! ### Learn IPFS commands as you go @@ -219,4 +217,4 @@ If you think you've found a bug or other issue with IPFS Desktop itself, please ## License -[MIT Protocol Labs, Inc.](./LICENSE) +[MIT — Protocol Labs, Inc.](./LICENSE) From f9e8db603a04fdc03436ea07a3ff1882e21a50dc Mon Sep 17 00:00:00 2001 From: Jessica Schilling Date: Wed, 21 Oct 2020 15:46:12 -0600 Subject: [PATCH 19/27] Add screenshots --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 07936bf5c..37bfcd68b 100644 --- a/README.md +++ b/README.md @@ -13,9 +13,9 @@ Use IPFS Desktop to get acquainted with IPFS without needing to touch the comman ![Status screen of IPFS Desktop](https://gateway.ipfs.io/ipfs/QmYHuXitXMf5xTjiQXmXdqszvMTADvrM5zA7EqoDj3d3RH) -| Files | Explore | Peers | Settings | Menu | +| Files screen | Explore screen | Peers screen | Settings screen | Menubar/taskbar | |-------|---------|-------|----------|------| -| ![Screenshot of the file browser page](docs/screenshots/ipfs-webui-files.png) | ![Screenshot of the IPLD explorer page](docs/screenshots/ipfs-webui-explore.png) | ![Screenshot of the swarm peers map](docs/screenshots/ipfs-webui-peers.png) | ![Screenshot of the settings page](docs/screenshots/ipfs-webui-settings.png) | ![Screenshot of Mac/Windows menus](https://gateway.ipfs.io/ipfs/QmbT2YtuNo17Qaq31FJWRZgRMY4E6N9cdfBwzZTFSHUoBP) | +| ![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) | ### Quick-install shortcuts @@ -145,7 +145,7 @@ Because IPFS Desktop app includes code from [IPFS Web UI](https://github.com/ipf - https://www.transifex.com/ipfs/ipfs-webui/ - https://www.transifex.com/ipfs/ipld-explorer/ -*Note for developers: We use English as our source of truth. This means that if you add any new text, make those additions in [./assets/locales/en.json](./assets/locales/en.json) and they will automatically propagate in Transifex for other languages.* +*Note for developers: We use English as our source of truth. This means that if you add any new text, make those additions in `[./assets/locales/en.json]`(./assets/locales/en.json) and they will automatically propagate in Transifex for other languages.* ### Developer notes From 173c8220e026f47ed85829e0c11d09f3d3f3f957 Mon Sep 17 00:00:00 2001 From: Jessica Schilling Date: Wed, 21 Oct 2020 15:58:20 -0600 Subject: [PATCH 20/27] Last tweaks before review --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 37bfcd68b..460bad935 100644 --- a/README.md +++ b/README.md @@ -7,9 +7,9 @@ [![total download count](https://img.shields.io/github/downloads/ipfs-shipyard/ipfs-desktop/total.svg?style=flat-square&label=all%20downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases) [![latest release download count](https://img.shields.io/github/downloads/ipfs-shipyard/ipfs-desktop/v0.13.2/total.svg?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/tag/v0.13.2) -**IPFS Desktop gives you all the power of [IPFS](https://ipfs.io) in an easy desktop app: a complete IPFS node, plus handy OS menubar/taskbar shortcuts and an all-in-one file manager, peer map, and content explorer.** +**IPFS Desktop gives you all the power of [IPFS](https://ipfs.io) 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.** -Use IPFS Desktop to get acquainted with IPFS without needing to touch the command line — or, if you're already experienced, use the powerful menubar/taskbar shortcuts alongside the command line to make your IPFS workflow faster. +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. ![Status screen of IPFS Desktop](https://gateway.ipfs.io/ipfs/QmYHuXitXMf5xTjiQXmXdqszvMTADvrM5zA7EqoDj3d3RH) @@ -48,12 +48,12 @@ Import files and folders to your IPFS node in a variety of convenient ways: - (Windows) Right-click a file/folder's icon to add it to IPFS from the pop-up menu - (Mac) Drag and drop a file/folder onto the IPFS logo in your menubar -Plus, you can use `Take Screenshot` under the IPFS logo menu to take a screenshot and import it to your node with one click. +Plus, you can use the `Take Screenshot` command under the IPFS logo menu to take a screenshot and import it to your node with one click. ### Easily manage the contents of your node -IPFS Desktop's `Files` screen gives you an easy, familiar interface for working with files on your node: -- Easily rename, move, or remove files +IPFS Desktop's `Files` screen gives you an easy, familiar interface for working with the contents of your node: +- Easily rename, move, or remove files and folders - Preview many common file formats directly in IPFS Desktop - Copy a file/folder's IPFS content ID or a shareable link to your clipboard - ["Pin"](https://docs.ipfs.io/concepts/persistence/) files to your IPFS node or (coming soon!) to a third-party pinning service @@ -109,7 +109,7 @@ Don't see your favorite package manager? Visit our [package managers page](https - **FreeBSD** (experimental): [ipfs-desktop-0.13.2-linux-x64.freebsd](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x64.freebsd)\ [![](https://img.shields.io/github/downloads/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-x64.freebsd.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x64.freebsd) - **Snapcraft** (community-maintained): `snap install ipfs-desktop` -- **AUR** (maintained by [@alexhenrie](https://github.com/alexhenrie)): [`ipfs-desktop` package](https://aur.archlinux.org/packages/ipfs-desktop/) +- **AUR** (maintained by [@alexhenrie](https://github.com/alexhenrie)): Use the [`ipfs-desktop` package](https://aur.archlinux.org/packages/ipfs-desktop/) ### Install from source @@ -138,14 +138,14 @@ No matter how you contribute, please be sure you read and follow the [IPFS Contr ### Translations -Contributing translations in your language is particularly valuable! We use Transifex to manage internationalization, which means you don't need to change any of the code in this repo to add your translations — just sign up for a Transifex account. +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. -Because IPFS Desktop app includes code 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: +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: - https://www.transifex.com/ipfs/ipfs-desktop/ - https://www.transifex.com/ipfs/ipfs-webui/ - https://www.transifex.com/ipfs/ipld-explorer/ -*Note for developers: We use English as our source of truth. This means that if you add any new text, make those additions in `[./assets/locales/en.json]`(./assets/locales/en.json) and they will automatically propagate in Transifex for other languages.* +*Note for developers: We use English as our source of truth. This means that if you add any new text, make those additions in [`./assets/locales/en.json`](./assets/locales/en.json) and they will automatically propagate in Transifex for other languages.* ### Developer notes @@ -186,7 +186,7 @@ $ ipfs-desktop --no-sandbox ### Where are my IPFS configuration and log files? -You can open these files from the IPFS Desktop logo menu by selecting `Open Logs Directory` or `Open Configuration File` from the `Advanced` submenu. Or, find them in your OS as follows: +You can open these 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: - **Mac:** `~/Library/Application Support/IPFS Desktop/` - **Windows:** `%appdata%/IPFS Desktop/` - **Linux:** `~/.config/IPFS Desktop/` @@ -195,13 +195,13 @@ You can open these files from the IPFS Desktop logo menu by selecting `Open Logs IPFS Desktop uses [ipfsd-ctl](https://github.com/ipfs/js-ipfsd-ctl), which, by default, checks the `IPFS_PATH` environment variable. If that isn't set, it falls back to `$HOME/.ipfs`. As soon as the first run has succeded, repository location info is saved in the configuration file, which becomes the source of truth. -To open your repo directory from the IPFS Desktop logo menu, select `Open Repository Directory` from the `Advanced` submenu. +To open your repo directory from the IPFS logo menu, select `Open Repository Directory` from the `Advanced` submenu. ### Which version of IPFS does IPFS Desktop use? Since IPFS Desktop uses [ipfsd-ctl](https://github.com/ipfs/js-ipfsd-ctl), it includes its own embedded IPFS binary, which in most circumstances is the latest version of [go-ipfs](https://github.com/ipfs/go-ipfs). -You can check which version of IPFS you're running from the IPFS Desktop logo menu by looking in the `About` submenu. +You can check which version of IPFS you're running from the IPFS logo menu by looking in the `About` submenu. ### Which flags does IPFS Desktop boot with? From 2f90d8919fab87368a853052651f199af20b88d7 Mon Sep 17 00:00:00 2001 From: Jessica Schilling Date: Thu, 22 Oct 2020 12:31:46 -0600 Subject: [PATCH 21/27] Update README.md Co-authored-by: Marcin Rataj --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 460bad935..047c8296f 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ If you already have an IPFS node on your computer, IPFS Desktop will act as a co ### Start your node at system startup and control it from your OS -IPFS Desktop can be set to launch at system startup, ensuring that your node is running whenever your computer is on. Plus, if you'd like to stop or restart your node at any point, you can do so straight from the IPFS logo menu in your OS menubar/system tray. +(Mac/Windows) IPFS Desktop can be set to launch at system startup, ensuring that your node is running whenever your computer is on. Plus, if you'd like to stop or restart your node at any point, you can do so straight from the IPFS logo menu in your OS menubar/system tray. ### Quickly import files, folders, and screenshots to IPFS From 1b49c92e71616c97c03c5ade8d5849f25f672eaa Mon Sep 17 00:00:00 2001 From: Jessica Schilling Date: Thu, 22 Oct 2020 12:32:16 -0600 Subject: [PATCH 22/27] Update README.md Co-authored-by: Marcin Rataj --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 047c8296f..7322ef880 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,7 @@ Import files and folders to your IPFS node in a variety of convenient ways: - (Windows) Right-click a file/folder's icon to add it to IPFS from the pop-up menu - (Mac) Drag and drop a file/folder onto the IPFS logo in your menubar -Plus, you can use the `Take Screenshot` command under the IPFS logo menu to take a screenshot and import it to your node with one click. +Plus, you can use the `Take Screenshot` command under the IPFS logo menu to take a screenshot and import it to your node with one click. Shareable link will be automatically placed in your clipboard. ### Easily manage the contents of your node From 5c342c60de72059df85a824138b65836791a045d Mon Sep 17 00:00:00 2001 From: Jessica Schilling Date: Thu, 22 Oct 2020 12:32:35 -0600 Subject: [PATCH 23/27] Update README.md Co-authored-by: Marcin Rataj --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7322ef880..742f237ec 100644 --- a/README.md +++ b/README.md @@ -72,7 +72,7 @@ Use the `Explore` screen to explore some example datasets — or your own files ### Enjoy OS-wide support for IPFS files and links -IPFS Desktop enables your operating system to support protocols including `ipfs://`, `ipns://` and `dweb:`. 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://ipfs.io`), it'll automatically open in IPFS Desktop. +IPFS Desktop enables your operating system (Mac/Windows and some Linux variants) to support protocols including `ipfs://`, `ipns://` and `dweb:`. 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. For an even better experience with `ipfs://`, `ipns://` and `dweb:` addresses, we also recommend installing [IPFS Companion](https://github.com/ipfs-shipyard/ipfs-companion) to add support in your favorite browser! From 810004c8051de149159e17ae29e455969680ab80 Mon Sep 17 00:00:00 2001 From: Jessica Schilling Date: Thu, 22 Oct 2020 12:33:02 -0600 Subject: [PATCH 24/27] Update README.md Co-authored-by: Marcin Rataj --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 742f237ec..7a5c3d544 100644 --- a/README.md +++ b/README.md @@ -207,7 +207,7 @@ You can check which version of IPFS you're running from the IPFS logo menu by lo By default, IPFS Desktop starts the IPFS daemon with the flags `--migrate=true --routing=dhtclient ----enable-gc=true`. -You can change this in the config file by editing the `IPFS Config` section of IPFS Desktop's `Settings` screen. +You can change this in the Desktop config file by selecting `Open Configuration File` from the `Advanced` submenu. ### I need more help! From 7966d6b06ca6bed22a1153d409fc5764455381ce Mon Sep 17 00:00:00 2001 From: Jessica Schilling Date: Thu, 22 Oct 2020 12:33:19 -0600 Subject: [PATCH 25/27] Update README.md Co-authored-by: Marcin Rataj --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7a5c3d544..1a011202f 100644 --- a/README.md +++ b/README.md @@ -199,7 +199,7 @@ To open your repo directory from the IPFS logo menu, select `Open Repository Dir ### Which version of IPFS does IPFS Desktop use? -Since IPFS Desktop uses [ipfsd-ctl](https://github.com/ipfs/js-ipfsd-ctl), it includes its own embedded IPFS binary, which in most circumstances is the latest version of [go-ipfs](https://github.com/ipfs/go-ipfs). +IPFS Desktop includes its own embedded binary in version defined in `package.json`, which iis the latest version of [go-ipfs](https://github.com/ipfs/go-ipfs) that passed QA for desktop use. You can check which version of IPFS you're running from the IPFS logo menu by looking in the `About` submenu. From 40228023db5c2cfaa714f7ab48c4c8543655a815 Mon Sep 17 00:00:00 2001 From: Jessica Schilling Date: Thu, 22 Oct 2020 12:35:04 -0600 Subject: [PATCH 26/27] Update README.md Co-authored-by: Marcin Rataj --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1a011202f..39ecd1962 100644 --- a/README.md +++ b/README.md @@ -55,7 +55,7 @@ Plus, you can use the `Take Screenshot` command under the IPFS logo menu to take IPFS Desktop's `Files` screen gives you an easy, familiar interface for working with the contents of your node: - Easily rename, move, or remove files and folders - Preview many common file formats directly in IPFS Desktop -- Copy a file/folder's IPFS content ID or a shareable link to your clipboard +- Copy a file/folder's IPFS [content ID (CID)](https://docs.ipfs.io/concepts/content-addressing/#identifier-formats) or a shareable link to your clipboard - ["Pin"](https://docs.ipfs.io/concepts/persistence/) files to your IPFS node or (coming soon!) to a third-party pinning service ### Quick download for CIDs, IPFS paths, and IPNS paths From dc29c5d9b7da5de511b6acfe13b8dc5eea69e2e3 Mon Sep 17 00:00:00 2001 From: Jessica Schilling Date: Thu, 22 Oct 2020 12:49:17 -0600 Subject: [PATCH 27/27] One more round of copy edits --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 39ecd1962..d9d0ad37d 100644 --- a/README.md +++ b/README.md @@ -38,17 +38,17 @@ If you already have an IPFS node on your computer, IPFS Desktop will act as a co ### Start your node at system startup and control it from your OS -(Mac/Windows) IPFS Desktop can be set to launch at system startup, ensuring that your node is running whenever your computer is on. Plus, if you'd like to stop or restart your node at any point, you can do so straight from the IPFS logo menu in your OS menubar/system tray. +IPFS Desktop enables you to stop or restart your node straight from the IPFS logo menu in your OS menubar/system tray. For Mac and Windows users, IPFS Desktop can be also be set to launch at system startup, ensuring that your node is running whenever your computer is on. ### Quickly import files, folders, and screenshots to IPFS Import files and folders to your IPFS node in a variety of convenient ways: - Drag and drop items onto IPFS Desktop's `Files` screen -- Click the `Import` button on the `Files` screen to add items from your computer or an IPFS content ID +- Click the `Import` button on the `Files` screen to add items from your computer or an IPFS [content ID (CID)](https://docs.ipfs.io/concepts/content-addressing/#identifier-formats) - (Windows) Right-click a file/folder's icon to add it to IPFS from the pop-up menu - (Mac) Drag and drop a file/folder onto the IPFS logo in your menubar -Plus, you can use the `Take Screenshot` command under the IPFS logo menu to take a screenshot and import it to your node with one click. Shareable link will be automatically placed in your clipboard. +Plus, you can use the `Take Screenshot` command under the IPFS logo menu to take a screenshot, import it to your node, and copy a shareable link to your clipboard with one click. ### Easily manage the contents of your node @@ -72,7 +72,7 @@ Use the `Explore` screen to explore some example datasets — or your own files ### Enjoy OS-wide support for IPFS files and links -IPFS Desktop enables your operating system (Mac/Windows and some Linux variants) to support protocols including `ipfs://`, `ipns://` and `dweb:`. 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. +IPFS Desktop enables most operating systems (Mac, Windows and some Linux flavors) to support protocols including `ipfs://`, `ipns://` and `dweb:`. 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. For an even better experience with `ipfs://`, `ipns://` and `dweb:` addresses, we also recommend installing [IPFS Companion](https://github.com/ipfs-shipyard/ipfs-companion) to add support in your favorite browser! @@ -199,7 +199,7 @@ To open your repo directory from the IPFS logo menu, select `Open Repository Dir ### Which version of IPFS does IPFS Desktop use? -IPFS Desktop includes its own embedded binary in version defined in `package.json`, which iis the latest version of [go-ipfs](https://github.com/ipfs/go-ipfs) that passed QA for desktop use. +IPFS Desktop includes its own embedded binary (with version defined in `package.json`); this is the latest version of [go-ipfs](https://github.com/ipfs/go-ipfs) that has passed QA for IPFS Desktop use. You can check which version of IPFS you're running from the IPFS logo menu by looking in the `About` submenu. @@ -207,7 +207,7 @@ You can check which version of IPFS you're running from the IPFS logo menu by lo By default, IPFS Desktop starts the IPFS daemon with the flags `--migrate=true --routing=dhtclient ----enable-gc=true`. -You can change this in the Desktop config file by selecting `Open Configuration File` from the `Advanced` submenu. +You can change this in the IPFS Desktop config file by selecting `Open Configuration File` from the `Advanced` submenu. ### I need more help!